267 lines
11 KiB
Plaintext
267 lines
11 KiB
Plaintext
---
|
||
title: ScalarOp (v1.2)
|
||
description: API reference for qiskit.quantum_info.ScalarOp in qiskit v1.2
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.quantum_info.ScalarOp
|
||
---
|
||
|
||
# ScalarOp
|
||
|
||
<Class id="qiskit.quantum_info.ScalarOp" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L29-L250" signature="qiskit.quantum_info.ScalarOp(dims=None, coeff=1)" modifiers="class">
|
||
Bases: `LinearOp`
|
||
|
||
Scalar identity operator class.
|
||
|
||
This is a symbolic representation of an scalar identity operator on multiple subsystems. It may be used to initialize a symbolic scalar multiplication of an identity and then be implicitly converted to other kinds of operator subclasses by using the [`compose()`](#qiskit.quantum_info.ScalarOp.compose "qiskit.quantum_info.ScalarOp.compose"), [`dot()`](#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot"), [`tensor()`](#qiskit.quantum_info.ScalarOp.tensor "qiskit.quantum_info.ScalarOp.tensor"), [`expand()`](#qiskit.quantum_info.ScalarOp.expand "qiskit.quantum_info.ScalarOp.expand") methods.
|
||
|
||
Initialize an operator object.
|
||
|
||
**Parameters**
|
||
|
||
* **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – subsystem dimensions.
|
||
* **coeff** (*Number*) – scalar coefficient for the identity operator (Default: 1).
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – If the optional coefficient is invalid.
|
||
|
||
## Attributes
|
||
|
||
### atol
|
||
|
||
<Attribute id="qiskit.quantum_info.ScalarOp.atol" attributeValue="1e-08" />
|
||
|
||
### coeff
|
||
|
||
<Attribute id="qiskit.quantum_info.ScalarOp.coeff">
|
||
Return the coefficient
|
||
</Attribute>
|
||
|
||
### dim
|
||
|
||
<Attribute id="qiskit.quantum_info.ScalarOp.dim">
|
||
Return tuple (input\_shape, output\_shape).
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.quantum_info.ScalarOp.num_qubits">
|
||
Return the number of qubits if a N-qubit operator or None otherwise.
|
||
</Attribute>
|
||
|
||
### qargs
|
||
|
||
<Attribute id="qiskit.quantum_info.ScalarOp.qargs">
|
||
Return the qargs for the operator.
|
||
</Attribute>
|
||
|
||
### rtol
|
||
|
||
<Attribute id="qiskit.quantum_info.ScalarOp.rtol" attributeValue="1e-05" />
|
||
|
||
## Methods
|
||
|
||
### adjoint
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.adjoint" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/mixins/adjoint.py#L42-L44" signature="adjoint()">
|
||
Return the adjoint of the Operator.
|
||
|
||
**Return type**
|
||
|
||
*Self*
|
||
</Function>
|
||
|
||
### compose
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.compose" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L97-L132" signature="compose(other, qargs=None, front=False)">
|
||
Return the operator composition with another ScalarOp.
|
||
|
||
**Parameters**
|
||
|
||
* **other** ([*ScalarOp*](#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – a ScalarOp object.
|
||
* **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None).
|
||
* **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False].
|
||
|
||
**Returns**
|
||
|
||
The composed ScalarOp.
|
||
|
||
**Return type**
|
||
|
||
[ScalarOp](#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems.
|
||
|
||
<Admonition title="Note" type="note">
|
||
Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while `@` (equivalent to [`dot()`](#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot")) is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B @ A == B.dot(A)` when `A` and `B` are of the same type.
|
||
|
||
Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot") method `A.dot(B) == A.compose(B, front=True)`.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### conjugate
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.conjugate" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L69-L72" signature="conjugate()">
|
||
Return the conjugate of the ScalarOp.
|
||
</Function>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/base_operator.py#L143-L145" signature="copy()">
|
||
Make a deep copy of current operator.
|
||
</Function>
|
||
|
||
### dot
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.dot" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/mixins/group.py#L133-L149" signature="dot(other, qargs=None)">
|
||
Return the right multiplied operator self \* other.
|
||
|
||
**Parameters**
|
||
|
||
* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object.
|
||
* **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None).
|
||
|
||
**Returns**
|
||
|
||
The right matrix multiplied Operator.
|
||
|
||
**Return type**
|
||
|
||
[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")
|
||
|
||
<Admonition title="Note" type="note">
|
||
The dot product can be obtained using the `@` binary operator. Hence `a.dot(b)` is equivalent to `a @ b`.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### expand
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.expand" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L159-L169" signature="expand(other)">
|
||
Return the reverse-order tensor product with another ScalarOp.
|
||
|
||
**Parameters**
|
||
|
||
**other** ([*ScalarOp*](#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – a ScalarOp object.
|
||
|
||
**Returns**
|
||
|
||
**the tensor product $b \otimes a$, where $a$**
|
||
|
||
is the current ScalarOp, and $b$ is the other ScalarOp.
|
||
|
||
**Return type**
|
||
|
||
[ScalarOp](#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")
|
||
</Function>
|
||
|
||
### input\_dims
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.input_dims" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/base_operator.py#L135-L137" signature="input_dims(qargs=None)">
|
||
Return tuple of input dimension for specified subsystems.
|
||
</Function>
|
||
|
||
### is\_unitary
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.is_unitary" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L77-L83" signature="is_unitary(atol=None, rtol=None)">
|
||
Return True if operator is a unitary matrix.
|
||
</Function>
|
||
|
||
### output\_dims
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.output_dims" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/base_operator.py#L139-L141" signature="output_dims(qargs=None)">
|
||
Return tuple of output dimension for specified subsystems.
|
||
</Function>
|
||
|
||
### power
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.power" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L134-L145" signature="power(n)">
|
||
Return the power of the ScalarOp.
|
||
|
||
**Parameters**
|
||
|
||
**n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the exponent for the scalar op.
|
||
|
||
**Returns**
|
||
|
||
the `coeff ** n` ScalarOp.
|
||
|
||
**Return type**
|
||
|
||
[ScalarOp](#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")
|
||
</Function>
|
||
|
||
### reshape
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.reshape" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/base_operator.py#L106-L133" signature="reshape(input_dims=None, output_dims=None, num_qubits=None)">
|
||
Return a shallow copy with reshaped input and output subsystem dimensions.
|
||
|
||
**Parameters**
|
||
|
||
* **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None].
|
||
* **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None].
|
||
* **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None].
|
||
|
||
**Returns**
|
||
|
||
returns self with reshaped input and output dimensions.
|
||
|
||
**Return type**
|
||
|
||
BaseOperator
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if combined size of all subsystem input dimension or subsystem output dimensions is not constant.
|
||
</Function>
|
||
|
||
### tensor
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.tensor" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L147-L157" signature="tensor(other)">
|
||
Return the tensor product with another ScalarOp.
|
||
|
||
**Parameters**
|
||
|
||
**other** ([*ScalarOp*](#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – a ScalarOp object.
|
||
|
||
**Returns**
|
||
|
||
**the tensor product $a \otimes b$, where $a$**
|
||
|
||
is the current ScalarOp, and $b$ is the other ScalarOp.
|
||
|
||
**Return type**
|
||
|
||
[ScalarOp](#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")
|
||
|
||
<Admonition title="Note" type="note">
|
||
The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### to\_matrix
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.to_matrix" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L85-L89" signature="to_matrix()">
|
||
Convert to a Numpy matrix.
|
||
</Function>
|
||
|
||
### to\_operator
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.to_operator" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L91-L95" signature="to_operator()">
|
||
Convert to an Operator object.
|
||
|
||
**Return type**
|
||
|
||
[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.operators.operator.Operator")
|
||
</Function>
|
||
|
||
### transpose
|
||
|
||
<Function id="qiskit.quantum_info.ScalarOp.transpose" github="https://github.com/Qiskit/qiskit/tree/stable/1.2/qiskit/quantum_info/operators/scalar_op.py#L74-L75" signature="transpose()">
|
||
Return the transpose of the ScalarOp.
|
||
</Function>
|
||
</Class>
|
||
|