The Quantum Exact Simulation Toolkit v4.0.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 * 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 *
11 * @defgroup api 📋 API
12 */
13
14/**
15 * @page apilink 📋 API
16 * The API documentation can be viewed at @ref api.
17 *
18 * We're working hard to move that page up one level. 😎
19 */
20
21/**
22 * @page testlink 🧪 Tests
23 *
24 * The unit and integration tests can be viewed at @ref tests.
25 *
26 * We're working hard to move that page up one level. 😎
27 */
28
29#ifndef QUEST_H
30#define QUEST_H
31
32
33// include version first so it is accessible to
34// debuggers in case a subsequent include fails
35#include "quest/include/version.h"
36
37// include before API headers since it validates
38// preprocessor configuration, and affirms macro
39// preconditions assumed by subsequent header
40#include "quest/include/modes.h"
41
42#include "quest/include/precision.h"
43#include "quest/include/types.h"
44#include "quest/include/calculations.h"
45#include "quest/include/debug.h"
46#include "quest/include/decoherence.h"
47#include "quest/include/environment.h"
48#include "quest/include/initialisations.h"
49#include "quest/include/channels.h"
50#include "quest/include/operations.h"
51#include "quest/include/paulis.h"
52#include "quest/include/qureg.h"
53#include "quest/include/matrices.h"
54#include "quest/include/wrappers.h"
55
56
57#if INCLUDE_DEPRECATED_FUNCTIONS
58 #include "quest/include/deprecated.h"
59#endif
60
61
62
63#endif // QUEST_H