DiagMatr

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

Functions
void	applyControlledDiagMatr (Qureg 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 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 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!

See also

applyControlledCompMatr1()

Definition at line 362 of file operations.cpp.

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

Referenced by applyControlledDiagMatr().

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!

See also

• applyDiagMatrPower()
• applyControlledCompMatr1()

Definition at line 440 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__);
    validate_matrixExpIsNonDiverging(matrix, exponent, __func__);
    validate_unitaryExponentIsReal(exponent, __func__);
 
    // notice exponent is a 'qcomp' not a 'qreal' despite validation; see applyMultiStateControlledDiagMatrPower()
 
    // harmlessly re-validates
    applyMultiStateControlledDiagMatrPower(qureg, &control, nullptr, 1, targets, numTargets, matrix, exponent);
}

Referenced by applyControlledDiagMatrPower().

applyDiagMatr()

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

Note

Documentation for this function or struct is under construction!

See also

applyCompMatr1()

Definition at line 357 of file operations.cpp.

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

Referenced by applyDiagMatr().

applyDiagMatrPower()

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

Note

Documentation for this function or struct is under construction!

Formulae

This function is equivalent to applyDiagMatr() except that matrix is raised to the given exponent.

Definition at line 426 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__);
    validate_matrixExpIsNonDiverging(matrix, exponent, __func__);
    validate_unitaryExponentIsReal(exponent, __func__);
 
    // notice exponent is a 'qcomp' not a 'qreal' despite validation; see applyMultiStateControlledDiagMatrPower()
 
    // harmlessly re-validates
    applyMultiStateControlledDiagMatrPower(qureg, nullptr, nullptr, 0, targets, numTargets, matrix, exponent);
}

Referenced by applyDiagMatrPower().

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!

See also

applyMultiControlledCompMatr1()

Definition at line 367 of file operations.cpp.

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

Referenced by applyMultiControlledDiagMatr().

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!

See also

• applyDiagMatrPower()
• applyMultiControlledCompMatr1()

Definition at line 454 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__);
    validate_matrixExpIsNonDiverging(matrix, exponent, __func__);
    validate_unitaryExponentIsReal(exponent, __func__);
 
    // notice exponent is a 'qcomp' not a 'qreal' despite validation; see applyMultiStateControlledDiagMatrPower()
 
    // harmlessly re-validates
    applyMultiStateControlledDiagMatrPower(qureg, controls, nullptr, numControls, targets, numTargets, matrix, exponent);
}

Referenced by applyMultiControlledDiagMatrPower().

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!

See also

applyMultiStateControlledCompMatr1()

Definition at line 372 of file operations.cpp.

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

Referenced by applyMultiStateControlledDiagMatr().

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!

See also

• applyDiagMatrPower()
• applyMultiStateControlledCompMatr1()

Definition at line 468 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__);
    validate_matrixIsUnitary(matrix, __func__); 
    validate_matrixExpIsNonDiverging(matrix, exponent, __func__);
    validate_unitaryExponentIsReal(exponent, __func__);
 
    // 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(), applyMultiControlledDiagMatrPower(), and applyMultiStateControlledDiagMatrPower().

multiplyDiagMatr()

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

Note

Documentation for this function or struct is under construction!

See also

multiplyCompMatr1()

Definition at line 347 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);
}

Referenced by multiplyDiagMatr().

multiplyDiagMatrPower()

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

Note

Documentation for this function or struct is under construction!

See also

• multiplyCompMatr1()
• applyDiagMatrPower()

Definition at line 416 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);
}

Referenced by multiplyDiagMatrPower().