CompMatr

Functions for applying general many-target dense matrices, as CompMatr. More...

Functions
void	applyCompMatr (Qureg qureg, int *targets, int numTargets, CompMatr matr)
void	applyCompMatr (Qureg qureg, std::vector< int > targets, CompMatr matr)
void	applyControlledCompMatr (Qureg qureg, int control, int *targets, int numTargets, CompMatr matr)
void	applyControlledCompMatr (Qureg qureg, int control, std::vector< int > targets, CompMatr matr)
void	applyMultiControlledCompMatr (Qureg qureg, int *controls, int numControls, int *targets, int numTargets, CompMatr matr)
void	applyMultiControlledCompMatr (Qureg qureg, std::vector< int > controls, std::vector< int > targets, CompMatr matr)
void	applyMultiStateControlledCompMatr (Qureg qureg, int *controls, int *states, int numControls, int *targets, int numTargets, CompMatr matr)
void	applyMultiStateControlledCompMatr (Qureg qureg, std::vector< int > controls, std::vector< int > states, std::vector< int > targets, CompMatr matr)
void	multiplyCompMatr (Qureg qureg, int *targets, int numTargets, CompMatr matr)
void	multiplyCompMatr (Qureg qureg, std::vector< int > targets, CompMatr matr)

Detailed Description

Functions for applying general many-target dense matrices, as CompMatr.

Function Documentation

applyCompMatr() [1/2]

void applyCompMatr	(	Qureg	qureg,
		int *	targets,
		int	numTargets,
		CompMatr	matr )

Note

Documentation for this function or struct is under construction!

Definition at line 186 of file operations.cpp.

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

Referenced by applyCompMatr().

applyCompMatr() [2/2]

void applyCompMatr	(	Qureg	qureg,
		std::vector< int >	targets,
		CompMatr	matr )

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

                                                                    {
 
    applyCompMatr(qureg, targets.data(), targets.size(), matr);
}

applyControlledCompMatr() [1/2]

void applyControlledCompMatr	(	Qureg	qureg,
		int	control,
		int *	targets,
		int	numTargets,
		CompMatr	matr )

Note

Documentation for this function or struct is under construction!

Definition at line 191 of file operations.cpp.

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

Referenced by applyControlledCompMatr().

applyControlledCompMatr() [2/2]

void applyControlledCompMatr	(	Qureg	qureg,
		int	control,
		std::vector< int >	targets,
		CompMatr	matr )

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

                                                                                           {
 
    applyControlledCompMatr(qureg, control, targets.data(), targets.size(), matr);
}

applyMultiControlledCompMatr() [1/2]

void applyMultiControlledCompMatr	(	Qureg	qureg,
		int *	controls,
		int	numControls,
		int *	targets,
		int	numTargets,
		CompMatr	matr )

Note

Documentation for this function or struct is under construction!

Definition at line 196 of file operations.cpp.

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

Referenced by applyMultiControlledCompMatr().

applyMultiControlledCompMatr() [2/2]

void applyMultiControlledCompMatr	(	Qureg	qureg,
		std::vector< int >	controls,
		std::vector< int >	targets,
		CompMatr	matr )

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

                                                                                                         {
 
    applyMultiControlledCompMatr(qureg, controls.data(), controls.size(), targets.data(), targets.size(), matr);
}

applyMultiStateControlledCompMatr() [1/2]

void applyMultiStateControlledCompMatr	(	Qureg	qureg,
		int *	controls,
		int *	states,
		int	numControls,
		int *	targets,
		int	numTargets,
		CompMatr	matr )

Note

Documentation for this function or struct is under construction!

Definition at line 201 of file operations.cpp.

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

Referenced by applyMultiStateControlledCompMatr().

applyMultiStateControlledCompMatr() [2/2]

void applyMultiStateControlledCompMatr	(	Qureg	qureg,
		std::vector< int >	controls,
		std::vector< int >	states,
		std::vector< int >	targets,
		CompMatr	matr )

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

                                                                                                                                  {
    validate_controlsMatchStates(controls.size(), states.size(), __func__);
 
    applyMultiStateControlledCompMatr(qureg, controls.data(), states.data(), controls.size(), targets.data(), targets.size(), matr);
}

multiplyCompMatr() [1/2]

void multiplyCompMatr	(	Qureg	qureg,
		int *	targets,
		int	numTargets,
		CompMatr	matr )

Note

Documentation for this function or struct is under construction!

Definition at line 176 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_mixedAmpsFitInNode(qureg, numTargets, __func__);
 
    bool conj = false;
    localiser_statevec_anyCtrlAnyTargDenseMatr(qureg, {}, {}, util_getVector(targets, numTargets), matrix, conj);
}

Referenced by multiplyCompMatr().

multiplyCompMatr() [2/2]

void multiplyCompMatr	(	Qureg	qureg,
		std::vector< int >	targets,
		CompMatr	matr )

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

                                                                       {
 
    multiplyCompMatr(qureg, targets.data(), targets.size(), matr);
}