Amplitudes

Functions for overwriting Qureg amplitudes. More...

Functions
void	setDensityQuregAmps (Qureg qureg, qindex startRow, qindex startCol, qcomp **amps, qindex numRows, qindex numCols)
void	setDensityQuregAmps (Qureg qureg, qindex startRow, qindex startCol, std::vector< std::vector< qcomp > > amps)
void	setDensityQuregFlatAmps (Qureg qureg, qindex startInd, qcomp *amps, qindex numAmps)
void	setDensityQuregFlatAmps (Qureg qureg, qindex startInd, std::vector< qcomp > amps)
void	setQuregAmps (Qureg qureg, qindex startInd, qcomp *amps, qindex numAmps)
void	setQuregAmps (Qureg qureg, qindex startInd, std::vector< qcomp > amps)
void	setQuregToClone (Qureg targetQureg, Qureg copyQureg)
void	setQuregToPartialTrace (Qureg out, Qureg in, int *traceOutQubits, int numTraceQubits)
void	setQuregToPartialTrace (Qureg out, Qureg in, std::vector< int > traceOutQubits)
void	setQuregToPauliStrSum (Qureg qureg, PauliStrSum sum)
void	setQuregToReducedDensityMatrix (Qureg out, Qureg in, int *retainQubits, int numRetainQubits)
void	setQuregToReducedDensityMatrix (Qureg out, Qureg in, std::vector< int > retainQubits)
qreal	setQuregToRenormalized (Qureg qureg)
void	setQuregToSuperposition (qcomp facOut, Qureg out, qcomp fac1, Qureg qureg1, qcomp fac2, Qureg qureg2)

Detailed Description

Functions for overwriting Qureg amplitudes.

Function Documentation

setDensityQuregAmps() [1/2]

void setDensityQuregAmps	(	Qureg	qureg,
		qindex	startRow,
		qindex	startCol,
		qcomp **	amps,
		qindex	numRows,
		qindex	numCols )

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 160 of file initialisations.cpp.

                                                                                                                      {
    validate_quregFields(qureg, __func__);
    validate_quregIsDensityMatrix(qureg, __func__);
    validate_basisStateRowCols(qureg, startRow, startCol, numRows, numCols, __func__);
 
    localiser_densmatr_setAmps(amps, qureg, startRow, startCol, numRows, numCols);
}

Referenced by TEST_CASE().

setDensityQuregAmps() [2/2]

void setDensityQuregAmps	(	Qureg	qureg,
		qindex	startRow,
		qindex	startCol,
		std::vector< std::vector< qcomp > >	amps )

Warning

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

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!

Remarks

This function is only available in C++.

See also

setDensityQuregAmps()

setDensityQuregFlatAmps() [1/2]

void setDensityQuregFlatAmps	(	Qureg	qureg,
		qindex	startInd,
		qcomp *	amps,
		qindex	numAmps )

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 169 of file initialisations.cpp.

                                                                                        {
    validate_quregFields(qureg, __func__);
    validate_quregIsDensityMatrix(qureg, __func__);
    validate_basisStateIndices(qureg, startInd, numAmps, __func__); // validation msg correct for density-matrix
 
    localiser_statevec_setAmps(amps, qureg, startInd, numAmps);
}

Referenced by TEST_CASE().

setDensityQuregFlatAmps() [2/2]

void setDensityQuregFlatAmps	(	Qureg	qureg,
		qindex	startInd,
		std::vector< qcomp >	amps )

Warning

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

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!

Remarks

This function is only available in C++.

See also

setDensityQuregFlatAmps()

setQuregAmps() [1/2]

void setQuregAmps	(	Qureg	qureg,
		qindex	startInd,
		qcomp *	amps,
		qindex	numAmps )

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 151 of file initialisations.cpp.

                                                                             {
    validate_quregFields(qureg, __func__);
    validate_quregIsStateVector(qureg, __func__);
    validate_basisStateIndices(qureg, startInd, numAmps, __func__);
 
    localiser_statevec_setAmps(amps, qureg, startInd, numAmps);
}

Referenced by TEST_CASE(), and TEST_CASE().

setQuregAmps() [2/2]

void setQuregAmps	(	Qureg	qureg,
		qindex	startInd,
		std::vector< qcomp >	amps )

Warning

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

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!

Remarks

This function is only available in C++.

See also

setQuregAmps()

setQuregToClone()

void setQuregToClone	(	Qureg	targetQureg,
		Qureg	copyQureg )

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 178 of file initialisations.cpp.

                                                         {
    validate_quregFields(targetQureg, __func__);
    validate_quregFields(copyQureg, __func__);
    validate_quregsCanBeCloned(targetQureg, copyQureg, __func__);
 
    // we invoke mixing/superposing, which involves superfluous
    // floating-point operators but is not expected to cause an
    // appreciable slowdown since simulation is memory-bound
    (targetQureg.isDensityMatrix)?
        localiser_densmatr_mixQureg(0, targetQureg, 1, copyQureg):
        localiser_statevec_setQuregToSuperposition(0, targetQureg, 1, copyQureg, 0, copyQureg);
}

Referenced by createCloneQureg().

setQuregToPartialTrace() [1/2]

void setQuregToPartialTrace	(	Qureg	out,
		Qureg	in,
		int *	traceOutQubits,
		int	numTraceQubits )

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 229 of file initialisations.cpp.

                                                                                          {
    validate_quregFields(in, __func__);
    validate_quregFields(out, __func__);
    validate_quregIsDensityMatrix(in, __func__);
    validate_quregIsDensityMatrix(out, __func__);
    validate_targets(in, traceOutQubits, numTraceQubits, __func__);
    validate_quregCanBeSetToReducedDensMatr(out, in, numTraceQubits, __func__);
 
    auto targets = util_getVector(traceOutQubits, numTraceQubits);
    localiser_densmatr_partialTrace(in, out, targets);
}

setQuregToPartialTrace() [2/2]

void setQuregToPartialTrace	(	Qureg	out,
		Qureg	in,
		std::vector< int >	traceOutQubits )

Warning

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

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!

Remarks

This function is only available in C++.

See also

setQuregToPartialTrace()

Definition at line 292 of file initialisations.cpp.

                                                                             {
    setQuregToPartialTrace(out, in, traceOutQubits.data(), traceOutQubits.size());
}

setQuregToPauliStrSum()

void setQuregToPauliStrSum	(	Qureg	qureg,
		PauliStrSum	sum )

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 216 of file initialisations.cpp.

                                                         {
    validate_quregFields(qureg, __func__);
    validate_quregIsDensityMatrix(qureg, __func__);
    validate_pauliStrSumFields(sum, __func__);
    validate_pauliStrSumTargets(sum, qureg, __func__);
 
    // sum is permitted to be non-Hermitian, since Hermiticity
    // is insufficient to ensure qureg would be physical/valid
 
    localiser_densmatr_setAmpsToPauliStrSum(qureg, sum);
}

Referenced by TEST_CASE().

setQuregToReducedDensityMatrix() [1/2]

void setQuregToReducedDensityMatrix	(	Qureg	out,
		Qureg	in,
		int *	retainQubits,
		int	numRetainQubits )

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 242 of file initialisations.cpp.

                                                                                                 {
    validate_quregFields(in, __func__);
    validate_quregFields(out, __func__);
    validate_quregIsDensityMatrix(in, __func__);
    validate_quregIsDensityMatrix(out, __func__);
    validate_targets(in, retainQubits, numRetainQubits, __func__);
    validate_quregCanBeSetToReducedDensMatr(out, in, in.numQubits - numRetainQubits, __func__);
 
    auto traceQubits = util_getNonTargetedQubits(retainQubits, numRetainQubits, in.numQubits);
    localiser_densmatr_partialTrace(in, out, traceQubits);
}

setQuregToReducedDensityMatrix() [2/2]

void setQuregToReducedDensityMatrix	(	Qureg	out,
		Qureg	in,
		std::vector< int >	retainQubits )

Warning

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

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!

Remarks

This function is only available in C++.

See also

setQuregToReducedDensityMatrix()

Definition at line 296 of file initialisations.cpp.

                                                                                   {
    setQuregToReducedDensityMatrix(out, in, retainQubits.data(), retainQubits.size());
}

setQuregToRenormalized()

qreal setQuregToRenormalized

(

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 202 of file initialisations.cpp.

                                          {
    validate_quregFields(qureg, __func__);
 
    qreal prob = calcTotalProb(qureg); // harmlessly re-validates
    validate_quregRenormProbIsNotZero(prob, __func__);
 
    qreal norm = (qureg.isDensityMatrix)? prob : std::sqrt(prob);
    qreal fac = 1 / norm;
    localiser_statevec_setQuregToSuperposition(fac, qureg, 0, qureg, 0, qureg);
 
    return fac;
}

Referenced by initRandomPureState(), and TEST_CASE().

setQuregToSuperposition()

void setQuregToSuperposition	(	qcomp	facOut,
		Qureg	out,
		qcomp	fac1,
		Qureg	qureg1,
		qcomp	fac2,
		Qureg	qureg2 )

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!

Formulae

Let \( f_{\text{out}} = \) facOut, \( f_1 = \) fac1 and \( f_2 = \) fac2. Similarly, let \( \psi_{\text{out}} = \) out, \( \psi_{1} = \) qureg1 and \( \psi_{2} = \) qureg2.

This function modifies only facOut to become

\[ |\psi_{\text{out}}\rangle \; \rightarrow \; f_{\text{out}} |\psi_{\text{out}}\rangle \, + \, f_1 |\psi_1\rangle \, + \, f_2 |\psi_2\rangle. \]

All factors are unconstrained and are permitted to be zero, and the same Qureg can be duplicated among all arguments.

Definition at line 192 of file initialisations.cpp.

                                                                                                          {
    validate_quregFields(out, __func__);
    validate_quregFields(qureg1, __func__);
    validate_quregFields(qureg2, __func__);
    validate_quregsCanBeSuperposed(out, qureg1, qureg2, __func__); // asserts statevectors
 
    localiser_statevec_setQuregToSuperposition(facOut, out, fac1, qureg1, fac2, qureg2);
}