Functions for creating statevectors and density matrices. More...

Functions
Qureg	createCloneQureg (Qureg qureg)

Qureg	createCustomQureg (int numQubits, int isDensMatr, int useDistrib, int useGpuAccel, int useMultithread)

Qureg	createDensityQureg (int numQubits)

Qureg	createForcedDensityQureg (int numQubits)

Qureg	createForcedQureg (int numQubits)

Qureg	createQureg (int numQubits)

Detailed Description

Functions for creating statevectors and density matrices.

Function Documentation

◆ createCloneQureg()

Qureg createCloneQureg ( Qureg qureg )

Note: Documentation for this function or struct is under construction!

Definition at line 313 of file qureg.cpp.

                                    {
    validate_quregFields(qureg, __func__);
 
    // create a new Qureg with identical fields, but zero'd memory
    Qureg clone = validateAndCreateCustomQureg(
        qureg.numQubits, qureg.isDensityMatrix, qureg.isDistributed, 
        qureg.isGpuAccelerated, qureg.isMultithreaded, __func__);
 
    setQuregToClone(clone, qureg); // harmlessly re-validates
 
    // if GPU-accelerated, clone's CPU amps are NOT updated
    return clone;
}

Referenced by TEST_CASE(), and TEST_CASE().

◆ createCustomQureg()

Qureg createCustomQureg	(	int	numQubits,
		int	isDensMatr,
		int	useDistrib,
		int	useGpuAccel,
		int	useMultithread )

Note: Documentation for this function or struct is under construction!

Definition at line 271 of file qureg.cpp.

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

Referenced by TEST_CASE().

◆ createDensityQureg()

Qureg createDensityQureg ( int numQubits )

Note: Documentation for this function or struct is under construction!

Definition at line 285 of file qureg.cpp.

                                        {
 
    int isDensMatr = 1;
    int autoMode = modeflag::USE_AUTO;
    return validateAndCreateCustomQureg(numQubits, isDensMatr, autoMode, autoMode, autoMode, __func__);
}

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

◆ createForcedDensityQureg()

Qureg createForcedDensityQureg ( int numQubits )

Note: Documentation for this function or struct is under construction!

Definition at line 303 of file qureg.cpp.

                                              {
    validate_envIsInit(__func__);
 
    QuESTEnv env = getQuESTEnv();
 
    int isDensMatr = 1;
    return validateAndCreateCustomQureg(numQubits, isDensMatr, env.isDistributed, env.isGpuAccelerated, env.isMultithreaded, __func__);
}

Referenced by 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(), 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(), TEST_CASE(), TEST_CASE(), and TEST_CASE().

◆ createForcedQureg()

Qureg createForcedQureg ( int numQubits )

Note: Documentation for this function or struct is under construction!

Definition at line 293 of file qureg.cpp.

                                       {
    validate_envIsInit(__func__);
 
    QuESTEnv env = getQuESTEnv();
 
    int isDensMatr = 0;
    return validateAndCreateCustomQureg(numQubits, isDensMatr, env.isDistributed, env.isGpuAccelerated, env.isMultithreaded, __func__);
}

Referenced by 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(), 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(), TEST_CASE(), TEST_CASE(), and TEST_CASE().

◆ createQureg()

Qureg createQureg ( int numQubits )

Note: Documentation for this function or struct is under construction!

Definition at line 277 of file qureg.cpp.

                                 {
 
    int isDensMatr = 0;
    int autoMode = modeflag::USE_AUTO;
    return validateAndCreateCustomQureg(numQubits, isDensMatr, autoMode, autoMode, autoMode, __func__);
}

Referenced by 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(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), and TEST_CASE().