Struct PauliProductWrapper

pub struct PauliProductWrapper {
    pub internal: PauliProduct,
}

PauliProducts are combinations of SinglePauliOperators on specific qubits.

PauliProducts can be used in either noise-free or a noisy system. They are representations of products of pauli matrices acting on qubits, in order to build the terms of a hamiltonian. For instance, to represent the term :math:\sigma_0^{x} :math:\sigma_2^{x} :

PauliProduct().x(0).x(2).

Note that these methods are setters that set the Pauli operator acting on the corresponding spin, and do not represent matrix multiplication. For example

PauliProduct().z(0).z(0)

will set the Pauli operator on spin 0 to Z and not to the identity.

PauliProduct is supposed to be used as input for the function set_pauli_product, for instance in the spin system classes PauliLindbladOpenSystem, PauliHamiltonian or PauliOperator, or in the mixed systems as part of MixedProduct <mixed_systems.MixedProduct> or as part of HermitianMixedProduct <mixed_systems.HermitianMixedProduct>.

Returns:

self: The new, empty PauliProduct.

Examples

.. code-block:: python

import numpy.testing as npt
from struqture_py.spins import PauliProduct
pp = PauliProduct().x(0).y(1).z(2)
pp = pp.set_pauli(3, "X")
npt.assert_equal(pp.get(0), "X")
npt.assert_equal(pp.keys(), [0, 1, 2, 3])

Fields

internal: PauliProduct

Internal storage of struqture::spins::PauliProduct

Implementations

impl PauliProductWrapper

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

Fallible conversion of generic python object..

impl PauliProductWrapper

pub fn new() -> Self

Create an empty PauliProduct.

Returns: self: The new, empty PauliProduct.

pub fn x(&self, index: usize) -> PauliProductWrapper

Set a new entry for SinglePauliOperator X in the internal dictionary.

Args: index (int): Index of set object.

Returns: PauliProduct: The PauliProduct with the new entry.

pub fn y(&self, index: usize) -> PauliProductWrapper

Set a new entry for SinglePauliOperator Y in the internal dictionary.

Args: index (int): Index of set object.

Returns: PauliProduct: The PauliProduct with the new entry.

pub fn z(&self, index: usize) -> PauliProductWrapper

Set a new entry for SinglePauliOperator Z in the internal dictionary.

Args: index (int): Index of set object.

Returns: PauliProduct: The PauliProduct with the new entry.

pub fn set_pauli(&self, index: usize, pauli: String) -> PyResult<Self>

Set a new entry in the internal_map. This function consumes self.

Args: index (int): Index of set object. pauli (str): Value of set object.

Returns: self: The entry was correctly set and the PauliProduct is returned.

pub fn hermitian_conjugate(&self) -> (PauliProductWrapper, f64)

Return the hermitian conjugate of self and its prefactor.

Returns: (self, float): The hermitian conjugate of self and the potential sign it has picked up.

pub fn is_natural_hermitian(&self) -> bool

Return whether self is naturally hermitian.

For spin objects, this is true when applying the hermitian conjugation does not change the sign. For bosonic and fermionic objects, this is true when creators == annihilators. For mixed objects, this is true when all of the spin, bosonic and fermionic parts’ is_naturally_hermitian functions evaluate to true.

Returns: bool: Whether self is naturally hermitian or not.

pub fn get(&self, index: usize) -> Option<String>

Get the pauli matrix corresponding to the index.

Args: index (int): Index of get object.

Returns: Optionalstr: The key’s corresponding value (if it exists).

pub fn keys(&self) -> Vec<usize>

Return a list of the unsorted keys in self.

Returns: List[int]: The sequence of qubit index keys of self.

pub fn current_number_spins(&self) -> usize

Return maximum index in self.

Returns: int: Maximum index.

pub fn __len__(&self) -> usize

Return number of entries in object.

Returns: int: The length of the content of the object.

pub fn is_empty(&self) -> bool

Return whether self is empty or not.

Returns: bool: Whether self is empty or not.

pub fn remap_qubits( &self, mapping: HashMap<usize, usize>, ) -> PauliProductWrapper

Remap the qubits in a new instance of self (returned).

Args: mapping (Dict[int, int]): The map containing the {qubit: qubit} mapping to use.

Returns: self: The new instance of self with the qubits remapped.

pub fn concatenate( &self, other: PauliProductWrapper, ) -> PyResult<PauliProductWrapper>

Return the concatenation of two objects of type self with no overlapping qubits.

Args: other (self): The object to concatenate self with.

Returns: List[int]: A list of the corresponding creator indices.

Raises: ValueError: The two objects could not be concatenated.

pub fn multiply( left: PauliProductWrapper, right: PauliProductWrapper, ) -> (PauliProductWrapper, Complex64)

Multiplication function for a self-typed object by a self-typed object.

Args: left (self): Left-hand self typed object to be multiplied. right (self): Right-hand self typed object to be multiplied.

Returns: (self, complex): The multiplied objects and the resulting prefactor.

pub fn __copy__(&self) -> PauliProductWrapper

Return a copy of self (copy here produces a deepcopy).

Returns: self: A deep copy of Self.

pub fn __deepcopy__(&self, _memodict: &Bound<'_, PyAny>) -> PauliProductWrapper

Return a deep copy of self.

Returns: self: A deep copy of Self.

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

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 Spin System.

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<PauliProductWrapper>

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 from_string(input: String) -> PyResult<PauliProductWrapper>

Convert a string representation of the object to an instance.

Args: input (str): The serialized index in str representation.

Returns: self: The converted object.

Raises: ValueError: Input cannot be converted from str.

pub fn __str__(&self) -> String

Return a string containing a printable representation of the index.

Returns: str: The printable string representation of the index.

pub fn __repr__(&self) -> String

Return a string containing a printable representation of the index.

Returns: str: The printable string representation of the index.

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

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

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.

pub fn __hash__(&self) -> PyResult<isize>

Return the hash magic method.

Returns: integer: Hash

impl PauliProductWrapper

pub fn jordan_wigner(&self) -> FermionOperatorWrapper

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

Trait Implementations

impl Clone for PauliProductWrapper

fn clone(&self) -> PauliProductWrapper

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PauliProductWrapper

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

Formats the value using the given formatter.

impl Default for PauliProductWrapper

fn default() -> PauliProductWrapper

Returns the “default value” for a type.

impl Hash for PauliProductWrapper

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'py> IntoPyObject<'py> for PauliProductWrapper

type Target = PauliProductWrapper

The Python output type

type Output = Bound<'py, <PauliProductWrapper 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 Ord for PauliProductWrapper

fn cmp(&self, other: &PauliProductWrapper) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PauliProductWrapper

fn eq(&self, other: &PauliProductWrapper) -> 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 PartialOrd for PauliProductWrapper

fn partial_cmp(&self, other: &PauliProductWrapper) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PyClass for PauliProductWrapper

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PauliProductWrapper

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<PauliProductWrapper>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPauliProductWrapper

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<PauliProductWrapper> for PyClassImplCollector<PauliProductWrapper>

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

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

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

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

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

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

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

impl PyTypeInfo for PauliProductWrapper

const NAME: &'static str = "PauliProduct"

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 PauliProductWrapper

impl Eq for PauliProductWrapper

impl StructuralPartialEq for PauliProductWrapper