ConstantUnitaryGate

class ConstantUnitaryGate(utry, radixes=[])[source]

Bases: Gate, CachedClass

An arbitrary constant unitary operator.

__init__(utry, radixes=[])[source]

Construct a constant unitary operator.

Parameters:
  • utry (UnitaryMatrix | complex128 | complex64 | int64 | int32 | float64 | float32 | Sequence[Sequence[int | float | complex]]) – The operation as a unitary matrix.

  • radixes (Sequence[int]) – The number of orthogonal states for each qudit this gate will act on. Defaults to qubits.

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 the unitary map as an np.ndarray.

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.

get_unitary_and_grad([params])

Return a tuple combining the outputs of get_unitary and get_grad.

is_constant()

Return true if this unitary doesn't take parameters.

is_differentiable()

Return true if this gate has a gradient definition.

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.