Skip to main content

EdgeBehavior

Enum EdgeBehavior 

Source
pub enum EdgeBehavior {
    Clamp,
    Wrap,
    Absorb,
}
Expand description

How a lattice space handles neighbors at its edges.

This is distinct from murk_core::BoundaryBehavior, which controls field value clamping. EdgeBehavior controls the topology — which cells are considered neighbors of boundary cells.

§Examples

use murk_space::{Square4, EdgeBehavior, Space};

// Absorb: corner has 2 neighbors, interior has 4.
let absorb = Square4::new(4, 4, EdgeBehavior::Absorb).unwrap();
let corner: murk_core::Coord = vec![0i32, 0].into();
let interior: murk_core::Coord = vec![1i32, 1].into();
assert_eq!(absorb.neighbours(&corner).len(), 2);
assert_eq!(absorb.neighbours(&interior).len(), 4);

// Wrap: all cells have exactly 4 neighbors (torus).
let wrap = Square4::new(4, 4, EdgeBehavior::Wrap).unwrap();
assert_eq!(wrap.neighbours(&corner).len(), 4);

Variants§

§

Clamp

Out-of-bounds neighbor maps to the boundary cell (self-loop).

§

Wrap

Out-of-bounds neighbor wraps to the opposite side (periodic).

§

Absorb

Out-of-bounds neighbor is omitted (fewer neighbors at edges).

Trait Implementations§

Source§

impl Clone for EdgeBehavior

Source§

fn clone(&self) -> EdgeBehavior

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EdgeBehavior

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for EdgeBehavior

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for EdgeBehavior

Source§

fn eq(&self, other: &EdgeBehavior) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for EdgeBehavior

Source§

impl Eq for EdgeBehavior

Source§

impl StructuralPartialEq for EdgeBehavior

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.