QuEST.h

Go to the documentation of this file.

// Distributed under MIT licence. See https://github.com/aniabrown/QuEST_GPU/blob/master/LICENCE.txt for details

# ifndef QuEST
# define QuEST

# include "QuEST_precision.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct ComplexArray
{
        REAL *real; 
        REAL *imag;
} ComplexArray;

typedef struct Complex
{
        REAL real;
        REAL imag;
} Complex;

typedef struct ComplexMatrix2
{
    Complex r0c0, r0c1;
    Complex r1c0, r1c1;
} ComplexMatrix2;

typedef struct Vector
{
    REAL x, y, z;
} Vector;

typedef struct MultiQubit
{
        ComplexArray stateVec; 
        ComplexArray pairStateVec;
        ComplexArray deviceStateVec;
        REAL *firstLevelReduction, *secondLevelReduction;
        int numQubits;
        long long int numAmps;
        int chunkId;
        int numChunks;
} MultiQubit;

typedef struct QuESTEnv
{
        int rank;
        int numRanks;
} QuESTEnv;

// Codes for sigmaZ phase gate variations
enum phaseGateType {SIGMA_Z=0, S_GATE=1, T_GATE=2};

// QuEST library functions whose implementation is independent of environment (local, MPI)


void reportState(MultiQubit multiQubit);

void reportMultiQubitParams(MultiQubit multiQubit);

void rotateAroundAxis(MultiQubit multiQubit, const int rotQubit, REAL angle, Vector unitAxis);

void rotateX(MultiQubit multiQubit, const int rotQubit, REAL angle);

void rotateY(MultiQubit multiQubit, const int rotQubit, REAL angle);

void rotateZ(MultiQubit multiQubit, const int rotQubit, REAL angle);

void controlledRotateX(MultiQubit multiQubit, const int controlQubit, const int targetQubit, REAL angle);

void controlledRotateY(MultiQubit multiQubit, const int controlQubit, const int targetQubit, REAL angle);

void controlledRotateZ(MultiQubit multiQubit, const int controlQubit, const int targetQubit, REAL angle);

void controlledRotateAroundAxis(MultiQubit multiQubit, const int controlQubit, const int targetQubit, REAL angle, Vector axis);

void sGate(MultiQubit multiQubit, const int targetQubit);

void tGate(MultiQubit multiQubit, const int targetQubit);

// QuEST library functions whose implementation depends on environment (local, MPI)

void getEnvironmentString(QuESTEnv env, MultiQubit multiQubit, char str[200]);

void reportStateToScreen(MultiQubit multiQubit, QuESTEnv env, int reportRank);

void controlledPhaseGate(MultiQubit multiQubit, const int idQubit1, const int idQubit2);

void multiControlledPhaseGate(MultiQubit multiQubit, int *controlQubits, int numControlQubits);

void controlledNot(MultiQubit multiQubit, const int controlQubit, const int targetQubit);

void createMultiQubit(MultiQubit *multiQubit, int numQubits, QuESTEnv env);

void destroyMultiQubit(MultiQubit multiQubit, QuESTEnv env);

void initStateZero(MultiQubit *multiQubit);

void initStatePlus(MultiQubit *multiQubit);

void initClassicalState(MultiQubit *multiQubit, long long int stateInd);

void initQuESTEnv(QuESTEnv *env);

void closeQuESTEnv(QuESTEnv env);

void syncQuESTEnv(QuESTEnv env);

int syncQuESTSuccess(int successCode);

void reportQuESTEnv(QuESTEnv env);

REAL calcTotalProbability(MultiQubit multiQubit);

void compactUnitary(MultiQubit multiQubit, const int rotQubit, Complex alpha, Complex beta);

void controlledCompactUnitary(MultiQubit multiQubit, const int controlQubit, const int targetQubit, Complex alpha, Complex beta);

void unitary(MultiQubit multiQubit, const int targetQubit, ComplexMatrix2 u);

void controlledUnitary(MultiQubit multiQubit, const int controlQubit, const int targetQubit, ComplexMatrix2 u);

void multiControlledUnitary(MultiQubit multiQubit, int* controlQubits, const int numControlQubits, const int targetQubit, ComplexMatrix2 u);

void sigmaX(MultiQubit multiQubit, const int targetQubit);

void sigmaY(MultiQubit multiQubit, const int targetQubit);

void sigmaZ(MultiQubit multiQubit, const int targetQubit);

void hadamard(MultiQubit multiQubit, const int targetQubit);

REAL findProbabilityOfOutcome(MultiQubit multiQubit, const int measureQubit, int outcome);


REAL collapseToOutcome(MultiQubit multiQubit, const int measureQubit, int outcome);

int measure(MultiQubit multiQubit, int measureQubit);

int measureWithStats(MultiQubit multiQubit, int measureQubit, REAL *stateProb);

void QuESTSeedRandomDefault(void);

void QuESTSeedRandom(unsigned long int *seedArray, int numSeeds);

#ifdef __cplusplus
}
#endif

# endif