CircuitGate

class CircuitGate(circuit, move=False)

Bases: Gate

The CircuitGate class.

A CircuitGate is a immutable circuit represented as a gate.

__init__(circuit, move=False)

CircuitGate Constructor.

Parameters:

• circuit (Circuit) – The circuit to copy into gate format.

• move (bool) – If true, the constructor will not copy the circuit. This should only be used when you are sure circuit will no longer be used on caller side. If unsure use the default. (Default: False)

Attributes

dim	The matrix dimension for this unitary.
name	The name of this gate.
num_params	The number of real parameters this unitary-valued function takes.
num_qudits	The number of qudits this unitary can act on.
qasm_name	The qasm identifier for this gate.
radixes	The number of orthogonal states for each qudit.

Methods

check_parameters(params)	Check parameters are valid and match the unitary.
get_grad([params])	Return the gradient for this gate.
get_inverse()	Return the gate's inverse as a gate.
get_inverse_params([params])	Return the parameters that invert the gate.
get_qasm(params, location)	Returns the qasm string for this gate.
get_qasm_gate_def()	Returns a qasm gate definition block for this gate.
get_unitary([params])	Return the unitary for this gate, see Unitary for more.
get_unitary_and_grad([params])	Return the unitary and gradient for this gate.
is_constant()	Return true if this unitary doesn't take parameters.
is_differentiable()	Return true if the circuit is differentiable.
is_parameterized()	Return true if this unitary is parameterized.
is_qubit_only()	Return true if this unitary can only act on qubits.
is_qudit_only(radix)	Return true if this unitary can only act on radix-qudits.
is_qutrit_only()	Return true if this unitary can only act on qutrits.
is_self_inverse([params])	Checks whether the unitary is its own inverse.
with_all_frozen_params(params)	Freeze all of a gate's parameters so they don't change from optimization.
with_frozen_params(frozen_params)	Freeze some of a gate's parameters so they don't change from optimization.