The Quantum Exact Simulation Toolkit v4.1.0
Loading...
Searching...
No Matches
quest.h.in
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 * Preprocessor 'INCLUDE_DEPRECATED_FUNCTIONS' can
6 * be defined as 1 to additionally include QuEST's
7 * deprecated v3 API, before including this header.
8 *
9 * @author Tyson Jones
10 * @author Luc Jaulmes (patching CMake install)
11 *
12 * @defgroup api 📋 API
13 */
14
15/**
16 * @page apilink 📋 API
17 * The API documentation can be viewed at @ref api.
18 *
19 * We're working hard to move that page up one level. 😎
20 */
21
22/**
23 * @page testlink 🧪 Tests
24 *
25 * The unit and integration tests can be viewed at @ref tests.
26 *
27 * We're working hard to move that page up one level. 😎
28 */
29
30#ifndef QUEST_H
31#define QUEST_H
32
33
34// bind compile settings to installed exec
35#if !@MULTI_LIB_HEADERS@
36#cmakedefine FLOAT_PRECISION @FLOAT_PRECISION@
37#cmakedefine01 COMPILE_MPI
38#cmakedefine01 COMPILE_OPENMP
39#cmakedefine01 COMPILE_CUDA
40#cmakedefine01 COMPILE_CUQUANTUM
41#endif
42
43
44// include version first so it is accessible to
45// debuggers in case a subsequent include fails
46#include "quest/include/version.h"
47
48// include before API headers since it validates
49// preprocessor configuration, and affirms macro
50// preconditions assumed by subsequent header
51#include "quest/include/modes.h"
52
53#include "quest/include/precision.h"
54#include "quest/include/types.h"
55#include "quest/include/calculations.h"
56#include "quest/include/debug.h"
57#include "quest/include/decoherence.h"
58#include "quest/include/environment.h"
59#include "quest/include/initialisations.h"
60#include "quest/include/channels.h"
61#include "quest/include/operations.h"
62#include "quest/include/paulis.h"
63#include "quest/include/qureg.h"
64#include "quest/include/matrices.h"
65#include "quest/include/wrappers.h"
66
67
68#if INCLUDE_DEPRECATED_FUNCTIONS
69 #include "quest/include/deprecated.h"
70#endif
71
72
73
74#endif // QUEST_H