test_data_structures.cpp

/** @file
 * Ported tests of the deprecated QuEST v3 interface,
 * unit testing the "data structures" module.
 * 
 * This file should be excluded from doxygen parsing so 
 * as not to conflict with the doc of the v4 unit tests.
 * 
 * @author Tyson Jones
 * @author Oliver Thomson Brown (ported to Catch2 v3)
 * @author Ali Rezaei (tested porting to QuEST v4)
 * @author Richard Meister (QuEST v3 patches)
 */
 
#include <catch2/catch_test_macros.hpp>
#include <catch2/matchers/catch_matchers_string.hpp>
#include <catch2/generators/catch_generators_range.hpp>
 
// must define preprocessors to enable quest's
// deprecated v3 API, and disable the numerous
// warnings issued by its compilation
#define INCLUDE_DEPRECATED_FUNCTIONS 1
#define DISABLE_DEPRECATION_WARNINGS 1
#include "quest/include/quest.h"
 
#include "test_utilities.hpp"
 
/* allows concise use of ContainsSubstring in catch's REQUIRE_THROWS_WITH */
using Catch::Matchers::ContainsSubstring;
 
 
 
// fromComplex removed because Complex is completely deprecated
 
    // /** @sa fromComplex
    //  * @ingroup deprecatedtests 
    //  * @author Tyson Jones 
    //  */
    // TEST_CASE( "fromComplex", "[data_structures]" ) {
        
    //     Complex a; 
    //     a.real= .5;
    //     a.imag= -.2;
    //     qcomp b = fromComplex(a);
        
    //     REQUIRE( a.real == real(b) );
    //     REQUIRE( a.imag == imag(b) );
    // }
 
 
 
// getStaticComplexMatrixN is completely deprecated
 
    // /** @sa getStaticComplexMatrixN
    //  * @ingroup deprecatedtests 
    //  * @author Tyson Jones 
    //  */
    // TEST_CASE( "getStaticComplexMatrixN", "[data_structures]" ) {
        
    //     /* use of this function is illegal in C++ */
    //     SUCCEED( );
    // }
 
 
 
// toComplex removed because Complex is completely deprecated 
 
    // /** @sa toComplex
    //  * @ingroup deprecatedtests 
    //  * @author Tyson Jones 
    //  */
    // TEST_CASE( "toComplex", "[data_structures]" ) {
        
    //     qcomp a = qcomp(.5,-.2);
    //     #if (!defined(_WIN32)) && (!defined(_WIN64))
    //     Complex b = toComplex(a);
    //     #else
    //     // MSVC profanely forbids in-line struct initialisation
    //     Complex b; b.real = real(a); b.imag = imag(a);
    //     #endif
        
    //     REQUIRE( real(a) == b.real );
    //     REQUIRE( imag(a) == b.imag );
    // }
 
 
 
/** @sa createCloneQureg
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "createCloneQureg", "[data_structures]" ) {
        
    SECTION( "state-vector" ) {
        
        Qureg a = createForcedQureg(NUM_QUBITS);    
        Qureg b = createCloneQureg(a);
        
        // check properties are the same
        REQUIRE( b.isMultithreaded  == a.isMultithreaded );
        REQUIRE( b.isGpuAccelerated == a.isGpuAccelerated );
        REQUIRE( b.isDistributed    == a.isDistributed );
 
        REQUIRE( b.rank        == a.rank );
        REQUIRE( b.numNodes    == a.numNodes );
        REQUIRE( b.logNumNodes == a.logNumNodes );
 
        REQUIRE( b.isDensityMatrix == a.isDensityMatrix );
        REQUIRE( b.numQubits       == a.numQubits );
        REQUIRE( b.numAmps         == a.numAmps );
        REQUIRE( b.logNumAmps      == a.logNumAmps );
 
        REQUIRE( b.numAmpsPerNode    == a.numAmpsPerNode );
        REQUIRE( b.logNumAmpsPerNode == a.logNumAmpsPerNode );
        REQUIRE( b.logNumColsPerNode == a.logNumColsPerNode );
        
        // check amps the same (works for GPU and distributed)
        REQUIRE( areEqual(a, b) );  
        
        destroyQureg(a);
        destroyQureg(b);
    }
    SECTION( "density-matrix" ) {
        
        Qureg a = createForcedDensityQureg(NUM_QUBITS);
        Qureg b = createCloneQureg(a);
        
        // check properties are the same
        REQUIRE( b.isMultithreaded  == a.isMultithreaded );
        REQUIRE( b.isGpuAccelerated == a.isGpuAccelerated );
        REQUIRE( b.isDistributed    == a.isDistributed );
 
        REQUIRE( b.rank        == a.rank );
        REQUIRE( b.numNodes    == a.numNodes );
        REQUIRE( b.logNumNodes == a.logNumNodes );
 
        REQUIRE( b.isDensityMatrix == a.isDensityMatrix );
        REQUIRE( b.numQubits       == a.numQubits );
        REQUIRE( b.numAmps         == a.numAmps );
        REQUIRE( b.logNumAmps      == a.logNumAmps );
 
        REQUIRE( b.numAmpsPerNode    == a.numAmpsPerNode );
        REQUIRE( b.logNumAmpsPerNode == a.logNumAmpsPerNode );
        REQUIRE( b.logNumColsPerNode == a.logNumColsPerNode );
        
        // check amps are the same (works for GPU and distributed)
        REQUIRE( areEqual(a, b) );  
        
        destroyQureg(a);
        destroyQureg(b);
    }
}
 
 
 
/** @sa createComplexMatrixN
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "createComplexMatrixN", "[data_structures]" ) {
    
    SECTION( "correctness" ) {
        
        int numQb = GENERATE( range(1,10+1) );
        ComplexMatrixN m = createComplexMatrixN(numQb);
        
        // ensure elems are created and initialised to 0
        REQUIRE( areEqual(toQMatrix(m), getZeroMatrix(1<<numQb)) );
        
        destroyComplexMatrixN(m);
    }
    SECTION( "input validation" ) {
        
        SECTION( "number of qubits" ) {
            
            int numQb = GENERATE( -1, 0 );
            REQUIRE_THROWS_WITH( createComplexMatrixN(numQb), ContainsSubstring("must target one or more qubits") );
        }
    }
}
 
 
 
/** @sa createDensityQureg
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "createDensityQureg", "[data_structures]" ) {
        
    // must be at least one column per node
    int minNumQb = calcLog2(getQuESTEnv().numNodes);
    if (minNumQb <= 0)
        minNumQb = 1;
    
    SECTION( "correctness" ) {
        
        // try 10 valid number of qubits
        int numQb = GENERATE_COPY( range(minNumQb, minNumQb+10) );
        Qureg reg = createForcedDensityQureg(numQb);
        
        // ensure elems (CPU and/or GPU) are created, and reg begins in |0><0|
        QMatrix ref = getZeroMatrix(1<<numQb);
        ref[0][0] = 1; // |0><0|
        REQUIRE( areEqual(reg, ref) );
        
        destroyQureg(reg);
    }
    SECTION( "input validation") {
        
        SECTION( "number of qubits" ) {
            
            int numQb = GENERATE( -1, 0 );
            REQUIRE_THROWS_WITH( createForcedDensityQureg(numQb), ContainsSubstring("must contain one or more qubits") );
        }
        SECTION( "number of amplitudes" ) {
 
            // v4 does not consult QuESTEnv
            
                // // use local QuESTEnv to safely modify
                // QuESTEnv env = getQuESTEnv();
            
            // too many amplitudes to store in type
            int maxQb = (int) calcLog2(SIZE_MAX) / 2;
            REQUIRE_THROWS_WITH( createForcedDensityQureg(maxQb+1), 
                ContainsSubstring("the density matrix would contain more amplitudes") && ContainsSubstring("than can be addressed by the qindex type") );
            
            // it is non-trivial to force an invalid distribution
            // in v4, since QuESTEnv arg is no longer consulted; we
            // will reserve this input validation for the full tests
 
                // /* n-qubit density matrix contains 2^(2n) amplitudes 
                //  * so can be spread between at most 2^(2n) ranks
                //  */
                // /* env.numNodes is an int, so maxQb must be capped at 16 for this
                //  * test to avoid an integer overflow when storing 2**(2*minQb) in it
                //  */
                // maxQb = maxQb > 16 ? 16 : maxQb;
                // int minQb = GENERATE_COPY( range(3,maxQb) );
                // env.numNodes = (int) pow(2, 2*minQb);
                // int numQb = GENERATE_COPY( range(1,minQb) );
                // REQUIRE_THROWS_WITH( createForcedDensityQureg(numQb, env), ContainsSubstring("Too few qubits") );
        }
        SECTION( "available memory" ) {
            
            /* there is no reliable way to force the malloc statements to
             * fail, and hence trigger the matrixInit validation */
            SUCCEED( );
        }
    }
}
 
 
 
/** @sa createDiagonalOp
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "createDiagonalOp", "[data_structures]" ) {
 
    QuESTEnv env = getQuESTEnv();
    
    // must be at least one amplitude per node
    int minNumQb = calcLog2(env.numNodes);
    if (minNumQb == 0)
        minNumQb = 1;
        
    SECTION( "correctness" ) {
        
        // try 10 valid number of qubits
        int numQb = GENERATE_COPY( range(minNumQb, minNumQb+10) );
        DiagonalOp op = createDiagonalOp(numQb, env);
        
        // check properties are correct
        REQUIRE( op.numQubits == numQb );
        REQUIRE( op.numElemsPerNode == (1LL << numQb) / (op.isDistributed? env.numNodes : 1) );
        REQUIRE( op.cpuElems != NULL );
        
        // check all elements in CPU are zero 
        REQUIRE( areEqual(toQVector(op), QVector(1LL << numQb)) );
        
        // (no concise way to check this for GPU)
        
        destroyDiagonalOp(op, env);
    }
    SECTION( "input validation" ) {
        
        SECTION( "number of qubits" ) {
            
            int numQb = GENERATE( -1, 0 );
            REQUIRE_THROWS_WITH( createDiagonalOp(numQb, env), ContainsSubstring("must target one or more qubits") );
        }
        SECTION( "number of elements" ) {
            
            // too many amplitudes to store in type
            int maxQb = (int) calcLog2(SIZE_MAX);
            REQUIRE_THROWS_WITH( createDiagonalOp(maxQb+1, env), 
                ContainsSubstring("the matrix would contain more elements") && ContainsSubstring("than the maximum which can be addressed by the qindex type") );
            
            // cannot test when there are too few elements, since the deprecated
            // interface is redirecting to createFullStateDiagMatr which auto-deploys,
            // and so simply automatically disables distribution
 
                // /* env.numNodes is an int, so maxQb must be capped at 32 for this
                //  * test to avoid an integer overflow when storing 2**minQb in it
                //  */
                // maxQb = maxQb > 32 ? 32 : maxQb;
                // // too few amplitudes to distribute
                // int minQb = GENERATE_COPY( range(2,maxQb) );
                // env.numNodes = (int) pow(2, minQb);
                // int numQb = GENERATE_COPY( range(1,minQb) );
                // REQUIRE_THROWS_WITH( createDiagonalOp(numQb, env), ContainsSubstring("Too few qubits") && ContainsSubstring("distributed"));
        }
        SECTION( "available memory" ) {
            
            /* there is no reliable way to force the malloc statements to
             * fail, and hence trigger the diagonalOpInit validation */
            SUCCEED( );
        }
    }
}
 
 
 
// createDiagonalOpFromPauliHamilFile removed because PauliHamil
// is deprecated, and replacement PauliStrSum (with analogous function
// createFullStateDiagMatrFromPauliStrSumFile) is incompatible
 
    // /** @sa createDiagonalOpFromPauliHamilFile
    //  * @ingroup deprecatedtests 
    //  * @author Tyson Jones 
    //  */
    // TEST_CASE( "createDiagonalOpFromPauliHamilFile", "[data_structures]" ) {
 
    //     // files created & populated during the test, and deleted afterward
    //     char fnPrefix[] = "temp_createDiagonalOpFromPauliHamilFile";
    //     char fn[100];
    //     int fnMaxLen = 100; 
        
    //     // each test uses a unique filename (managed by master node), to avoid file IO locks
    //     // (it's safe for sub-test to overwrite this, since after each test, all files
    //     //  with prefix fnPrefix are deleted)
    //     setUniqueFilename(fn, fnMaxLen, fnPrefix);
        
    //     // diagonal op must have at least one amplitude per node
    //     int minNumQb = calcLog2(getQuESTEnv().numNodes);
    //     if (minNumQb == 0)
    //         minNumQb = 1;
 
    //     SECTION( "correctness" ) {
 
    //         SECTION( "general" ) {
                
    //             // try several Pauli Hamiltonian sizes
    //             int numQb = GENERATE_COPY( range(minNumQb, 6+minNumQb) );
    //             int numTerms = GENERATE_COPY( 1, minNumQb, 10*minNumQb );
                
    //             // create a PauliHamil with random elements
 
    //             PauliHamil hamil = createPauliHamil(numQb, numTerms);
    //             createPauliStrSum()
    //             setRandomDiagPauliHamil(hamil, numQb);
                
    //             // write the Hamiltonian to file (with trailing whitespace, and trailing newline)
    //             if (getQuESTEnv().rank == 0) { 
    //                 FILE* file = fopen(fn, "w");
    //                 int i=0;
    //                 for (int n=0; n<numTerms; n++) {
    //                     fprintf(file, REAL_STRING_FORMAT, hamil.termCoeffs[n]);
    //                     fprintf(file, " ");
    //                     for (int q=0; q<numQb; q++)
    //                         fprintf(file, "%d ", (int) hamil.pauliCodes[i++]);
    //                     fprintf(file, "\n");
    //                 }
    //                 fprintf(file, "\n");
    //                 fclose(file);
    //             }
    //             syncQuESTEnv(getQuESTEnv());
                
    //             // load the file as a diagonal operator, and compare
    //             DiagonalOp op = createDiagonalOpFromPauliHamilFile(fn, env);
    //             REQUIRE( areEqual(toQMatrix(op), toQMatrix(hamil)) );
 
    //             destroyPauliHamil(hamil);
    //             destroyDiagonalOp(op, env);
    //         }
    //         SECTION( "edge cases" ) {
                
    //             // prepare a valid single-term diagonal Pauli Hamiltonian
    //             qreal coeffs[] = {.1};
    //             VLA(pauliOpType, codes, minNumQb);
    //             for (int q=0; q<minNumQb; q++)
    //                 codes[q] = (q%2)? PAULI_I : PAULI_Z; 
                    
    //             QMatrix ref = toQMatrix(coeffs, codes, minNumQb, 1);
 
    //             // prepare basic encoding string 
    //             string line = to_string(coeffs[0]) + " ";
    //             for (int q=0; q<minNumQb; q++)
    //                 line += to_string(codes[q]) + ((q<minNumQb-1)? " ":"");
                
    //             SECTION( "no trailing newline or space" ) {
                    
    //                 writeToFileSynch(fn, line);
                    
    //                 DiagonalOp op = createDiagonalOpFromPauliHamilFile(fn, env);
    //                 REQUIRE( areEqual(ref, toQMatrix(op)) );
                    
    //                 destroyDiagonalOp(op, env);
    //             }
    //             SECTION( "trailing newlines" ) {
                    
    //                 writeToFileSynch(fn, line + "\n\n\n");
                    
    //                 DiagonalOp op = createDiagonalOpFromPauliHamilFile(fn, env);
    //                 REQUIRE( areEqual(ref, toQMatrix(op)) );
                    
    //                 destroyDiagonalOp(op, env);
    //             }
    //             SECTION( "trailing spaces" ) {
                    
    //                 writeToFileSynch(fn, line + "    ");
                    
    //                 DiagonalOp op = createDiagonalOpFromPauliHamilFile(fn, env);
    //                 REQUIRE( areEqual(ref, toQMatrix(op)) );
                    
    //                 destroyDiagonalOp(op, env);
    //             }
    //         }
    //     }
    //     SECTION( "input validation") {
 
    //         SECTION( "number of qubits" ) {
                
    //             writeToFileSynch(fn, ".1 "); // 0 qubits
    //             REQUIRE_THROWS_WITH( createDiagonalOpFromPauliHamilFile(fn, env), ContainsSubstring("The number of qubits") && ContainsSubstring("strictly positive"));
    //         }
    //         SECTION( "number of elements" ) {
                
    //             // too many amplitudes to store in type
    //             int maxQb = (int) calcLog2(SIZE_MAX);
                
    //             // encode one more qubit than legal to file
    //             string line = ".1 ";
    //             for (int q=0; q<(maxQb+1); q++)
    //                 line += "3 "; // trailing space ok
    //             writeToFileSynch(fn, line);
                
    //             REQUIRE_THROWS_WITH( createDiagonalOpFromPauliHamilFile(fn, env), ContainsSubstring("Too many qubits") && ContainsSubstring("size_t type") );
                
    //             // use local QuESTEnv to safely modify
    //             QuESTEnv env = getQuESTEnv();
                
    //             // too few elements to distribute
    //             /* env.numNodes is an int, so maxQb must be capped at 32 for this
    //              * test to avoid an integer overflow when storing 2**minQb in it
    //              */
    //             maxQb = maxQb > 32 ? 32 : maxQb;
    //             int minQb = GENERATE_COPY( range(2,maxQb) );
    //             env.numNodes = (int) pow(2, minQb);
    //             int numQb = GENERATE_COPY( range(1,minQb) );
                
    //             line = ".1 ";
    //             for (int q=0; q<numQb; q++)
    //                 line += "3 "; // trailing space ok
    //             setUniqueFilename(fn, fnMaxLen, fnPrefix);
    //             writeToFileSynch(fn, line);
                
    //             REQUIRE_THROWS_WITH( createDiagonalOpFromPauliHamilFile(fn, env), ContainsSubstring("Too few qubits") && ContainsSubstring("distributed") );
    //         }
    //         SECTION( "coefficient type" ) {
 
    //             writeToFileSynch(fn, "notanumber 1 2 3");
    //             REQUIRE_THROWS_WITH( createDiagonalOpFromPauliHamilFile(fn, env), ContainsSubstring("Failed to parse") && ContainsSubstring("coefficient"));
    //         }
    //         SECTION( "pauli code" ) {
 
    //             writeToFileSynch(fn, ".1 0 3 2");  // final is invalid Y
    //             REQUIRE_THROWS_WITH( createDiagonalOpFromPauliHamilFile(fn, env), ContainsSubstring("contained operators other than PAULI_Z and PAULI_I"));
                
    //             setUniqueFilename(fn, fnMaxLen, fnPrefix);
    //             writeToFileSynch(fn, ".1 0 1 3");  // second is invalid X
    //             REQUIRE_THROWS_WITH( createDiagonalOpFromPauliHamilFile(fn, env), ContainsSubstring("contained operators other than PAULI_Z and PAULI_I"));
                
    //             setUniqueFilename(fn, fnMaxLen, fnPrefix);
    //             writeToFileSynch(fn, ".1 0 1 4");  // final is invalid Pauli code
    //             REQUIRE_THROWS_WITH( createDiagonalOpFromPauliHamilFile(fn, env), ContainsSubstring("invalid pauli code"));
                
    //             setUniqueFilename(fn, fnMaxLen, fnPrefix);
    //             writeToFileSynch(fn, ".1 3 0 notanumber");  // final is invalid type
    //             REQUIRE_THROWS_WITH( createDiagonalOpFromPauliHamilFile(fn, env), ContainsSubstring("Failed to parse the next expected Pauli code"));
    //         }
    //     }
        
    //     // delete all files created above
    //     deleteFilesWithPrefixSynch(fnPrefix);
    // }
 
 
 
// createPauliHamil removed because PauliHamil is deprecated, and 
// replacement PauliStrSum has an incompatible constructor
 
    // /** @sa createPauliHamil
    //  * @ingroup deprecatedtests 
    //  * @author Tyson Jones 
    //  */
    // TEST_CASE( "createPauliHamil", "[data_structures]" ) {
 
    //     SECTION( "correctness" ) {
 
    //         int numQb = GENERATE( range(1,5) );
    //         int numTerms = GENERATE( range(1,5) );
    //         PauliHamil hamil = createPauliHamil(numQb, numTerms);
            
    //         // check fields are correct
    //         REQUIRE( hamil.numQubits == numQb );
    //         REQUIRE( hamil.numSumTerms == numTerms );
            
    //         // check all Pauli codes are identity
    //         int numPaulis = numQb * numTerms;
    //         for (int i=0; i<numPaulis; i++) {
    //             REQUIRE( hamil.pauliCodes[i] == PAULI_I );
    //         }
                
    //         // check all term coefficients can be written to (no seg fault)
    //         for (int j=0; j<numTerms; j++) {
    //             hamil.termCoeffs[j] = 1;
    //             REQUIRE( hamil.termCoeffs[j] == 1 );
    //         }
            
    //         destroyPauliHamil(hamil);
    //     }
    //     SECTION( "input validation") {
 
    //         SECTION( "number of qubits" ) {
 
    //             int numQb = GENERATE( -1, 0 );
    //             REQUIRE_THROWS_WITH( createPauliHamil(numQb, 1), ContainsSubstring("The number of qubits and terms in the PauliHamil must be strictly positive.") );
    //         }
    //         SECTION( "number of terms" ) {
 
    //             int numTerms = GENERATE( -1, 0 );
    //             REQUIRE_THROWS_WITH( createPauliHamil(1, numTerms), ContainsSubstring("The number of qubits and terms in the PauliHamil must be strictly positive.") );
    //         }
    //     }
    // }
 
 
 
// createPauliHamilFromFile removed because PauliHamil is deprecated, and 
// replacement PauliStrSum (with analogous function createPauliStrSumFromFile
// has incompatible struct fields
 
    // /** @sa createPauliHamilFromFile
    //  * @ingroup deprecatedtests 
    //  * @author Tyson Jones 
    //  */
    // TEST_CASE( "createPauliHamilFromFile", "[data_structures]" ) {
        
    //     // files created & populated during the test, and deleted afterward
    //     char fnPrefix[] = "temp_createPauliHamilFromFile";
    //     char fn[100];
    //     int fnMaxLen = 100;
        
    //     // each test uses a unique filename (managed by master node), to avoid file IO locks
    //     // (it's safe for sub-test to overwrite this, since after each test, all files
    //     //  with prefix fnPrefix are deleted)
    //     setUniqueFilename(fn, fnMaxLen, fnPrefix);
 
    //     SECTION( "correctness" ) {
            
    //         SECTION( "general" ) {
                
    //             // for several sizes...
    //             int numQb = GENERATE( 1, 5, 10, 15 );
    //             int numTerms = GENERATE( 1, 10, 30 );
    //             int numPaulis = numQb*numTerms;
                
    //             // create a PauliHamil with random elements
    //             VLA(qreal, coeffs, numTerms);
    //             VLA(pauliOpType, paulis, numPaulis);
    //             setRandomPauliSum(coeffs, paulis, numQb, numTerms);
                
    //             // write the Hamiltonian to file (with trailing whitespace, and trailing newline)
    //             if (getQuESTEnv().rank == 0) {
    //                 FILE* file = fopen(fn, "w");
    //                 int i=0;
    //                 for (int n=0; n<numTerms; n++) {
    //                     fprintf(file, REAL_STRING_FORMAT, coeffs[n]);
    //                     fprintf(file, " ");
    //                     for (int q=0; q<numQb; q++)
    //                         fprintf(file, "%d ", (int) paulis[i++]);
    //                     fprintf(file, "\n");
    //                 }
    //                 fprintf(file, "\n");
    //                 fclose(file);
    //             }
    //             syncQuESTEnv(getQuESTEnv());
                
    //             // load the file as a PauliHamil
    //             PauliHamil hamil = createPauliHamilFromFile(fn);
 
    //             // check fields agree
    //             REQUIRE( hamil.numQubits == numQb );
    //             REQUIRE( hamil.numSumTerms == numTerms );
                
    //             // check elements agree
    //             int j=0;
    //             for (int n=0; n<numTerms; n++) {
    //                 REQUIRE( absReal(hamil.termCoeffs[n] - coeffs[n]) <= REAL_EPS );
    //                 for (int q=0; q<numQb; q++) {
    //                     REQUIRE( hamil.pauliCodes[j] == paulis[j] );
    //                     j++;
    //                 }
    //             }
                
    //             destroyPauliHamil(hamil);
    //         }
    //         SECTION( "edge cases" ) {
                
    //             SECTION( "no trailing newline or space" ) {
                    
    //                 writeToFileSynch(fn, ".1 1 0 1");
            
    //                 PauliHamil hamil = createPauliHamilFromFile(fn);
    //                 REQUIRE( hamil.numSumTerms == 1 );
    //                 REQUIRE( hamil.numQubits == 3 );
                    
    //                 destroyPauliHamil(hamil); 
    //             }
    //             SECTION( "trailing newlines" ) {
                    
    //                 writeToFileSynch(fn, ".1 1 0 1\n\n\n");
 
    //                 PauliHamil hamil = createPauliHamilFromFile(fn);
    //                 REQUIRE( hamil.numSumTerms == 1 );
    //                 REQUIRE( hamil.numQubits == 3 );
                    
    //                 destroyPauliHamil(hamil); 
    //             }
    //             SECTION( "trailing spaces" ) {
                    
    //                 writeToFileSynch(fn, ".1 1 0 1    ");
                    
    //                 PauliHamil hamil = createPauliHamilFromFile(fn);
    //                 REQUIRE( hamil.numSumTerms == 1 );
    //                 REQUIRE( hamil.numQubits == 3 );
                    
    //                 destroyPauliHamil(hamil); 
    //             }
    //         }
    //     }
    //     SECTION( "input validation") {
 
    //         SECTION( "number of qubits" ) {
 
    //             writeToFileSynch(fn, ".1 ");
 
    //             REQUIRE_THROWS_WITH( createPauliHamilFromFile(fn), ContainsSubstring("The number of qubits") && ContainsSubstring("strictly positive"));
    //         }
    //         SECTION( "coefficient type" ) {
 
    //             writeToFileSynch(fn, "notanumber 1 2 3");
 
    //             REQUIRE_THROWS_WITH( createPauliHamilFromFile(fn), ContainsSubstring("Failed to parse") && ContainsSubstring("coefficient"));
    //         }
    //         SECTION( "pauli code" ) {
                
    //             writeToFileSynch(fn, ".1 1 2 4"); // invalid int
 
    //             REQUIRE_THROWS_WITH( createPauliHamilFromFile(fn), ContainsSubstring("invalid pauli code"));
                
    //             setUniqueFilename(fn, fnMaxLen, fnPrefix);
    //             writeToFileSynch(fn, ".1 1 2 notanumber"); // invalid type
                
    //             REQUIRE_THROWS_WITH( createPauliHamilFromFile(fn), ContainsSubstring("Failed to parse the next expected Pauli code"));
    //         }
    //     }
        
    //     // cleanup temp files
    //     deleteFilesWithPrefixSynch(fn);
    // }
 
 
 
/** @sa createQuESTEnv
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "createQuESTEnv", "[data_structures]" ) {
    
    /* there is no meaningful way to test this */
    SUCCEED( );
}
 
 
 
/** @sa createQureg
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "createQureg", "[data_structures]" ) {
 
    // we use createForcedQureg() in lieu of createQureg()
    // to override the auto-deployer and force Qureg to use
    // every available parallellisation method
        
    // must be at least one amplitude per node
    int minNumQb = calcLog2(getQuESTEnv().numNodes);
    if (minNumQb == 0)
        minNumQb = 1;
    
    SECTION( "correctness" ) {
        
        // try 10 valid number of qubits
        int numQb = GENERATE_COPY( range(minNumQb, minNumQb+10) );
        Qureg reg = createForcedQureg(numQb);
        
        // ensure elems (CPU and/or GPU) are created, and reg begins in |0>
        QVector ref = QVector(1<<numQb);
        ref[0] = 1; // |0>
        REQUIRE( areEqual(reg, ref) );
        
        destroyQureg(reg);
    }
    SECTION( "input validation") {
        
        SECTION( "number of qubits" ) {
            
            int numQb = GENERATE( -1, 0 );
            REQUIRE_THROWS_WITH( createForcedQureg(numQb), ContainsSubstring("must contain one or more qubits") );
        }
        SECTION( "number of amplitudes" ) {
            
            // too many amplitudes to store in type
            int maxQb = (int) calcLog2(SIZE_MAX);
            REQUIRE_THROWS_WITH( createForcedQureg(maxQb+1), 
                ContainsSubstring("the statevector would contain more amplitudes") && 
                ContainsSubstring("than the maximum which can be addressed by the qindex type") );
 
            // it is non-trivial to force an invalid distribution
            // in v4, since QuESTEnv arg is no longer consulted; we
            // will reserve this input validation for the full tests
            
                // // too few amplitudes to distribute
                // /* env.numNodes is an int, so maxQb must be capped at 32 for this
                //  * test to avoid an integer overflow when storing 2**minQb in it
                //  */
                // maxQb = maxQb > 32 ? 32 : maxQb;
                // int minQb = GENERATE_COPY( range(2,maxQb) );
                // env.numNodes = (int) pow(2, minQb);
                // int numQb = GENERATE_COPY( range(1,minQb) );
                // REQUIRE_THROWS_WITH( createForcedQureg(numQb, env), ContainsSubstring("Too few qubits") );
        }
        SECTION( "available memory" ) {
            
            /* there is no reliable way to force the malloc statements to
             * fail, and hence trigger the matrixInit validation */
            SUCCEED( );
        }
    }
}
 
 
 
/** @sa createSubDiagonalOp
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "createSubDiagonalOp", "[data_structures]" ) {
    
    SECTION( "correctness" ) {
        
        int numQb = GENERATE( range(1,10+1) );
        SubDiagonalOp op = createSubDiagonalOp(numQb);
        
        // ensure elems are created and initialised to 0
        REQUIRE( areEqual(toQMatrix(op), getZeroMatrix(1<<numQb)) );
        
        destroySubDiagonalOp(op);
    }
    SECTION( "input validation" ) {
        
        SECTION( "number of qubits" ) {
            
            int numQb = GENERATE( -1, 0 );
            REQUIRE_THROWS_WITH( createSubDiagonalOp(numQb), ContainsSubstring("must target one or more qubits") );
            
            numQb = 100;
            REQUIRE_THROWS_WITH( createSubDiagonalOp(numQb), 
                ContainsSubstring("the matrix would contain more elements") && 
                ContainsSubstring("than the maximum which can be addressed by the qindex type") );
        }
    }
}
 
 
 
/** @sa destroyComplexMatrixN
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "destroyComplexMatrixN", "[data_structures]" ) {
    
    SECTION( "correctness" ) {
        
        /* there is no meaningful way to test this */
        SUCCEED( );
    }
    SECTION( "input validation" ) {
        
        SECTION( "matrix not created" ) {
            
            /* this is an artificial test case since nothing in the QuEST API 
             * automatically sets un-initialised ComplexMatrixN fields to 
             * the NULL pointer.
             */
            ComplexMatrixN m;
            m.cpuElems = NULL;
             
            /* the error message is also somewhat unrelated, but oh well 
             */
            REQUIRE_THROWS_WITH( destroyComplexMatrixN(m), ContainsSubstring("Invalid CompMatr") );
        }
    }
}
 
 
 
/** @sa destroyDiagonalOp
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "destroyDiagonalOp", "[data_structures]" ) {
 
    /* there is no meaningful way to test this */
    SUCCEED( );
}
 
 
 
/** @sa destroyPauliHamil
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "destroyPauliHamil", "[data_structures]" ) {
    
    /* there is no meaningful way to test this.
     * We e.g. cannot check that the pointers are NULL because 
     * they are not updated; this function passes the struct by value,
     * not by reference. We also cannot reliably monitor the 
     * memory used in the heap at runtime.
     */
    SUCCEED( );
}
 
 
 
/** @sa destroyQuESTEnv
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "destroyQuESTEnv", "[data_structures]" ) {
 
    /* there is no meaningful way to test this */
    SUCCEED( );
}
 
 
 
/** @sa destroyQureg
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "destroyQureg", "[data_structures]" ) {
    
    /* there is no meaningful way to test this.
     * We e.g. cannot check that the pointers are NULL because 
     * they are not updated; this function passes the struct by value,
     * not by reference. We also cannot reliably monitor the 
     * memory used in the heap at runtime.
     */
    SUCCEED( );
}
 
 
 
/** @sa destroySubDiagonalOp
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "destroySubDiagonalOp", "[data_structures]" ) {
 
    /* there is no meaningful way to test this */
    SUCCEED( );
}
 
 
 
// initComplexMatrixN removed because ComplexMatrixN is deprecated,
// and replacement CompMatr has analogous function setCompMatr with
// an incompatible signature
 
    // /** @sa initComplexMatrixN
    //  * @ingroup deprecatedtests 
    //  * @author Tyson Jones 
    //  */
    // TEST_CASE( "initComplexMatrixN", "[data_structures]" ) {
        
    //     /* use of this function is illegal in C++ */
    //     SUCCEED( );
    // }
 
 
 
// initDiagonalOp removed because DiagonalOp is deprecated, and
// analogous function setFullStateDiagMatr of replacement
// FullStateDiagMatr has an incompatible signature
 
    /** @sa initDiagonalOp
     * @ingroup deprecatedtests 
     * @author Tyson Jones 
     */
    // TEST_CASE( "initDiagonalOp", "[data_structures]" ) {
        
    //     // must be at least one amplitude per node
    //     int minNumQb = calcLog2(getQuESTEnv().numNodes);
    //     if (minNumQb == 0)
    //         minNumQb = 1;
        
    //     SECTION( "correctness" ) {
            
    //         // try 10 valid number of qubits
    //         int numQb = GENERATE_COPY( range(minNumQb, minNumQb+10) );
    //         DiagonalOp op = createDiagonalOp(numQb, getQuESTEnv());
            
    //         long long int len = (1LL << numQb);
    //         vector<qcomp> elems(len);
 
    //         VLA(qreal, reals, len);
    //         VLA(qreal, imags, len);
    //         long long int n;
    //         for (n=0; n<len; n++) {
    //             reals[n] = (qreal)    n;
    //             imags[n] = (qreal) -2*n; // (n - 2n i)
    //         }
    //         initDiagonalOp(op, reals, imags);
            
    //         // check that op.real and op.imag were modified...
    //         REQUIRE( areEqual(toQVector(op), reals, imags) );
            
    //         // and also that GPU real and imag were modified
    //         // via if it modifies an all-unity state-vec correctly 
    //         Qureg qureg = createForcedQureg(numQb);
    //         for (long long int i=0; i<qureg.numAmpsPerChunk; i++) {
    //             qureg.stateVec.real[i] = 1;
    //             qureg.stateVec.imag[i] = 1;
    //         }
    //         copyStateToGPU(qureg);
            
    //         QVector prodRef = toQMatrix(op) * toQVector(qureg);
            
    //         // (n - 2n i) * (1 + 1i) = 3n - n*i
    //         applyDiagonalOp(qureg, op);
    //         copyStateFromGPU(qureg);
    //         QVector result = toQVector(qureg);    
    //         REQUIRE( areEqual(prodRef, result) );
            
    //         destroyQureg(qureg, getQuESTEnv());
    //         destroyDiagonalOp(op, getQuESTEnv());
    //     }
// }
 
 
 
// initDiagonalOpFromPauliHamil removed because DiagonalOp is 
// deprecated in favour of FullStateDiagMatr, which indeed has
// analogous function setFullStateDiagMatrFromPauliStrSum, but
// the involved PauliStrSum is incompatible with the deprecated
// PauliHamil
 
    /** @sa initDiagonalOpFromPauliHamil
     * @ingroup deprecatedtests 
     * @author Tyson Jones 
     */
    // TEST_CASE( "initDiagonalOpFromPauliHamil", "[data_structures]" ) {
        
    //     // distributed diagonal op must contain at least one amplitude per node
    //     int minNumQb = calcLog2(getQuESTEnv().numNodes);
    //     if (minNumQb == 0)
    //         minNumQb = 1;
        
    //     SECTION( "correctness" ) {    
 
    //         // try (at most) 10 valid number of qubits (even for validation)
    //         int numQb = GENERATE_COPY( range(minNumQb, std::min(10,minNumQb+10)) );
    //         DiagonalOp op = createDiagonalOp(numQb, getQuESTEnv());
            
    //         // try several sized random all-Z Hamiltonians
    //         int numTerms = GENERATE_COPY( 1, numQb, 5*numQb );
    //         PauliHamil hamil = createPauliHamil(numQb, numTerms);
    //         setRandomDiagPauliHamil(hamil);
 
    //         initDiagonalOpFromPauliHamil(op, hamil);
    //         REQUIRE( areEqual(toQMatrix(op), toQMatrix(hamil)) );
 
    //         destroyPauliHamil(hamil);
    //         destroyDiagonalOp(op, getQuESTEnv());
    //     }
    //     SECTION( "input validation" ) {
            
    //         SECTION( "hamiltonian parameters" ) {
                
    //             DiagonalOp op = createDiagonalOp(minNumQb, getQuESTEnv());
    //             PauliHamil hamil;
                
    //             hamil.numQubits = GENERATE( -1, 0 );
    //             hamil.numSumTerms = 1;
    //             REQUIRE_THROWS_WITH( initDiagonalOpFromPauliHamil(op, hamil), ContainsSubstring("number of qubits") && ContainsSubstring("strictly positive") );
                
    //             hamil.numQubits = minNumQb;
    //             hamil.numSumTerms = GENERATE( -1, 0 );
    //             REQUIRE_THROWS_WITH( initDiagonalOpFromPauliHamil(op, hamil), ContainsSubstring("terms") && ContainsSubstring("strictly positive") );
                
    //             destroyDiagonalOp(op, getQuESTEnv());
    //         }
    //         SECTION( "mismatching dimensions" ) {
                
    //             int numQbA = minNumQb+1;
    //             int numQbB = GENERATE_COPY( numQbA-1, numQbA+1 );
                
    //             DiagonalOp op = createDiagonalOp(numQbA, getQuESTEnv());
    //             PauliHamil hamil = createPauliHamil(numQbB, 1);
                
    //             REQUIRE_THROWS_WITH( initDiagonalOpFromPauliHamil(op, hamil), ContainsSubstring("Pauli Hamiltonian and diagonal operator have different, incompatible dimensions") );
                
    //             destroyDiagonalOp(op, getQuESTEnv());
    //             destroyPauliHamil(hamil);
    //         }
    //         SECTION( "pauli codes" ) {
            
    //             DiagonalOp op = createDiagonalOp(minNumQb, getQuESTEnv());
    //             PauliHamil hamil = createPauliHamil(minNumQb, 5);  // all I
                
    //             // make only one code invalid
    //             int numCodes = minNumQb * hamil.numSumTerms;
    //             int ind = GENERATE_COPY( range(0,numCodes) );
    //             hamil.pauliCodes[ind] = GENERATE( PAULI_X, PAULI_Y );
                
    //             REQUIRE_THROWS_WITH( initDiagonalOpFromPauliHamil(op, hamil), ContainsSubstring("contained operators other than PAULI_Z and PAULI_I") );
                
    //             destroyDiagonalOp(op, getQuESTEnv());
    //             destroyPauliHamil(hamil);
    //         }
    //     }
    // }
 
 
 
// initPauliHamil removed because PauliHamil is deprecated in 
// favour of PauliStrSum with (so far) an incompatible initialiser
 
    /** @sa initPauliHamil
     * @ingroup deprecatedtests 
     * @author Tyson Jones 
     */
    // TEST_CASE( "initPauliHamil", "[data_structures]" ) {
        
    //     SECTION( "correctness" ) {
            
    //         PauliHamil hamil = createPauliHamil(3, 2);
            
    //         qreal coeffs[] = {-5, 5};
    //         enum pauliOpType codes[] = {
    //             PAULI_X, PAULI_Y, PAULI_Z,
    //             PAULI_Z, PAULI_Y, PAULI_X};
    //         initPauliHamil(hamil, coeffs, codes);
            
    //         // check everything written correctly
    //         for (int t=0; t<2; t++) {
    //             REQUIRE( coeffs[t] == hamil.termCoeffs[t] );
    //             for (int q=0; q<3; q++) {
    //                 int ind = 3*t+q;
    //                 REQUIRE( codes[ind] == hamil.pauliCodes[ind] );
    //             }
    //         }
                
    //         destroyPauliHamil(hamil);
    //     }
    //     SECTION( "input validation" ) {
            
    //         SECTION( "parameters" ) {
                
    //             // parameters checked before codes, so safe to leave un-initialised
    //             qreal coeffs[1];
    //             enum pauliOpType codes[1];
    //             PauliHamil hamil;
                
    //             hamil.numQubits = GENERATE( -1, 0 );
    //             hamil.numSumTerms = 1;
    //             REQUIRE_THROWS_WITH( initPauliHamil(hamil, coeffs, codes), ContainsSubstring("number of qubits") && ContainsSubstring("strictly positive") );
                
    //             hamil.numQubits = 1;
    //             hamil.numSumTerms = GENERATE( -1, 0 );
    //             REQUIRE_THROWS_WITH( initPauliHamil(hamil, coeffs, codes), ContainsSubstring("terms") && ContainsSubstring("strictly positive") );
    //         }
    //         SECTION( "Pauli codes" ) {
            
    //             int numQb = 3;
    //             int numTerms = 2;
    //             int numCodes = numQb * numTerms;
    //             VLA(qreal, coeffs, numTerms);
    //             VLA(pauliOpType, codes, numCodes);
                
    //             // make only one code invalid
    //             for (int i=0; i<numCodes; i++)
    //                 codes[i] = PAULI_I;
    //             codes[GENERATE_COPY( range(0,numCodes) )] = (pauliOpType) GENERATE( -1, 4 );
                
    //             PauliHamil hamil = createPauliHamil(numQb, numTerms);
    //             REQUIRE_THROWS_WITH( initPauliHamil(hamil, coeffs, codes), ContainsSubstring("Invalid Pauli code") );
    //             destroyPauliHamil(hamil);
    //         }
    //     }
    // }
 
 
 
// setDiagonalOpElems removed because DiagonalOp is deprecated
// in favour of FullStateDiagMatr, which has an initialiser
// setFullStateDiagMatr() with an incompatible signature
 
    // /** @sa setDiagonalOpElems
    //  * @ingroup deprecatedtests 
    //  * @author Tyson Jones 
    //  */
    // TEST_CASE( "setDiagonalOpElems", "[data_structures]" ) {
        
    //     // must be at least one amplitude per node
    //     int minNumQb = calcLog2(getQuESTEnv().numNodes);
    //     if (minNumQb == 0)
    //         minNumQb = 1;
        
    //     // try 10 valid number of qubits (even for validation)
    //     int numQb = GENERATE_COPY( range(minNumQb, minNumQb+10) );
    //     DiagonalOp op = createDiagonalOp(numQb, getQuESTEnv());
        
    //     SECTION( "correctness" ) {
        
    //         // make entire array on every node
    //         long long int len = (1LL << numQb);
    //         VLA(qreal, reals, len);
    //         VLA(qreal, imags, len);
    //         long long int n;
    //         for (n=0; n<len; n++) {
    //             reals[n] = (qreal)    n;
    //             imags[n] = (qreal) -2*n; // (n - 2n i)
    //         }
            
    //         // set one value at a time (only relevant nodes will update)
    //         for (n=0; n<len; n++)
    //             setDiagonalOpElems(op, n, &reals[n], &imags[n], 1);
            
    //         // check op.real and op.imag updated correctly 
    //         REQUIRE( areEqual(toQVector(op), reals, imags) );
            
    //         // no check that GPU values updated (occurs in initDiagonalOp)
    //     }
    //     SECTION( "input validation" ) {
            
    //         long long int maxInd = (1LL << numQb);
    //         qreal *reals = NULL;
    //         qreal *imags = NULL;
            
    //         SECTION( "start index" ) {
                
    //             int startInd = GENERATE_COPY( -1, maxInd );
    //             int numAmps = 1;
    //             REQUIRE_THROWS_WITH( setDiagonalOpElems(op, startInd, reals, imags, numAmps), ContainsSubstring("Invalid element index") );
    //         }
            
    //         SECTION( "number of elements" ) {
                
    //             // independent
    //             int startInd = 0;
    //             int numAmps = GENERATE_COPY( -1, maxInd+1 );
    //             REQUIRE_THROWS_WITH( setDiagonalOpElems(op, startInd, reals, imags, numAmps), ContainsSubstring("Invalid number of elements") );
 
    //             // invalid considering start-index
    //             startInd = maxInd - 1;
    //             numAmps = 2;
    //             REQUIRE_THROWS_WITH( setDiagonalOpElems(op, startInd, reals, imags, numAmps), ContainsSubstring("More elements given than exist") );
    //         }
    //     }
        
    //     destroyDiagonalOp(op);
    // }
 
 
 
/** @sa syncDiagonalOp
 * @ingroup deprecatedtests 
 * @author Tyson Jones 
 */
TEST_CASE( "syncDiagonalOp", "[data_structures]" ) {
    
    // must be at least one amplitude per node
    int minNumQb = calcLog2(getQuESTEnv().numNodes);
    if (minNumQb == 0)
        minNumQb = 1;
        
    SECTION( "correctness" ) {
        
        // try 10 valid number of qubits
        int numQb = GENERATE_COPY( range(minNumQb, minNumQb+10) );
 
        // createDiagonalOp() redirects to createFullStateDiagMatr()
        // which auto-deploys and will auto disable distribution,
        // so we resort to custom invocation
 
        QuESTEnv env = getQuESTEnv();
        DiagonalOp op = createCustomFullStateDiagMatr(numQb, env.isDistributed, env.isGpuAccelerated, env.isMultithreaded);
 
        // check that changes get sync'd to the GPU...
        long long int n;
        for (n=0; n<op.numElemsPerNode; n++)
            op.cpuElems[n] = qcomp(n, -2*n);
        syncDiagonalOp(op);
        
        // via if it modifies an all-unity state-vec correctly 
        Qureg qureg = createForcedQureg(numQb);
        for (long long int i=0; i<qureg.numAmpsPerNode; i++)
            qureg.cpuAmps[i] = qcomp(1,1);
        copyStateToGPU(qureg);
        
        // (n - 2n i) * (1 + 1i) = 3n - n*i
        applyDiagonalOp(qureg, op);
        copyStateFromGPU(qureg);
        for (n=0; n<qureg.numAmpsPerNode; n++) {
            REQUIRE( real(qureg.cpuAmps[n]) == 3*n );
            REQUIRE( imag(qureg.cpuAmps[n]) == -n );
        }
        
        destroyQureg(qureg, getQuESTEnv());
        destroyDiagonalOp(op, getQuESTEnv());
    }
}