# qml.ops.op_math.CompositeOp¶

class CompositeOp(*operands: pennylane.operation.Operator, do_queue=True, id=None)[source]

A base class for operators that are composed of other operators.

Parameters

operands – (tuple[~.operation.Operator]): a tuple of operators which will be combined.

Keyword Arguments
• do_queue (bool) – determines if the operator will be queued. Default is True.

• id (str or None) – id for the operator. Default is None.

The child composite operator should define the _op_symbol property during initialization and define any relevant representations, such as matrix() and decomposition().

 arithmetic_depth Arithmetic depth of the operator. batch_size Batch size of the operator if it is used with broadcasted parameters. data Create data property eigendecomposition Return the eigendecomposition of the matrix specified by the operator. has_adjoint has_decomposition has_diagonalizing_gates bool(x) -> bool has_matrix bool(x) -> bool has_overlapping_wires Boolean expression that indicates if the factors have overlapping wires. hash Integer hash that uniquely represents the operator. hyperparameters Dictionary of non-trainable variables that this operation depends on. id Custom string to label a specific operator instance. is_hermitian This property determines if the composite operator is hermitian. name String for the name of the operator. ndim_params Number of dimensions per trainable parameter of the operator. num_params Number of trainable parameters that the operator depends on. num_wires Number of wires the operator acts on. overlapping_ops Groups all operands of the composite operator that act on overlapping wires. parameters Trainable parameters that the operator depends on. wires Wires that the operator acts on.
arithmetic_depth
batch_size

Batch size of the operator if it is used with broadcasted parameters.

The batch_size is determined based on ndim_params and the provided parameters for the operator. If (some of) the latter have an additional dimension, and this dimension has the same size for all parameters, its size is the batch size of the operator. If no parameter has an additional dimension, the batch size is None.

Returns

Size of the parameter broadcasting dimension if present, else None.

Return type

int or None

data

parameters of the operator

Type

list[Any]

eigendecomposition

Return the eigendecomposition of the matrix specified by the operator.

This method uses pre-stored eigenvalues for standard observables where possible and stores the corresponding eigenvectors from the eigendecomposition.

It transforms the input operator according to the wires specified.

Returns

dictionary containing the eigenvalues and the

eigenvectors of the operator.

Return type

dict[str, array]

has_adjoint = False
has_decomposition = False
has_diagonalizing_gates
has_matrix
has_overlapping_wires

Boolean expression that indicates if the factors have overlapping wires.

hash
hyperparameters

Dictionary of non-trainable variables that this operation depends on.

Type

dict

id

Custom string to label a specific operator instance.

is_hermitian

This property determines if the composite operator is hermitian.

name

String for the name of the operator.

ndim_params

Number of dimensions per trainable parameter of the operator.

By default, this property returns the numbers of dimensions of the parameters used for the operator creation. If the parameter sizes for an operator subclass are fixed, this property can be overwritten to return the fixed value.

Returns

Number of dimensions for each trainable parameter.

Return type

tuple

num_params
num_wires
overlapping_ops

Groups all operands of the composite operator that act on overlapping wires.

Returns

List of lists of operators that act on overlapping wires. All the inner lists commute with each other.

Return type

List[List[Operator]]

parameters

Trainable parameters that the operator depends on.

wires

Wires that the operator acts on.

Returns

wires

Return type

Wires

 Create an operation that is the adjoint of this one. compute_decomposition(*params[, wires]) Representation of the operator as a product of other operators (static method). compute_diagonalizing_gates(*params, wires, …) Sequence of gates that diagonalize the operator in the computational basis (static method). compute_eigvals(*params, **hyperparams) Eigenvalues of the operator in the computational basis (static method). compute_matrix(*params, **hyperparams) Representation of the operator as a canonical matrix in the computational basis (static method). compute_sparse_matrix(*params, **hyperparams) Representation of the operator as a sparse matrix in the computational basis (static method). Representation of the operator as a product of other operators. Sequence of gates that diagonalize the operator in the computational basis. Return the eigenvalues of the specified operator. Returns a tape that has recorded the decomposition of the operator. Generator of an operator that is in single-parameter-form. label([decimals, base_label, cache]) How the composite operator is represented in diagrams and drawings. map_wires(wire_map) Returns a copy of the current operator with its wires changed according to the given wire map. matrix([wire_order]) Representation of the operator as a matrix in the computational basis. A list of new operators equal to this one raised to the given power. queue([context]) Updates each operator’s owner to self, this ensures that the operators are not applied to the circuit repeatedly. Reduce the depth of nested operators to the minimum. sparse_matrix([wire_order]) Representation of the operator as a sparse matrix in the computational basis. Representation of the operator as a linear combination of other operators.
adjoint()pennylane.operation.Operator

Create an operation that is the adjoint of this one.

Adjointed operations are the conjugated and transposed version of the original operation. Adjointed ops are equivalent to the inverted operation for unitary gates.

Returns

static compute_decomposition(*params, wires=None, **hyperparameters)

Representation of the operator as a product of other operators (static method).

$O = O_1 O_2 \dots O_n.$

Note

Operations making up the decomposition should be queued within the compute_decomposition method.

Parameters
• params (list) – trainable parameters of the operator, as stored in the parameters attribute

• wires (Iterable[Any], Wires) – wires that the operator acts on

• hyperparams (dict) – non-trainable hyperparameters of the operator, as stored in the hyperparameters attribute

Returns

decomposition of the operator

Return type

list[Operator]

static compute_diagonalizing_gates(*params, wires, **hyperparams)

Sequence of gates that diagonalize the operator in the computational basis (static method).

Given the eigendecomposition $$O = U \Sigma U^{\dagger}$$ where $$\Sigma$$ is a diagonal matrix containing the eigenvalues, the sequence of diagonalizing gates implements the unitary $$U^{\dagger}$$.

The diagonalizing gates rotate the state into the eigenbasis of the operator.

Parameters
• params (list) – trainable parameters of the operator, as stored in the parameters attribute

• wires (Iterable[Any], Wires) – wires that the operator acts on

• hyperparams (dict) – non-trainable hyperparameters of the operator, as stored in the hyperparameters attribute

Returns

list of diagonalizing gates

Return type

list[Operator]

static compute_eigvals(*params, **hyperparams)

Eigenvalues of the operator in the computational basis (static method).

If diagonalizing_gates are specified and implement a unitary $$U^{dagger}$$, the operator can be reconstructed as

$O = U \Sigma U^{\dagger},$

where $$\Sigma$$ is the diagonal matrix containing the eigenvalues.

Otherwise, no particular order for the eigenvalues is guaranteed.

Parameters
• params (list) – trainable parameters of the operator, as stored in the parameters attribute

• hyperparams (dict) – non-trainable hyperparameters of the operator, as stored in the hyperparameters attribute

Returns

eigenvalues

Return type

tensor_like

static compute_matrix(*params, **hyperparams)

Representation of the operator as a canonical matrix in the computational basis (static method).

The canonical matrix is the textbook matrix representation that does not consider wires. Implicitly, this assumes that the wires of the operator correspond to the global wire order.

Parameters
• params (list) – trainable parameters of the operator, as stored in the parameters attribute

• hyperparams (dict) – non-trainable hyperparameters of the operator, as stored in the hyperparameters attribute

Returns

matrix representation

Return type

tensor_like

static compute_sparse_matrix(*params, **hyperparams)

Representation of the operator as a sparse matrix in the computational basis (static method).

The canonical matrix is the textbook matrix representation that does not consider wires. Implicitly, this assumes that the wires of the operator correspond to the global wire order.

Parameters
• params (list) – trainable parameters of the operator, as stored in the parameters attribute

• hyperparams (dict) – non-trainable hyperparameters of the operator, as stored in the hyperparameters attribute

Returns

sparse matrix representation

Return type

scipy.sparse._csr.csr_matrix

decomposition()

Representation of the operator as a product of other operators.

$O = O_1 O_2 \dots O_n$

A DecompositionUndefinedError is raised if no representation by decomposition is defined.

Returns

decomposition of the operator

Return type

list[Operator]

diagonalizing_gates()[source]

Sequence of gates that diagonalize the operator in the computational basis.

Given the eigendecomposition $$O = U \Sigma U^{\dagger}$$ where $$\Sigma$$ is a diagonal matrix containing the eigenvalues, the sequence of diagonalizing gates implements the unitary $$U^{\dagger}$$.

The diagonalizing gates rotate the state into the eigenbasis of the operator.

A DiagGatesUndefinedError is raised if no representation by decomposition is defined.

Returns

a list of operators

Return type

list[Operator] or None

eigvals()[source]

Return the eigenvalues of the specified operator.

This method uses pre-stored eigenvalues for standard observables where possible and stores the corresponding eigenvectors from the eigendecomposition.

Returns

array containing the eigenvalues of the operator

Return type

array

expand()

Returns a tape that has recorded the decomposition of the operator.

Returns

quantum tape

Return type

QuantumTape

generator()

Generator of an operator that is in single-parameter-form.

For example, for operator

$U(\phi) = e^{i\phi (0.5 Y + Z\otimes X)}$

we get the generator

>>> U.generator()
(0.5) [Y0]
+ (1.0) [Z0 X1]


The generator may also be provided in the form of a dense or sparse Hamiltonian (using Hermitian and SparseHamiltonian respectively).

The default value to return is None, indicating that the operation has no defined generator.

label(decimals=None, base_label=None, cache=None)[source]

How the composite operator is represented in diagrams and drawings.

Parameters
• decimals (int) – If None, no parameters are included. Else, how to round the parameters. Defaults to None.

• base_label (Iterable[str]) – Overwrite the non-parameter component of the label. Must be same length as operands attribute. Defaults to None.

• cache (dict) – Dictionary that carries information between label calls in the same drawing. Defaults to None.

Returns

label to use in drawings

Return type

str

Example (using the Sum composite operator)

>>> op = qml.S(0) + qml.PauliX(0) + qml.Rot(1,2,3, wires=[1])
>>> op.label()
'(S+X)+Rot'
>>> op.label(decimals=2, base_label=[["my_s", "my_x"], "inc_rot"])
'(my_s+my_x)+inc_rot\n(1.00,\n2.00,\n3.00)'

map_wires(wire_map: dict)[source]

Returns a copy of the current operator with its wires changed according to the given wire map.

Parameters

wire_map (dict) – dictionary containing the old wires as keys and the new wires as values

Returns

new operator

Return type

Operator

abstract matrix(wire_order=None)[source]

Representation of the operator as a matrix in the computational basis.

pow(z)List[pennylane.operation.Operator]

A list of new operators equal to this one raised to the given power.

Parameters

z (float) – exponent for the operator

Returns

list[Operator]

queue(context=<class 'pennylane.queuing.QueuingManager'>)[source]

Updates each operator’s owner to self, this ensures that the operators are not applied to the circuit repeatedly.

simplify()pennylane.operation.Operator

Reduce the depth of nested operators to the minimum.

Returns

simplified operator

Return type

Operator

sparse_matrix(wire_order=None)

Representation of the operator as a sparse matrix in the computational basis.

If wire_order is provided, the numerical representation considers the position of the operator’s wires in the global wire order. Otherwise, the wire order defaults to the operator’s wires.

A SparseMatrixUndefinedError is raised if the sparse matrix representation has not been defined.

Parameters

wire_order (Iterable) – global wire order, must contain all wire labels from the operator’s wires

Returns

sparse matrix representation

Return type

scipy.sparse._csr.csr_matrix

terms()

Representation of the operator as a linear combination of other operators.

$O = \sum_i c_i O_i$

A TermsUndefinedError is raised if no representation by terms is defined.

Returns

list of coefficients $$c_i$$ and list of operations $$O_i$$

Return type

tuple[list[tensor_like or float], list[Operation]]