Sequential Quantum Gate Decomposer  v1.9.3
Powerful decomposition of general unitarias into one- and two-qubit gates gates
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
Composite Class Reference

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

#include <Composite.h>

Inheritance diagram for Composite:
Inheritance graph
[legend]

Public Member Functions

void add_adaptive (int target_qbit, int control_qbit)
 Append a Adaptive gate to the list of gates. More...
 
void add_adaptive_to_front (int target_qbit, int control_qbit)
 Add a Adaptive gate to the front of the list of gates. More...
 
void add_ch (int target_qbit, int control_qbit)
 Append a CH gate (i.e. More...
 
void add_ch_to_front (int target_qbit, int control_qbit)
 Add a CH gate (i.e. More...
 
void add_child (Gate *child)
 Call to add a child gate to the current gate. More...
 
void add_cnot (int target_qbit, int control_qbit)
 Append a CNOT gate gate to the list of gates. More...
 
void add_cnot_to_front (int target_qbit, int control_qbit)
 Add a C_NOT gate gate to the front of the list of gates. More...
 
void add_composite ()
 Append a Composite gate to the list of gates. More...
 
void add_composite_to_front ()
 Add a Composite gate to the front of the list of gates. More...
 
void add_crot (int target_qbit, int control_qbit, crot_type subtype_in)
 Append a CNOT gate gate to the list of gates. More...
 
void add_crot_to_front (int target_qbit, int control_qbit, crot_type subtype_in)
 Add a C_NOT gate gate to the front of the list of gates. More...
 
void add_cry (int target_qbit, int control_qbit)
 Append a CRY gate to the list of gates. More...
 
void add_cry_to_front (int target_qbit, int control_qbit)
 Add a CRY gate to the front of the list of gates. More...
 
void add_cz (int target_qbit, int control_qbit)
 Append a CZ gate gate to the list of gates. More...
 
void add_cz_nu (int target_qbit, int control_qbit)
 Append a CZ_NU gate to the list of gates. More...
 
void add_cz_nu_to_front (int target_qbit, int control_qbit)
 Add a CZ_NU gate to the front of the list of gates. More...
 
void add_cz_to_front (int target_qbit, int control_qbit)
 Add a CZ gate gate to the front of the list of gates. More...
 
void add_gate (Gate *gate)
 Append a general gate to the list of gates. More...
 
void add_gate_nums (std::map< std::string, int > &gate_nums)
 Call to add the number of the individual gate types in the circuit to the map given in the argument. More...
 
void add_gate_to_front (Gate *gate)
 Add an gate to the front of the list of gates. More...
 
void add_gates (std::vector< Gate *> gates_in)
 Append a list of gates to the list of gates. More...
 
void add_gates_to_front (std::vector< Gate *> gates_in)
 Add an array of gates to the front of the list of gates. More...
 
void add_h (int target_qbit)
 Append a Hadamard gate to the list of gates. More...
 
void add_h_to_front (int target_qbit)
 Add a Hadamard gate to the front of the list of gates. More...
 
void add_on ()
 Append a ON gate to the list of gates. More...
 
void add_on_to_front ()
 Add a OUN gate to the front of the list of gates. More...
 
void add_parent (Gate *parent)
 Call to add a parent gate to the current gate. More...
 
void add_r (int target_qbit)
 Append a R gate to the list of gates. More...
 
void add_r_to_front (int target_qbit)
 Add a R gate to the front of the list of gates. More...
 
void add_rx (int target_qbit)
 Append a RX gate to the list of gates. More...
 
void add_rx_to_front (int target_qbit)
 Add a RX gate to the front of the list of gates. More...
 
void add_ry (int target_qbit)
 Append a RY gate to the list of gates. More...
 
void add_ry_to_front (int target_qbit)
 Add a RY gate to the front of the list of gates. More...
 
void add_rz (int target_qbit)
 Append a RZ gate to the list of gates. More...
 
void add_rz_to_front (int target_qbit)
 Add a RZ gate to the front of the list of gates. More...
 
void add_sx (int target_qbit)
 Append a SX gate to the list of gates. More...
 
void add_sx_to_front (int target_qbit)
 Add a SX gate to the front of the list of gates. More...
 
void add_syc (int target_qbit, int control_qbit)
 Append a Sycamore gate (i.e. More...
 
void add_syc_to_front (int target_qbit, int control_qbit)
 Add a Sycamore gate (i.e. More...
 
void add_t (int target_qbit)
 Append a T gate to the list of gates. More...
 
void add_t_to_front (int target_qbit)
 Add a T gate to the front of the list of gates. More...
 
void add_tdg (int target_qbit)
 Append a Tdg gate to the list of gates. More...
 
void add_tdg_to_front (int target_qbit)
 Add a Tdg gate to the front of the list of gates. More...
 
void add_u1 (int target_qbit)
 Append a U1 gate to the list of gates. More...
 
void add_u1_to_front (int target_qbit)
 Add a U1 gate to the front of the list of gates. More...
 
void add_u2 (int target_qbit)
 Append a U2 gate to the list of gates. More...
 
void add_u2_to_front (int target_qbit)
 Add a U2 gate to the front of the list of gates. More...
 
void add_u3 (int target_qbit)
 Append a U3 gate to the list of gates. More...
 
void add_u3_to_front (int target_qbit)
 Add a U3 gate to the front of the list of gates. More...
 
void add_un ()
 Append a UN gate to the list of gates. More...
 
void add_un_to_front ()
 Add a UN gate to the front of the list of gates. More...
 
void add_x (int target_qbit)
 Append a X gate to the list of gates. More...
 
void add_x_to_front (int target_qbit)
 Add a X gate to the front of the list of gates. More...
 
void add_y (int target_qbit)
 Append a Y gate to the list of gates. More...
 
void add_y_to_front (int target_qbit)
 Add a Y gate to the front of the list of gates. More...
 
void add_z (int target_qbit)
 Append a Z gate to the list of gates. More...
 
void add_z_to_front (int target_qbit)
 Add a Z gate to the front of the list of gates. More...
 
virtual std::vector< Matrixapply_derivate_to (Matrix_real &parameters_mtx, Matrix &input, int parallel)
 Call to evaluate the derivate of the circuit on an inout with respect to all of the free parameters. More...
 
void apply_from_right (Matrix_real &parameters, Matrix &input)
 Call to apply the gate on the input array/matrix by input*Gate. More...
 
virtual void apply_from_right (Matrix &input)
 Call to apply the gate on the input array/matrix by input*Gate. More...
 
void apply_to (Matrix_real &parameters, Matrix &input, int parallel)
 Call to apply the gate on the input array/matrix. More...
 
virtual void apply_to (Matrix &input, int parallel)
 Call to apply the gate on the input array/matrix. More...
 
void apply_to_list (Matrix_real &parameters, std::vector< Matrix > &inputs, int parallel)
 Call to apply the gate on the input array/matrix by U3*input. More...
 
virtual void apply_to_list (std::vector< Matrix > &inputs, int parallel)
 Call to apply the gate on a list of inputs. More...
 
virtual 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...
 
void clear_children ()
 Call to erase data on children. More...
 
void clear_parents ()
 Call to erase data on parents. More...
 
Compositeclone ()
 Call to create a clone of the present class. More...
 
void combine (Gates_block *op_block)
 Call to append the gates of an gate block to the current block. More...
 
 Composite ()
 Default constructor of the class. More...
 
 Composite (int qbit_num_in)
 Constructor of the class. More...
 
bool contains_adaptive_gate ()
 Call to determine, whether the circuit contains daptive gate or not. More...
 
bool contains_adaptive_gate (int idx)
 Call to determine, whether the sub-circuit at a given position in the circuit contains daptive gate or not. More...
 
Gates_blockcreate_remapped_circuit (const std::map< int, int > &qbit_map)
 Call to create a new circuit with remapped qubits. More...
 
Gates_blockcreate_remapped_circuit (const std::map< int, int > &qbit_map, const int qbit_num_)
 Call to create a new circuit with remapped qubits. More...
 
void determine_children (Gate *gate)
 Call to obtain the child gates in the circuit. More...
 
void determine_parents (Gate *gate)
 Call to obtain the parent gates in the circuit. More...
 
int extract_gates (Gates_block *op_block)
 Call to extract the gates stored in the class. More...
 
virtual Matrix_real extract_parameters (Matrix_real &parameters)
 Call to extract parameters from the parameter array corresponding to the circuit, in which the gate is embedded. More...
 
void fragment_circuit ()
 
std::vector< Gate * > get_children ()
 Call to get the children of the current gate. More...
 
int get_control_qbit ()
 Call to get the index of the control qubit. More...
 
Gates_blockget_flat_circuit ()
 Method to generate a flat circuit. More...
 
Gateget_gate (int idx)
 Call to get the gates stored in the class. More...
 
int get_gate_num ()
 Call to get the number of gates grouped in the class. More...
 
std::map< std::string, intget_gate_nums ()
 Call to get the number of the individual gate types in the list of gates. More...
 
std::vector< Gate * > get_gates ()
 Call to get the gates stored in the class. More...
 
std::vector< intget_involved_qubits ()
 Call to get the qubits involved in the gates stored in the block of gates. More...
 
Matrix get_matrix (Matrix_real &parameters)
 Call to retrieve the operation matrix. More...
 
Matrix get_matrix (Matrix_real &parameters, int parallel)
 Call to retrieve the operation matrix. More...
 
virtual Matrix get_matrix ()
 Call to retrieve the operation matrix. More...
 
virtual Matrix get_matrix (int parallel)
 Call to retrieve the operation matrix. More...
 
std::string get_name ()
 Call to get the name label of the gate. More...
 
void get_parameter_max (Matrix_real &range_max)
 
int get_parameter_num ()
 Call to get the number of free parameters. More...
 
int get_parameter_start_idx ()
 Call to get the starting index of the parameters in the parameter array corresponding to the circuit in which the current gate is incorporated. More...
 
std::vector< Gate * > get_parents ()
 Call to get the parents of the current gate. More...
 
int get_qbit_num ()
 Call to get the number of qubits composing the unitary. More...
 
Matrix get_reduced_density_matrix (Matrix_real &parameters_mtx, Matrix &input_state, matrix_base< int > &qbit_list_subset)
 Call to evaluate the reduced densiy matrix. More...
 
double get_second_Renyi_entropy (Matrix_real &parameters_mtx, Matrix &input_state, matrix_base< int > &qbit_list)
 Call to evaluate the seconf Rényi entropy. 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...
 
void insert_gate (Gate *gate, int idx)
 Call to insert a gate at a given position. More...
 
void list_gates (const Matrix_real &parameters, int start_index)
 Call to print the list of gates stored in the block of gates for a specific set of parameters. 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...
 
void release_gate (int idx)
 Call to release one gate in the list. More...
 
void release_gates ()
 Call to release the stored gates. More...
 
virtual void reorder_qubits (std::vector< int > qbit_list)
 Call to reorder the qubits in the matrix of the operation. More...
 
void reset_dependency_graph ()
 Method to reset the dependency graph of the gates in the circuit. More...
 
void reset_parameter_start_indices ()
 Method to reset the parameter start indices of gate operations incorporated in the circuit. More...
 
void set_children (std::vector< Gate *> &children_)
 Call to set the children of the current gate. 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...
 
void set_parameter_start_idx (int start_idx)
 Call to set the starting index of the parameters in the parameter array corresponding to the circuit in which the current gate is incorporated. More...
 
void set_parents (std::vector< Gate *> &parents_)
 Call to set the parents of the current gate. 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 ~Composite ()
 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, int parallel=0)
 Call to apply the gate kernel on the input state or unitary with optional AVX support. More...
 

Protected Attributes

std::vector< intblock_end
 
std::vector< intblock_type
 
std::vector< Gate * > children
 list of child gates to be applied after this current gate More...
 
int control_qbit
 The index of the qubit which acts as a control qubit (control_qbit >= 0) in controlled operations. More...
 
int fragmentation_type
 
bool fragmented
 boolean variable indicating whether the circuit was already partitioned or not More...
 
std::vector< Gate * > gates
 The list of stored gates. More...
 
std::vector< std::vector< int > > involved_qbits
 
int layer_num
 number of gate layers More...
 
int matrix_size
 The size N of the NxN matrix associated with the operations. More...
 
int max_fusion
 maximal number of qubits in partitions More...
 
std::string name
 A string labeling the gate operation. More...
 
int parameter_num
 the number of free parameters of the operation More...
 
int parameter_start_idx
 the index in the parameter array (corrensponding to the encapsulated circuit) where the gate parameters begin (if gates are placed into a circuit a single parameter array is used to execute the whole circuit) More...
 
Matrix_real parameters
 Parameters theta, phi, lambda of the U3 gate after the decomposition of the unitary is done. More...
 
std::vector< Gate * > parents
 list of parent gates to be applied in the circuit prior to this current gate 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...
 

Detailed Description

Base class for the representation of general gate operations.

Definition at line 47 of file Composite.h.

Constructor & Destructor Documentation

◆ Composite() [1/2]

Composite::Composite ( )

Default constructor of the class.

Deafult constructor of the class.

Returns
An instance of the class

Definition at line 35 of file Composite.cpp.

Here is the caller graph for this function:

◆ ~Composite()

Composite::~Composite ( )
virtual

Destructor of the class.

Definition at line 84 of file Composite.cpp.

◆ Composite() [2/2]

Composite::Composite ( int  qbit_num_in)

Constructor of the class.

Parameters
qbit_num_inThe number of qubits spanning the unitaries
Returns
An instance of the class

Definition at line 61 of file Composite.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ add_adaptive()

void Gates_block::add_adaptive ( int  target_qbit,
int  control_qbit 
)
inherited

Append a Adaptive gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1553 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_adaptive_to_front()

void Gates_block::add_adaptive_to_front ( int  target_qbit,
int  control_qbit 
)
inherited

Add a Adaptive gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1568 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_ch()

void Gates_block::add_ch ( int  target_qbit,
int  control_qbit 
)
inherited

Append a CH gate (i.e.

controlled Hadamard gate) gate to the list of gates

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

controlled Hadamard gate) operation to the list of gates

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1414 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_ch_to_front()

void Gates_block::add_ch_to_front ( int  target_qbit,
int  control_qbit 
)
inherited

Add a CH gate (i.e.

controlled Hadamard gate) gate to the front of the list of gates

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

controlled Hadamard gate) operation to the front of the list of gates

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1431 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_child()

void Gate::add_child ( Gate child)
inherited

Call to add a child gate to the current gate.

Parameters
childThe parent gate of the current gate.

Definition at line 426 of file Gate.cpp.

Here is the caller graph for this function:

◆ add_cnot()

void Gates_block::add_cnot ( int  target_qbit,
int  control_qbit 
)
inherited

Append a CNOT gate gate to the list of gates.

Append a C_NOT gate operation to the list of gates.

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1100 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_cnot_to_front()

void Gates_block::add_cnot_to_front ( int  target_qbit,
int  control_qbit 
)
inherited

Add a C_NOT gate gate to the front of the list of gates.

Add a C_NOT gate operation to the front of the list of gates.

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1117 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_composite()

void Gates_block::add_composite ( )
inherited

Append a Composite gate to the list of gates.

Definition at line 1524 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_composite_to_front()

void Gates_block::add_composite_to_front ( )
inherited

Add a Composite gate to the front of the list of gates.

Definition at line 1536 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_crot()

void Gates_block::add_crot ( int  target_qbit,
int  control_qbit,
crot_type  subtype_in 
)
inherited

Append a CNOT gate gate to the list of gates.

Append a RY gate to the list of gates.

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1006 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_crot_to_front()

void Gates_block::add_crot_to_front ( int  target_qbit,
int  control_qbit,
crot_type  subtype_in 
)
inherited

Add a C_NOT gate gate to the front of the list of gates.

Add a RY gate to the front of the list of gates.

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1022 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_cry()

void Gates_block::add_cry ( int  target_qbit,
int  control_qbit 
)
inherited

Append a CRY gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 974 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_cry_to_front()

void Gates_block::add_cry_to_front ( int  target_qbit,
int  control_qbit 
)
inherited

Add a CRY gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 990 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_cz()

void Gates_block::add_cz ( int  target_qbit,
int  control_qbit 
)
inherited

Append a CZ gate gate to the list of gates.

Append a CZ gate operation to the list of gates.

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1135 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_cz_nu()

void Gates_block::add_cz_nu ( int  target_qbit,
int  control_qbit 
)
inherited

Append a CZ_NU gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1037 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_cz_nu_to_front()

void Gates_block::add_cz_nu_to_front ( int  target_qbit,
int  control_qbit 
)
inherited

Add a CZ_NU gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1053 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_cz_to_front()

void Gates_block::add_cz_to_front ( int  target_qbit,
int  control_qbit 
)
inherited

Add a CZ gate gate to the front of the list of gates.

Add a CZ gate operation to the front of the list of gates.

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1152 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_gate()

void Gates_block::add_gate ( Gate gate)
inherited

Append a general gate to the list of gates.

Parameters
gateA pointer to a class Gate describing an gate.
gateA pointer to a class Gate describing a gate operation.

Definition at line 1584 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_gate_nums()

void Gates_block::add_gate_nums ( std::map< std::string, int > &  gate_nums)
inherited

Call to add the number of the individual gate types in the circuit to the map given in the argument.

Parameters
Amap<gate_name, gate_count> describing the number of the individual gate types

Definition at line 1675 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_gate_to_front()

void Gates_block::add_gate_to_front ( Gate gate)
inherited

Add an gate to the front of the list of gates.

Add a gate to the front of the list of gates.

Parameters
gateA pointer to a class Gate describing an gate.
gateA pointer to a class Gate describing a gate.

Definition at line 1614 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_gates()

void Gates_block::add_gates ( std::vector< Gate *>  gates_in)
inherited

Append a list of gates to the list of gates.

Parameters
gates_inA list of gate class instances.
gates_inA list of operation class instances.

Definition at line 1445 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_gates_to_front()

void Gates_block::add_gates_to_front ( std::vector< Gate *>  gates_in)
inherited

Add an array of gates to the front of the list of gates.

Parameters
gates_inA list of gate class instances.
gates_inA list of operation class instances.

Definition at line 1458 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_h()

void Gates_block::add_h ( int  target_qbit)
inherited

Append a Hadamard gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1166 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_h_to_front()

void Gates_block::add_h_to_front ( int  target_qbit)
inherited

Add a Hadamard gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1179 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_on()

void Gates_block::add_on ( )
inherited

Append a ON gate to the list of gates.

Definition at line 1498 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_on_to_front()

void Gates_block::add_on_to_front ( )
inherited

Add a OUN gate to the front of the list of gates.

Add a ON gate to the front of the list of gates.

Definition at line 1510 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_parent()

void Gate::add_parent ( Gate parent)
inherited

Call to add a parent gate to the current gate.

Parameters
parentThe parent gate of the current gate.

Definition at line 409 of file Gate.cpp.

Here is the caller graph for this function:

◆ add_r()

void Gates_block::add_r ( int  target_qbit)
inherited

Append a R gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 914 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_r_to_front()

void Gates_block::add_r_to_front ( int  target_qbit)
inherited

Add a R gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 927 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_rx()

void Gates_block::add_rx ( int  target_qbit)
inherited

Append a RX gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 887 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_rx_to_front()

void Gates_block::add_rx_to_front ( int  target_qbit)
inherited

Add a RX gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 900 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_ry()

void Gates_block::add_ry ( int  target_qbit)
inherited

Append a RY gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 942 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_ry_to_front()

void Gates_block::add_ry_to_front ( int  target_qbit)
inherited

Add a RY gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 956 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_rz()

void Gates_block::add_rz ( int  target_qbit)
inherited

Append a RZ gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1069 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_rz_to_front()

void Gates_block::add_rz_to_front ( int  target_qbit)
inherited

Add a RZ gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1082 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_sx()

void Gates_block::add_sx ( int  target_qbit)
inherited

Append a SX gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1347 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_sx_to_front()

void Gates_block::add_sx_to_front ( int  target_qbit)
inherited

Add a SX gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1360 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_syc()

void Gates_block::add_syc ( int  target_qbit,
int  control_qbit 
)
inherited

Append a Sycamore gate (i.e.

Append a Sycamore gate operation to the list of gates.

controlled Hadamard gate) gate to the list of gates

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1379 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_syc_to_front()

void Gates_block::add_syc_to_front ( int  target_qbit,
int  control_qbit 
)
inherited

Add a Sycamore gate (i.e.

Add a Sycamore gate operation to the front of the list of gates.

controlled Hadamard gate) gate to the front of the list of gates

Parameters
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)
control_qbitThe identification number of the control qubit. (0 <= target_qbit <= qbit_num-1)
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1396 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_t()

void Gates_block::add_t ( int  target_qbit)
inherited

Append a T gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1285 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_t_to_front()

void Gates_block::add_t_to_front ( int  target_qbit)
inherited

Add a T gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1298 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_tdg()

void Gates_block::add_tdg ( int  target_qbit)
inherited

Append a Tdg gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1315 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_tdg_to_front()

void Gates_block::add_tdg_to_front ( int  target_qbit)
inherited

Add a Tdg gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1328 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_u1()

void Gates_block::add_u1 ( int  target_qbit)
inherited

Append a U1 gate to the list of gates.

Parameters
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 808 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_u1_to_front()

void Gates_block::add_u1_to_front ( int  target_qbit)
inherited

Add a U1 gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 821 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_u2()

void Gates_block::add_u2 ( int  target_qbit)
inherited

Append a U2 gate to the list of gates.

Parameters
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 834 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_u2_to_front()

void Gates_block::add_u2_to_front ( int  target_qbit)
inherited

Add a U2 gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the target qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 847 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_u3()

void Gates_block::add_u3 ( int  target_qbit)
inherited

Append a U3 gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
ThetaThe Theta parameter of the U3 gate
PhiThe Phi parameter of the U3 gate
LambdaThe Lambda parameter of the U3 gate
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 860 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ add_u3_to_front()

void Gates_block::add_u3_to_front ( int  target_qbit)
inherited

Add a U3 gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)
ThetaThe Theta parameter of the U3 gate
PhiThe Phi parameter of the U3 gate
LambdaThe Lambda parameter of the U3 gate
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 873 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_un()

void Gates_block::add_un ( )
inherited

Append a UN gate to the list of gates.

Definition at line 1472 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_un_to_front()

void Gates_block::add_un_to_front ( )
inherited

Add a UN gate to the front of the list of gates.

Definition at line 1484 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_x()

void Gates_block::add_x ( int  target_qbit)
inherited

Append a X gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1197 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_x_to_front()

void Gates_block::add_x_to_front ( int  target_qbit)
inherited

Add a X gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1210 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_y()

void Gates_block::add_y ( int  target_qbit)
inherited

Append a Y gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1226 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_y_to_front()

void Gates_block::add_y_to_front ( int  target_qbit)
inherited

Add a Y gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1239 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_z()

void Gates_block::add_z ( int  target_qbit)
inherited

Append a Z gate to the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1255 of file Gates_block.cpp.

Here is the call graph for this function:

◆ add_z_to_front()

void Gates_block::add_z_to_front ( int  target_qbit)
inherited

Add a Z gate to the front of the list of gates.

Parameters
target_qbitThe identification number of the targt qubit. (0 <= target_qbit <= qbit_num-1)

Definition at line 1268 of file Gates_block.cpp.

Here is the call graph for this function:

◆ apply_derivate_to()

std::vector< Matrix > Gates_block::apply_derivate_to ( Matrix_real parameters_mtx_in,
Matrix input,
int  parallel 
)
virtualinherited

Call to evaluate the derivate of the circuit on an inout with respect to all of the free parameters.

Parameters
parametersAn array of the input parameters.
inputThe input array on which the gate is applied
parallelSet 0 for sequential execution, 1 for parallel execution with OpenMP (NOT IMPLEMENTED YET) and 2 for parallel with TBB (optional)

Reimplemented from Gate.

Definition at line 705 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ apply_from_right() [1/2]

void Composite::apply_from_right ( Matrix_real parameters,
Matrix input 
)
virtual

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

Parameters
inputThe input array on which the gate is applied

Reimplemented from Gates_block.

Definition at line 183 of file Composite.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ apply_from_right() [2/2]

void Gate::apply_from_right ( Matrix input)
virtualinherited

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

Parameters
inputThe input array on which the gate is applied

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

Definition at line 285 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 
)
protectedinherited

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

Parameters
u3_1qbitThe 2x2 kernel of the gate operation
inputThe input matrix on which the transformation is applied
derivSet true to apply derivate transformation, false otherwise

Definition at line 613 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,
int  parallel = 0 
)
protectedinherited

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

Parameters
u3_1qbitThe 2x2 kernel of the gate operation
inputThe input matrix on which the transformation is applied
derivSet true to apply derivate transformation, false otherwise (optional)
parallelSet true to apply parallel kernels, false otherwise (optional)
parallelSet 0 for sequential execution (default), 1 for parallel execution with OpenMP and 2 for parallel with TBB (optional)
u3_1qbitThe 2x2 kernel of the gate operation
inputThe input matrix on which the transformation is applied
derivSet true to apply derivate transformation, false otherwise (optional)
derivSet true to apply parallel kernels, false otherwise (optional)
parallelSet 0 for sequential execution (default), 1 for parallel execution with OpenMP and 2 for parallel with TBB (optional)

Definition at line 537 of file Gate.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ apply_to() [1/2]

void Composite::apply_to ( Matrix_real parameters,
Matrix input,
int  parallel 
)
virtual

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

Parameters
inputThe input array on which the gate is applied
parallelSet 0 for sequential execution, 1 for parallel execution with OpenMP and 2 for parallel with TBB (optional)

Reimplemented from Gates_block.

Definition at line 153 of file Composite.cpp.

Here is the call graph for this function:

◆ apply_to() [2/2]

void Gate::apply_to ( Matrix input,
int  parallel 
)
virtualinherited

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

Parameters
inputThe input array on which the gate is applied
parallelSet 0 for sequential execution, 1 for parallel execution with OpenMP and 2 for parallel with TBB (optional)

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

Definition at line 237 of file Gate.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ apply_to_list() [1/2]

void Gates_block::apply_to_list ( Matrix_real parameters_mtx,
std::vector< Matrix > &  inputs,
int  parallel 
)
virtualinherited

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

Parameters
parametersAn array of parameters to calculate the matrix of the U3 gate.
inputsThe input array on which the gate is applied
parallelSet 0 for sequential execution, 1 for parallel execution with OpenMP and 2 for parallel with TBB (optional)
parametersAn array of parameters to calculate the matrix of the U3 gate.
inputThe input array on which the gate is applied

Reimplemented from Gate.

Definition at line 202 of file Gates_block.cpp.

Here is the call graph for this function:

◆ apply_to_list() [2/2]

void Gate::apply_to_list ( std::vector< Matrix > &  inputs,
int  parallel 
)
virtualinherited

Call to apply the gate on a list of inputs.

Parameters
inputsThe input array on which the gate is applied
parallelSet 0 for sequential execution, 1 for parallel execution with OpenMP and 2 for parallel with TBB (optional)

Definition at line 187 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 
)
virtualinherited

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

Parameters
ThetaReal parameter standing for the parameter theta.
PhiReal parameter standing for the parameter phi.
LambdaReal parameter standing for the parameter lambda.
Returns
Returns with the matrix of the one-qubit matrix.
Parameters
ThetaOver2Real parameter standing for the parameter theta.
PhiReal parameter standing for the parameter phi.
LambdaReal parameter standing for the parameter lambda.
Returns
Returns with the matrix of the one-qubit matrix.

Definition at line 695 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 ( )
virtualinherited

Calculate the matrix of the constans gates.

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

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

Definition at line 750 of file Gate.cpp.

Here is the caller graph for this function:

◆ clear_children()

void Gate::clear_children ( )
inherited

Call to erase data on children.

Definition at line 441 of file Gate.cpp.

Here is the caller graph for this function:

◆ clear_parents()

void Gate::clear_parents ( )
inherited

Call to erase data on parents.

Definition at line 451 of file Gate.cpp.

Here is the caller graph for this function:

◆ clone()

Composite * Composite::clone ( )
virtual

Call to create a clone of the present class.

Returns
Return with a pointer pointing to the cloned object

Reimplemented from Gates_block.

Definition at line 279 of file Composite.cpp.

Here is the call graph for this function:

◆ combine()

void Gates_block::combine ( Gates_block op_block)
inherited

Call to append the gates of an gate block to the current block.

Call to append the gates of a gate block to the current circuit.

Parameters
op_blockA pointer to an instance of class Gate_block
op_blockA pointer to an instance of class Gates_block

Definition at line 2292 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ contains_adaptive_gate() [1/2]

bool Gates_block::contains_adaptive_gate ( )
inherited

Call to determine, whether the circuit contains daptive gate or not.

Returns
Return with true if the circuit contains an adaptive gate.

Definition at line 2423 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ contains_adaptive_gate() [2/2]

bool Gates_block::contains_adaptive_gate ( int  idx)
inherited

Call to determine, whether the sub-circuit at a given position in the circuit contains daptive gate or not.

Parameters
idxThe position of the gate to be checked.
Returns
Return with true if the circuit contains an adaptive gate.

Definition at line 2450 of file Gates_block.cpp.

Here is the call graph for this function:

◆ create_remapped_circuit() [1/2]

Gates_block * Gates_block::create_remapped_circuit ( const std::map< int, int > &  qbit_map)
inherited

Call to create a new circuit with remapped qubits.

Parameters
qbit_mapThe map to reorder the qbits in a form of map: {int(initial_qbit): int(remapped_qbit)}.
Returns
Returns with the remapped circuit

Definition at line 2030 of file Gates_block.cpp.

Here is the caller graph for this function:

◆ create_remapped_circuit() [2/2]

Gates_block * Gates_block::create_remapped_circuit ( const std::map< int, int > &  qbit_map,
const int  qbit_num_ 
)
inherited

Call to create a new circuit with remapped qubits.

Parameters
qbit_mapThe map to reorder the qbits in a form of map: {int(initial_qbit): int(remapped_qbit)}. .
qbit_numThe number of qubits in the remapped circuit
Returns
Returns with the remapped circuit

Definition at line 2044 of file Gates_block.cpp.

Here is the call graph for this function:

◆ determine_children()

void Gates_block::determine_children ( Gate gate)
inherited

Call to obtain the child gates in the circuit.

A child gate needs to be applied after the given gate. The children gates are stored via the "children" attribute of the gate instance

Parameters
gateThe gate for which the children are determined.

Definition at line 2770 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ determine_parents()

void Gates_block::determine_parents ( Gate gate)
inherited

Call to obtain the parent gates in the circuit.

A parent gate needs to be applied prior to the given gate. The parent gates are stored via the "parents" attribute of the gate instance

Parameters
gateThe gate for which the parents are determined.

Definition at line 2724 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ extract_gates()

int Gates_block::extract_gates ( Gates_block op_block)
inherited

Call to extract the gates stored in the class.

Parameters
op_blockAn instance of Gates_block class in which the gates will be stored. (The current gates will be erased)
Returns
Return with 0 on success.

Definition at line 2382 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ extract_parameters()

Matrix_real Gates_block::extract_parameters ( Matrix_real parameters)
virtualinherited

Call to extract parameters from the parameter array corresponding to the circuit, in which the gate is embedded.

Parameters
parametersThe parameter array corresponding to the circuit in which the gate is embedded
Returns
Returns with the array of the extracted parameters.

Reimplemented from Gate.

Definition at line 2895 of file Gates_block.cpp.

Here is the call graph for this function:

◆ fragment_circuit()

void Gates_block::fragment_circuit ( )
inherited

Definition at line 398 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_children()

std::vector< Gate * > Gate::get_children ( )
inherited

Call to get the children of the current gate.

Returns
Returns with the list of the children

Definition at line 474 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_control_qbit()

int Gate::get_control_qbit ( )
inherited

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 378 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_flat_circuit()

Gates_block * Gates_block::get_flat_circuit ( )
inherited

Method to generate a flat circuit.

A flat circuit is a circuit does not containing subcircuits: there are no Gates_block instances (containing subcircuits) in the resulting circuit. If the original circuit contains subcircuits, the gates in the subcircuits are directly incorporated in the resulting flat circuit.

Definition at line 2857 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_gate()

Gate * Gates_block::get_gate ( int  idx)
inherited

Call to get the gates stored in the class.

Call to get a gate stored in the class.

Returns
Return with a list of the gates.
Return with a pointer to the gate. (Borrowed reference, dont free the memory)

Definition at line 2278 of file Gates_block.cpp.

Here is the caller graph for this function:

◆ get_gate_num()

int Gates_block::get_gate_num ( )
inherited

Call to get the number of gates grouped in the class.

Returns
Return with the number of the gates grouped in the gate block.

Definition at line 1733 of file Gates_block.cpp.

Here is the caller graph for this function:

◆ get_gate_nums()

std::map< std::string, int > Gates_block::get_gate_nums ( )
inherited

Call to get the number of the individual gate types in the list of gates.

Returns
Returns with a map<gate_name, gate_count> describing the number of the individual gate types

Definition at line 1707 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_gates()

std::vector< Gate * > Gates_block::get_gates ( )
inherited

Call to get the gates stored in the class.

Returns
Return with a list of the gates.

(The resulting vector contains borrowed pointers to the gates, so they dont need to be deleted.)

Returns
Return with a list of the gates.

Definition at line 2269 of file Gates_block.cpp.

Here is the caller graph for this function:

◆ get_involved_qubits()

std::vector< int > Gates_block::get_involved_qubits ( )
virtualinherited

Call to get the qubits involved in the gates stored in the block of gates.

Returns
Return with a list of the involved qubits
Return with a list of the invovled qubits

Reimplemented from Gate.

Definition at line 2237 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_matrix() [1/4]

Matrix Composite::get_matrix ( Matrix_real parameters)
virtual

Call to retrieve the operation matrix.

Parameters
parallelSet true to apply parallel kernels, false otherwise
Returns
Returns with a matrix of the operation
Parameters
parametersAn array of parameters to calculate the matrix of the composite gate.
Returns
Returns with a matrix of the operation

Reimplemented from Gate.

Definition at line 110 of file Composite.cpp.

Here is the call graph for this function:

◆ get_matrix() [2/4]

Matrix Composite::get_matrix ( Matrix_real parameters,
int  parallel 
)
virtual

Call to retrieve the operation matrix.

Parameters
parallelSet 0 for sequential execution, 1 for parallel execution with OpenMP and 2 for parallel with TBB (optional)
Returns
Returns with a matrix of the operation
Parameters
parametersAn array of parameters to calculate the matrix of the composite gate.
parallelSet 0 for sequential execution, 1 for parallel execution with OpenMP and 2 for parallel with TBB (optional)
Returns
Returns with a matrix of the operation

Reimplemented from Gate.

Definition at line 124 of file Composite.cpp.

Here is the call graph for this function:

◆ get_matrix() [3/4]

Matrix Gate::get_matrix ( )
virtualinherited

Call to retrieve the operation matrix.

Returns
Returns with a matrix of the operation

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

Definition at line 129 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_matrix() [4/4]

Matrix Gate::get_matrix ( int  parallel)
virtualinherited

Call to retrieve the operation matrix.

Parameters
parallelSet 0 for sequential execution, 1 for parallel execution with OpenMP and 2 for parallel with TBB (optional)
Returns
Returns with the matrix of the operation

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

Definition at line 141 of file Gate.cpp.

◆ get_name()

std::string Gate::get_name ( )
inherited

Call to get the name label of the gate.

Returns
Returns with the name label of the gate

Definition at line 839 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_parameter_max()

void Gates_block::get_parameter_max ( Matrix_real range_max)
inherited

Definition at line 491 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_parameter_num()

int Composite::get_parameter_num ( )

Call to get the number of free parameters.

Returns
Return with the number of the free parameters

Definition at line 250 of file Composite.cpp.

◆ get_parameter_start_idx()

int Gate::get_parameter_start_idx ( )
inherited

Call to get the starting index of the parameters in the parameter array corresponding to the circuit in which the current gate is incorporated.

Parameters
start_idxThe starting index

Definition at line 814 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_parents()

std::vector< Gate * > Gate::get_parents ( )
inherited

Call to get the parents of the current gate.

Returns
Returns with the list of the parents

Definition at line 463 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_qbit_num()

int Composite::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 270 of file Composite.cpp.

◆ get_reduced_density_matrix()

Matrix Gates_block::get_reduced_density_matrix ( Matrix_real parameters_mtx,
Matrix input_state,
matrix_base< int > &  qbit_list_subset 
)
inherited

Call to evaluate the reduced densiy matrix.

Parameters
parametersAn array of parameters to calculate the entropy
input_stateThe input state on which the gate structure is applied
qbit_listSubset of qubits for which the entropy should be calculated. (Should conatin unique elements) Returns with the reduced density matrix.

Definition at line 2477 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_second_Renyi_entropy()

double Gates_block::get_second_Renyi_entropy ( Matrix_real parameters_mtx,
Matrix input_state,
matrix_base< int > &  qbit_list_subset 
)
inherited

Call to evaluate the seconf Rényi entropy.

The quantum circuit is applied on an input state input. The entropy is evaluated for the transformed state.

Parameters
parametersAn array of parameters to calculate the entropy
input_stateThe input state on which the gate structure is applied
qbit_listSubset of qubits for which the entropy should be calculated. (Should conatin unique elements) Returns with the calculated entropy

Definition at line 2654 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_target_qbit()

int Gate::get_target_qbit ( )
inherited

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 370 of file Gate.cpp.

Here is the caller graph for this function:

◆ get_type()

gate_type Composite::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 260 of file Composite.cpp.

◆ insert_gate()

void Gates_block::insert_gate ( Gate gate,
int  idx 
)
inherited

Call to insert a gate at a given position.

Parameters
gateA pointer to a class Gate describing a gate.
idxThe position where to insert the gate.

Definition at line 1647 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ list_gates()

void Gates_block::list_gates ( const Matrix_real parameters,
int  start_index 
)
inherited

Call to print the list of gates stored in the block of gates for a specific set of parameters.

Parameters
parametersThe parameters of the gates that should be printed.
start_indexThe ordinal number of the first gate.

Definition at line 1743 of file Gates_block.cpp.

Here is the call graph for this function:
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 
)
virtualinherited

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
ThetaReal parameter standing for the parameter theta.
PhiReal parameter standing for the parameter phi.
LambdaReal parameter standing for the parameter lambda.
Returns
Returns with the matrix of the one-qubit matrix.
Parameters
ThetaOver2Real parameter standing for the parameter theta.
PhiReal parameter standing for the parameter phi.
LambdaReal parameter standing for the parameter lambda.

Reimplemented in RY, RX, RZ, RZ_P, U1, and U2.

Definition at line 767 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
sstreamThe stringstream input to store the output messages.
verbose_levelInteger 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.

◆ release_gate()

void Gates_block::release_gate ( int  idx)
inherited

Call to release one gate in the list.

Definition at line 132 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ release_gates()

void Gates_block::release_gates ( )
inherited

Call to release the stored gates.

Definition at line 111 of file Gates_block.cpp.

Here is the caller graph for this function:

◆ reorder_qubits()

void Composite::reorder_qubits ( std::vector< int qbit_list)
virtual

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

Parameters
qbit_listThe reordered list of qubits spanning the matrix

Reimplemented from Gates_block.

Definition at line 216 of file Composite.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reset_dependency_graph()

void Gates_block::reset_dependency_graph ( )
inherited

Method to reset the dependency graph of the gates in the circuit.

Definition at line 2828 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reset_parameter_start_indices()

void Gates_block::reset_parameter_start_indices ( )
inherited

Method to reset the parameter start indices of gate operations incorporated in the circuit.

Method reset the parameter start indices of gate operations incorporated in the circuit.

(When a gate is inserted into the circuit at other position than the end.)

Definition at line 2807 of file Gates_block.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_children()

void Gate::set_children ( std::vector< Gate *> &  children_)
inherited

Call to set the children of the current gate.

Parameters
children_the list of the children

Definition at line 802 of file Gate.cpp.

Here is the caller graph for this function:

◆ set_control_qbit()

void Gate::set_control_qbit ( int  control_qbit_in)
inherited

Call to set the control qubit for the gate operation.

Parameters
control_qbit_inThe control qubit. Should be: 0 <= control_qbit_in < qbit_num

Definition at line 308 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
debugfileString 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)
inherited

Call to set the stored matrix in the operation.

Parameters
inputThe operation matrix to be stored. The matrix is stored by attribute matrix_alloc.
Returns
Returns with 0 on success.

Definition at line 299 of file Gate.cpp.

Here is the caller graph for this function:

◆ set_parameter_start_idx()

void Gate::set_parameter_start_idx ( int  start_idx)
inherited

Call to set the starting index of the parameters in the parameter array corresponding to the circuit in which the current gate is incorporated.

Parameters
start_idxThe starting index

Definition at line 779 of file Gate.cpp.

Here is the caller graph for this function:

◆ set_parents()

void Gate::set_parents ( std::vector< Gate *> &  parents_)
inherited

Call to set the parents of the current gate.

Parameters
parents_the list of the parents

Definition at line 790 of file Gate.cpp.

Here is the caller graph for this function:

◆ set_qbit_num()

void Composite::set_qbit_num ( int  qbit_num_in)
virtual

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

Parameters
qbit_num_inThe number of qubits spanning the matrix

Reimplemented from Gates_block.

Definition at line 91 of file Composite.cpp.

Here is the call graph for this function:

◆ set_target_qbit()

void Gate::set_target_qbit ( int  target_qbit_in)
inherited

Call to set the target qubit for the gate operation.

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

Definition at line 324 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_inInteger 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

◆ block_end

std::vector<int> Gates_block::block_end
protectedinherited

Definition at line 59 of file Gates_block.h.

◆ block_type

std::vector<int> Gates_block::block_type
protectedinherited

Definition at line 60 of file Gates_block.h.

◆ children

std::vector<Gate*> Gate::children
protectedinherited

list of child gates to be applied after this current gate

Definition at line 97 of file Gate.h.

◆ control_qbit

int Gate::control_qbit
protectedinherited

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

Definition at line 87 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.

◆ fragmentation_type

int Gates_block::fragmentation_type
protectedinherited

Definition at line 55 of file Gates_block.h.

◆ fragmented

bool Gates_block::fragmented
protectedinherited

boolean variable indicating whether the circuit was already partitioned or not

Definition at line 54 of file Gates_block.h.

◆ gates

std::vector<Gate*> Gates_block::gates
protectedinherited

The list of stored gates.

Definition at line 46 of file Gates_block.h.

◆ involved_qbits

std::vector< std::vector<int> > Gates_block::involved_qbits
protectedinherited

Definition at line 58 of file Gates_block.h.

◆ layer_num

int Gates_block::layer_num
protectedinherited

number of gate layers

Definition at line 48 of file Gates_block.h.

◆ matrix_size

int Gate::matrix_size
protectedinherited

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

Definition at line 89 of file Gate.h.

◆ max_fusion

int Gates_block::max_fusion
protectedinherited

maximal number of qubits in partitions

Definition at line 57 of file Gates_block.h.

◆ name

std::string Gate::name
protectedinherited

A string labeling the gate operation.

Definition at line 79 of file Gate.h.

◆ parameter_num

int Gate::parameter_num
protectedinherited

the number of free parameters of the operation

Definition at line 91 of file Gate.h.

◆ parameter_start_idx

int Gate::parameter_start_idx
protectedinherited

the index in the parameter array (corrensponding to the encapsulated circuit) where the gate parameters begin (if gates are placed into a circuit a single parameter array is used to execute the whole circuit)

Definition at line 93 of file Gate.h.

◆ parameters

Matrix_real Composite::parameters
protected

Parameters theta, phi, lambda of the U3 gate after the decomposition of the unitary is done.

Definition at line 53 of file Composite.h.

◆ parents

std::vector<Gate*> Gate::parents
protectedinherited

list of parent gates to be applied in the circuit prior to this current gate

Definition at line 95 of file Gate.h.

◆ qbit_num

int Gate::qbit_num
protectedinherited

number of qubits spanning the matrix of the operation

Definition at line 81 of file Gate.h.

◆ target_qbit

int Gate::target_qbit
protectedinherited

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

Definition at line 85 of file Gate.h.

◆ type

gate_type Gate::type
protectedinherited

The type of the operation (see enumeration gate_type)

Definition at line 83 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: