Functions for applying the two-qubit SWAP and related gates. More...

Functions
void	applyControlledSqrtSwap (Qureg qureg, int control, int qubit1, int qubit2)

void	applyControlledSwap (Qureg qureg, int control, int qubit1, int qubit2)

void	applyMultiControlledSqrtSwap (Qureg qureg, int *controls, int numControls, int qubit1, int qubit2)

void	applyMultiControlledSqrtSwap (Qureg qureg, std::vector< int > controls, int qubit1, int qubit2)

void	applyMultiControlledSwap (Qureg qureg, int *controls, int numControls, int qubit1, int qubit2)

void	applyMultiControlledSwap (Qureg qureg, std::vector< int > controls, int qubit1, int qubit2)

void	applyMultiStateControlledSqrtSwap (Qureg qureg, int controls, int states, int numControls, int qubit1, int qubit2)

void	applyMultiStateControlledSqrtSwap (Qureg qureg, std::vector< int > controls, std::vector< int > states, int numControls, int qubit1, int qubit2)

void	applyMultiStateControlledSwap (Qureg qureg, int controls, int states, int numControls, int qubit1, int qubit2)

void	applyMultiStateControlledSwap (Qureg qureg, std::vector< int > controls, std::vector< int > states, int qubit1, int qubit2)

void	applySqrtSwap (Qureg qureg, int qubit1, int qubit2)

void	applySwap (Qureg qureg, int qubit1, int qubit2)

void	multiplySwap (Qureg qureg, int qubit1, int qubit2)

Detailed Description

Functions for applying the two-qubit SWAP and related gates.

Function Documentation

◆ applyControlledSqrtSwap()

void applyControlledSqrtSwap	(	Qureg	qureg,
		int	control,
		int	qubit1,
		int	qubit2 )

Note: Documentation for this function or struct is under construction!

Definition at line 824 of file operations.cpp.

                                                                                 {
    validate_quregFields(qureg, __func__);
    validate_controlAndTwoTargets(qureg, control, target1, target2, __func__);
 
    // harmlessly re-validates
    applyMultiStateControlledSqrtSwap(qureg, &control, nullptr, 1, target1, target2);
}

◆ applyControlledSwap()

void applyControlledSwap	(	Qureg	qureg,
		int	control,
		int	qubit1,
		int	qubit2 )

Note: Documentation for this function or struct is under construction!

Definition at line 761 of file operations.cpp.

                                                                           {
    validate_quregFields(qureg, __func__);
    validate_controlAndTwoTargets(qureg, control, qubit1, qubit2, __func__);
 
    // harmlessly re-valdiates
    applyMultiStateControlledSwap(qureg, &control, nullptr, 1, qubit1, qubit2);
}

◆ applyMultiControlledSqrtSwap() [1/2]

void applyMultiControlledSqrtSwap	(	Qureg	qureg,
		int *	controls,
		int	numControls,
		int	qubit1,
		int	qubit2 )

Note: Documentation for this function or struct is under construction!

Definition at line 832 of file operations.cpp.

                                                                                                         {
    validate_quregFields(qureg, __func__);
    validate_controlsAndTwoTargets(qureg, controls, numControls, target1, target2, __func__);
 
    // harmlessly re-validates
    applyMultiStateControlledSqrtSwap(qureg, controls, nullptr, numControls, target1, target2);
}

Referenced by applyMultiControlledSqrtSwap().

◆ applyMultiControlledSqrtSwap() [2/2]

void applyMultiControlledSqrtSwap	(	Qureg	qureg,
		std::vector< int >	controls,
		int	qubit1,
		int	qubit2 )

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

                                                                                             {
 
    applyMultiControlledSqrtSwap(qureg, controls.data(), controls.size(), qubit1, qubit2);
}

◆ applyMultiControlledSwap() [1/2]

void applyMultiControlledSwap	(	Qureg	qureg,
		int *	controls,
		int	numControls,
		int	qubit1,
		int	qubit2 )

Note: Documentation for this function or struct is under construction!

Definition at line 769 of file operations.cpp.

                                                                                                   {
    validate_quregFields(qureg, __func__);
    validate_controlsAndTwoTargets(qureg, controls, numControls, qubit1, qubit2, __func__);
 
    // harmlessly re-valdiates
    applyMultiStateControlledSwap(qureg, controls, nullptr, numControls, qubit1, qubit2);
}

Referenced by applyMultiControlledSwap().

◆ applyMultiControlledSwap() [2/2]

void applyMultiControlledSwap	(	Qureg	qureg,
		std::vector< int >	controls,
		int	qubit1,
		int	qubit2 )

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

                                                                                         {
 
    applyMultiControlledSwap(qureg, controls.data(), controls.size(), qubit1, qubit2);
}

◆ applyMultiStateControlledSqrtSwap() [1/2]

void applyMultiStateControlledSqrtSwap	(	Qureg	qureg,
		int *	controls,
		int *	states,
		int	numControls,
		int	qubit1,
		int	qubit2 )

Note: Documentation for this function or struct is under construction!

Definition at line 840 of file operations.cpp.

                                                                                                                           {
    validate_quregFields(qureg, __func__);
    validate_controlsAndTwoTargets(qureg, controls, numControls, target1, target2, __func__);
    validate_controlStates(states, numControls, __func__); // permits states==nullptr
 
    /// @todo
    /// this function exacts sqrtSwap as a dense 2-qubit matrix,
    /// where as bespoke communication and simulation strategy is
    /// clearly possible which we have not supported because the gate
    /// is somewhat esoteric. As such, we must validate mixed-amps fit
 
    validate_mixedAmpsFitInNode(qureg, 2, __func__); // to throw SqrtSwap error, not generic CompMatr2 error
 
    CompMatr2 matr = getCompMatr2({
        {1, 0, 0, 0},
        {0, .5+.5_i, .5-.5_i, 0},
        {0, .5-.5_i, .5+.5_i, 0},
        {0, 0, 0, 1}});
 
    applyMultiStateControlledCompMatr2(qureg, controls, states, numControls, target1, target2, matr);
}

Referenced by applyControlledSqrtSwap(), applyMultiControlledSqrtSwap(), and applySqrtSwap().

◆ applyMultiStateControlledSqrtSwap() [2/2]

void applyMultiStateControlledSqrtSwap	(	Qureg	qureg,
		std::vector< int >	controls,
		std::vector< int >	states,
		int	numControls,
		int	qubit1,
		int	qubit2 )

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++.

◆ applyMultiStateControlledSwap() [1/2]

void applyMultiStateControlledSwap	(	Qureg	qureg,
		int *	controls,
		int *	states,
		int	numControls,
		int	qubit1,
		int	qubit2 )

Note: Documentation for this function or struct is under construction!

Definition at line 777 of file operations.cpp.

                                                                                                                     {
    validate_quregFields(qureg, __func__);
    validate_controlsAndTwoTargets(qureg, controls, numControls, qubit1, qubit2, __func__);
    validate_controlStates(states, numControls, __func__); // permits states==nullptr
 
    auto ctrlVec = util_getVector(controls, numControls);
    auto stateVec = util_getVector(states, numControls); // empty if states==nullptr
    localiser_statevec_anyCtrlSwap(qureg, ctrlVec, stateVec, qubit1, qubit2);
 
    if (!qureg.isDensityMatrix)
        return;
 
    ctrlVec = util_getBraQubits(ctrlVec, qureg);
    qubit1 = util_getBraQubit(qubit1, qureg);
    qubit2 = util_getBraQubit(qubit2, qureg);
    localiser_statevec_anyCtrlSwap(qureg, ctrlVec, stateVec, qubit1, qubit2);
}

Referenced by applyControlledSwap(), applyMultiControlledSwap(), applyMultiStateControlledSwap(), and applySwap().

◆ applyMultiStateControlledSwap() [2/2]

void applyMultiStateControlledSwap	(	Qureg	qureg,
		std::vector< int >	controls,
		std::vector< int >	states,
		int	qubit1,
		int	qubit2 )

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

                                                                                                                  {
    validate_controlsMatchStates(controls.size(), states.size(), __func__);
 
    applyMultiStateControlledSwap(qureg, controls.data(), states.data(), controls.size(), qubit1, qubit2);
}

◆ applySqrtSwap()

void applySqrtSwap	(	Qureg	qureg,
		int	qubit1,
		int	qubit2 )

Note: Documentation for this function or struct is under construction!

Definition at line 816 of file operations.cpp.

                                                          {
    validate_quregFields(qureg, __func__);
    validate_twoTargets(qureg,target1, target2, __func__);
 
    // harmlessly re-validates
    applyMultiStateControlledSqrtSwap(qureg, nullptr, nullptr, 0, target1, target2);
}

◆ applySwap()

void applySwap	(	Qureg	qureg,
		int	qubit1,
		int	qubit2 )

Applies a SWAP gate between qubit1 and qubit2 of qureg.

Diagram: <p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p>

Note: Documentation for this function or struct is under construction!

Definition at line 753 of file operations.cpp.

                                                    {
    validate_quregFields(qureg, __func__);
    validate_twoTargets(qureg, qubit1, qubit2, __func__);
 
    // harmlessly re-valdiates
    applyMultiStateControlledSwap(qureg, nullptr, nullptr, 0, qubit1, qubit2);
}

Referenced by applyQuantumFourierTransform().

◆ multiplySwap()

void multiplySwap	(	Qureg	qureg,
		int	qubit1,
		int	qubit2 )

Note: Documentation for this function or struct is under construction!

Definition at line 746 of file operations.cpp.

                                                       {
    validate_quregFields(qureg, __func__);
    validate_twoTargets(qureg, qubit1, qubit2, __func__);
 
    localiser_statevec_anyCtrlSwap(qureg, {}, {}, qubit1, qubit2);
}