Struct PauliLindbladOpenSystemWrapper

pub struct PauliLindbladOpenSystemWrapper {
    pub internal: PauliLindbladOpenSystem,
}

These are representations of noisy systems of spins.

In a PauliLindbladOpenSystem is characterized by a SpinLindbladOpenOperator to represent the hamiltonian of the system, and an optional number of spins.

Returns: SpinLindbladOpenSystem: The new SpinLindbladOpenSystem.

Examples

.. code-block:: python

import numpy.testing as npt
import scipy.sparse as sp
from qoqo_calculator_pyo3 import CalculatorComplex, CalculatorFloat
from struqture_py.spins import PauliLindbladOpenSystem, DecoherenceProduct

slns = PauliLindbladOpenSystem()
dp = DecoherenceProduct().z(0).x(1)
slns.system_add_operator_product(dp, 2.0)
npt.assert_equal(slns.current_number_spins(), 2)
npt.assert_equal(slns.system().get(dp), CalculatorFloat(2))
dimension = 4**slns.current_number_spins()
matrix = sp.coo_matrix(slns.sparse_matrix_superoperator_coo(slns.current_number_spins()), shape=(dimension, dimension))

Fields

internal: PauliLindbladOpenSystem

Internal storage of struqture::spins::PauliLindbladOpenSystem

Implementations

impl PauliLindbladOpenSystemWrapper

pub fn from_pyany(input: &Bound<'_, PyAny>) -> PyResult<PauliLindbladOpenSystem>

Fallible conversion of generic python object..

impl PauliLindbladOpenSystemWrapper

pub fn new() -> Self

Create a new PauliLindbladOpenSystem.

Returns: PauliLindbladOpenSystem: The new PauliLindbladOpenSystem.

pub fn current_number_spins(&self) -> usize

Return the current_number_spins input of self.

Returns: int: The number of spins in self.

pub fn number_spins(&self) -> usize

Return maximum index in self.

Returns: int: Maximum index.

pub fn system(&self) -> PauliHamiltonianWrapper

Return the system part of self.

Returns: System type: The system of self.

pub fn noise(&self) -> PauliLindbladNoiseOperatorWrapper

Return the noise part of self.

Returns: Noise type: The noise of self.

pub fn ungroup( &self, ) -> (PauliHamiltonianWrapper, PauliLindbladNoiseOperatorWrapper)

Return a tuple of the system and the noise of self.

Returns: (System, Noise): The system and noise of self.

pub fn group( system: &Bound<'_, PyAny>, noise: &Bound<'_, PyAny>, ) -> PyResult<Self>

Take a tuple of a system term and a noise term and combines them to be a OpenSystem.

Args: system: The system to have in the new instance. noise: The noise to have in the new instance.

Returns: self: The OpenSystem with input system and noise terms.

Raises: ValueError: System could not be constructed. ValueError: Noise could not be constructed. ValueError: Grouping could not be constructed.

pub fn empty_clone(&self) -> PauliLindbladOpenSystemWrapper

Return an instance of self that has no entries but clones all other properties, with the given capacity.

Returns: self: An empty clone with the same properties as self, with the given capacity.

pub fn truncate(&self, threshold: f64) -> PauliLindbladOpenSystemWrapper

Truncate self by returning a copy without entries under a threshold.

Args: threshold: The threshold for inclusion.

Returns: self: The truncated version of self.

pub fn system_set( &mut self, key: &Bound<'_, PyAny>, value: &Bound<'_, PyAny>, ) -> PyResult<PauliLindbladOpenSystemWrapper>

Set a new entry in the system of the open system.

Args: key (Product type): Product key of set object. value (Union[CalculatorComplex, CalculatorFloat]): Value of set object.

Returns: OpenSystem: The OpenSystem with the new entry.

Raises: ValueError: key element cannot be converted to product. TypeError: Value cannot be converted to Union[CalculatorComplex, CalculatorFloat].

pub fn noise_set( &mut self, key: (Py<PyAny>, Py<PyAny>), value: &Bound<'_, PyAny>, ) -> PyResult<PauliLindbladOpenSystemWrapper>

Set a new entry in the noise of the open system.

Args: key (Tuple[Product type, Product type]): Tuple of Products of set object. value (CalculatorComplex): CalculatorComplex value of set object.

Returns: OpenSystem: The OpenSystem with the new entry.

Raises: ValueError: Left key element cannot be converted to product. ValueError: Right key element cannot be converted to product. TypeError: Value cannot be converted to Union[CalculatorComplex, CalculatorFloat].

pub fn system_get( &mut self, key: &Bound<'_, PyAny>, ) -> PyResult<CalculatorFloatWrapper>

Get the CalculatorComplex or CalculatorFloat coefficient corresponding to the key.

Args: key (Product type): Product key of set object.

Returns: CalculatorComplex or CalculatorFloat: Value at key (or 0.0).

Raises: ValueError: key element cannot be converted to product.

pub fn noise_get( &mut self, key: (Py<PyAny>, Py<PyAny>), ) -> PyResult<CalculatorComplexWrapper>

Get the CalculatorComplex coefficient corresponding to the key.

Args: key (Tuple[Product type, Product type]): Tuple of Products of set object.

Returns: CalculatorComplex: Value at key (or 0.0).

Raises: ValueError: Left key element cannot be converted to product. ValueError: Right key element cannot be converted to product.

pub fn system_add_operator_product( &mut self, key: &Bound<'_, PyAny>, value: &Bound<'_, PyAny>, ) -> PyResult<PauliLindbladOpenSystemWrapper>

Add a new entry to the system of the open system.

Args: key (Product type): Product key of set object. value (Union[CalculatorComplex, CalculatorFloat]): Value of set object.

Returns: OpenSystem: The OpenSystem with the new entry.

Raises: ValueError: key element cannot be converted to product. TypeError: Value cannot be converted to Union[CalculatorComplex, CalculatorFloat].

pub fn noise_add_operator_product( &mut self, key: (Py<PyAny>, Py<PyAny>), value: &Bound<'_, PyAny>, ) -> PyResult<PauliLindbladOpenSystemWrapper>

Add a new entry to the system of the open system.

Args: key (Tuple[Product type, Product type]): Tuple of Products of set object. value (CalculatorComplex): Value of set object.

Returns: OpenSystem: The OpenSystem with the new entry.

Raises: ValueError: Left key element cannot be converted to product. ValueError: Right key element cannot be converted to product. TypeError: Value cannot be converted to CalculatorComplex.

pub fn __mul__( &self, value: &Bound<'_, PyAny>, ) -> PyResult<PauliLindbladOpenSystemWrapper>

Implement * for self and CalculatorFloat.

Args: value (CalculatorFloat): value by which to multiply self by.

Returns: self: The object multiplied by the value.

Raises: ValueError: The rhs of the multiplication cannot be converted to CalculatorFloat.

pub fn sparse_matrix_superoperator_coo( &self, number_spins: usize, ) -> PyResult<PyCooMatrix>

Construct the sparse matrix representation of the superoperator in COO representation.

The superoperator for the operator O is defined as the Matrix S so that flatten(-i [O, p]) = S flatten(p) wher [,] is the commutator, p is a matrix and flatten flattens a matrix into a vector in row-major form.

Args: number_spins (int): The number of spins in self.

Returns: Tuple[np.ndarray, Tuple[np.ndarray, np.ndarray]]: The matrix little endian representation of self.

Raises: ValueError: CalculatorError. RuntimeError: Could not convert to complex superoperator matrix.

pub fn __neg__(&self) -> PauliLindbladOpenSystemWrapper

Implement -1 for self.

Returns: self: The object * -1.

pub fn __add__( &self, other: PauliLindbladOpenSystemWrapper, ) -> PyResult<PauliLindbladOpenSystemWrapper>

Implement + for self with self-type.

Args: other (self): value by which to add to self.

Returns: self: The two objects added.

Raises: ValueError: Objects could not be added.

pub fn __sub__( &self, other: PauliLindbladOpenSystemWrapper, ) -> PyResult<PauliLindbladOpenSystemWrapper>

Implement - for self with self-type.

Args: other (self): value by which to subtract from self.

Returns: self: The two objects subtracted.

Raises: ValueError: Objects could not be subtracted.

pub fn __copy__(&self) -> PauliLindbladOpenSystemWrapper

Return a copy (copy here produces a deepcopy).

Returns: Operator: A deep copy of self.

pub fn __deepcopy__( &self, _memodict: Py<PyAny>, ) -> PauliLindbladOpenSystemWrapper

Return a deep copy .

Returns: Operator: A deep copy of self.

pub fn from_bincode( input: &Bound<'_, PyAny>, ) -> PyResult<PauliLindbladOpenSystemWrapper>

Convert the bincode representation of the object to an instance using the bincode crate.

Args: input (bytearray): The serialized object (in bincode form).

Returns: The deserialized object.

Raises: TypeError: Input cannot be converted to byte array. ValueError: Input cannot be deserialized.

pub fn to_bincode(&self) -> PyResult<Py<PyByteArray>>

Return the bincode representation of the object using the bincode crate.

Returns: bytearray: The serialized object (in bincode form).

Raises: ValueError: Cannot serialize object to bytes.

pub fn to_json(&self) -> PyResult<String>

Return the json representation of the object.

Returns: str: The serialized form of the object.

Raises: ValueError: Cannot serialize object to json.

pub fn from_json(input: String) -> PyResult<PauliLindbladOpenSystemWrapper>

Convert the json representation of the object to an instance.

Args: input (str): The serialized object in json form.

Returns: The deserialized object.

Raises: ValueError: Input cannot be deserialized.

pub fn __str__(&self) -> String

Return a string containing a printable representation of self.

Returns: str: The printable string representation of self.

pub fn __repr__(&self) -> String

Return a string containing a printable representation of self.

Returns: str: The printable string representation of self.

pub fn __richcmp__( &self, other: &Bound<'_, PyAny>, op: CompareOp, ) -> PyResult<bool>

Return the richcmp magic method to perform rich comparison operations on object.

Args: other: The object to compare self to. op: Whether they should be equal or not.

Returns: Whether the two operations compared evaluated to True or False

Raises: NotImplementedError: Other comparison not implemented.

impl PauliLindbladOpenSystemWrapper

pub fn jordan_wigner(&self) -> FermionLindbladOpenSystemWrapper

Transform the given spin object into a fermionic object using the Jordan Wigner mapping.

Trait Implementations

impl Clone for PauliLindbladOpenSystemWrapper

fn clone(&self) -> PauliLindbladOpenSystemWrapper

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PauliLindbladOpenSystemWrapper

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PauliLindbladOpenSystemWrapper

fn default() -> PauliLindbladOpenSystemWrapper

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for PauliLindbladOpenSystemWrapper

type Target = PauliLindbladOpenSystemWrapper

The Python output type

type Output = Bound<'py, <PauliLindbladOpenSystemWrapper as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for PauliLindbladOpenSystemWrapper

fn eq(&self, other: &PauliLindbladOpenSystemWrapper) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for PauliLindbladOpenSystemWrapper

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PauliLindbladOpenSystemWrapper

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PauliLindbladOpenSystemWrapper>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPauliLindbladOpenSystemWrapper

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<PauliLindbladOpenSystemWrapper> for PyClassImplCollector<PauliLindbladOpenSystemWrapper>

fn new_text_signature(self) -> Option<&'static str>

impl PyClass__add__SlotFragment<PauliLindbladOpenSystemWrapper> for PyClassImplCollector<PauliLindbladOpenSystemWrapper>

unsafe fn __add__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__mul__SlotFragment<PauliLindbladOpenSystemWrapper> for PyClassImplCollector<PauliLindbladOpenSystemWrapper>

unsafe fn __mul__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl PyClass__sub__SlotFragment<PauliLindbladOpenSystemWrapper> for PyClassImplCollector<PauliLindbladOpenSystemWrapper>

unsafe fn __sub__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a PauliLindbladOpenSystemWrapper

type Holder = Option<PyRef<'py, PauliLindbladOpenSystemWrapper>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut PauliLindbladOpenSystemWrapper

type Holder = Option<PyRefMut<'py, PauliLindbladOpenSystemWrapper>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyTypeInfo for PauliLindbladOpenSystemWrapper

const NAME: &'static str = "PauliLindbladOpenSystem"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for PauliLindbladOpenSystemWrapper

impl StructuralPartialEq for PauliLindbladOpenSystemWrapper