PauliStr

Functions for applying a tensor product of Pauli operators, as a PauliStr. More...

Functions
void	applyControlledPauliStr (Qureg qureg, int control, PauliStr str)
void	applyMultiControlledPauliStr (Qureg qureg, int *controls, int numControls, PauliStr str)
void	applyMultiControlledPauliStr (Qureg qureg, std::vector< int > controls, PauliStr str)
void	applyMultiStateControlledPauliStr (Qureg qureg, int *controls, int *states, int numControls, PauliStr str)
void	applyMultiStateControlledPauliStr (Qureg qureg, std::vector< int > controls, std::vector< int > states, PauliStr str)
void	applyPauliStr (Qureg qureg, PauliStr str)
void	multiplyPauliStr (Qureg qureg, PauliStr str)

Detailed Description

Functions for applying a tensor product of Pauli operators, as a PauliStr.

Function Documentation

applyControlledPauliStr()

void applyControlledPauliStr	(	Qureg	qureg,
		int	control,
		PauliStr	str )

Note

Documentation for this function or struct is under construction!

Definition at line 1044 of file operations.cpp.

                                                                     {
    validate_quregFields(qureg, __func__);
    validate_controlAndPauliStrTargets(qureg, control, str, __func__);
 
    // harmlessly re-validates
    applyMultiStateControlledPauliStr(qureg, &control, nullptr, 1, str);
}

applyMultiControlledPauliStr() [1/2]

void applyMultiControlledPauliStr	(	Qureg	qureg,
		int *	controls,
		int	numControls,
		PauliStr	str )

Note

Documentation for this function or struct is under construction!

Definition at line 1052 of file operations.cpp.

                                                                                             {
    validate_quregFields(qureg, __func__);
    validate_controlsAndPauliStrTargets(qureg, controls, numControls, str, __func__);
 
    // harmlessly re-validates
    applyMultiStateControlledPauliStr(qureg, controls, nullptr, numControls, str);
}

Referenced by applyMultiControlledPauliStr().

applyMultiControlledPauliStr() [2/2]

void applyMultiControlledPauliStr	(	Qureg	qureg,
		std::vector< int >	controls,
		PauliStr	str )

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

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

applyMultiStateControlledPauliStr() [1/2]

void applyMultiStateControlledPauliStr	(	Qureg	qureg,
		int *	controls,
		int *	states,
		int	numControls,
		PauliStr	str )

Note

Documentation for this function or struct is under construction!

Definition at line 1060 of file operations.cpp.

                                                                                                               {
    validate_quregFields(qureg, __func__);
    validate_controlsAndPauliStrTargets(qureg, controls, numControls, str, __func__);
    validate_controlStates(states, numControls, __func__); // permits states==nullptr
 
    qcomp factor = 1;
    auto ctrlVec = util_getVector(controls, numControls);
    auto stateVec = util_getVector(states, numControls); // empty if states==nullptr
 
    // when there are no control qubits, we can merge the density matrix's 
    // operation sinto a single tensor, i.e. +- (shift(str) (x) str), to 
    // avoid superfluous re-enumeration of the state
    if (qureg.isDensityMatrix && numControls == 0) {
        factor = paulis_hasOddNumY(str)? -1 : 1;
        ctrlVec = util_getConcatenated(ctrlVec, util_getBraQubits(ctrlVec, qureg));
        stateVec = util_getConcatenated(stateVec, stateVec); 
        str = paulis_getKetAndBraPauliStr(str, qureg);
    }
 
    localiser_statevec_anyCtrlPauliTensor(qureg, ctrlVec, stateVec, str, factor);
 
    // but density-matrix control qubits require two distinct operations
    if (qureg.isDensityMatrix && numControls > 0) {
        factor = paulis_hasOddNumY(str)? -1 : 1;
        ctrlVec = util_getBraQubits(ctrlVec, qureg);
        str = paulis_getShiftedPauliStr(str, qureg.numQubits);
        localiser_statevec_anyCtrlPauliTensor(qureg, ctrlVec, stateVec, str, factor);
    }
}

Referenced by applyControlledPauliStr(), applyMultiControlledPauliStr(), applyMultiStateControlledMultiQubitNot(), applyMultiStateControlledPauliStr(), applyMultiStateControlledPauliX(), applyMultiStateControlledPauliY(), and applyPauliStr().

applyMultiStateControlledPauliStr() [2/2]

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

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

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

applyPauliStr()

void applyPauliStr	(	Qureg	qureg,
		PauliStr	str )

Note

Documentation for this function or struct is under construction!

Definition at line 1036 of file operations.cpp.

                                              {
    validate_quregFields(qureg, __func__);
    validate_pauliStrTargets(qureg, str, __func__);
 
    // harmlessly re-validates
    applyMultiStateControlledPauliStr(qureg, nullptr, nullptr, 0, str);
}

multiplyPauliStr()

void multiplyPauliStr	(	Qureg	qureg,
		PauliStr	str )

Note

Documentation for this function or struct is under construction!

Definition at line 1029 of file operations.cpp.

                                                 {
    validate_quregFields(qureg, __func__);
    validate_pauliStrTargets(qureg, str, __func__);
 
    localiser_statevec_anyCtrlPauliTensor(qureg, {}, {}, str);
}

Referenced by multiplyMultiQubitNot().