Functions for initialising Qureg into physical states. More...

Functions
void	initArbitraryPureState (Qureg qureg, qcomp *amps)

void	initBlankState (Qureg qureg)

void	initClassicalState (Qureg qureg, qindex stateInd)

void	initDebugState (Qureg qureg)

void	initPlusState (Qureg qureg)

void	initPureState (Qureg qureg, Qureg pure)

void	initRandomMixedState (Qureg qureg, qindex numPureStates)

void	initRandomPureState (Qureg qureg)

void	initZeroState (Qureg qureg)

Detailed Description

Functions for initialising Qureg into physical states.

Function Documentation

◆ initArbitraryPureState()

void initArbitraryPureState	(	Qureg	qureg,
		qcomp *	amps )

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

Attention: This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Definition at line 99 of file initialisations.cpp.

                                                      {
    validate_quregFields(qureg, __func__);
 
    // set qureg = |amps> or |amps><amps|
    (qureg.isDensityMatrix)?
        localiser_densmatr_initArbitraryPureState(qureg, amps):
        localiser_statevec_initArbitraryPureState(qureg, amps);
}

Referenced by TEST_CASE(), and TEST_CASE().

◆ initBlankState()

void initBlankState ( Qureg qureg )

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

Attention: This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Definition at line 41 of file initialisations.cpp.

                                 {
    validate_quregFields(qureg, __func__);
 
    // |null> = {0, 0, 0, ...}
    qcomp amp = 0;
    localiser_statevec_initUniformState(qureg, amp);
}

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

◆ initClassicalState()

void initClassicalState	(	Qureg	qureg,
		qindex	stateInd )

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

Attention: This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Definition at line 80 of file initialisations.cpp.

                                                 {
    validate_quregFields(qureg, __func__);
    validate_basisStateIndex(qureg, ind, __func__);
 
    // |ind><ind| = ||ind'>>
    if (qureg.isDensityMatrix)
        ind = util_getGlobalFlatIndex(qureg, ind, ind);
 
    localiser_statevec_initClassicalState(qureg, ind);
}

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

◆ initDebugState()

void initDebugState ( Qureg qureg )

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

Attention: This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Definition at line 92 of file initialisations.cpp.

                                 {
    validate_quregFields(qureg, __func__);
 
    localiser_statevec_initDebugState(qureg);
}

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

◆ initPlusState()

void initPlusState ( Qureg qureg )

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

Attention: This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Definition at line 59 of file initialisations.cpp.

                                {
    validate_quregFields(qureg, __func__);
 
    // |+>    = sum_i 1/sqrt(2^N) |i>  where 2^N = numAmps
    // |+><+| = sum_ij 1/2^N |i><j|    where 2^N = sqrt(numAmps)
    qcomp amp = 1.0 / std::sqrt(qureg.numAmps);
    localiser_statevec_initUniformState(qureg, amp);
}

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

◆ initPureState()

void initPureState	(	Qureg	qureg,
		Qureg	pure )

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

Attention: This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

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

Definition at line 69 of file initialisations.cpp.

                                            {
    validate_quregFields(qureg, __func__);
    validate_quregFields(pure, __func__);
    validate_quregCanBeInitialisedToPureState(qureg, pure, __func__);
 
    (qureg.isDensityMatrix)?
        localiser_densmatr_initPureState(qureg, pure):
        localiser_statevec_setQuregToClone(qureg, pure);
}

Referenced by TEST_CASE().

◆ initRandomMixedState()

void initRandomMixedState	(	Qureg	qureg,
		qindex	numPureStates )

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

Attention: This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Definition at line 132 of file initialisations.cpp.

                                                             {
    validate_quregFields(qureg, __func__);
    validate_quregIsDensityMatrix(qureg, __func__);
    validate_numInitRandomPureStates(numPureStates, __func__);
 
    localiser_densmatr_initMixtureOfUniformlyRandomPureStates(qureg, numPureStates);
}

Referenced by TEST_CASE().

◆ initRandomPureState()

void initRandomPureState ( Qureg qureg )

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

Attention: This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Definition at line 117 of file initialisations.cpp.

                                      {
    validate_quregFields(qureg, __func__);
 
    // these invoked localiser functions may harmlessly 
    // re-call the API and re-perform input validation
 
    if (qureg.isDensityMatrix)
        localiser_densmatr_initUniformlyRandomPureStateAmps(qureg); 
    else {
        localiser_statevec_initUnnormalisedUniformlyRandomPureStateAmps(qureg);
        setQuregToRenormalized(qureg);
    }
}

Referenced by TEST_CASE().

◆ initZeroState()

void initZeroState ( Qureg qureg )

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

Attention: This function's input validation has not yet been unit tested, so erroneous usage may produce unexpected output. Please use with caution!

Definition at line 50 of file initialisations.cpp.

                                {
    validate_quregFields(qureg, __func__);
 
    // |0> = |0><0|
    qindex ind = 0;
    localiser_statevec_initClassicalState(qureg, ind);
}

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