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)

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!

Applies a singly-controlled arbitrarily-sized diagonal unitary matrix upon the targets of qureg.

‍- See applyDiagMatr() for information about the base operation, targets and matrix.

• See applyControlledCompMatr1() for information about the control qubit.

Author

Tyson Jones

Definition at line 303 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!

Applies a singly-controlled arbitrarily-sized diagonal unitary matrix, raised to the power exponent, upon the targets of qureg.

‍- See applyDiagMatr() for information about targets and matrix.

• See applyDiagMatrPower() for information about exponent.
• See applyControlledCompMatr1() for information about the control qubit.

Author

Tyson Jones

Definition at line 366 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!

Applies an arbitrarily-sized diagonal unitary matrix upon the targets of qureg.

Remarks

To efficiently apply a diagonal matrix upon all targets of qureg, use applyFullStateDiagMatr().

This function is sometimes more efficient when targets are specified in increasing order.

See also

• applyDiagMatrPower()
• applyControlledDiagMatr()
• applyFullStateDiagMatr()

Author

Tyson Jones

Definition at line 298 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!

Applies an arbitrarily-sized diagonal unitary matrix, raised to the power exponent, upon the targets of qureg.

Remarks

To efficiently apply an exponentiated diagonal matrix upon all targets of qureg, use applyFullStateDiagMatrPower().

This function is sometimes more efficient when targets are specified in increasing order.

Formulae

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

See also

• applyControlledDiagMatrPower()
• applyFullStateDiagMatrPower()

Definition at line 352 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!

Applies a multiply-controlled arbitrarily-sized diagonal unitary matrix upon the targets of qureg.

‍- See applyDiagMatr() for information about targets and matrix.

• See applyMultiControlledCompMatr1() for information about controls.

Author

Tyson Jones

Definition at line 308 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!

Applies a multiply-controlled arbitrarily-sized diagonal unitary matrix, raised to the power exponent, upon the targets of qureg.

‍- See applyDiagMatr() for information about targets and matrix.

• See applyDiagMatrPower() for information about exponent.
• See applyMultiControlledCompMatr1() for information about controls.

Author

Tyson Jones

Definition at line 380 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!

Applies an arbitrarily-controlled arbitrarily-sized diagonal unitary matrix upon the targets of qureg, conditioned upon the controls being in the corresponding states.

‍- See applyDiagMatr() for information about targets and matrix.

• See applyMultiStateControlledCompMatr1() for information about controls and states.

Author

Tyson Jones

Definition at line 313 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!

Applies an arbitrarily-controlled arbitrarily-sized diagonal unitary matrix, raised to the power exponent, upon the targets of qureg, conditioned upon the controls being in the corresponding states.

‍- See applyDiagMatr() for information about targets and matrix.

• See applyDiagMatrPower() for information about exponent.
• See applyMultiStateControlledCompMatr1() for information about controls and states.

Author

Tyson Jones

Definition at line 394 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 ctrlList = lists_getList64(controls, numControls);
    auto stateList = util_getList64OrAllOnes(states, numControls);
    auto targList = lists_getList64(targets,  numTargets);
    localiser_statevec_anyCtrlAnyTargDiagMatr(qureg, ctrlList, stateList, targList, matrix, exponent, conj);
 
    if (!qureg.isDensityMatrix)
        return;
 
    conj = true;
    ctrlList = util_getBraQubits(ctrlList, qureg);
    targList = util_getBraQubits(targList, qureg);
    localiser_statevec_anyCtrlAnyTargDiagMatr(qureg, ctrlList, stateList, targList, matrix, exponent, conj);
}

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