VariableUnitaryGate

class VariableUnitaryGate[source]

Bases: GeneralGate

A Variable n-qudit unitary operator.

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

Creates an VariableUnitaryGate, defaulting to a qubit gate.

Parameters:
  • num_qudits (int) – The number of qudits this gate acts on.

  • radixes (Sequence[int]) – The number of orthogonal states for each qudit. 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

calc_params(utry)

Return the parameters for this gate to implement utry

check_env_matrix(env_matrix)

Check to ensure the env_matrix is validly shaped.

check_parameters(params)

Check parameters are valid and match the unitary.

get_inverse()

Return the gate's inverse as a gate.

get_inverse_params([params])

Return the parameters that invert the gate.

get_params(utry)

Return the params for this gate, given a unitary matrix.

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.

identity_as_params(radixes)

Return the parameters for the gate that implements the identity.

is_constant()

Return true if this unitary doesn't take parameters.

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.

optimize(env_matrix)

Return the optimal parameters with respect to an environment matrix.

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.