PauliGate

class PauliGate[source]

Bases: QubitGate, DifferentiableUnitary, GeneralGate

A gate representing an arbitrary rotation.

This gate is given by:

\exp({i(\vec{\alpha} \cdot \vec{\sigma^{\otimes n}})})

Where \vec{\alpha} are the gate’s parameters, \vec{\sigma} are the Pauli matrices, and n is the number of qubits this gate acts on.

__init__(num_qudits)[source]

Create a PauliGate acting on num_qudits qubits.

Parameters:

num_qudits (int) – The number of qudits this gate will act on.

Raises:

ValueError – If num_qudits is nonpositive.

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_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.

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.