Struct FermionOperatorWrapper

pub struct FermionOperatorWrapper {
    pub internal: FermionOperator,
}

These are representations of systems of fermions.

FermionOperators are characterized by a FermionOperator to represent the hamiltonian of the spin system and an optional number of fermions.

Returns: self: The new FermionSystem with the input number of fermions.

Examples

.. code-block:: python

import numpy.testing as npt
import scipy.sparse as sp
from qoqo_calculator_pyo3 import CalculatorComplex
from struqture_py.fermions import FermionOperator, FermionProduct

system = FermionOperator()
pp = FermionProduct([0], [0])
system.add_operator_product(pp, 5.0)
npt.assert_equal(system.current_number_modes(), 1)
npt.assert_equal(system.get(pp), CalculatorComplex(5))
npt.assert_equal(system.keys(), [pp])

Fields

internal: FermionOperator

Internal storage of struqture::fermions::FermionOperator

Implementations

impl FermionOperatorWrapper

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

Fallible conversion of generic python object.

impl FermionOperatorWrapper

pub fn new() -> Self

Create an empty FermionOperator.

Returns: self: The new FermionOperator with the input number of fermions.

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

Implement * for FermionOperator and FermionOperator/CalculatorComplex/CalculatorFloat.

Args: value (Union[FermionOperator, CalculatorComplex, CalculatorFloat]): value by which to multiply the self FermionOperator

Returns: FermionOperator: The FermionOperator multiplied by the value.

Raises: ValueError: The rhs of the multiplication is neither CalculatorFloat, CalculatorComplex, nor FermionOperator.

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

Return a list of the unsorted keys in self.

Returns: List[OperatorProduct]: The sequence of keys of the self.

pub fn __len__(&self) -> usize

Return number of entries in self.

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

pub fn empty_clone(&self, capacity: Option<usize>) -> FermionOperatorWrapper

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

Args: capacity (Optional[int]): The capacity of the new instance to create.

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

pub fn is_empty(&self) -> bool

Return true if self contains no values.

Returns: bool: Whether self is empty or not.

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

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

Args: threshold (float): The threshold for inclusion.

Returns: self: The truncated version of self.

pub fn get(&self, key: &Bound<'_, PyAny>) -> PyResult<CalculatorComplexWrapper>

Get the coefficient corresponding to the key.

Args: key: Product to get the value of.

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

Raises: ValueError: Product could not be constructed from key.

pub fn remove( &mut self, key: &Bound<'_, PyAny>, ) -> PyResult<Option<CalculatorComplexWrapper>>

Remove the value of the input key.

Args: key (Product type): The key of the value to remove.

Returns: Optional[Union[CalculatorComplex, CalculatorFloat]]: Key existed if this is not None, and this is the value it had before it was removed.

Raises: ValueError: Product could not be constructed.

pub fn set( &mut self, key: &Bound<'_, PyAny>, value: &Bound<'_, PyAny>, ) -> PyResult<Option<CalculatorComplexWrapper>>

Overwrite an existing entry or set a new entry in self.

Args: key (Product type): The key to set. value (Union[CalculatorComplex, CalculatorFloat]): The value to set.

Returns: Optional[Union[CalculatorComplex, CalculatorFloat]]: Key existed if this is not None, and this is the value it had before it was overwritten.

Raises: ValueError: Product could not be constructed.

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

Add a new (key object, value Union[CalculatorComplex, CalculatorFloat]) pair to existing entries.

Args: key (Product type): The key object value (Union[CalculatorComplex, CalculatorFloat]): The value to add.

Raises: TypeError: Value is not CalculatorComplex or CalculatorFloat. ValueError: Product could not be constructed. ValueError: Error in add_operator_product function of self.

pub fn values(&self) -> Vec<CalculatorComplexWrapper>

Return unsorted values in self.

Returns: List[Union[CalculatorComplex, CalculatorFloat]]: The sequence of values of self.

pub fn hermitian_conjugate(&self) -> FermionOperatorWrapper

Return the hermitian conjugate of self.

Returns: self: The hermitian conjugate of self.

pub fn current_number_modes(&self) -> usize

Return the current_number_modes input of self.

Returns: int: The number of modes in self.

pub fn __neg__(&self) -> FermionOperatorWrapper

Implement -1 for self.

Returns: self: The object * -1.

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

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: FermionOperatorWrapper, ) -> PyResult<FermionOperatorWrapper>

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) -> FermionOperatorWrapper

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

Returns: self: A deep copy of self.

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

Return a deep copy of self.

Returns: self: A deep copy of self.

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

Convert the bincode representation of self 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 self 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 self.

Returns: str: The serialized form of self.

Raises: ValueError: Cannot serialize object to json.

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

Convert the json representation of self 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 FermionOperatorWrapper

pub fn jordan_wigner(&self) -> PauliOperatorWrapper

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

Trait Implementations

impl Clone for FermionOperatorWrapper

fn clone(&self) -> FermionOperatorWrapper

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FermionOperatorWrapper

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

Formats the value using the given formatter.

impl Default for FermionOperatorWrapper

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for FermionOperatorWrapper

type Target = FermionOperatorWrapper

The Python output type

type Output = Bound<'py, <FermionOperatorWrapper 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 FermionOperatorWrapper

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for FermionOperatorWrapper

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

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForFermionOperatorWrapper

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

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

impl PyClass__add__SlotFragment<FermionOperatorWrapper> for PyClassImplCollector<FermionOperatorWrapper>

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

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

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 FermionOperatorWrapper

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

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

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

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

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

impl PyTypeInfo for FermionOperatorWrapper

const NAME: &'static str = "FermionOperator"

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 FermionOperatorWrapper

impl StructuralPartialEq for FermionOperatorWrapper