Enum CellIdentifier

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

Available on crate feature elli only.

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

Available on crate feature cpu_os_threads only.

Constructs a new CellIdentifier::Division

pub fn new_initial(index: usize) -> CellIdentifier

Available on crate feature cpu_os_threads only.

Construct a new CellIdentifier::Initial

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

Available on crate feature cpu_os_threads only.

Construct a new CellIdentifier::Inserted

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

Available on crate feature cpu_os_threads only.

Returns an identical clone of the identifier

pub fn copy(&self) -> CellIdentifier

Available on crate feature cpu_os_threads only.

Returns an identical clone of the identifier

pub fn __copy__(&self) -> CellIdentifier

Available on crate feature cpu_os_threads only.

Returns an identical clone of the identifier

pub fn __repr__(&self) -> String

Available on crate feature cpu_os_threads only.

Formats the CellIdentifier

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

Available on crate feature cpu_os_threads only.

Performs the == operation.

pub fn __hash__(&self) -> u64

Available on crate feature cpu_os_threads only.

Calculates a hash value of type u64

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

Available on crate feature cpu_os_threads only.

Performs the < operation

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

Available on crate feature cpu_os_threads only.

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 copy 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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<CellIdentifier, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CellIdentifier

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

where __H: Hasher,

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 IntoPy<Py<PyAny>> for CellIdentifier

fn into_py(self, py: Python<'_>) -> Py<PyAny>

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

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<<CellIdentifier as IntoPyObject<'py>>::Output, <CellIdentifier as IntoPyObject<'py>>::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 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 type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for [PyTypeInfo::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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for [PyTypeInfo::is_type_of].

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for [PyTypeInfo::is_exact_type_of].

impl Serialize for CellIdentifier

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CellIdentifier

impl Eq for CellIdentifier

impl StructuralPartialEq for CellIdentifier