Base class for the representation of general gate operations. More...

#include <Gate.h>

Inheritance diagram for Gate:

Public Member Functions
virtual void	apply_from_right (Matrix &input)
	Call to apply the gate on the input array/matrix by input*Gate. More...

virtual void	apply_to (Matrix &input, bool parallel=false)
	Call to apply the gate on the input array/matrix. More...

void	apply_to_list (std::vector< Matrix > &input)
	Call to apply the gate on the input array/matrix by U3*input. More...

Matrix	calc_one_qubit_u3 (double Theta, double Phi, double Lambda)
	Calculate the matrix of a U3 gate gate corresponding to the given parameters acting on a single qbit space. More...

virtual Matrix	calc_one_qubit_u3 ()
	Calculate the matrix of the constans gates. More...

virtual Gate *	clone ()
	Call to create a clone of the present class. More...

	Gate ()
	Default constructor of the class. More...

	Gate (int qbit_num_in)
	Constructor of the class. More...

int	get_control_qbit ()
	Call to get the index of the control qubit. More...

Matrix	get_matrix ()
	Call to retrieve the operation matrix. More...

int	get_parameter_num ()
	Call to get the number of free parameters. More...

int	get_qbit_num ()
	Call to get the number of qubits composing the unitary. More...

int	get_target_qbit ()
	Call to get the index of the target qubit. More...

gate_type	get_type ()
	Call to get the type of the operation. More...

virtual void	parameters_for_calc_one_qubit (double &ThetaOver2, double &Phi, double &Lambda)
	Calculate the matrix of a U3 gate gate corresponding to the given parameters acting on a single qbit space. More...

void	print (const std::stringstream &sstream, int verbose_level=1) const
	Call to print output messages in the function of the verbosity level. More...

virtual void	reorder_qubits (std::vector< int > qbit_list)
	Call to reorder the qubits in the matrix of the operation. More...

void	set_control_qbit (int control_qbit_in)
	Call to set the control qubit for the gate operation. More...

void	set_debugfile (std::string debugfile)
	Call to set the debugfile name. More...

void	set_matrix (Matrix input)
	Call to set the stored matrix in the operation. More...

virtual void	set_qbit_num (int qbit_num_in)
	Set the number of qubits spanning the matrix of the operation. More...

void	set_target_qbit (int target_qbit_in)
	Call to set the target qubit for the gate operation. More...

void	set_verbose (int verbose_in)
	Call to set the verbose attribute. More...

virtual	~Gate ()
	Destructor of the class. More...

Public Attributes
bool	debug
	Logical variable. Set true to write output messages to the 'debug.txt' file. More...

std::string	debugfile_name
	String variable. Set the debug file name. More...

int	verbose
	Set the verbosity level of the output messages. More...

Protected Member Functions
void	apply_kernel_from_right (Matrix &u3_1qbit, Matrix &input)
	Call to apply the gate kernel on the input state or unitary from right (no AVX support) More...

void	apply_kernel_to (Matrix &u3_1qbit, Matrix &input, bool deriv=false, bool parallel=false)
	Call to apply the gate kernel on the input state or unitary with optional AVX support. More...

Protected Attributes
int	control_qbit
	The index of the qubit which acts as a control qubit (control_qbit >= 0) in controlled operations. More...

int	matrix_size
	The size N of the NxN matrix associated with the operations. More...

int	parameter_num
	the number of free parameters of the operation More...

int	qbit_num
	number of qubits spanning the matrix of the operation More...

int	target_qbit
	The index of the qubit on which the operation acts (target_qbit >= 0) More...

gate_type	type
	The type of the operation (see enumeration gate_type) More...

Private Attributes
Matrix	matrix_alloc
	Matrix of the operation. More...

Detailed Description

Base class for the representation of general gate operations.

Definition at line 41 of file Gate.h.

Constructor & Destructor Documentation

◆ Gate() [1/2]

Gate::Gate ( )

Default constructor of the class.

Deafult constructor of the class.

Returns: An instance of the class

Definition at line 39 of file Gate.cpp.

Here is the caller graph for this function:

◆ ~Gate()

Gate::~Gate ( )

virtual

Destructor of the class.

Definition at line 87 of file Gate.cpp.

◆ Gate() [2/2]

Gate::Gate ( int qbit_num_in )

Constructor of the class.

Parameters

qbit_num_in The number of qubits spanning the unitaries

Returns: An instance of the class

Definition at line 62 of file Gate.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ apply_from_right()

void Gate::apply_from_right ( Matrix & input )

virtual

Call to apply the gate on the input array/matrix by input*Gate.

Parameters

input The input array on which the gate is applied

Reimplemented in SX, X, Y, Z, SYC, CH, CNOT, and CZ.

Definition at line 156 of file Gate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ apply_kernel_from_right()

void Gate::apply_kernel_from_right	(	Matrix &	u3_1qbit,
		Matrix &	input
	)

protected

Call to apply the gate kernel on the input state or unitary from right (no AVX support)

Parameters

u3_1qbit	The 2x2 kernel of the gate operation
input	The input matrix on which the transformation is applied
deriv	Set true to apply derivate transformation, false otherwise

Definition at line 359 of file Gate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ apply_kernel_to()

void Gate::apply_kernel_to	(	Matrix &	u3_1qbit,
		Matrix &	input,
		bool	deriv = `false`,
		bool	parallel = `false`
	)

protected

Call to apply the gate kernel on the input state or unitary with optional AVX support.

Parameters

u3_1qbit	The 2x2 kernel of the gate operation
input	The input matrix on which the transformation is applied
deriv	Set true to apply derivate transformation, false otherwise (optional)
parallel	Set true to apply parallel kernels, false otherwise (optional)
u3_1qbit	The 2x2 kernel of the gate operation
input	The input matrix on which the transformation is applied
deriv	Set true to apply derivate transformation, false otherwise (optional)
deriv	Set true to apply parallel kernels, false otherwise (optional)

Definition at line 292 of file Gate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ apply_to()

void Gate::apply_to	(	Matrix &	input,
		bool	parallel = `false`
	)

virtual

Call to apply the gate on the input array/matrix.

Parameters

input	The input array on which the gate is applied
parallel	Set true to apply parallel kernels, false otherwise (optional)

Reimplemented in SX, X, Y, Z, CH, CZ, SYC, and CNOT.

Definition at line 143 of file Gate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ apply_to_list()

void Gate::apply_to_list ( std::vector< Matrix > & input )

Call to apply the gate on the input array/matrix by U3*input.

Parameters

parameters	An array of parameters to calculate the matrix of the U3 gate.
input	The input array on which the gate is applied

Definition at line 127 of file Gate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calc_one_qubit_u3() [1/2]

Matrix Gate::calc_one_qubit_u3	(	double	ThetaOver2,
		double	Phi,
		double	Lambda
	)

Calculate the matrix of a U3 gate gate corresponding to the given parameters acting on a single qbit space.

Parameters

Theta	Real parameter standing for the parameter theta.
Phi	Real parameter standing for the parameter phi.
Lambda	Real parameter standing for the parameter lambda.

Returns: Returns with the matrix of the one-qubit matrix.

Parameters

ThetaOver2	Real parameter standing for the parameter theta.
Phi	Real parameter standing for the parameter phi.
Lambda	Real parameter standing for the parameter lambda.

Returns: Returns with the matrix of the one-qubit matrix.

Definition at line 439 of file Gate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calc_one_qubit_u3() [2/2]

Matrix Gate::calc_one_qubit_u3 ( )

virtual

Calculate the matrix of the constans gates.

Returns: Returns with the matrix of the one-qubit matrix.

Reimplemented in SX, X, Y, Z, CH, CNOT, and CZ.

Definition at line 494 of file Gate.cpp.

Here is the caller graph for this function:

◆ clone()

Gate * Gate::clone ( )

virtual

Call to create a clone of the present class.

Returns: Return with a pointer pointing to the cloned object

Reimplemented in Gates_block, Sub_Matrix_Decomposition, U3, Composite, ON, UN, Adaptive, RY, CH, CNOT, CZ, RX, RZ, RZ_P, SYC, CRY, SX, X, Y, Z, and custom_kernel_1qubit_gate.

Definition at line 273 of file Gate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_control_qbit()

int Gate::get_control_qbit ( )

Call to get the index of the control qubit.

Returns: Return with the index of the control qubit (return with -1 if control qubit was not set)

Definition at line 238 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_matrix()

Matrix Gate::get_matrix ( )

Call to retrieve the operation matrix.

Returns: Returns with a matrix of the operation

Definition at line 116 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_parameter_num()

int Gate::get_parameter_num ( )

Call to get the number of free parameters.

Returns: Return with the number of the free parameters

Definition at line 246 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_qbit_num()

int Gate::get_qbit_num ( )

Call to get the number of qubits composing the unitary.

Returns: Return with the number of qubits composing the unitary

Definition at line 264 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_target_qbit()

int Gate::get_target_qbit ( )

Call to get the index of the target qubit.

Returns: Return with the index of the target qubit (return with -1 if target qubit was not set)

Definition at line 230 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_type()

gate_type Gate::get_type ( )

Call to get the type of the operation.

Returns: Return with the type of the operation (see gate_type for details)

Definition at line 255 of file Gate.cpp.

Here is the caller graph for this function:

◆ parameters_for_calc_one_qubit()

void Gate::parameters_for_calc_one_qubit	(	double &	ThetaOver2,
		double &	Phi,
		double &	Lambda
	)

virtual

Calculate the matrix of a U3 gate gate corresponding to the given parameters acting on a single qbit space.

Set static values for the angles and constans parameters for calculating the matrix of the gates.

Parameters

Theta	Real parameter standing for the parameter theta.
Phi	Real parameter standing for the parameter phi.
Lambda	Real parameter standing for the parameter lambda.

Returns: Returns with the matrix of the one-qubit matrix.

Parameters

ThetaOver2	Real parameter standing for the parameter theta.
Phi	Real parameter standing for the parameter phi.
Lambda	Real parameter standing for the parameter lambda.

Reimplemented in RY, RX, RZ, and RZ_P.

Definition at line 508 of file Gate.cpp.

◆ print()

void logging::print	(	const std::stringstream &	sstream,
		int	verbose_level = `1`
	)		const

inherited

Call to print output messages in the function of the verbosity level.

Parameters

sstream	The stringstream input to store the output messages.
verbose_level	Integer input. High level means write more to the standart output, 0 means write nothing. The default value is set to 1.

Definition at line 55 of file logging.cpp.

◆ reorder_qubits()

void Gate::reorder_qubits ( std::vector< int > qbit_list )

virtual

Call to reorder the qubits in the matrix of the operation.

Parameters

qbit_list The reordered list of qubits spanning the matrix

Reimplemented in Gates_block, Decomposition_Base, U3, Composite, SX, X, Y, Z, ON, UN, SYC, CH, CNOT, and CZ.

Definition at line 196 of file Gate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_control_qbit()

void Gate::set_control_qbit ( int control_qbit_in )

Call to set the control qubit for the gate operation.

Parameters

control_qbit_in The control qubit. Should be: 0 <= control_qbit_in < qbit_num

Definition at line 179 of file Gate.cpp.

Here is the caller graph for this function:

◆ set_debugfile()

void logging::set_debugfile ( std::string debugfile )

inherited

Call to set the debugfile name.

Parameters

debugfile String variable. Set the debugfile name.

Definition at line 95 of file logging.cpp.

Here is the caller graph for this function:

◆ set_matrix()

void Gate::set_matrix ( Matrix input )

Call to set the stored matrix in the operation.

Parameters

input The operation matrix to be stored. The matrix is stored by attribute matrix_alloc.

Returns: Returns with 0 on success.

Definition at line 170 of file Gate.cpp.

Here is the caller graph for this function:

◆ set_qbit_num()

void Gate::set_qbit_num ( int qbit_num_in )

virtual

Set the number of qubits spanning the matrix of the operation.

Parameters

qbit_num_in The number of qubits spanning the matrix

Reimplemented in Gates_block, Decomposition_Base, U3, Composite, SX, X, Y, ON, UN, Z, SYC, CNOT, CH, and CZ.

Definition at line 94 of file Gate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_target_qbit()

void Gate::set_target_qbit ( int target_qbit_in )

Call to set the target qubit for the gate operation.

Parameters

target_qbit_in The target qubit on which the gate is applied. Should be: 0 <= target_qbit_in < qbit_num

Definition at line 188 of file Gate.cpp.

Here is the caller graph for this function:

◆ set_verbose()

void logging::set_verbose ( int verbose_in )

inherited

Call to set the verbose attribute.

Parameters

verbose_in Integer variable. Set the number to specify the verbosity level for output messages.

Definition at line 85 of file logging.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ control_qbit

int Gate::control_qbit

protected

The index of the qubit which acts as a control qubit (control_qbit >= 0) in controlled operations.

Definition at line 53 of file Gate.h.

◆ debug

bool logging::debug

inherited

Logical variable. Set true to write output messages to the 'debug.txt' file.

Definition at line 53 of file logging.h.

◆ debugfile_name

std::string logging::debugfile_name

inherited

String variable. Set the debug file name.

Definition at line 56 of file logging.h.

◆ matrix_alloc

Matrix Gate::matrix_alloc

private

Matrix of the operation.

Definition at line 62 of file Gate.h.

◆ matrix_size

int Gate::matrix_size

protected

The size N of the NxN matrix associated with the operations.

Definition at line 55 of file Gate.h.

◆ parameter_num

int Gate::parameter_num

protected

the number of free parameters of the operation

Definition at line 57 of file Gate.h.

◆ qbit_num

int Gate::qbit_num

protected

number of qubits spanning the matrix of the operation

Definition at line 47 of file Gate.h.

◆ target_qbit

int Gate::target_qbit

protected

The index of the qubit on which the operation acts (target_qbit >= 0)

Definition at line 51 of file Gate.h.

◆ type

gate_type Gate::type

protected

The type of the operation (see enumeration gate_type)

Definition at line 49 of file Gate.h.

◆ verbose

int logging::verbose

inherited

Set the verbosity level of the output messages.

Definition at line 50 of file logging.h.

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Gate() [1/2]

◆ ~Gate()

◆ Gate() [2/2]

Member Function Documentation

◆ apply_from_right()

◆ apply_kernel_from_right()

◆ apply_kernel_to()

◆ apply_to()

◆ apply_to_list()

◆ calc_one_qubit_u3() [1/2]

◆ calc_one_qubit_u3() [2/2]

◆ clone()

◆ get_control_qbit()

◆ get_matrix()

◆ get_parameter_num()

◆ get_qbit_num()

◆ get_target_qbit()

◆ get_type()

◆ parameters_for_calc_one_qubit()

◆ print()

◆ reorder_qubits()

◆ set_control_qbit()

◆ set_debugfile()

◆ set_matrix()

◆ set_qbit_num()

◆ set_target_qbit()

◆ set_verbose()

Member Data Documentation

◆ control_qbit

◆ debug

◆ debugfile_name

◆ matrix_alloc

◆ matrix_size

◆ parameter_num

◆ qbit_num

◆ target_qbit

◆ type

◆ verbose