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	applyControlledDiagMatr (Qureg qureg, int control, std::vector< int > targets, DiagMatr matrix)
void	applyControlledDiagMatrPower (Qureg qureg, int control, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)
void	applyControlledDiagMatrPower (Qureg qureg, int control, std::vector< int > targets, DiagMatr matrix, qcomp exponent)
void	applyDiagMatr (Qureg qureg, int *targets, int numTargets, DiagMatr matrix)
void	applyDiagMatr (Qureg qureg, std::vector< int > targets, DiagMatr matrix)
void	applyDiagMatrPower (Qureg qureg, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)
void	applyDiagMatrPower (Qureg qureg, std::vector< int > targets, DiagMatr matrix, qcomp exponent)
void	applyMultiControlledDiagMatr (Qureg qureg, int *controls, int numControls, int *targets, int numTargets, DiagMatr matrix)
void	applyMultiControlledDiagMatr (Qureg qureg, std::vector< int > controls, std::vector< int > targets, DiagMatr matrix)
void	applyMultiControlledDiagMatrPower (Qureg qureg, int *controls, int numControls, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)
void	applyMultiControlledDiagMatrPower (Qureg qureg, std::vector< int > controls, std::vector< int > targets, DiagMatr matrix, qcomp exponent)
void	applyMultiStateControlledDiagMatr (Qureg qureg, int *controls, int *states, int numControls, int *targets, int numTargets, DiagMatr matrix)
void	applyMultiStateControlledDiagMatr (Qureg qureg, std::vector< int > controls, std::vector< int > states, std::vector< int > targets, DiagMatr matrix)
void	applyMultiStateControlledDiagMatrPower (Qureg qureg, int *controls, int *states, int numControls, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)
void	applyMultiStateControlledDiagMatrPower (Qureg qureg, std::vector< int > controls, std::vector< int > states, std::vector< int > targets, DiagMatr matrix, qcomp exponent)
void	multiplyDiagMatr (Qureg qureg, int *targets, int numTargets, DiagMatr matrix)
void	multiplyDiagMatr (Qureg qureg, std::vector< int > targets, DiagMatr matrix)
void	multiplyDiagMatrPower (Qureg qureg, int *targets, int numTargets, DiagMatr matrix, qcomp exponent)
void	multiplyDiagMatrPower (Qureg qureg, std::vector< int > targets, DiagMatr matrix, qcomp exponent)

Detailed Description

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

Function Documentation

applyControlledDiagMatr() [1/2]

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 361 of file operations.cpp.

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

Referenced by applyControlledDiagMatr().

applyControlledDiagMatr() [2/2]

void applyControlledDiagMatr	(	Qureg	qureg,
		int	control,
		std::vector< int >	targets,
		DiagMatr	matrix )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 388 of file operations.cpp.

                                                                                             {
 
    applyControlledDiagMatr(qureg, control, targets.data(), targets.size(), matrix);
}

applyControlledDiagMatrPower() [1/2]

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 439 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().

applyControlledDiagMatrPower() [2/2]

void applyControlledDiagMatrPower	(	Qureg	qureg,
		int	control,
		std::vector< int >	targets,
		DiagMatr	matrix,
		qcomp	exponent )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 512 of file operations.cpp.

                                                                                                                  {
 
    applyControlledDiagMatrPower(qureg, control, targets.data(), targets.size(), matrix, exponent);
}

applyDiagMatr() [1/2]

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

Note

Documentation for this function or struct is under construction!

Definition at line 356 of file operations.cpp.

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

Referenced by applyDiagMatr().

applyDiagMatr() [2/2]

void applyDiagMatr	(	Qureg	qureg,
		std::vector< int >	targets,
		DiagMatr	matrix )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 383 of file operations.cpp.

                                                                      {
 
    applyDiagMatr(qureg, targets.data(), targets.size(), matrix);
}

applyDiagMatrPower() [1/2]

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 425 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().

applyDiagMatrPower() [2/2]

void applyDiagMatrPower	(	Qureg	qureg,
		std::vector< int >	targets,
		DiagMatr	matrix,
		qcomp	exponent )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 507 of file operations.cpp.

                                                                                           {
 
    applyDiagMatrPower(qureg, targets.data(), targets.size(), matrix, exponent);
}

applyMultiControlledDiagMatr() [1/2]

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 366 of file operations.cpp.

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

Referenced by applyMultiControlledDiagMatr().

applyMultiControlledDiagMatr() [2/2]

void applyMultiControlledDiagMatr	(	Qureg	qureg,
		std::vector< int >	controls,
		std::vector< int >	targets,
		DiagMatr	matrix )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 393 of file operations.cpp.

                                                                                                           {
 
    applyMultiControlledDiagMatr(qureg, controls.data(), controls.size(), targets.data(), targets.size(), matrix);
}

applyMultiControlledDiagMatrPower() [1/2]

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 453 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().

applyMultiControlledDiagMatrPower() [2/2]

void applyMultiControlledDiagMatrPower	(	Qureg	qureg,
		std::vector< int >	controls,
		std::vector< int >	targets,
		DiagMatr	matrix,
		qcomp	exponent )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 517 of file operations.cpp.

                                                                                                                                {
 
    applyMultiControlledDiagMatrPower(qureg, controls.data(), controls.size(), targets.data(), targets.size(), matrix, exponent);
}

applyMultiStateControlledDiagMatr() [1/2]

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 371 of file operations.cpp.

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

Referenced by applyMultiStateControlledDiagMatr().

applyMultiStateControlledDiagMatr() [2/2]

void applyMultiStateControlledDiagMatr	(	Qureg	qureg,
		std::vector< int >	controls,
		std::vector< int >	states,
		std::vector< int >	targets,
		DiagMatr	matrix )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 398 of file operations.cpp.

                                                                                                                                    {
    validate_controlsMatchStates(controls.size(), states.size(), __func__);
    
    applyMultiStateControlledDiagMatr(qureg, controls.data(), states.data(), controls.size(), targets.data(), targets.size(), matrix);
}

applyMultiStateControlledDiagMatrPower() [1/2]

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 467 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().

applyMultiStateControlledDiagMatrPower() [2/2]

void applyMultiStateControlledDiagMatrPower	(	Qureg	qureg,
		std::vector< int >	controls,
		std::vector< int >	states,
		std::vector< int >	targets,
		DiagMatr	matrix,
		qcomp	exponent )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 522 of file operations.cpp.

                                                                                                                                                         {
    validate_controlsMatchStates(controls.size(), states.size(), __func__);
 
    applyMultiStateControlledDiagMatrPower(qureg, controls.data(), states.data(), controls.size(), targets.data(), targets.size(), matrix, exponent);
}

multiplyDiagMatr() [1/2]

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

Note

Documentation for this function or struct is under construction!

Definition at line 346 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().

multiplyDiagMatr() [2/2]

void multiplyDiagMatr	(	Qureg	qureg,
		std::vector< int >	targets,
		DiagMatr	matrix )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 378 of file operations.cpp.

                                                                         {
 
    multiplyDiagMatr(qureg, targets.data(), targets.size(), matrix);
}

multiplyDiagMatrPower() [1/2]

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 415 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().

multiplyDiagMatrPower() [2/2]

void multiplyDiagMatrPower	(	Qureg	qureg,
		std::vector< int >	targets,
		DiagMatr	matrix,
		qcomp	exponent )

Warning

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

Attention

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

Note

Documentation for this function or struct is under construction!

Remarks

This function is only available in C++.

Definition at line 502 of file operations.cpp.

                                                                                              {
 
    multiplyDiagMatrPower(qureg, targets.data(), targets.size(), matrix, exponent);
}