The Quantum Exact Simulation Toolkit v4.3.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// Create empty 'apilink' and 'testlink' top-level pages which
14// will appear as links in the left-hand navigation column of
15// the rendered doc pages. We will redirect the links to the
16// API and Test doc groups within doxygen-awesome-quest.js
17
18/**
19 * @page apilink 📋 API
20 * @page testlink 🧪 Tests
21 */
22
23
24#ifndef QUEST_H
25#define QUEST_H
26
27// include config.h first to define macros
28// consulted by subsequent headers
29#include "quest/include/config.h"
30
31#include "quest/include/modes.h"
32#include "quest/include/precision.h"
33#include "quest/include/types.h"
34#include "quest/include/calculations.h"
35#include "quest/include/debug.h"
36#include "quest/include/decoherence.h"
37#include "quest/include/environment.h"
38#include "quest/include/experimental.h"
39#include "quest/include/trotterisation.h"
40#include "quest/include/initialisations.h"
41#include "quest/include/channels.h"
42#include "quest/include/multiplication.h"
43#include "quest/include/operations.h"
44#include "quest/include/paulis.h"
45#include "quest/include/qureg.h"
46#include "quest/include/matrices.h"
47#include "quest/include/wrappers.h"
48
49#if QUEST_INCLUDE_DEPRECATED_FUNCTIONS
50 #include "quest/include/deprecated.h"
51#endif
52
53#endif // QUEST_H