Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

Stinespring

class Stinespring(data, input_dims=None, output_dims=None)

GitHub(opens in a new tab)

Bases: qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel

Stinespring representation of a quantum channel.

The Stinespring representation of a quantum channel E\mathcal{E} is a rectangular matrix AA such that the evolution of a DensityMatrix ρ\rho is given by

E(ρ)=Tr2[AρA]\mathcal{E}(ρ) = \text{Tr}_2\left[A ρ A^\dagger\right]

where Tr2\text{Tr}_2 is the partial_trace() over subsystem 2.

A general operator map G\mathcal{G} can also be written using the generalized Stinespring representation which is given by two matrices AA, BB such that

G(ρ)=Tr2[AρB]\mathcal{G}(ρ) = \text{Tr}_2\left[A ρ B^\dagger\right]

See reference [1] for further details.

References

  1. C.J. Wood, J.D. Biamonte, D.G. Cory, Tensor networks and graphical calculus for open quantum systems, Quant. Inf. Comp. 15, 0579-0811 (2015). arXiv:1111.6950 [quant-ph](opens in a new tab)

Initialize a quantum channel Stinespring operator.

Parameters

  • or (data (QuantumCircuit) – Instruction or BaseOperator or matrix): data to initialize superoperator.
  • input_dims (tuple) – the input subsystem dimensions. [Default: None]
  • output_dims (tuple) – the output subsystem dimensions. [Default: None]

Raises

QiskitError – if input data cannot be initialized as a a list of Kraus matrices.

Additional Information:

If the input or output dimensions are None, they will be automatically determined from the input data. This can fail for the Stinespring operator if the output dimension cannot be automatically determined.


Methods

adjoint

Stinespring.adjoint()

Return the adjoint quantum channel.

Note

This is equivalent to the matrix Hermitian conjugate in the SuperOp representation ie. for a channel E\mathcal{E}, the SuperOp of the adjoint channel E\mathcal{{E}}^\dagger is SE=SES_{\mathcal{E}^\dagger} = S_{\mathcal{E}}^\dagger.

compose

Stinespring.compose(other, qargs=None, front=False)

Return the operator composition with another Stinespring.

Parameters

  • other (Stinespring) – a Stinespring object.
  • qargs (list or None) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None).
  • front (bool) – If True compose using right operator multiplication, instead of left multiplication [default: False].

Returns

The composed Stinespring.

Return type

Stinespring

Raises

QiskitError – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems.

Note

Composition (&) by default is defined as left matrix multiplication for matrix operators, while @ (equivalent to 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() method A.dot(B) == A.compose(B, front=True).

conjugate

Stinespring.conjugate()

Return the conjugate quantum channel.

Note

This is equivalent to the matrix complex conjugate in the SuperOp representation ie. for a channel E\mathcal{E}, the SuperOp of the conjugate channel E\overline{{\mathcal{{E}}}} is SE=SES_{\overline{\mathcal{E}^\dagger}} = \overline{S_{\mathcal{E}}}.

copy

Stinespring.copy()

Make a deep copy of current operator.

dot

Stinespring.dot(other, qargs=None)

Return the right multiplied operator self * other.

Parameters

  • other (Operator) – an operator object.
  • qargs (list 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

Note

The dot product can be obtained using the @ binary operator. Hence a.dot(b) is equivalent to a @ b.

expand

Stinespring.expand(other)

Return the reverse-order tensor product with another Stinespring.

Parameters

other (Stinespring) – a Stinespring object.

Returns

the tensor product bab \otimes a, where aa

is the current Stinespring, and bb is the other Stinespring.

Return type

Stinespring

input_dims

Stinespring.input_dims(qargs=None)

Return tuple of input dimension for specified subsystems.

is_cp

Stinespring.is_cp(atol=None, rtol=None)

Test if Choi-matrix is completely-positive (CP)

is_cptp

Stinespring.is_cptp(atol=None, rtol=None)

Return True if completely-positive trace-preserving.

is_tp

Stinespring.is_tp(atol=None, rtol=None)

Test if a channel is trace-preserving (TP)

is_unitary

Stinespring.is_unitary(atol=None, rtol=None)

Return True if QuantumChannel is a unitary channel.

output_dims

Stinespring.output_dims(qargs=None)

Return tuple of output dimension for specified subsystems.

power

Stinespring.power(n)

Return the power of the quantum channel.

Parameters

n (float) – the power exponent.

Returns

the channel En\mathcal{{E}} ^n.

Return type

SuperOp

Raises

QiskitError – if the input and output dimensions of the SuperOp are not equal.

Note

For non-positive or non-integer exponents the power is defined as the matrix power of the SuperOp representation ie. for a channel E\mathcal{{E}}, the SuperOp of the powered channel En\mathcal{{E}}^n is SEn=SEnS_{{\mathcal{{E}}^n}} = S_{{\mathcal{{E}}}}^n.

reshape

Stinespring.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) – new subsystem input dimensions. If None the original input dims will be preserved [Default: None].
  • output_dims (None or tuple) – new subsystem output dimensions. If None the original output dims will be preserved [Default: None].
  • num_qubits (None or int) – reshape to an N-qubit operator [Default: None].

Returns

returns self with reshaped input and output dimensions.

Return type

BaseOperator

Raises

QiskitError – if combined size of all subsystem input dimension or subsystem output dimensions is not constant.

tensor

Stinespring.tensor(other)

Return the tensor product with another Stinespring.

Parameters

other (Stinespring) – a Stinespring object.

Returns

the tensor product aba \otimes b, where aa

is the current Stinespring, and bb is the other Stinespring.

Return type

Stinespring

Note

The tensor product can be obtained using the ^ binary operator. Hence a.tensor(b) is equivalent to a ^ b.

to_instruction

Stinespring.to_instruction()

Convert to a Kraus or UnitaryGate circuit instruction.

If the channel is unitary it will be added as a unitary gate, otherwise it will be added as a kraus simulator instruction.

Returns

A kraus instruction for the channel.

Return type

qiskit.circuit.Instruction

Raises

QiskitError – if input data is not an N-qubit CPTP quantum channel.

to_operator

Stinespring.to_operator()

Try to convert channel to a unitary representation Operator.

transpose

Stinespring.transpose()

Return the transpose quantum channel.

Note

This is equivalent to the matrix transpose in the SuperOp representation, ie. for a channel E\mathcal{E}, the SuperOp of the transpose channel ET\mathcal{{E}}^T is SmathcalET=SETS_{mathcal{E}^T} = S_{\mathcal{E}}^T.


Attributes

atol

Default value: 1e-08

data

dim

Return tuple (input_shape, output_shape).

num_qubits

Return the number of qubits if a N-qubit operator or None otherwise.

qargs

Return the qargs for the operator.

rtol

Default value: 1e-05

settings

Return settings.

Was this page helpful?
Report a bug or request content on GitHub.