MPRYGate

class MPRYGate(num_qudits, target_qubit=-1)[source]

Bases: QubitGate, DifferentiableUnitary, CachedClass, LocallyOptimizableUnitary

A gate representing a multiplexed Y rotation.

A multiplexed Y rotation uses n - 1 qubits as select qubits and applies a Y rotation to the target. If the target qubit is the last qubit, then the unitary is block diagonal. Each block is a 2x2 RY matrix with parameter theta.

Since there are n - 1 select qubits, there are 2^(n-1) parameters (thetas).

We allow the target qubit to be specified to any qubit, and the other qubits maintain their order. Qubit 0 is the most significant qubit.

See this paper: https://arxiv.org/pdf/quant-ph/0406176

__init__(num_qudits, target_qubit=-1)[source]

Attributes

dim

The matrix dimension for this unitary.

name

The name of this gate, with the number of qudits appended.

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_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_decomposition([params])

Get the corresponding parameters for one level of decomposition of a multiplexed gate.

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 a tuple combining the outputs of get_unitary and get_grad.

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.