The Quantum Exact Simulation Toolkit v4.2.0
Loading...
Searching...
No Matches
quest.h
1/** @file
2 * The main QuEST header, exposing the entire API.
3 * This header is intendedly included by user
4 * source-code, and is both C11 and C++14 compatible.
5 *
6 * @author Tyson Jones
7 * @author Luc Jaulmes (patching CMake install)
8 *
9 * @defgroup api 📋 API
10 */
11
12/**
13 * @page apilink 📋 API
14 * The API documentation can be viewed at @ref api.
15 *
16 * We're working hard to move that page up one level. 😎
17 */
18
19/**
20 * @page testlink 🧪 Tests
21 *
22 * The unit and integration tests can be viewed at @ref tests.
23 *
24 * We're working hard to move that page up one level. 😎
25 */
26
27#ifndef QUEST_H
28#define QUEST_H
29
30// include config.h first to define macros
31// consulted by subsequent headers
32#include "quest/include/config.h"
33
34#include "quest/include/modes.h"
35#include "quest/include/precision.h"
36#include "quest/include/types.h"
37#include "quest/include/calculations.h"
38#include "quest/include/debug.h"
39#include "quest/include/decoherence.h"
40#include "quest/include/environment.h"
41#include "quest/include/trotterisation.h"
42#include "quest/include/initialisations.h"
43#include "quest/include/channels.h"
44#include "quest/include/multiplication.h"
45#include "quest/include/operations.h"
46#include "quest/include/paulis.h"
47#include "quest/include/qureg.h"
48#include "quest/include/matrices.h"
49#include "quest/include/wrappers.h"
50
51
52#if INCLUDE_DEPRECATED_FUNCTIONS
53 #include "quest/include/deprecated.h"
54#endif
55
56
57
58#endif // QUEST_H