Struct MemoryPosition 

pub struct MemoryPosition<T = usize> { /* private fields */ }

MemoryPosition tracks the current indices for various aspects of the memory system to ensure consistency when allocating new features or patterns.

Implementations

impl<T> MemoryPosition<T>

pub fn new(feature_id: T, pattern_id: T) -> MemoryPosition<T>

returns a new instance of MemoryPosition using the provided feature_id and pattern_id.

pub fn default() -> MemoryPosition<T>

where T: Default,

initializes a new instance using the logical Default for type T.

pub fn one() -> MemoryPosition<T>

where T: One,

initialize a new instance using num_traits::One

pub fn zero() -> MemoryPosition<T>

where T: Zero,

initialize a new instance using num_traits::Zero

pub fn from_feature_id(feature_id: T) -> MemoryPosition<T>

where T: Default,

creates a new instance of MemoryPosition from a given feature_id and a default pattern_id.

pub fn from_pattern_id(pattern_id: T) -> MemoryPosition<T>

where T: Default,

creates a new instance of MemoryPosition from a given pattern_id and a default feature_id.

pub const fn feature_id(&self) -> &T

returns an immutable reference to the current feature id

pub const fn feature_id_mut(&mut self) -> &mut T

returns a mutable reference to the current feature id

pub const fn pattern_id(&self) -> &T

returns an immutable reference to the current pattern id

pub const fn pattern_id_mut(&mut self) -> &mut T

returns a mutable reference to the current pattern id

pub const fn replace_feature_id(&mut self, id: T) -> T

replace the current feature ID with the given id and return the old value.

pub const fn replace_pattern_id(&mut self, id: T) -> T

replace the current pattern ID with the given id and return the old value.

pub fn next_feature_id(&mut self) -> T

where T: One, &'a T: for<'a> Add<T, Output = T>,

returns the current feature id, replacing it with the logical successor

pub fn next_pattern_id(&mut self) -> T

where T: One, &'a T: for<'a> Add<T, Output = T>,

returns the current pattern id and replaces it with an incremented value

Trait Implementations

impl<T> Clone for MemoryPosition<T>

where T: Clone,

fn clone(&self) -> MemoryPosition<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for MemoryPosition<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for MemoryPosition<T>

where T: Default,

fn default() -> MemoryPosition<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for MemoryPosition<T>

where MemoryPosition<T>: Default, T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for MemoryPosition<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> Hash for MemoryPosition<T>

where T: Hash,

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<T> Ord for MemoryPosition<T>

where T: Ord,

fn cmp(&self, other: &MemoryPosition<T>) -> 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<T> PartialEq for MemoryPosition<T>

where T: PartialEq,

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

where T: PartialOrd,

fn partial_cmp(&self, other: &MemoryPosition<T>) -> 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<T> Serialize for MemoryPosition<T>

where T: Serialize,

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<T> Copy for MemoryPosition<T>

where T: Copy,

impl<T> Eq for MemoryPosition<T>

where T: Eq,

impl<T> StructuralPartialEq for MemoryPosition<T>