Calculations

	TEST_CASE ("calcExpecPauliStr", TEST_CATEGORY)
	TEST_CASE ("calcExpecPauliStrSum", TEST_CATEGORY)
	TEST_CASE ("calcExpecNonHermitianPauliStrSum", TEST_CATEGORY)
	TEST_CASE ("calcProbOfBasisState", TEST_CATEGORY)
	TEST_CASE ("calcProbOfQubitOutcome", TEST_CATEGORY)
	TEST_CASE ("calcProbOfMultiQubitOutcome", TEST_CATEGORY)
	TEST_CASE ("calcProbsOfAllMultiQubitOutcomes", TEST_CATEGORY)
	TEST_CASE ("calcTotalProb", TEST_CATEGORY)
	TEST_CASE ("calcPurity", TEST_CATEGORY)
	TEST_CASE ("calcPartialTrace", TEST_CATEGORY)
	TEST_CASE ("calcReducedDensityMatrix", TEST_CATEGORY)
	TEST_CASE ("calcInnerProduct", TEST_CATEGORY LABEL_MIXED_DEPLOY_TAG)
	TEST_CASE ("calcFidelity", TEST_CATEGORY LABEL_MIXED_DEPLOY_TAG)
	TEST_CASE ("calcDistance", TEST_CATEGORY LABEL_MIXED_DEPLOY_TAG)
	TEST_CASE ("calcExpecFullStateDiagMatr", TEST_CATEGORY LABEL_MIXED_DEPLOY_TAG)
	TEST_CASE ("calcExpecNonHermitianFullStateDiagMatr", TEST_CATEGORY LABEL_MIXED_DEPLOY_TAG)
	TEST_CASE ("calcExpecFullStateDiagMatrPower", TEST_CATEGORY LABEL_MIXED_DEPLOY_TAG)
	TEST_CASE ("calcExpecNonHermitianFullStateDiagMatrPower", TEST_CATEGORY LABEL_MIXED_DEPLOY_TAG)

Detailed Description

Function Documentation

TEST_CASE() [1/18]

TEST_CASE	(	"calcDistance"	,
		TEST_CATEGORY	LABEL_MIXED_DEPLOY_TAG )

Definition at line 497 of file calculations.cpp.

                                                                  {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        qvector refSV = getRefStatevec();
        qmatrix refDM = getRefDensmatr();
        auto apiFunc = calcDistance;
 
        GENERATE( range(0, TEST_NUM_MIXED_DEPLOYMENT_REPETITIONS) );
 
        SECTION( LABEL_STATEVEC LABEL_DELIMITER LABEL_STATEVEC ) {
 
            // sqrt(2 - 2 |<A|B>|)
            auto refFunc = [&](qvector a, qvector b) { return std::sqrt(2 - 2 * std::abs(getInnerProduct(a,b))); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedStatevecs(), getAltCachedStatevecs(), refSV, refSV, apiFunc, refFunc);
        }
 
        SECTION( LABEL_STATEVEC LABEL_DELIMITER LABEL_DENSMATR ) {
 
            // sqrt(1 - <psi|rho|psi>)
            auto refFunc = [&](qvector a, qmatrix b) { return std::sqrt(1 - std::real(getInnerProduct(a, b * a))); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedStatevecs(), getAltCachedDensmatrs(), refSV, refDM, apiFunc, refFunc );
        }
 
        SECTION( LABEL_DENSMATR LABEL_DELIMITER LABEL_STATEVEC ) {
 
            // sqrt(1 - <psi|rho|psi>)
            auto refFunc = [&](qmatrix a, qvector b) { return std::sqrt(1 - std::real(getInnerProduct(b, a * b))); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedDensmatrs(), getAltCachedStatevecs(), refDM, refSV, apiFunc, refFunc );
        }
 
        SECTION( LABEL_DENSMATR LABEL_DELIMITER LABEL_DENSMATR ) {
 
            // sqrt(Tr((A-B)(A-B)^dagger)
            auto refFunc = [&](qmatrix a, qmatrix b) { return std::sqrt(std::real(getTrace((a-b)*getConjugateTranspose(a-b)))); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedDensmatrs(), getAltCachedDensmatrs(), refDM, refDM, apiFunc, refFunc );
        }
    }
 
    /// @todo input validation
}

TEST_CASE() [2/18]

TEST_CASE	(	"calcExpecFullStateDiagMatr"	,
		TEST_CATEGORY	LABEL_MIXED_DEPLOY_TAG )

Definition at line 545 of file calculations.cpp.

                                                                                {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        qmatrix refMatr = getRandomDiagonalHermitian(getNumCachedQubits());
        auto apiFunc = calcExpecFullStateDiagMatr;
 
        GENERATE( range(0, TEST_NUM_MIXED_DEPLOYMENT_REPETITIONS) );
 
        SECTION( LABEL_STATEVEC ) {
 
            auto refFunc = [&] (qvector state, qmatrix matr) { return getReferenceExpectationValue(state, matr); };
 
            TEST_ON_CACHED_QUREG_AND_MATRIX( getCachedStatevecs(), getCachedFullStateDiagMatrs(), apiFunc, getRefStatevec(), refMatr, refFunc);
        }
 
        SECTION( LABEL_DENSMATR ) {
 
            auto refFunc = [&] (qmatrix state, qmatrix matr) { return getReferenceExpectationValue(state, matr); };
 
            TEST_ON_CACHED_QUREG_AND_MATRIX( getCachedDensmatrs(), getCachedFullStateDiagMatrs(), apiFunc, getRefDensmatr(), refMatr, refFunc);
        }
    }
 
    /// @todo input validation
}

TEST_CASE() [3/18]

TEST_CASE	(	"calcExpecFullStateDiagMatrPower"	,
		TEST_CATEGORY	LABEL_MIXED_DEPLOY_TAG )

Definition at line 603 of file calculations.cpp.

                                                                                     {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        qmatrix refMatr = getRandomDiagonalHermitian(getNumCachedQubits());
 
        // integer and non-integer exponents have different requirements
        bool isIntegerExp = GENERATE( true, false );
        qreal exponent = (isIntegerExp)?
            getRandomInt(-3, 3):
            getRandomReal(-3, 3);
        
        // when exponent is non-integer, the matrix cannot contain negative 
        // numbers which otherwise become complex, making the matrix non-
        // Hermitian and triggering validation
        if (!isIntegerExp)
            for (size_t i=0; i<refMatr.size(); i++)
                refMatr[i][i] = std::abs(std::real(refMatr[i][i]));
 
        // when exponent is negative, the matrix cannot contain near-zero
        // magnitude numbers which create divergences and trigger validation.
        // Negative exponents are particularly unstable (they can produce 
        // very large matrix elements which ergo have less post-decimal
        // precision and sum catastrophically), so we scale up matrix.
        if (exponent < 0)
            for (size_t i=0; i<refMatr.size(); i++)
                refMatr[i][i] *= 100;
 
        auto apiFunc = [&](Qureg qureg, FullStateDiagMatr matr) { 
            return calcExpecFullStateDiagMatrPower(qureg, matr, exponent);
        };
 
        CAPTURE( exponent );
 
        GENERATE( range(0, TEST_NUM_MIXED_DEPLOYMENT_REPETITIONS) );
 
        SECTION( LABEL_STATEVEC ) {
 
            auto refFunc = [&] (qvector state, qmatrix matr) { 
                matr = getPowerOfDiagonalMatrix(matr, qcomp(exponent,0));
                return getReferenceExpectationValue(state, matr);
            };
 
            TEST_ON_CACHED_QUREG_AND_MATRIX( getCachedStatevecs(), getCachedFullStateDiagMatrs(), apiFunc, getRefStatevec(), refMatr, refFunc);
        }
 
        SECTION( LABEL_DENSMATR ) {
 
            auto refFunc = [&] (qmatrix state, qmatrix matr) { 
                matr = getPowerOfDiagonalMatrix(matr, qcomp(exponent,0));
                return getReferenceExpectationValue(state, matr);
            };
 
            TEST_ON_CACHED_QUREG_AND_MATRIX( getCachedDensmatrs(), getCachedFullStateDiagMatrs(), apiFunc, getRefDensmatr(), refMatr, refFunc);
        }
    }
 
    /// @todo input validation
}

TEST_CASE() [4/18]

TEST_CASE	(	"calcExpecNonHermitianFullStateDiagMatr"	,
		TEST_CATEGORY	LABEL_MIXED_DEPLOY_TAG )

Definition at line 574 of file calculations.cpp.

                                                                                            {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        qmatrix refMatr = getRandomDiagonalMatrix(getPow2(getNumCachedQubits()));
        auto apiFunc = calcExpecNonHermitianFullStateDiagMatr;
 
        GENERATE( range(0, TEST_NUM_MIXED_DEPLOYMENT_REPETITIONS) );
 
        SECTION( LABEL_STATEVEC ) {
 
            auto refFunc = [&] (qvector state, qmatrix matr) { return getReferenceExpectationValue(state, matr); };
 
            TEST_ON_CACHED_QUREG_AND_MATRIX( getCachedStatevecs(), getCachedFullStateDiagMatrs(), apiFunc, getRefStatevec(), refMatr, refFunc);
        }
 
        SECTION( LABEL_DENSMATR ) {
 
            auto refFunc = [&] (qmatrix state, qmatrix matr) { return getReferenceExpectationValue(state, matr); };
 
            TEST_ON_CACHED_QUREG_AND_MATRIX( getCachedDensmatrs(), getCachedFullStateDiagMatrs(), apiFunc, getRefDensmatr(), refMatr, refFunc);
        }
    }
 
    /// @todo input validation
}

TEST_CASE() [5/18]

TEST_CASE	(	"calcExpecNonHermitianFullStateDiagMatrPower"	,
		TEST_CATEGORY	LABEL_MIXED_DEPLOY_TAG )

Definition at line 665 of file calculations.cpp.

                                                                                                 {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        qmatrix refMatr = getRandomDiagonalMatrix(getPow2(getNumCachedQubits()));
        qcomp exponent = getRandomComplex();
 
        auto apiFunc = [&](Qureg qureg, FullStateDiagMatr matr) { 
            return calcExpecNonHermitianFullStateDiagMatrPower(qureg, matr, exponent);
        };
 
        CAPTURE( exponent );
 
        GENERATE( range(0, TEST_NUM_MIXED_DEPLOYMENT_REPETITIONS) );
 
        SECTION( LABEL_STATEVEC ) {
 
            auto refFunc = [&] (qvector state, qmatrix matr) { 
                matr = getPowerOfDiagonalMatrix(matr, exponent);
                return getReferenceExpectationValue(state, matr);
            };
 
            TEST_ON_CACHED_QUREG_AND_MATRIX( getCachedStatevecs(), getCachedFullStateDiagMatrs(), apiFunc, getRefStatevec(), refMatr, refFunc);
        }
 
        SECTION( LABEL_DENSMATR ) {
 
            auto refFunc = [&] (qmatrix state, qmatrix matr) { 
                matr = getPowerOfDiagonalMatrix(matr, exponent);
                return getReferenceExpectationValue(state, matr);
            };
 
            TEST_ON_CACHED_QUREG_AND_MATRIX( getCachedDensmatrs(), getCachedFullStateDiagMatrs(), apiFunc, getRefDensmatr(), refMatr, refFunc);
        }
    }
 
    /// @todo input validation
}

TEST_CASE() [6/18]

TEST_CASE	(	"calcExpecNonHermitianPauliStrSum"	,
		TEST_CATEGORY	)

Definition at line 203 of file calculations.cpp.

                                                               {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        GENERATE( range(0,10) );
        int numQubits = getNumCachedQubits();
        int numTerms = GENERATE_COPY( 1, numQubits, getPow2(2*numQubits) );
 
        PauliStrSum sum = createRandomNonHermitianPauliStrSum(numQubits, numTerms);
 
        TEST_ALL_QUREGS(
            qureg, calcExpecNonHermitianPauliStrSum(qureg, sum),  
            state, getReferenceExpectationValue(state, sum)
        );
 
        destroyPauliStrSum(sum);
    }
 
    /// @todo input validation
}

TEST_CASE() [7/18]

TEST_CASE	(	"calcExpecPauliStr"	,
		TEST_CATEGORY	)

TESTS

Definition at line 159 of file calculations.cpp.

                                                {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        int numQubits = getNumCachedQubits();
        int numTargs = GENERATE_COPY( range(1,numQubits+1) );
        auto targets = GENERATE_TARGS(numQubits, numTargs);
 
        PauliStr str = getRandomPauliStr(targets);
 
        TEST_ALL_QUREGS(
            qureg, calcExpecPauliStr(qureg, str),  
            state, std::real(getReferenceExpectationValue(state, str))
        );
    }
 
    /// @todo input validation
}

Referenced by TEST_ALL_CTRL_OPERATIONS(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), and TEST_CASE().

TEST_CASE() [8/18]

TEST_CASE	(	"calcExpecPauliStrSum"	,
		TEST_CATEGORY	)

Definition at line 180 of file calculations.cpp.

                                                   {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        int numQubits = getNumCachedQubits();
        int numTerms = GENERATE_COPY( 1, numQubits, getPow2(2*numQubits) );
 
        GENERATE( range(0,10) );
        PauliStrSum sum = createRandomPauliStrSum(numQubits, numTerms);
 
        TEST_ALL_QUREGS(
            qureg, calcExpecPauliStrSum(qureg, sum),  
            state, std::real(getReferenceExpectationValue(state, sum))
        );
 
        destroyPauliStrSum(sum);
    }
 
    /// @todo input validation
}

TEST_CASE() [9/18]

TEST_CASE	(	"calcFidelity"	,
		TEST_CATEGORY	LABEL_MIXED_DEPLOY_TAG )

Definition at line 455 of file calculations.cpp.

                                                                  {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        qvector refSV = getRefStatevec();
        qmatrix refDM = getRefDensmatr();
        auto apiFunc = calcFidelity;
 
        GENERATE( range(0, TEST_NUM_MIXED_DEPLOYMENT_REPETITIONS) );
 
        SECTION( LABEL_STATEVEC LABEL_DELIMITER LABEL_STATEVEC ) {
 
            // |<a|b>|^2
            auto refFunc = [&](qvector a, qvector b) { return std::norm(getInnerProduct(a,b)); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedStatevecs(), getAltCachedStatevecs(), refSV, refSV, apiFunc, refFunc );
        }
 
        SECTION( LABEL_STATEVEC LABEL_DELIMITER LABEL_DENSMATR ) {
 
            // Re[<A|B|A>]
            auto refFunc = [&](qvector a, qmatrix b) { return std::real(getInnerProduct(a, b * a)); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedStatevecs(), getAltCachedDensmatrs(), refSV, refDM, apiFunc, refFunc );
        }
 
        SECTION( LABEL_DENSMATR LABEL_DELIMITER LABEL_STATEVEC ) {
 
            // Re[<B|A|B>]
            auto refFunc = [&](qmatrix a, qvector b) { return std::real(getInnerProduct(b, a * b)); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedDensmatrs(), getAltCachedStatevecs(), refDM, refSV, apiFunc, refFunc );
        }
 
        // (densitymatrix, densitymatrix) not supported
    }
 
    /// @todo input validation
}

TEST_CASE() [10/18]

TEST_CASE	(	"calcInnerProduct"	,
		TEST_CATEGORY	LABEL_MIXED_DEPLOY_TAG )

Definition at line 406 of file calculations.cpp.

                                                                      {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        qvector refSV = getRefStatevec();
        qmatrix refDM = getRefDensmatr();
        auto apiFunc = calcInnerProduct;
 
        GENERATE( range(0, TEST_NUM_MIXED_DEPLOYMENT_REPETITIONS) );
 
        SECTION( LABEL_STATEVEC LABEL_DELIMITER LABEL_STATEVEC ) {
 
            // <a|b>
            auto refFunc = [&](qvector a, qvector b) { return getInnerProduct (a,b); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedStatevecs(), getAltCachedStatevecs(), refSV, refSV, apiFunc, refFunc );
        }
 
        SECTION( LABEL_STATEVEC LABEL_DELIMITER LABEL_DENSMATR ) {
 
            // <A|B|A>
            auto refFunc = [&](qvector a, qmatrix b) { return getInnerProduct(a, b * a); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedStatevecs(), getAltCachedDensmatrs(), refSV, refDM, apiFunc, refFunc );
        }
 
        SECTION( LABEL_DENSMATR LABEL_DELIMITER LABEL_STATEVEC ) {
 
            // <B|A^dagger|B>
            
            auto refFunc = [&](qmatrix a, qvector b) { return getInnerProduct(b, getConjugateTranspose(a) * b); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedDensmatrs(), getAltCachedStatevecs(), refDM, refSV, apiFunc, refFunc );
        }
 
        SECTION( LABEL_DENSMATR LABEL_DELIMITER LABEL_DENSMATR ) {
 
            // Tr(a^dagger b)
            auto refFunc = [&](qmatrix a, qmatrix b) { return getTrace(getConjugateTranspose(a) * b); };
 
            TEST_ON_MIXED_CACHED_QUREGS( getCachedDensmatrs(), getAltCachedDensmatrs(), refDM, refDM, apiFunc, refFunc );
        }
    }
 
    /// @todo input validation
}

TEST_CASE() [11/18]

TEST_CASE	(	"calcPartialTrace"	,
		TEST_CATEGORY	)

Definition at line 353 of file calculations.cpp.

                                               {
 
    // no statevector equivalent
 
    SECTION( LABEL_CORRECTNESS ) {
 
        SECTION( LABEL_DENSMATR ) {
 
            int numQubits = getNumCachedQubits();
            int maxNumTargs = getMaxNumTracedQubits(numQubits);
            int numTargs = GENERATE_COPY( range(1,maxNumTargs+1) );
            auto targets = GENERATE_TARGS(numQubits, numTargs);
 
            auto apiFunc = [&](Qureg qureg) { return calcPartialTrace(qureg, targets.data(), numTargs); };
            auto refFunc = [&](qmatrix ref) { return getPartialTrace(ref, targets); };
            
            TEST_ON_CACHED_QUREGS(getCachedDensmatrs(), getRefDensmatr(), apiFunc, refFunc);
        }
    }
 
    /// @todo input validation
}

TEST_CASE() [12/18]

TEST_CASE	(	"calcProbOfBasisState"	,
		TEST_CATEGORY	)

Definition at line 226 of file calculations.cpp.

                                                   {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        qindex index = GENERATE( range(0, 1 << getNumCachedQubits()) );
 
        TEST_ALL_QUREGS(
            qureg, calcProbOfBasisState(qureg, index),  
            state, getReferenceProbability(state, index)
        );
    }
 
    /// @todo input validation
}

TEST_CASE() [13/18]

TEST_CASE	(	"calcProbOfMultiQubitOutcome"	,
		TEST_CATEGORY	)

Definition at line 261 of file calculations.cpp.

                                                          {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        int numQubits = getNumCachedQubits();
        int numTargs = GENERATE_COPY( range(1, numQubits+1) );
        auto targets = GENERATE_TARGS(numQubits, numTargs);
        auto outcomes = getRandomOutcomes(numTargs);
 
        TEST_ALL_QUREGS(
            qureg, calcProbOfMultiQubitOutcome(qureg, targets.data(), outcomes.data(), numTargs),  
            state, getReferenceProbability(state, targets, outcomes)
        );
    }
 
    /// @todo input validation
}

TEST_CASE() [14/18]

TEST_CASE	(	"calcProbOfQubitOutcome"	,
		TEST_CATEGORY	)

Definition at line 243 of file calculations.cpp.

                                                     {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        int target = GENERATE( range(0, getNumCachedQubits()) );
        int outcome = GENERATE( 0, 1 );
 
        TEST_ALL_QUREGS(
            qureg, calcProbOfQubitOutcome(qureg, target, outcome),  
            state, getReferenceProbability(state, {target}, {outcome})
        );
    }
 
    /// @todo input validation
}

TEST_CASE() [15/18]

TEST_CASE	(	"calcProbsOfAllMultiQubitOutcomes"	,
		TEST_CATEGORY	)

Definition at line 281 of file calculations.cpp.

                                                               {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        int numQubits = getNumCachedQubits();
        int numTargs = GENERATE_COPY( range(1,numQubits+1) );
        auto targets = GENERATE_TARGS(numQubits, numTargs);
 
        auto apiFunc = [&](Qureg qureg) { 
            vector<qreal> out(getPow2(numTargs));
            calcProbsOfAllMultiQubitOutcomes(out.data(), qureg, targets.data(), numTargs);
            return out;
        };
        auto refFunc = [&](auto& state) {
            return getAllReferenceProbabilities(state, targets);
        };
 
        TEST_ON_CACHED_STATEVECS_AND_DENSMATRS( apiFunc, refFunc );
    }
 
    /// @todo input validation
}

TEST_CASE() [16/18]

TEST_CASE	(	"calcPurity"	,
		TEST_CATEGORY	)

Definition at line 323 of file calculations.cpp.

                                         {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        GENERATE( range(0,100) );
 
        TEST_ALL_QUREGS(
            qureg, calcPurity(qureg),  
            state, getReferencePurity(state)
        );
    }
 
    /// @todo input validation
}

TEST_CASE() [17/18]

TEST_CASE	(	"calcReducedDensityMatrix"	,
		TEST_CATEGORY	)

Definition at line 378 of file calculations.cpp.

                                                       {
 
    // no statevector equivalent
 
    SECTION( LABEL_CORRECTNESS ) {
 
        SECTION( LABEL_DENSMATR ) {
 
            int numQubits = getNumCachedQubits();
            int maxNumTraced = getMaxNumTracedQubits(numQubits);
            int minNumRetained = numQubits - maxNumTraced;
            int maxNumRetained = numQubits - 1;
            int numRetained = GENERATE_COPY( range(minNumRetained, maxNumRetained+1) );
            auto retains = GENERATE_TARGS(numQubits, numRetained);
            auto targets = getComplement(getRange(numQubits), retains);
 
            auto apiFunc = [&](Qureg qureg) { return calcReducedDensityMatrix(qureg, retains.data(), numRetained); };
            auto refFunc = [&](qmatrix ref) { return getPartialTrace(ref, targets); };
            
            TEST_ON_CACHED_QUREGS(getCachedDensmatrs(), getRefDensmatr(), apiFunc, refFunc);
        }
    }
 
    /// @todo input validation
}

TEST_CASE() [18/18]

TEST_CASE	(	"calcTotalProb"	,
		TEST_CATEGORY	)

Definition at line 306 of file calculations.cpp.

                                            {
 
    SECTION( LABEL_CORRECTNESS ) {
 
        GENERATE( range(0,100) );
 
        TEST_ALL_QUREGS(
            qureg, calcTotalProb(qureg),  
            state, getReferenceProbability(state)
        );
    }
 
    /// @todo input validation
}