Testing utilities which compare scalars produced by the QuEST API to those produced by other test utilities, and Quregs modified by the API to qvector qmatrix references. More...

Functions
bool	doMatricesAgree (qmatrix a, qmatrix b)

bool	doScalarsAgree (qcomp a, qcomp b)

qreal	getTestAbsoluteEpsilon ()

qreal	getTestRelativeEpsilon ()

void	REQUIRE_AGREE (CompMatr matrix, qmatrix reference)

void	REQUIRE_AGREE (CompMatr1 matrix, qmatrix reference)

void	REQUIRE_AGREE (CompMatr2 matrix, qmatrix reference)

void	REQUIRE_AGREE (DiagMatr matrix, qmatrix reference)

void	REQUIRE_AGREE (DiagMatr1 matrix, qmatrix reference)

void	REQUIRE_AGREE (DiagMatr2 matrix, qmatrix reference)

void	REQUIRE_AGREE (qcomp scalar, qcomp reference)

void	REQUIRE_AGREE (qmatrix matrix, qmatrix reference)

void	REQUIRE_AGREE (qreal scalar, qreal reference)

void	REQUIRE_AGREE (Qureg qureg, qmatrix reference)

void	REQUIRE_AGREE (Qureg qureg, Qureg other)

void	REQUIRE_AGREE (Qureg qureg, qvector reference)

void	REQUIRE_AGREE (SuperOp matrix, qmatrix reference)

void	REQUIRE_AGREE (vector< qcomp > list, vector< qcomp > reference)

void	REQUIRE_AGREE (vector< qreal > list, vector< qreal > reference)

Detailed Description

Testing utilities which compare scalars produced by the QuEST API to those produced by other test utilities, and Quregs modified by the API to qvector qmatrix references.

Function Documentation

◆ doMatricesAgree()

bool doMatricesAgree	(	qmatrix	a,
		qmatrix	b )

Definition at line 81 of file compare.cpp.

                                           {
    DEMAND( a.size() == b.size() );
 
    // assumed square and equal-size
    size_t dim = a.size();
 
    for (size_t i=0; i<dim; i++)
        for (size_t j=0; j<dim; j++)
            if (!doScalarsAgree(a[i][j], b[i][j]))
                return false;
 
    return true;
}

◆ doScalarsAgree()

bool doScalarsAgree	(	qcomp	a,
		qcomp	b )

Definition at line 71 of file compare.cpp.

                                      {
 
    // permit absolute OR relative agreement
 
    if (getAbsDif(a, b) <= ABSOLUTE_EPSILON)
        return true;
 
   return (getRelDif(a, b) <= RELATIVE_EPSILON);
}

◆ getTestAbsoluteEpsilon()

qreal getTestAbsoluteEpsilon ( )

Definition at line 48 of file compare.cpp.

                               {
 
    return ABSOLUTE_EPSILON;
}

◆ getTestRelativeEpsilon()

qreal getTestRelativeEpsilon ( )

Definition at line 53 of file compare.cpp.

                               {
 
    return RELATIVE_EPSILON;
}

◆ REQUIRE_AGREE() [1/15]

void REQUIRE_AGREE	(	CompMatr	matrix,
		qmatrix	reference )

Definition at line 256 of file compare.cpp.

256{ REQUIRE_AGREE( getMatrix(matrix), reference ); }

◆ REQUIRE_AGREE() [2/15]

void REQUIRE_AGREE	(	CompMatr1	matrix,
		qmatrix	reference )

Definition at line 254 of file compare.cpp.

254{ REQUIRE_AGREE( getMatrix(matrix), reference ); }

◆ REQUIRE_AGREE() [3/15]

void REQUIRE_AGREE	(	CompMatr2	matrix,
		qmatrix	reference )

Definition at line 255 of file compare.cpp.

255{ REQUIRE_AGREE( getMatrix(matrix), reference ); }

◆ REQUIRE_AGREE() [4/15]

void REQUIRE_AGREE	(	DiagMatr	matrix,
		qmatrix	reference )

Definition at line 259 of file compare.cpp.

259{ REQUIRE_AGREE( getMatrix(matrix), reference ); }

◆ REQUIRE_AGREE() [5/15]

void REQUIRE_AGREE	(	DiagMatr1	matrix,
		qmatrix	reference )

Definition at line 257 of file compare.cpp.

257{ REQUIRE_AGREE( getMatrix(matrix), reference ); }

◆ REQUIRE_AGREE() [6/15]

void REQUIRE_AGREE	(	DiagMatr2	matrix,
		qmatrix	reference )

Definition at line 258 of file compare.cpp.

258{ REQUIRE_AGREE( getMatrix(matrix), reference ); }

◆ REQUIRE_AGREE() [7/15]

void REQUIRE_AGREE	(	qcomp	scalar,
		qcomp	reference )

Definition at line 177 of file compare.cpp.

                                                    {
 
    if (!doScalarsAgree(scalar, reference))
        REPORT_SCALAR_AND_FAIL(scalar, reference);
 
    SUCCEED( );
}

◆ REQUIRE_AGREE() [8/15]

void REQUIRE_AGREE	(	qmatrix	matrix,
		qmatrix	reference )

Definition at line 240 of file compare.cpp.

                                                        {
    DEMAND( matrix.size() == reference.size() );
 
    size_t dim = matrix.size();
 
    for (size_t r=0; r<dim; r++)
        for (size_t c=0; c<dim; c++)
            if (!doScalarsAgree(matrix[r][c], reference[r][c]))
                REPORT_ELEM_AND_FAIL(r, c, matrix[r][c], reference[r][c]);
 
    SUCCEED( );
}

◆ REQUIRE_AGREE() [9/15]

void REQUIRE_AGREE	(	qreal	scalar,
		qreal	reference )

Definition at line 185 of file compare.cpp.

                                                    {
 
    if (!doScalarsAgree(qcomp(scalar,0), qcomp(reference,0)))
        REPORT_SCALAR_AND_FAIL(scalar, reference);
    
    SUCCEED( );
}

◆ REQUIRE_AGREE() [10/15]

void REQUIRE_AGREE	(	Qureg	qureg,
		qmatrix	reference )

Definition at line 131 of file compare.cpp.

                                          {
    DEMAND( q.isDensityMatrix );
    DEMAND( getPow2(q.numQubits) == (qindex) m1.size() );
 
    qmatrix m2 = getMatrix(q);
 
    for (size_t i=0; i<m1.size(); i++)
        for (size_t j=0; j<m1.size(); j++)
            if (!doScalarsAgree(m1[i][j], m2[i][j]))
                REPORT_AMP_AND_FAIL(j*m1.size()+i, m2[i][j], m1[i][j]);
 
    SUCCEED( );
}

◆ REQUIRE_AGREE() [11/15]

void REQUIRE_AGREE	(	Qureg	qureg,
		Qureg	other )

Definition at line 271 of file compare.cpp.

                                               {
    DEMAND( qureg.numQubits == other.numQubits );
    DEMAND( qureg.isDensityMatrix == other.isDensityMatrix );
 
    return (qureg.isDensityMatrix)?
        REQUIRE_AGREE( qureg, getMatrix(other) ):
        REQUIRE_AGREE( qureg, getVector(other) );
}

◆ REQUIRE_AGREE() [12/15]

void REQUIRE_AGREE	(	Qureg	qureg,
		qvector	reference )

Definition at line 117 of file compare.cpp.

                                          {
    DEMAND( !q.isDensityMatrix );
    DEMAND( q.numAmps == (qindex) v1.size() );
 
    qvector v2 = getVector(q);   
 
    for (size_t i=0; i<v1.size(); i++)
        if (!doScalarsAgree(v1[i], v2[i]))
            REPORT_AMP_AND_FAIL(i, v2[i], v1[i]);
 
    SUCCEED( );
}

◆ REQUIRE_AGREE() [13/15]

void REQUIRE_AGREE	(	SuperOp	matrix,
		qmatrix	reference )

Definition at line 260 of file compare.cpp.

260{ REQUIRE_AGREE( getMatrix(matrix), reference ); }

◆ REQUIRE_AGREE() [14/15]

void REQUIRE_AGREE	(	vector< qcomp >	list,
		vector< qcomp >	reference )

Definition at line 211 of file compare.cpp.

                                                                   {
    DEMAND( apiList.size() == refList.size() );
 
    for (size_t i=0; i<apiList.size(); i++)
        if (!doScalarsAgree(apiList[i], refList[i]))
            REPORT_SCALAR_AND_FAIL(apiList[i], refList[i]);
 
    SUCCEED( );
}

◆ REQUIRE_AGREE() [15/15]

void REQUIRE_AGREE	(	vector< qreal >	list,
		vector< qreal >	reference )

Definition at line 200 of file compare.cpp.

                                                                   {
    DEMAND( apiList.size() == refList.size() );
 
    for (size_t i=0; i<apiList.size(); i++)
        if (!doScalarsAgree(apiList[i], refList[i]))
            REPORT_SCALAR_AND_FAIL(apiList[i], refList[i]);
 
    SUCCEED( );
}

Functions