Constructors

Functions for creating variable-size matrices. More...

Functions
CompMatr	createCompMatr (int numQubits)
FullStateDiagMatr	createCustomFullStateDiagMatr (int numQubits, int useDistrib, int useGpuAccel, int useMultithread)
DiagMatr	createDiagMatr (int numQubits)
FullStateDiagMatr	createFullStateDiagMatr (int numQubits)
FullStateDiagMatr	createFullStateDiagMatrFromPauliStrSum (PauliStrSum in)
CompMatr	createInlineCompMatr (int numQb, std::vector< std::vector< qcomp > > elems)
DiagMatr	createInlineDiagMatr (int numQb, std::vector< qcomp > elems)

Detailed Description

Functions for creating variable-size matrices.

Function Documentation

createCompMatr()

CompMatr createCompMatr

(

int

numQubits

)

Note

Documentation for this function or struct is under construction!

Definition at line 211 of file matrices.cpp.

                                                  {
    validate_envIsInit(__func__);
    validate_newCompMatrParams(numQubits, __func__);
 
    // validation ensures these never overflow
    qindex numRows = powerOf2(numQubits);
    qindex numElems = numRows * numRows;
 
    qcomp* cpuMem = cpu_allocArray(numElems); // nullptr if failed
    qcomp* gpuMem = nullptr;
    if (getQuESTEnv().isGpuAccelerated)
        gpuMem = gpu_allocArray(numElems); // nullptr if failed
 
    // initialise all CompMatr fields inline because most are const
    CompMatr out = {
        .numQubits = numQubits,
        .numRows = numRows,
 
        // allocate flags in the heap so that struct copies are mutable
        .isApproxUnitary    = util_allocEpsilonSensitiveHeapFlag(), // nullptr if failed
        .isApproxHermitian  = util_allocEpsilonSensitiveHeapFlag(),
 
        .wasGpuSynced = cpu_allocHeapFlag(), // nullptr if failed
 
        .cpuElems = cpu_allocAndInitMatrixWrapper(cpuMem, numRows), // nullptr if failed
        .cpuElemsFlat = cpuMem,
        .gpuElemsFlat = gpuMem
    };
 
    validateMatrixAllocs(out, __func__);
    setInitialHeapFlags(out);
    return out;
}

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

createCustomFullStateDiagMatr()

FullStateDiagMatr createCustomFullStateDiagMatr	(	int	numQubits,
		int	useDistrib,
		int	useGpuAccel,
		int	useMultithread )

Note

Documentation for this function or struct is under construction!

Definition at line 322 of file matrices.cpp.

                                                                                                                               {
 
    return validateAndCreateCustomFullStateDiagMatr(numQubits, useDistrib, useGpuAccel, useMultithread, __func__);
}

Referenced by TEST_CASE().

createDiagMatr()

DiagMatr createDiagMatr

(

int

numQubits

)

Note

Documentation for this function or struct is under construction!

Definition at line 246 of file matrices.cpp.

                                                  {
    validate_envIsInit(__func__);
    validate_newDiagMatrParams(numQubits, __func__);
 
    // validation ensures this never overflows
    qindex numElems = powerOf2(numQubits);
 
    // initialise all CompMatr fields inline because most are const
    DiagMatr out = {
        .numQubits = numQubits,
        .numElems = numElems,
 
        // allocate flags in the heap so that struct copies are mutable
        .isApproxUnitary       = util_allocEpsilonSensitiveHeapFlag(), // nullptr if failed
        .isApproxHermitian     = util_allocEpsilonSensitiveHeapFlag(),
        .isApproxNonZero       = util_allocEpsilonSensitiveHeapFlag(),
        .isStrictlyNonNegative = cpu_allocHeapFlag(), // nullptr if failed
        .wasGpuSynced          = cpu_allocHeapFlag(),
 
        // 1D CPU memory
        .cpuElems = cpu_allocArray(numElems), // nullptr if failed
 
        // 1D GPU memory
        .gpuElems = (getQuESTEnv().isGpuAccelerated)? gpu_allocArray(numElems) : nullptr // nullptr if failed or not needed
    };
 
    validateMatrixAllocs(out, __func__);
    setInitialHeapFlags(out);
    return out;
}

Referenced by TEST_CASE(), and TEST_CASE().

createFullStateDiagMatr()

FullStateDiagMatr createFullStateDiagMatr

(

int

numQubits

)

Note

Documentation for this function or struct is under construction!

Definition at line 327 of file matrices.cpp.

                                                                    {
 
    return validateAndCreateCustomFullStateDiagMatr(numQubits, modeflag::USE_AUTO, modeflag::USE_AUTO, modeflag::USE_AUTO, __func__);
}

Referenced by createFullStateDiagMatrFromPauliStrSum(), and TEST_CASE().

createFullStateDiagMatrFromPauliStrSum()

FullStateDiagMatr createFullStateDiagMatrFromPauliStrSum

(

PauliStrSum

in

)

Note

Documentation for this function or struct is under construction!

Warning

This function has not yet been unit tested and may contain bugs. Please use with caution!

Definition at line 658 of file matrices.cpp.

                                                                                    {
    validate_pauliStrSumFields(in, __func__);
    
    // ensure createFullStateDiagMatr() below succeeds (so if not, that thrower name is correct)
    int numQubits = 1 + paulis_getIndOfLefmostNonIdentityPauli(in);
    validate_newFullStateDiagMatrParams(numQubits, modeflag::USE_AUTO, modeflag::USE_AUTO, modeflag::USE_AUTO, __func__);
 
    // permit 'in' to be non-Hermitian since it does not determine 'out' unitarity
 
    FullStateDiagMatr out = createFullStateDiagMatr(numQubits);
    localiser_fullstatediagmatr_setElemsToPauliStrSum(out, in);
    markMatrixAsSynced(out);
    return out;
}

createInlineCompMatr()

CompMatr createInlineCompMatr	(	int	numQb,
		std::vector< std::vector< qcomp > >	elems )

Note

Documentation for this function or struct is under construction!

createInlineDiagMatr()

DiagMatr createInlineDiagMatr	(	int	numQb,
		std::vector< qcomp >	elems )

Note

Documentation for this function or struct is under construction!