DiagMatr

Functions for applying general many-qubit diagonal matrices, as DiagMatr. More...

Functions
void	applyControlledDiagMatr (Qureg, int control, int *targets, int numTargets, DiagMatr matrix)
void	applyControlledDiagMatrPower (Qureg qureg, int control, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)
void	applyDiagMatr (Qureg qureg, int *targets, int numTargets, DiagMatr matrix)
void	applyDiagMatrPower (Qureg qureg, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)
void	applyMultiControlledDiagMatr (Qureg, int *controls, int numControls, int *targets, int numTargets, DiagMatr matrix)
void	applyMultiControlledDiagMatrPower (Qureg qureg, int *controls, int numControls, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)
void	applyMultiStateControlledDiagMatr (Qureg, int *controls, int *states, int numControls, int *targets, int numTargets, DiagMatr matrix)
void	applyMultiStateControlledDiagMatrPower (Qureg qureg, int *controls, int *states, int numControls, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)
void	multiplyDiagMatr (Qureg qureg, int *targets, int numTargets, DiagMatr matrix)
void	multiplyDiagMatrPower (Qureg qureg, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)

Detailed Description

Functions for applying general many-qubit diagonal matrices, as DiagMatr.

Function Documentation

applyControlledDiagMatr()

void applyControlledDiagMatr	(	Qureg	qureg,
		int	control,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix )

Note

Documentation for this function or struct is under construction!

Definition at line 277 of file operations.cpp.

                                                                                                      {
 
    validateAndApplyAnyCtrlAnyTargUnitaryMatrix(qureg, &control, nullptr, 1, targets, numTargets, matrix, __func__);
}

applyControlledDiagMatrPower()

void applyControlledDiagMatrPower	(	Qureg	qureg,
		int	control,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix,
		qcomp	exponent )

Note

Documentation for this function or struct is under construction!

Definition at line 325 of file operations.cpp.

                                                                                                                           {
    validate_quregFields(qureg, __func__);
    validate_controlAndTargets(qureg, control, targets, numTargets, __func__);
    validate_matrixDimMatchesTargets(matrix, numTargets, __func__); // also checks fields and is-synced
    validate_matrixIsUnitary(matrix, __func__);  // checks abs=1 (so no risk of 0^(-neg exp)) and rechecks fields/synced
    validate_matrixExpIsNonDiverging(matrix, exponent, __func__); // harmlessly re-validates fields and is-sync
    validate_unitaryExponentIsReal(exponent, __func__); // checks matrix^exponent is approx unitary (abs=1)
 
    // notice exponent is a 'qcomp' not a 'qreal' despite validation; see applyMultiStateControlledDiagMatrPower()
 
    // harmlessly re-validates
    applyMultiStateControlledDiagMatrPower(qureg, &control, nullptr, 1, targets, numTargets, matrix, exponent);
}

applyDiagMatr()

void applyDiagMatr	(	Qureg	qureg,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix )

Note

Documentation for this function or struct is under construction!

Definition at line 272 of file operations.cpp.

                                                                               {
 
    validateAndApplyAnyCtrlAnyTargUnitaryMatrix(qureg, nullptr, nullptr, 0, targets, numTargets, matrix, __func__);
}

applyDiagMatrPower()

void applyDiagMatrPower	(	Qureg	qureg,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix,
		qcomp	exponent )

Note

Documentation for this function or struct is under construction!

Definition at line 311 of file operations.cpp.

                                                                                                     {
    validate_quregFields(qureg, __func__);
    validate_targets(qureg, targets, numTargets, __func__);
    validate_matrixDimMatchesTargets(matrix, numTargets, __func__); // also checks fields and is-synced
    validate_matrixIsUnitary(matrix, __func__);  // checks abs=1 (so no risk of 0^(-neg exp)) and rechecks fields/synced
    validate_matrixExpIsNonDiverging(matrix, exponent, __func__); // harmlessly re-validates fields and is-sync
    validate_unitaryExponentIsReal(exponent, __func__); // checks matrix^exponent is approx unitary (abs=1)
 
    // notice exponent is a 'qcomp' not a 'qreal' despite validation; see applyMultiStateControlledDiagMatrPower()
 
    // harmlessly re-validates
    applyMultiStateControlledDiagMatrPower(qureg, nullptr, nullptr, 0, targets, numTargets, matrix, exponent);
}

applyMultiControlledDiagMatr()

void applyMultiControlledDiagMatr	(	Qureg	qureg,
		int *	controls,
		int	numControls,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix )

Note

Documentation for this function or struct is under construction!

Definition at line 282 of file operations.cpp.

                                                                                                                              {
 
    validateAndApplyAnyCtrlAnyTargUnitaryMatrix(qureg, controls, nullptr, numControls, targets, numTargets, matrix, __func__);
}

applyMultiControlledDiagMatrPower()

void applyMultiControlledDiagMatrPower	(	Qureg	qureg,
		int *	controls,
		int	numControls,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix,
		qcomp	exponent )

Note

Documentation for this function or struct is under construction!

Definition at line 339 of file operations.cpp.

                                                                                                                                                   {
    validate_quregFields(qureg, __func__);
    validate_controlsAndTargets(qureg, controls, numControls, targets, numTargets, __func__);
    validate_matrixDimMatchesTargets(matrix, numTargets, __func__); // also checks fields and is-synced
    validate_matrixIsUnitary(matrix, __func__);  // checks abs=1 (so no risk of 0^(-neg exp)) and rechecks fields/synced
    validate_matrixExpIsNonDiverging(matrix, exponent, __func__); // harmlessly re-validates fields and is-sync
    validate_unitaryExponentIsReal(exponent, __func__); // checks matrix^exponent is approx unitary (abs=1)
 
    // notice exponent is a 'qcomp' not a 'qreal' despite validation; see applyMultiStateControlledDiagMatrPower()
 
    // harmlessly re-validates
    applyMultiStateControlledDiagMatrPower(qureg, controls, nullptr, numControls, targets, numTargets, matrix, exponent);
}

applyMultiStateControlledDiagMatr()

void applyMultiStateControlledDiagMatr	(	Qureg	qureg,
		int *	controls,
		int *	states,
		int	numControls,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix )

Note

Documentation for this function or struct is under construction!

Definition at line 287 of file operations.cpp.

                                                                                                                                                {
 
    validateAndApplyAnyCtrlAnyTargUnitaryMatrix(qureg, controls, states, numControls, targets, numTargets, matrix, __func__);
}

applyMultiStateControlledDiagMatrPower()

void applyMultiStateControlledDiagMatrPower	(	Qureg	qureg,
		int *	controls,
		int *	states,
		int	numControls,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix,
		qcomp	exponent )

Note

Documentation for this function or struct is under construction!

Definition at line 353 of file operations.cpp.

                                                                                                                                                                     {
    validate_quregFields(qureg, __func__);
    validate_controlsAndTargets(qureg, controls, numControls, targets, numTargets, __func__);
    validate_controlStates(states, numControls, __func__); // can be nullptr, ignoring numControls
    validate_matrixDimMatchesTargets(matrix, numTargets, __func__); // also checks fields and is-synced
    validate_matrixIsUnitary(matrix, __func__);  // checks abs=1 (so no risk of 0^(-neg exp)) and rechecks fields/synced
    validate_matrixExpIsNonDiverging(matrix, exponent, __func__); // harmlessly re-validates fields and is-sync
    validate_unitaryExponentIsReal(exponent, __func__); // checks matrix^exponent is approx unitary (abs=1)
 
    // unlike calcExpecDiagMatrPower which accepts a 'qreal' exponent,
    // this function accepts a 'qcomp'. This is because it always
    // evaluates the relatively numerically unstable pow(qcomp,qcomp)
    // overload, rather than pow(qreal,qreal), since there is no reason
    // to think matrix is real (unitarity permits it to be complex).
    // As such, despite unitarity requiring exponent is also real, we
    // accept a qcomp types so that complex exponents can be passed
    // when numerical validation is disabled without a separate func.
 
    bool conj = false;
    auto ctrlVec = util_getVector(controls, numControls);
    auto stateVec = util_getVector(states,  numControls); // empty if states==nullptr
    auto targVec = util_getVector(targets,  numTargets);
    localiser_statevec_anyCtrlAnyTargDiagMatr(qureg, ctrlVec, stateVec, targVec, matrix, exponent, conj);
 
    if (!qureg.isDensityMatrix)
        return;
 
    conj = true;
    ctrlVec = util_getBraQubits(ctrlVec, qureg);
    targVec = util_getBraQubits(targVec, qureg);
    localiser_statevec_anyCtrlAnyTargDiagMatr(qureg, ctrlVec, stateVec, targVec, matrix, exponent, conj);
}

Referenced by applyControlledDiagMatrPower(), applyDiagMatrPower(), and applyMultiControlledDiagMatrPower().

multiplyDiagMatr()

void multiplyDiagMatr	(	Qureg	qureg,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix )

Note

Documentation for this function or struct is under construction!

Definition at line 262 of file operations.cpp.

                                                                                  {
    validate_quregFields(qureg, __func__);
    validate_targets(qureg, targets, numTargets, __func__);
    validate_matrixDimMatchesTargets(matrix, numTargets, __func__); // also validates fields and is-sync, but not unitarity
 
    bool conj = false;
    qcomp exponent = 1;
    localiser_statevec_anyCtrlAnyTargDiagMatr(qureg, {}, {}, util_getVector(targets, numTargets), matrix, exponent, conj);
}

multiplyDiagMatrPower()

void multiplyDiagMatrPower	(	Qureg	qureg,
		int *	targets,
		int	numTargets,
		DiagMatr	matrix,
		qcomp	exponent )

Note

Documentation for this function or struct is under construction!

Definition at line 301 of file operations.cpp.

                                                                                                       {
    validate_quregFields(qureg, __func__);
    validate_targets(qureg, targets, numTargets, __func__);
    validate_matrixDimMatchesTargets(matrix, numTargets, __func__); // also validates fields and is-sync, but not unitarity
    validate_matrixExpIsNonDiverging(matrix, exponent, __func__); // harmlessly re-validates fields and is-sync
 
    bool conj = false;
    localiser_statevec_anyCtrlAnyTargDiagMatr(qureg, {}, {}, util_getVector(targets, numTargets), matrix, exponent, conj);
}