qp.OutMultiplier¶
- class OutMultiplier(x_wires, y_wires, output_wires, mod=None, work_wires=(), output_wires_zeroed=False)[source]¶
Bases:
Operator2Performs the out-place modular multiplication operation.
This operator performs the modular multiplication of integers \(x\) and \(y\) modulo \(mod\) in the computational basis:
\[\text{OutMultiplier}(mod) |x \rangle |y \rangle |z \rangle = |x \rangle |y \rangle |z + x \cdot y \; \text{mod} \; mod \rangle,\]There are five implementations available, which differ in the auxiliary wires and in the gate counts they require, and in whether or not they support arbitrary values for the modulus
mod. See the usage details for more information.Note
To obtain the correct result, \(x\), \(y\) and \(z\) must be smaller than \(mod\).
See also
Multiplier,SemiAdder, andPhaseAdder.- Parameters:
x_wires (Sequence[int]) – wires that store the integer \(x\)
y_wires (Sequence[int]) – wires that store the integer \(y\)
output_wires (Sequence[int]) – wires that store the multiplication result. If the register is in a non-zero state \(z\), the solution will be added to this value
mod (int) – the modulo for performing the multiplication. If not provided, it will be set to its maximum value, \(2^{\text{len(output_wires)}}\)
work_wires (Sequence[int]) – auxiliary wires to use for the multiplication. The needed number of work wires depends on the decomposition, the register sizes and
output_wires_zeroed. Defaults to an empty tuple, i.e., no work wires.output_wires_zeroed (bool) – Whether the
output_wiresare guaranteed to be in state \(|0\rangle\) initially. Setting this argument toTruereduces the cost of the operation.
Example
This example performs the multiplication of two integers \(x=2\) and \(y=7\) modulo \(mod=12\). We’ll let \(z=0\). See Usage Details for \(z \neq 0\).
x = 2 y = 7 mod = 12 x_wires = [0, 1] y_wires = [2, 3, 4] output_wires = [6, 7, 8, 9] work_wires = [5, 10] dev = qp.device("default.qubit") @qp.qnode(dev, shots=1) def circuit(): x_bin = qp.math.int_to_binary(x, len(x_wires)) y_bin = qp.math.int_to_binary(y, len(y_wires)) qp.BasisState(x_bin, wires=x_wires) qp.BasisState(y_bin, wires=y_wires) qp.OutMultiplier(x_wires, y_wires, output_wires, mod, work_wires) return qp.sample(wires=output_wires)
>>> print(circuit()) [[0 0 1 0]]
The result \([[0 0 1 0]]\), is the binary representation of \(2 \cdot 7 \; \text{modulo} \; 12 = 2\).
Available decompositions
Resources are general, for \(n\)
x_wires, \(m\)y_wires, \(k \geq n + m\)output_wires, \(w\)work_wires,mod\(=2^k\) andoutput_wires_zeroed=False. Each circuit shows one example of the rule. Use a rule when decomposing withqp.decompose:qp.decompose(gate_set=..., fixed_decomps={qp.OutMultiplier: "<name>"})
with_qftExample: \(n=m=1\), \(k=2\)
Requires program capture to be disabled
with_adderExample: \(n=m=1\), \(k=2\)
Requires \(w \geq k\) work wires
with_caddsubExample: \(n=m=1\), \(k=2\)
Requires \(w \geq k + 1\) work wires
Gate
Count
Example
\((n + 1)k - m - \binom{n}{2}\)
3
\((n + 1)k - m - \binom{n}{2}\)
3
\((n + 1)k + 5nm + n - m - 4 - \binom{n}{2}\)
5
\(2k + 8\)
12
Xwith 1 control on \(|0\rangle\)\(4n\)
4
MultiXwith 1 control on \(|0\rangle\)\(2n\,[m > 1]\)
0
\(2\)
2
\(1\)
1
where \([m > 1]\) equal to 1 if \(m > 1\) and 0 otherwise
with_cacheExample: \(n=m=1\), \(k=2\)
Requires \(w \geq 2k - 1\) work wires
swap_factorsExample: \(n=m=1\), \(k=2\)
Requires \(n > m\)
Gate
Count
OutMultiplierwithx_wiresandy_wiresswapped\(1\)
where the circuit shows \(n=2\), \(m=1\) and \(k=3\)
Usage Details
This template takes as input four different registers of wires.
The first register is
x_wireswhich is used to encode the integer \(x < mod\) in the computational basis.The second register is
y_wireswhich is used to encode the integer \(y < mod\) in the computational basis.The third register is
output_wireswhich is used to encode the integer \((z+ x \cdot y) \; \text{mod} \; mod\) in the computational basis. Therefore, it will require at least \(\lceil \log_2(mod)\rceil\) wires Note that these wires can be initialized with any integer \(z < mod\).The fourth register is
work_wirescontaining the auxiliary qubits used to perform the modular multiplication operation. The number of auxiliary wires determines which decomposition is available (also see below).Initial state of output wires
As indicated above, the initial state of
output_wirescan encode any value \(z<mod\). The following is an example for \(z = 1\).z = 1 x = 2 y = 7 mod = 12 x_wires = [0, 1] y_wires = [2, 3, 4] output_wires = [6, 7, 8, 9] work_wires = [5, 10] dev = qp.device("default.qubit") @qp.qnode(dev, shots=1) def circuit(): x_bin = qp.math.int_to_binary(x, len(x_wires)) qp.BasisState(x_bin, wires=x_wires) y_bin = qp.math.int_to_binary(y, len(y_wires)) qp.BasisState(y_bin, wires=y_wires) z_bin = qp.math.int_to_binary(z, len(output_wires)) qp.BasisState(z_bin, wires=output_wires) qp.OutMultiplier(x_wires, y_wires, output_wires, mod, work_wires) return qp.sample(wires=output_wires)
>>> print(circuit()) [[0 0 1 1]]
The result \((0011)_2\), is the binary representation of \((1 + 2 \cdot 7)\; \text{modulo} \; 12 = 3\):
If the initial state on the output wires is guaranteed to be \(|0\rangle\), this can be indicated to
OutMultiplierby settingoutput_wires_zeroed=True. This simplifies some of the available decompositions (also see below), saving quantum resources.Different decompositions
There are five decompositions, which differ in the required number of work wires and gates, and in whether they support
mod!=2**len(output_wires).The first decomposition is based on the quantum Fourier transform (QFT) method presented in arXiv:2311.08555. We nest
ControlledSequencearoundPhaseAdderto create doubly-controlled in place phase addition in the output register, which is then transformed into addition by a basis change usingQFTs. It requires zero (two) auxiliary wires formod=2**len(output_wires)(for other values ofmod) Any value formodis supported, subject to the description above.The second decomposition uses controlled
SemiAdders to realize the multiplication. For \(n\)x_wires, \(m\)y_wiresand \(k\)output_wires, we need \(L = \min(k, n)\) adders with usually varying sizes \(\min(k - i, m + 1)\) for \(0\leq i<L\). The decomposition is shown in Fig. 2a) (for \(k=2m=2n\)) and Fig. 2c) (for \(k=m=n\)) in arXiv:2410.00899.The third decomposition uses controlled addition/subtraction to replace the controlled
SemiAdders from the previous decomposition, based on Litinski’s arXiv:2410.00899. For \(n\)x_wires, \(m\)y_wiresand \(k\)output_wires, we need \(L=\min(k, n)\) controlled add/subtract operations of usually varying size \(\min(k + 1 - i, m + 1)\) for \(0\leq i<L\), threeSemiAdders of sizes \(\min(k + 1 - m, n + 1)\), \(\min(k + 1 - n, m + 1)\) and \(k+1\), as well as an incrementer on \(\min(k + 1, n + m)\) qubits and Pauli gates. For \(n=m\) and \(k=2n\), this decomposition is shown in Fig. 2b), for \(k=n=m\) in Fig. 2d).The fourth decomposition uses additional work wires as cache in order to implement the multiplier with
output_wires_zeroed=Falsevia a multiplier withoutput_wires_zeroed=True. For this, the latter computes the product into the additional cache register, which is then added with a simpleSemiAdderto the actual target register. Finally, the cache is uncomputed.The fifth decomposition simply switches the two input registers of the multiplier if the
x_wiresregister is larger thany_wires. This is a valid decomposition because multiplication is commutative, and it saves resources because the cost of other decompositions is not symmetric with respect to the input register sizes.
Attributes
The expected types for the arguments of an operator.
Dictionary mapping argument names to their values.
Arithmetic depth of the operator.
Batch size of the operator if it is used with broadcasted parameters.
The names of arguments that are treated as compilable static arguments.
Dictionary mapping compilable argument names to their values.
Legacy Operator compatibility view of dynamic numerical arguments.
The names of arguments that are treated as dynamic.
Dictionary mapping dynamic argument names to their values.
Gradient computation method.
Compute 'grad_recipe' lazily.
Whether the expected signature of an operator is fixed.
The names of arguments that represent dynamic data wrapped in static structures (known as Pytrees).
Dictionary mapping hybrid argument names to their values.
Legacy Operator compatibility view of non-dynamic, non-wire constructor arguments.
Whether this operator contains only abstract data.
This property determines if an operator is verified to be Hermitian.
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
Operator name.
Number of dimensions per trainable parameter of the operator.
Number of trainable parameters.
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
Legacy Operator compatibility view of dynamic numerical arguments as a list.
A
PauliSentencerepresentation of the Operator, orNoneif it doesn't have one.The names of arguments that are treated as static.
Dictionary mapping static argument names to their values.
The names of arguments corresponding to wires.
Dictionary mapping wire argument names to their values.
The expected number of wire labels for each wire argument.
All wires involved in the operation.
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
- arg_specs = {'output_wires': AbstractWires(-1), 'work_wires': AbstractWires(-1), 'x_wires': AbstractWires(-1), 'y_wires': AbstractWires(-1)}¶
The expected types for the arguments of an operator. This attribute is optional—not setting it has no loss of functionality. If set, it can be used to perform automatic validation of an operators inputs during construction. Additionally, when defining decomposition rules for an operator, operator types with
arg_specsthat spans all the arguments with static types can be placed in the rules’ resources without needing to fully construct abstract operators.Note
A type that is listed in ‘arg_specs’ says what an argument is allowed to be, not what it actually is. For example, if arg_specs contains Complex[-1, -1], the Operator can still be instantiated with a real float64 array, which will then be reported as complex even though it holds real data.
The decomposition graph goes by the reported type, so real and complex inputs will look like the same operator and share one rule. To let them decompose differently, leave the argument out of
arg_specsand give each rule aregister_conditionthat checks the type. For a concrete example seeBasisRotation.
- arguments¶
Dictionary mapping argument names to their values.
- arithmetic_depth¶
Arithmetic depth of the operator.
- batch_size¶
Batch size of the operator if it is used with broadcasted parameters.
The
batch_sizeis determined based onndim_paramsand 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 isNone.- Returns:
Size of the parameter broadcasting dimension if present, else
None.- Return type:
int or None
- compilable_argnames = ('mod', 'output_wires_zeroed')¶
The names of arguments that are treated as compilable static arguments. Compilable static arguments are a subset of static arguments—arguments whose concrete values are known when compiling the program. But, unlike
static_argnames, they are lowered to the compiler intermediate representation, making their values visible to the compiler, which may be useful if the compiler needs to interact with such values. Such values may include numbers, strings, and lists, tuples, or dictionaries thereof. This feature is opt-in; if any static arguments are not guaranteed to be compilable, it is safer to place them instatic_argnames.Note
An operator can only specify
static_argnamesandhybrid_argnames, orcompilable_argnames, but not both; if any static or hybrid arguments are not or cannot be lowered to the IR, then all static and hybrid arguments are assumed to not be lowerable.
- compilable_args¶
Dictionary mapping compilable argument names to their values.
- data¶
Legacy Operator compatibility view of dynamic numerical arguments.
- dynamic_argnames = ()¶
The names of arguments that are treated as dynamic. Dynamic arguments are numerical arguments whose concrete values may not be known at compile-time, such as rotation angles, matrices, etc., and may include trainable data. Additionally, dynamic arguments are the only ones used to infer
batch_size, necessary for broadcasting support.Inputs for these arguments must be scalars, arrays, or castable to arrays (e.g. multi- dimensional lists with homogenous shapes), and operator constructors will be responsible for “canonicalizing” them (such as casting a list input to an array). At compile-time, the concrete values of these arguments are assumed to be unknown—only their shapes and data types are known.
- dynamic_args¶
Dictionary mapping dynamic argument names to their values.
- grad_method¶
Gradient computation method.
'A': analytic differentiation using the parameter-shift method.'F': finite difference numerical differentiation.None: the operation may not be differentiated.
Default is
'F', orNoneif the Operation has zero parameters.
- grad_recipe¶
Compute ‘grad_recipe’ lazily.
- has_adjoint = False¶
- has_decomposition = True¶
- has_diagonalizing_gates = False¶
- has_fixed_sig = False¶
Whether the expected signature of an operator is fixed. If
True, then the operator’s signature will always be fully known. When defining decomposition rules for an operator, operator types with fixed signatures can be placed in the rules’ resources without needing to fully construct abstract operators. This is set automatically whenarg_specscovers every dynamic and wire argument, there are no hybrid, static, or compilable arguments, and every declared type is fully fixed (no unknown array shapes or wire counts).
- has_generator = False¶
- has_matrix = False¶
- has_sparse_matrix = False¶
- hybrid_argnames = ()¶
The names of arguments that represent dynamic data wrapped in static structures (known as Pytrees). Names in this category must be disjoint from
dynamic_argnames,static_argnames, andcompilable_argnames, but may overlap withwire_argnameswhen those arguments contain nested structures of wires. Examples of hybrid arguments include collections of wires or dynamic arrays, operators, etc.Note
An operator can only specify
static_argnamesandhybrid_argnames, orcompilable_argnames, but not both; if any static or hybrid arguments are not or cannot be lowered to the IR, then all static and hybrid arguments are assumed to not be lowerable.
- hybrid_args¶
Dictionary mapping hybrid argument names to their values.
- hyperparameters¶
Legacy Operator compatibility view of non-dynamic, non-wire constructor arguments.
- is_fully_abstract¶
Whether this operator contains only abstract data.
- is_verified_hermitian¶
This property determines if an operator is verified to be Hermitian.
Note
This property provides a fast, non-exhaustive check used for internal optimizations. It relies on quick, provable shortcuts (e.g., operator properties) rather than a full, computationally expensive check.
For a definitive check, use the
pennylane.is_hermitian()function. Please note that this comes with increased computational cost.- Returns:
The property will return
Trueif the operator is guaranteed to be Hermitian andFalseif the check is inconclusive and the operator may or may not be Hermitian.- Return type:
bool
Consider this operator,
>>> op = (qp.X(0) @ qp.Y(0) - qp.X(0) @ qp.Z(0)) * 1j
In this case, Hermicity cannot be verified and leads to an inconclusive result:
>>> op.is_verified_hermitian # inconclusive False
However, using
pennylane.is_hermitian()will give the correct answer:>>> qp.is_hermitian(op) # definitive True
- mod¶
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
- name¶
Operator name.
- 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¶
Number of trainable parameters.
- output_wires¶
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
- output_wires_zeroed¶
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
- parameters¶
Legacy Operator compatibility view of dynamic numerical arguments as a list.
- pauli_rep¶
A
PauliSentencerepresentation of the Operator, orNoneif it doesn’t have one.
- static_argnames = ()¶
The names of arguments that are treated as static. Static arguments are those whose concrete values are known when compiling the program. Arguments specified here are not lowered to a compiler intermediate representation (IR). Alternatively, if an argument is of a type that can be lowered, it can be moved to
compilable_argnames.Note
An operator can only specify
static_argnamesandhybrid_argnames, orcompilable_argnames, but not both; if any static or hybrid arguments are not or cannot be lowered to the IR, then all static and hybrid arguments are assumed to not be lowerable.
- static_args¶
Dictionary mapping static argument names to their values.
- wire_argnames = ('x_wires', 'y_wires', 'output_wires', 'work_wires')¶
The names of arguments corresponding to wires. Values for these arguments are automatically wrapped in
Wiresobjects by theOperator2constructor. If an argument is expected to be a structure that wraps wires (known as pytrees), such as a list of wire registers, make sure to include its name inhybrid_argnamesas well. Additionally,Operator2does not descend into the pytree structure of such arguments, so subclasses must ensure every wire leaf inside a hybrid wire argument is already aWiresobject before forwarding it tosuper().__init__.The order in which names appear in
wire_argnamesdetermines the order in which their wires appear inop.wires(seeOperator2.wires). For hybrid wire arguments, the containedWiresleaves are ordered by pytree traversal order. Wires contributed by arguments which are themselvesOperator2objects are appended after allwire_argnameswires. The special names"work_wires"and"work_wire"may be included inwire_argnamesbut their values are excluded fromop.wires.
- wire_args¶
Dictionary mapping wire argument names to their values.
- wire_sizes = (None, None, None, None)¶
The expected number of wire labels for each wire argument. If any wire arguments support an arbitrary size,
Nonemust be used. By default, all wire arguments are assumed to support arbitrary sizes. For hybrid wire arguments, the wire size must always beNone. Specifying wire sizes allows for additional automatic validation to be implemented, but, specifying it is optional if such validation is not needed.
- wires¶
All wires involved in the operation.
- work_wires¶
partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.
Methods
adjoint()Create an operation that is the adjoint of this one.
compute_decomposition(*args, **kwargs)Representation of the operator as a product of other operators (static method).
compute_diagonalizing_gates(*args, **kwargs)Sequence of gates that diagonalize the operator in the computational basis (static method).
compute_eigvals(*args, **kwargs)Eigenvalues of the operator in the computational basis (static method).
compute_matrix(*args, **kwargs)Representation of the operator as a canonical matrix in the computational basis (static method).
compute_sparse_matrix(*args[, format])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.
eigvals()Eigenvalues of the operator in the computational basis.
Generator of an operator that is in single-parameter-form.
label([decimals, base_label, cache])A customizable string representation of the operator.
map_wires(wire_map)Returns a new 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.
pow(z)A list of new operators equal to this one raised to the given power.
queue([context])Append the operator to the Operator queue.
simplify()Reduce the depth of nested operators to the minimum.
sparse_matrix([wire_order, format])Representation of the operator as a sparse matrix in the computational basis.
terms()Representation of the operator as a linear combination of other operators.
- adjoint()¶
Create an operation that is the adjoint of this one. Used to simplify
Adjointoperators constructed byadjoint(). TODO: [sc-120844] Fix docstring after Adjoint is addedAdjointed operations are the conjugated and transposed version of the original operation. Adjointed ops are equivalent to the inverted operation for unitary gates.
Operator2.adjointcan be optionally defined by Operator developers, whileadjoint()is the entry point for constructing generic adjoint representations.- Returns:
The adjointed operation.
>>> from pennylane.core.operator import Operator2 >>> class MyClass(Operator2): ... dynamic_argnames = ("phi",) ... ... def __init__(self, phi, wires): ... super().__init__(phi, wires) ... ... def adjoint(self): ... return self ... >>> op = MyClass(0.5, wires=0).adjoint() >>> op MyClass(0.5, wires=[0])
- classmethod compute_decomposition(*args, **kwargs)¶
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_decompositionmethod.See also
- Parameters:
*args (tuple) – Positional arguments of the operator
**kwargs (dict) – Keyword arguments of the operator
- Returns:
decomposition of the operator
- Return type:
list[Operator2]
- static compute_diagonalizing_gates(*args, **kwargs)¶
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.
See also
- Parameters:
*args (tuple) – Positional arguments of the operator
**kwargs (dict) – Keyword arguments of the operator
- Returns:
list of diagonalizing gates
- Return type:
list[.Operator2]
- static compute_eigvals(*args, **kwargs)¶
Eigenvalues of the operator in the computational basis (static method).
If
diagonalizing_gatesare 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.
See also
- Parameters:
*args (tuple) – Positional arguments of the operator
**kwargs (dict) – Keyword arguments of the operator
- Returns:
eigenvalues
- Return type:
tensor_like
- static compute_matrix(*args, **kwargs)¶
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.
See also
- Parameters:
*args (tuple) – Positional arguments of the operator
**kwargs (dict) – Keyword arguments of the operator
- Returns:
matrix representation
- Return type:
tensor_like
- static compute_sparse_matrix(*args, format='csr', **kwargs)¶
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.
See also
- Parameters:
*args (tuple) – Positional arguments of the operator
format (str) – format of the returned scipy sparse matrix, for example ‘csr’
**kwargs (dict) – Keyword arguments of the operator
- 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
DecompositionUndefinedErroris raised if no representation by decomposition is defined.See also
- Returns:
decomposition of the operator
- Return type:
list[Operator2]
- diagonalizing_gates()¶
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
DiagGatesUndefinedErroris raised if no representation by decomposition is defined.See also
- Returns:
a list of operators
- Return type:
list[.Operator2] or None
- eigvals()¶
Eigenvalues of the operator in the computational basis.
If
diagonalizing_gatesare 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.
Note
When eigenvalues are not explicitly defined, they are computed automatically from the matrix representation. Currently, this computation is not differentiable.
A
EigvalsUndefinedErroris raised if the eigenvalues have not been defined and cannot be inferred from the matrix representation.See also
- Returns:
eigenvalues
- Return type:
tensor_like
- 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 * Y(0) + Z(0) @ X(1)
The generator may also be provided in the form of a dense or sparse Hamiltonian (using
LinearCombinationandSparseHamiltonianrespectively).
- label(decimals=None, base_label=None, cache=None)¶
A customizable string representation of the operator.
- Parameters:
decimals=None (int) – If
None, no parameters are included. Else, specifies how to round the parameters.base_label=None (str) – overwrite the non-parameter component of the label
cache=None (dict) – dictionary that carries information between label calls in the same drawing
- Returns:
label to use in drawings
- Return type:
str
Example:
>>> op = qp.RX(1.23456, wires=0) >>> op.label() 'RX' >>> op.label(base_label="my_label") 'my_label' >>> op = qp.RX(1.23456, wires=0) >>> op.label() 'RX' >>> op.label(decimals=2) 'RX\n(1.23)' >>> op.label(base_label="my_label") 'my_label' >>> op.label(decimals=2, base_label="my_label") 'my_label\n(1.23)'
Note that by default, operator wires and static inputs are not included in the label. To override this behaviour,
Operator2subclasses must override thelabelmethod.If the operation has a matrix-valued parameter and a cache dictionary is provided, unique matrices will be cached in the
'matrices'key list. The label will contain the index of the matrix in the'matrices'list.>>> op2 = qp.QubitUnitary(np.eye(2), wires=0) >>> cache = {'matrices': []} >>> op2.label(cache=cache) 'U\n(M0)' >>> cache['matrices'] [array([[1., 0.], [0., 1.]])] >>> op3 = qp.QubitUnitary(np.eye(4), wires=(0,1)) >>> op3.label(cache=cache) 'U\n(M1)' >>> cache['matrices'] [array([[1., 0.], [0., 1.]]), array([[1., 0., 0., 0.], [0., 1., 0., 0.], [0., 0., 1., 0.], [0., 0., 0., 1.]])]
- map_wires(wire_map)¶
Returns a new 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:
.Operator2
- matrix(wire_order=None)¶
Representation of the operator as a matrix in the computational basis.
If
wire_orderis 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.If the matrix depends on trainable parameters, the result will be cast in the same autodifferentiation framework as the parameters.
A
MatrixUndefinedErroris raised if the matrix representation has not been defined.See also
- Parameters:
wire_order (Iterable) – global wire order, must contain all wire labels from the operator’s wires
- Returns:
matrix representation
- Return type:
tensor_like
- pow(z)¶
A list of new operators equal to this one raised to the given power. This method is used to simplify
Powinstances created bypow()orop ** power. TODO: [sc-120843] Fix docstring after Pow is addedOperator2.powcan be optionally defined by Operator developers, whilepow()orop ** powerare the entry point for constructing generic powers to exponents.- Parameters:
z (float) – exponent for the operator
- Returns:
list[
Operator2]
>>> from pennylane.core.operator import Operator2 >>> class MyClass(Operator2): ... dynamic_argnames = ("phi",) ... ... def __init__(self, phi, wires): ... super().__init__(phi, wires) ... ... def pow(self, z): ... return [MyClass(self.phi*z, self.wires)] ... >>> MyClass(0.5, 0).pow(2) [MyClass(1.0, wires=[0])]
- queue(context=<class 'pennylane.core.queuing.QueuingManager'>)¶
Append the operator to the Operator queue.
- simplify()¶
Reduce the depth of nested operators to the minimum.
- Returns:
simplified operator
- Return type:
.Operator2
- sparse_matrix(wire_order=None, format='csr')¶
Representation of the operator as a sparse matrix in the computational basis.
If
wire_orderis 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
SparseMatrixUndefinedErroris raised if the sparse matrix representation has not been defined.See also
- Parameters:
wire_order (Iterable) – global wire order, must contain all wire labels from the operator’s wires
format (str) – format of the returned scipy sparse matrix, for example ‘csr’
- 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
TermsUndefinedErroris 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[.Operator2]]