Pauli gadgets

Functions for applying many-qubit rotations around arbitrary PauliStr. More...

Functions
void	applyControlledPauliGadget (Qureg qureg, int control, PauliStr str, qreal angle)
void	applyMultiControlledPauliGadget (Qureg qureg, int *controls, int numControls, PauliStr str, qreal angle)
void	applyMultiControlledPauliGadget (Qureg qureg, std::vector< int > controls, PauliStr str, qreal angle)
void	applyMultiStateControlledPauliGadget (Qureg qureg, int *controls, int *states, int numControls, PauliStr str, qreal angle)
void	applyMultiStateControlledPauliGadget (Qureg qureg, std::vector< int > controls, std::vector< int > states, PauliStr str, qreal angle)
void	applyPauliGadget (Qureg qureg, PauliStr str, qreal angle)
void	multiplyPauliGadget (Qureg qureg, PauliStr str, qreal angle)

Detailed Description

Functions for applying many-qubit rotations around arbitrary PauliStr.

Function Documentation

applyControlledPauliGadget()

void applyControlledPauliGadget	(	Qureg	qureg,
		int	control,
		PauliStr	str,
		qreal	angle )

Note

Documentation for this function or struct is under construction!

Definition at line 1423 of file operations.cpp.

                                                                                     {
    validate_quregFields(qureg, __func__);
    validate_controlAndPauliStrTargets(qureg, control, str, __func__);
    
    applyMultiStateControlledPauliGadget(qureg, &control, nullptr, 1, str, angle);
}

applyMultiControlledPauliGadget() [1/2]

void applyMultiControlledPauliGadget	(	Qureg	qureg,
		int *	controls,
		int	numControls,
		PauliStr	str,
		qreal	angle )

Note

Documentation for this function or struct is under construction!

Definition at line 1430 of file operations.cpp.

                                                                                                             {
    validate_quregFields(qureg, __func__);
    validate_controlsAndPauliStrTargets(qureg, controls, numControls, str, __func__);
    
    applyMultiStateControlledPauliGadget(qureg, controls, nullptr, numControls, str, angle);
}

Referenced by applyMultiControlledPauliGadget().

applyMultiControlledPauliGadget() [2/2]

void applyMultiControlledPauliGadget	(	Qureg	qureg,
		std::vector< int >	controls,
		PauliStr	str,
		qreal	angle )

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

                                                                                                   {
 
    applyMultiControlledPauliGadget(qureg, controls.data(), controls.size(), str, angle);
}

applyMultiStateControlledPauliGadget() [1/2]

void applyMultiStateControlledPauliGadget	(	Qureg	qureg,
		int *	controls,
		int *	states,
		int	numControls,
		PauliStr	str,
		qreal	angle )

Note

Documentation for this function or struct is under construction!

Definition at line 1437 of file operations.cpp.

                                                                                                                               {
    validate_quregFields(qureg, __func__);
    validate_controlsAndPauliStrTargets(qureg, controls, numControls, str, __func__);
    validate_controlStates(states, numControls, __func__); // permits states==nullptr
 
    /// @todo
    /// CRUCIAL NOTE:
    /// exp(theta I..I) might be algorithmically ok (I'm not sure), but it WILL NOT
    /// effect a global phase change of theta (I think). Should validate against this
    /// sitaution just in case, or make the doc extremely explicit
 
    qreal phase = util_getPhaseFromGateAngle(angle);
    auto ctrlVec = util_getVector(controls, numControls);
    auto stateVec = util_getVector(states, numControls); // empty if states==nullptr
    localiser_statevec_anyCtrlPauliGadget(qureg, ctrlVec, stateVec, str, phase);
 
    if (!qureg.isDensityMatrix)
        return;
 
    // conj(e^iXZ) = e^(-iXZ), but conj(Y)=-Y, so odd-Y undoes phase negation
    phase *= paulis_hasOddNumY(str) ? 1 : -1;
    ctrlVec = util_getBraQubits(ctrlVec, qureg);
    str = paulis_getShiftedPauliStr(str, qureg.numQubits);
    localiser_statevec_anyCtrlPauliGadget(qureg, ctrlVec, stateVec, str, phase);
}

Referenced by applyControlledPauliGadget(), applyMultiControlledPauliGadget(), applyMultiStateControlledPauliGadget(), applyMultiStateControlledRotateX(), applyMultiStateControlledRotateY(), applyMultiStateControlledRotateZ(), and applyPauliGadget().

applyMultiStateControlledPauliGadget() [2/2]

void applyMultiStateControlledPauliGadget	(	Qureg	qureg,
		std::vector< int >	controls,
		std::vector< int >	states,
		PauliStr	str,
		qreal	angle )

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

                                                                                                                            {
    validate_controlsMatchStates(controls.size(), states.size(), __func__);
 
    applyMultiStateControlledPauliGadget(qureg, controls.data(), states.data(), controls.size(), str, angle);
}

applyPauliGadget()

void applyPauliGadget	(	Qureg	qureg,
		PauliStr	str,
		qreal	angle )

Note

Documentation for this function or struct is under construction!

Definition at line 1416 of file operations.cpp.

                                                              {
    validate_quregFields(qureg, __func__);
    validate_pauliStrTargets(qureg, str, __func__);
    
    applyMultiStateControlledPauliGadget(qureg, nullptr, nullptr, 0, str, angle);
}

multiplyPauliGadget()

void multiplyPauliGadget	(	Qureg	qureg,
		PauliStr	str,
		qreal	angle )

Note

Documentation for this function or struct is under construction!

Definition at line 1408 of file operations.cpp.

                                                                 {
    validate_quregFields(qureg, __func__);
    validate_pauliStrTargets(qureg, str, __func__);
 
    qreal phase = util_getPhaseFromGateAngle(angle);
    localiser_statevec_anyCtrlPauliGadget(qureg, {}, {}, str, phase);
}