added doc to unit tests

with new doxygen group 'unittest'
QuEST-Kit · Jan 15, 2020 · 44ca661 · 44ca661
1 parent a0ce170
commit 44ca661
Show file tree

Hide file tree

Showing 8 changed files with 356 additions and 1 deletion.
diff --git a/testing/QuEST_test_calculations.cpp b/testing/QuEST_test_calculations.cpp
@@ -8,6 +8,10 @@ using Catch::Matchers::Contains;
 
 
 
+/** @sa calcDensityInnerProduct
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "calcDensityInnerProduct", "[calculations]" ) {
 
     Qureg mat1 = createDensityQureg(NUM_QUBITS, QUEST_ENV);
@@ -100,6 +104,10 @@ TEST_CASE( "calcDensityInnerProduct", "[calculations]" ) {
 
 
 
+/** @sa calcExpecPauliProd
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "calcExpecPauliProd", "[calculations]" ) {
 
     Qureg vec = createQureg(NUM_QUBITS, QUEST_ENV);
@@ -238,6 +246,10 @@ TEST_CASE( "calcExpecPauliProd", "[calculations]" ) {
 
 
 
+/** @sa calcExpecPauliSum
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "calcExpecPauliSum", "[calculations]" ) {
 
     Qureg vec = createQureg(NUM_QUBITS, QUEST_ENV);
@@ -374,6 +386,10 @@ TEST_CASE( "calcExpecPauliSum", "[calculations]" ) {
 
 
 
+/** @sa calcFidelity
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "calcFidelity", "[calculations]" ) {
 
     Qureg vec = createQureg(NUM_QUBITS, QUEST_ENV);
@@ -522,6 +538,10 @@ TEST_CASE( "calcFidelity", "[calculations]" ) {
 
 
 
+/** @sa calcHilbertSchmidtDistance
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "calcHilbertSchmidtDistance", "[calculations]" ) {
 
     Qureg mat1 = createDensityQureg(NUM_QUBITS, QUEST_ENV);
@@ -614,6 +634,10 @@ TEST_CASE( "calcHilbertSchmidtDistance", "[calculations]" ) {
 
 
 
+/** @sa calcInnerProduct
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "calcInnerProduct", "[calculations]" ) {
 
     Qureg vec1 = createQureg(NUM_QUBITS, QUEST_ENV);
@@ -685,6 +709,10 @@ TEST_CASE( "calcInnerProduct", "[calculations]" ) {
 
 
 
+/** @sa calcProbOfOutcome
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "calcProbOfOutcome", "[calculations]" ) {
 
     Qureg vec = createQureg(NUM_QUBITS, QUEST_ENV);
@@ -804,6 +832,10 @@ TEST_CASE( "calcProbOfOutcome", "[calculations]" ) {
 
 
 
+/** @sa calcPurity
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "calcPurity", "[calculations]" ) {
 
     Qureg mat = createDensityQureg(NUM_QUBITS, QUEST_ENV);
@@ -872,6 +904,10 @@ TEST_CASE( "calcPurity", "[calculations]" ) {
 
 
 
+/** @sa calcTotalProb
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "calcTotalProb", "[calculations]" ) {
 
     Qureg vec = createQureg(NUM_QUBITS, QUEST_ENV);
@@ -935,6 +971,10 @@ TEST_CASE( "calcTotalProb", "[calculations]" ) {
 
 
 
+/** @sa getAmp
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "getAmp", "[calculations]" ) {
 
     Qureg vec = createQureg(NUM_QUBITS, QUEST_ENV);
@@ -970,6 +1010,10 @@ TEST_CASE( "getAmp", "[calculations]" ) {
 
 
 
+/** @sa getDensityAmp
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "getDensityAmp", "[calculations]" ) {
 
     Qureg mat = createDensityQureg(NUM_QUBITS, QUEST_ENV);
@@ -1009,6 +1053,10 @@ TEST_CASE( "getDensityAmp", "[calculations]" ) {
 
 
 
+/** @sa getImagAmp
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "getImagAmp", "[calculations]" ) {
 
     Qureg vec = createQureg(NUM_QUBITS, QUEST_ENV);
@@ -1043,6 +1091,10 @@ TEST_CASE( "getImagAmp", "[calculations]" ) {
 
 
 
+/** @sa getNumAmps
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "getNumAmps", "[calculations]" ) {
 
     SECTION( "correctness" ) {
@@ -1069,6 +1121,10 @@ TEST_CASE( "getNumAmps", "[calculations]" ) {
 
 
 
+/** @sa getNumQubits
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "getNumQubits", "[calculations]" ) {
 
     SECTION( "correctness" ) {
@@ -1098,6 +1154,10 @@ TEST_CASE( "getNumQubits", "[calculations]" ) {
 
 
 
+/** @sa getProbAmp
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "getProbAmp", "[calculations]" ) {
 
     Qureg vec = createQureg(NUM_QUBITS, QUEST_ENV);
@@ -1133,6 +1193,10 @@ TEST_CASE( "getProbAmp", "[calculations]" ) {
 
 
 
+/** @sa getRealAmp
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "getRealAmp", "[calculations]" ) {
 
     Qureg vec = createQureg(NUM_QUBITS, QUEST_ENV);

diff --git a/testing/QuEST_test_data_structures.cpp b/testing/QuEST_test_data_structures.cpp
@@ -8,6 +8,10 @@ using Catch::Matchers::Contains;
 
 
 
+/** @sa fromComplex
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "fromComplex", "[data_structures]" ) {
 
     Complex a = {.real=.5, .imag=-.2};
@@ -19,6 +23,10 @@ TEST_CASE( "fromComplex", "[data_structures]" ) {
 
 
 
+/** @sa getStaticComplexMatrixN
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "getStaticComplexMatrixN", "[data_structures]" ) {
 
     /* use of this function is illegal in C++ */
@@ -27,6 +35,10 @@ TEST_CASE( "getStaticComplexMatrixN", "[data_structures]" ) {
 
 
 
+/** @sa toComplex
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "toComplex", "[data_structures]" ) {
 
     qcomp a = .5 - .2i;
@@ -38,6 +50,10 @@ TEST_CASE( "toComplex", "[data_structures]" ) {
 
 
 
+/** @sa createCloneQureg
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "createCloneQureg", "[data_structures]" ) {
 
     SECTION( "state-vector" ) {
@@ -80,6 +96,10 @@ TEST_CASE( "createCloneQureg", "[data_structures]" ) {
 
 
 
+/** @sa createComplexMatrixN
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "createComplexMatrixN", "[data_structures]" ) {
 
     SECTION( "correctness" ) {
@@ -104,6 +124,10 @@ TEST_CASE( "createComplexMatrixN", "[data_structures]" ) {
 
 
 
+/** @sa createDensityQureg
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "createDensityQureg", "[data_structures]" ) {
 
     // must be at least one amplitude per node
@@ -159,6 +183,10 @@ TEST_CASE( "createDensityQureg", "[data_structures]" ) {
 
 
 
+/** @sa createQuESTEnv
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "createQuESTEnv", "[data_structures]" ) {
 
     /* there is no meaningful way to test this */
@@ -167,6 +195,10 @@ TEST_CASE( "createQuESTEnv", "[data_structures]" ) {
 
 
 
+/** @sa createQureg
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "createQureg", "[data_structures]" ) {
 
     // must be at least one amplitude per node
@@ -220,6 +252,10 @@ TEST_CASE( "createQureg", "[data_structures]" ) {
 
 
 
+/** @sa destroyComplexMatrixN
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "destroyComplexMatrixN", "[data_structures]" ) {
 
     SECTION( "correctness" ) {
@@ -247,6 +283,10 @@ TEST_CASE( "destroyComplexMatrixN", "[data_structures]" ) {
 
 
 
+/** @sa destroyQuESTEnv
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "destroyQuESTEnv", "[data_structures]" ) {
 
     /* there is no meaningful way to test this */
@@ -255,6 +295,10 @@ TEST_CASE( "destroyQuESTEnv", "[data_structures]" ) {
 
 
 
+/** @sa destroyQureg
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "destroyQureg", "[data_structures]" ) {
 
     /* there is no meaningful way to test this.
@@ -268,6 +312,10 @@ TEST_CASE( "destroyQureg", "[data_structures]" ) {
 
 
 
+/** @sa initComplexMatrixN
+ * @ingroup unittest 
+ * @author Tyson Jones 
+ */
 TEST_CASE( "initComplexMatrixN", "[data_structures]" ) {
 
     /* use of this function is illegal in C++ */