utilities.hpp
Go to the documentation of this file.
1 
14 #ifndef QUEST_TEST_UTILS_H
15 #define QUEST_TEST_UTILS_H
16 
17 #include "QuEST.h"
18 #include "QuEST_complex.h"
19 #include "catch.hpp"
20 #include <vector>
21 
25 extern QuESTEnv QUEST_ENV;
26 
36 #define NUM_QUBITS 5
37 
49 typedef std::vector<std::vector<qcomp>> QMatrix;
50 
60 typedef std::vector<qcomp> QVector;
61 
62 /* (Excluded from Doxygen doc)
63  *
64  * Define QVector and QMatrix operator overloads.
65  * Note that QMatrix overloads don't simply use QVector
66  * overloads, since the complex vector dot product involves
67  * conjugation, which doesn't occur in complex matrix multiplication.
68  * Note too we also avoid defining operators in terms of other operators
69  * (e.g. minus is plus(negative times)) since compiler optimisations
70  * may change the order of operations and confuse the overloads invoked.
71  * Definition of division using multiplication can furthermore
72  * heighten numerical errors.
73  *
74  * @ingroup testutilities
75  * @author Tyson Jones
76  */
77 QVector operator + (const QVector& v1, const QVector& v2);
78 QVector operator - (const QVector& v1, const QVector& v2);
79 QVector operator * (const qcomp& a, const QVector& v);
80 QVector operator * (const QVector& v, const qcomp& a);
81 QVector operator / (const QVector& v, const qcomp& a);
82 qcomp operator * (const QVector &v1, const QVector& v2);
83 void operator += (QVector& v1, const QVector& v2);
84 void operator -= (QVector& v1, const QVector& v2);
85 void operator *= (QVector& v1, const qcomp& a);
86 void operator /= (QVector& v1, const qcomp& a);
87 QMatrix operator + (const QMatrix& m1, const QMatrix& m2);
88 QMatrix operator - (const QMatrix& m1, const QMatrix& m2);
89 QMatrix operator * (const qcomp& a, const QMatrix& m);
90 QMatrix operator * (const QMatrix& m, const qcomp& a);
91 QMatrix operator / (const QMatrix& m, const qcomp& a);
92 QMatrix operator * (const QMatrix& m1, const QMatrix& m2);
93 void operator += (QMatrix& m1, const QMatrix& m2);
94 void operator -= (QMatrix& m1, const QMatrix& m2);
95 void operator *= (QMatrix& m1, const qreal& a);
96 void operator /= (QMatrix& m1, const qreal& a);
97 void operator *= (QMatrix& m1, const QMatrix& m2);
98 QVector operator * (const QMatrix& m, const QVector& v);
99 
107 QVector toQVector(Qureg qureg);
108 
117 
125 QMatrix toQMatrix(Qureg qureg);
126 
133 QMatrix toQMatrix(Complex alpha, Complex beta);
134 
141 
148 
155 
162 QMatrix toQMatrix(qreal* coeffs, pauliOpType* paulis, int numQubits, int numTerms);
163 
170 
177 
185 
193 
202 
211 void toQureg(Qureg qureg, QVector vec);
212 
221 void toQureg(Qureg qureg, QMatrix mat);
222 
228 QMatrix getZeroMatrix(size_t dim);
229 
235 QMatrix getIdentityMatrix(size_t dim);
236 
244 
255 
263 
271 QMatrix getSwapMatrix(int qb1, int qb2, int numQb);
272 
287 QMatrix getFullOperatorMatrix(int* ctrls, int numCtrls, int *targs, int numTargs, QMatrix op, int numQubits);
288 
297 QMatrix getKetBra(QVector ket, QVector bra);
298 
305 
313 int getRandomInt(int min, int max);
314 
322 qreal getRandomReal(qreal min, qreal max);
323 
331 QVector getRandomQVector(int dim);
332 
340 QMatrix getRandomQMatrix(int dim);
341 
355 QMatrix getRandomUnitary(int numQb);
356 
364 QVector getRandomStateVector(int numQb);
365 
374 
384 std::vector<QMatrix> getRandomKrausMap(int numQb, int numOps);
385 
392 
401 void setSubMatrix(QMatrix &dest, QMatrix sub, size_t r, size_t c);
402 
422 void applyReferenceOp(QMatrix &state, int* ctrls, int numCtrls, int *targs, int numTargs, QMatrix op);
423 
443 void applyReferenceOp(QMatrix &state, int* ctrls, int numCtrls, int targ1, int targ2, QMatrix op);
444 
463 void applyReferenceOp(QMatrix &state, int* ctrls, int numCtrls, int target, QMatrix op);
464 
483 void applyReferenceOp(QMatrix &state, int *targs, int numTargs, QMatrix op);
484 
502 void applyReferenceOp(QMatrix &state, int ctrl, int targ, QMatrix op);
503 
522 void applyReferenceOp(QMatrix &state, int ctrl, int* targs, int numTargs, QMatrix op);
523 
541 void applyReferenceOp(QMatrix &state, int ctrl, int targ1, int targ2, QMatrix op);
542 
560 void applyReferenceOp(QMatrix &state, int targ, QMatrix op);
561 
580 void applyReferenceOp(QVector &state, int* ctrls, int numCtrls, int *targs, int numTargs, QMatrix op);
581 
598 void applyReferenceOp(QVector &state, int* ctrls, int numCtrls, int targ1, int targ2, QMatrix op);
599 
616 void applyReferenceOp(QVector &state, int* ctrls, int numCtrls, int target, QMatrix op);
617 
633 void applyReferenceOp(QVector &state, int *targs, int numTargs, QMatrix op);
634 
650 void applyReferenceOp(QVector &state, int ctrl, int targ, QMatrix op);
651 
668 void applyReferenceOp(QVector &state, int ctrl, int* targs, int numTargs, QMatrix op);
669 
686 void applyReferenceOp(QVector &state, int ctrl, int targ1, int targ2, QMatrix op);
687 
703 void applyReferenceOp(QVector &state, int targ, QMatrix op);
704 
713 void applyReferenceMatrix(QVector &state, int* ctrls, int numCtrls, int *targs, int numTargs, QMatrix op);
714 
723 void applyReferenceMatrix(QMatrix &state, int* ctrls, int numCtrls, int *targs, int numTargs, QMatrix op);
724 
738 bool areEqual(Qureg qureg1, Qureg qureg2);
739 
752 bool areEqual(Qureg qureg, QVector vec);
753 
766 bool areEqual(Qureg qureg, QMatrix matr);
767 
781 bool areEqual(Qureg qureg1, Qureg qureg2, qreal precision);
782 
795 bool areEqual(Qureg qureg, QVector vec, qreal precision);
796 
809 bool areEqual(Qureg qureg, QMatrix matr, qreal precision);
810 
817 bool areEqual(QVector a, QVector b);
818 
825 bool areEqual(QMatrix a, QMatrix b);
826 
833 bool areEqual(QVector vec, qreal* reals, qreal* imags);
834 
839 qcomp expI(qreal phase);
840 
846 unsigned int calcLog2(long unsigned int res);
847 
854 void setRandomPauliSum(qreal* coeffs, pauliOpType* codes, int numQubits, int numTerms);
855 
861 void setRandomPauliSum(PauliHamil hamil);
862 
863 // makes below signatures more concise
864 template<class T> using CatchGen = Catch::Generators::GeneratorWrapper<T>;
865 
888 CatchGen<int*> sublists(int* list, int len, int sublen);
889 
915 CatchGen<int*> sublists(CatchGen<int>&& gen, int numSamps, const int* exclude, int numExclude);
916 
942 CatchGen<int*> sublists(CatchGen<int>&& gen, int numSamps, int excluded);
943 
964 CatchGen<int*> sublists(CatchGen<int>&& gen, int sublen);
965 
980 CatchGen<int*> bitsets(int numBits);
981 
998 CatchGen<int*> sequences(int base, int numDigits);
999 
1016 CatchGen<pauliOpType*> pauliseqs(int numPaulis);
1017 
1018 #endif // QUEST_TEST_UTILS_H
pauliOpType
Codes for specifying Pauli operators.
Definition: QuEST.h:96
QMatrix getFullOperatorMatrix(int *ctrls, int numCtrls, int *targs, int numTargs, QMatrix op, int numQubits)
Takes a 2^numTargs-by-2^numTargs matrix op and a returns a 2^numQubits-by-2^numQubits matrix where op...
Definition: utilities.cpp:293
Catch::Generators::GeneratorWrapper< T > CatchGen
Definition: utilities.hpp:864
qcomp expI(qreal phase)
Returns the unit-norm complex number exp(i*phase).
Definition: utilities.cpp:406
void applyReferenceOp(QMatrix &state, int *ctrls, int numCtrls, int *targs, int numTargs, QMatrix op)
Modifies the density matrix state to be the result of applying the multi-target operator matrix op,...
Definition: utilities.cpp:629
QMatrix getConjugateTranspose(QMatrix a)
Returns the conjugate transpose of the complex square matrix a.
Definition: utilities.cpp:179
int getRandomInt(int min, int max)
Returns a random integer between min (inclusive) and max (exclusive), from the uniform distribution.
Definition: utilities.cpp:481
std::vector< QMatrix > getRandomKrausMap(int numQb, int numOps)
Returns a random Kraus map of #numOps 2^numQb-by-2^numQb operators, from an undisclosed distribution.
Definition: utilities.cpp:533
QMatrix getSwapMatrix(int qb1, int qb2, int numQb)
Returns the 2^numQb-by-2^numQb unitary matrix which swaps qubits qb1 and qb2; the SWAP gate of not-ne...
Definition: utilities.cpp:219
QMatrix getRandomUnitary(int numQb)
Returns a uniformly random (under Haar) 2^numQb-by-2^numQb unitary matrix.
Definition: utilities.cpp:485
qreal getRandomReal(qreal min, qreal max)
Returns a random real between min (inclusive) and max (exclusive), from the uniform distribution.
Definition: utilities.cpp:410
QMatrix getKetBra(QVector ket, QVector bra)
Returns the matrix |ket><bra|, with ith-jth element ket(i) conj(bra(j)), since |ket><bra| = sum_i a_i...
Definition: utilities.cpp:159
QuESTEnv QUEST_ENV
The single QuESTEnv environment created before the Catch tests begin, and destroyed thereafter.
Definition: main.cpp:20
void operator/=(QVector &v1, const qcomp &a)
Definition: utilities.cpp:73
Represents a 4x4 matrix of complex numbers.
Definition: QuEST.h:125
Information about the environment the program is running in.
Definition: QuEST.h:242
Represents a general 2^N by 2^N matrix of complex numbers.
Definition: QuEST.h:136
#define qreal
void toQureg(Qureg qureg, QVector vec)
Initialises the state-vector qureg to have the same amplitudes as vec.
Definition: utilities.cpp:1026
unsigned int calcLog2(long unsigned int res)
Returns log2 of numbers which must be gauranteed to be 2^n.
QMatrix getExponentialOfPauliMatrix(qreal angle, QMatrix a)
Returns the matrix exponential of a kronecker product of pauli matrices (or of any involutory matrice...
Definition: utilities.cpp:205
void setRandomPauliSum(qreal *coeffs, pauliOpType *codes, int numQubits, int numTerms)
Populates the coeffs array with random qreals in (-5, 5), and populates codes with random Pauli codes...
Definition: utilities.cpp:1054
void toComplexMatrixN(QMatrix qm, ComplexMatrixN cm)
Initialises cm with the values of qm.
Definition: utilities.cpp:858
std::vector< qcomp > QVector
A complex vector, which can be zero-initialised with QVector(numAmps).
Definition: utilities.hpp:60
void setSubMatrix(QMatrix &dest, QMatrix sub, size_t r, size_t c)
Modifies dest by overwriting its submatrix (from top-left corner (r, c) to bottom-right corner (r + d...
Definition: utilities.cpp:211
QVector toQVector(Qureg qureg)
Returns an equal-size copy of the given state-vector qureg.
Definition: utilities.cpp:938
CatchGen< int * > sequences(int base, int numDigits)
Returns a Catch2 generator of every numDigits-length sequence in the given base, in increasing lexogr...
Definition: utilities.cpp:1273
#define qcomp
ComplexMatrix4 toComplexMatrix4(QMatrix qm)
Returns a ComplexMatrix4 copy of QMatix qm.
Definition: utilities.cpp:852
bool areEqual(Qureg qureg1, Qureg qureg2)
Performs a hardware-agnostic comparison of the given quregs, checking whether the difference between ...
Definition: utilities.cpp:724
Represents a diagonal complex operator on the full Hilbert state of a Qureg.
Definition: QuEST.h:178
Represents a weighted sum of pauli products.
Definition: QuEST.h:158
void operator-=(QVector &v1, const QVector &v2)
Definition: utilities.cpp:67
QVector getRandomStateVector(int numQb)
Returns a random numQb-length L2-normalised state-vector from an undisclosed distribution.
Definition: utilities.cpp:453
QVector operator-(const QVector &v1, const QVector &v2)
Definition: utilities.cpp:33
QMatrix getRandomQMatrix(int dim)
Returns a dim-by-dim complex matrix, where the real and imaginary value of each element are independe...
Definition: utilities.cpp:368
Represents a system of qubits.
Definition: QuEST.h:203
CatchGen< pauliOpType * > pauliseqs(int numPaulis)
Returns a Catch2 generator of every numPaulis-length set of Pauli-matrix types (or base-4 integers).
Definition: utilities.cpp:1278
QVector operator*(const qcomp &a, const QVector &v)
Definition: utilities.cpp:40
std::vector< std::vector< qcomp > > QMatrix
A complex square matrix.
Definition: utilities.hpp:49
ComplexMatrix2 toComplexMatrix2(QMatrix qm)
Returns a ComplexMatrix2 copy of QMatix qm.
Definition: utilities.cpp:846
CatchGen< int * > sublists(int *list, int len, int sublen)
Returns a Catch2 generator of every length-sublen sublist of length-len list, in increasing lexograph...
Definition: utilities.cpp:1199
QVector getNormalised(QVector vec)
Returns an L2-normalised copy of vec, using Kahan summation for improved accuracy.
Definition: utilities.cpp:431
QMatrix getIdentityMatrix(size_t dim)
Returns a dim-by-dim identity matrix.
Definition: utilities.cpp:151
QMatrix getKroneckerProduct(QMatrix a, QMatrix b)
Returns the kronecker product of a and b, where a and b are square but possibly differently-sized com...
Definition: utilities.cpp:169
QMatrix getRandomDensityMatrix(int numQb)
Returns a random numQb-by-numQb density matrix, from an undisclosed distribution, in a very mixed sta...
Definition: utilities.cpp:457
QVector operator/(const QVector &v, const qcomp &a)
Definition: utilities.cpp:49
QMatrix toQMatrix(Qureg qureg)
Returns an equal-size copy of the given density matrix qureg.
Definition: utilities.cpp:896
QMatrix getExponentialOfDiagonalMatrix(QMatrix a)
Returns the matrix exponential of a diagonal, square, complex matrix.
Definition: utilities.cpp:187
QMatrix getZeroMatrix(size_t dim)
Returns a dim-by-dim square complex matrix, initialised to all zeroes.
Definition: utilities.cpp:143
void operator*=(QVector &v1, const qcomp &a)
Definition: utilities.cpp:70
Represents one complex number.
Definition: QuEST.h:103
void operator+=(QVector &v1, const QVector &v2)
Definition: utilities.cpp:64
QVector getRandomQVector(int dim)
Returns a dim-length vector with random complex amplitudes in the square joining {-1-i,...
Definition: utilities.cpp:420
void applyReferenceMatrix(QVector &state, int *ctrls, int numCtrls, int *targs, int numTargs, QMatrix op)
Modifies the state-vector state to be the result of left-multiplying the multi-target operator matrix...
Definition: utilities.cpp:686
CatchGen< int * > bitsets(int numBits)
Returns a Catch2 generator of every numBits-length bit-set, in increasing lexographic order,...
Definition: utilities.cpp:1268
QVector operator+(const QVector &v1, const QVector &v2)
Definition: utilities.cpp:26
Represents a 2x2 matrix of complex numbers.
Definition: QuEST.h:114