Enum CellIdentifier 

pub enum CellIdentifier {
    Division(VoxelPlainIndex, u64),
    Initial(usize),
    Inserted(VoxelPlainIndex, u64),
}

Unique identifier which is given to every cell in the simulation

The identifier is comprised of the VoxelPlainIndex in which the cell was first spawned. This can be due to initial setup or due to other methods such as division in a cell cycle. The second parameter is a counter which is unique for each voxel. This ensures that each cell obtains a unique identifier over the course of the simulation.

Variants

Division(VoxelPlainIndex, u64)

Produced from a division process

Initial(usize)

Initially placed inside the simulation

Inserted(VoxelPlainIndex, u64)

Inserted manually by other processes

Implementations

impl CellIdentifier

pub fn new(voxel_plain_index: VoxelPlainIndex, counter: u64) -> Self

Constructs a new CellIdentifier::Division

pub fn new_initial(index: usize) -> Self

Construct a new CellIdentifier::Initial

pub fn new_inserted(voxel_plain_index: VoxelPlainIndex, counter: u64) -> Self

Construct a new CellIdentifier::Inserted

pub fn __deepcopy__(&self, _memo: Bound<'_, PyDict>) -> Self

Returns an identical clone of the identifier

pub fn copy(&self) -> Self

Returns an identical clone of the identifier

pub fn __copy__(&self) -> Self

Returns an identical clone of the identifier

pub fn __repr__(&self) -> String

Formats the CellIdentifier

pub fn __eq__(&self, other: &Self) -> bool

Performs the == operation.

pub fn __hash__(&self) -> u64

Calculates a hash value of type u64

pub fn __lt__(&self, other: &Self) -> bool

Performs the < operation

pub fn __getitem__<'py>( &self, py: Python<'py>, key: usize, ) -> PyResult<Bound<'py, PyAny>>

Implementes the __getitem__ method. Since the CellIdentifier is built like a list this only works for the entires 0 and 1 and will yield an error otherwise

Trait Implementations

impl Clone for CellIdentifier

fn clone(&self) -> CellIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CellIdentifier

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CellIdentifier

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CellIdentifier

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 CellIdentifier

type Target = CellIdentifier

The Python output type

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

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

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

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

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for CellIdentifier

type LayoutAsBase = PyClassObject<CellIdentifier>

type BaseNativeType = <CellIdentifier as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<CellIdentifier>

type PyClassMutability = <CellIdentifier as PyClassImpl>::PyClassMutability

impl PyClassImpl for CellIdentifier

const IS_BASETYPE: bool = true

#[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)]

const RAW_DOC: &'static CStr = /// Unique identifier which is given to every cell in the simulation /// /// The identifier is comprised of the [VoxelPlainIndex] in which the cell was first spawned. /// This can be due to initial setup or due to other methods such as division in a cell cycle. /// The second parameter is a counter which is unique for each voxel. /// This ensures that each cell obtains a unique identifier over the course of the simulation.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<CellIdentifier>

This handles following two situations:

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

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for CellIdentifier

const TEXT_SIGNATURE: &'static str = "(voxel_plain_index, counter)"

impl PyClass__eq__SlotFragment<CellIdentifier> for PyClassImplCollector<CellIdentifier>

unsafe fn __eq__( 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__lt__SlotFragment<CellIdentifier> for PyClassImplCollector<CellIdentifier>

unsafe fn __lt__( 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 PyMethods<CellIdentifier> for PyClassImplCollector<CellIdentifier>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for CellIdentifier

const NAME: &'static str = "CellIdentifier"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

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 Serialize for CellIdentifier

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CellIdentifier

impl Eq for CellIdentifier

impl ExtractPyClassWithClone for CellIdentifier

impl StructuralPartialEq for CellIdentifier