Skip to main content

RegularTernaryGrid

Struct RegularTernaryGrid 

Source
pub struct RegularTernaryGrid { /* private fields */ }
Expand description

A reusable view of the canonical regular ternary composition lattice.

The grid visits lattice coordinates in the exact order used by RegularTernaryScalarField: i increases first, then j, with k = subdivisions - i - j. Its iterators are lazy and do not allocate.

Example:

use ternary_contours::{LatticeCoordinate, RegularTernaryGrid};

let grid = RegularTernaryGrid::new(2)?;
let coordinates: Vec<_> = grid.lattice_coordinates().collect();
assert_eq!(coordinates[0], LatticeCoordinate { i: 0, j: 0, k: 2 });

Implementations§

Source§

impl RegularTernaryGrid

Source

pub fn new(subdivisions: usize) -> Result<RegularTernaryGrid, FieldError>

Create a regular ternary lattice with subdivisions intervals per edge.

The subdivision count must be positive. Its vertex count is (n + 1) * (n + 2) / 2 and is checked for overflow.

Source

pub const fn subdivisions(&self) -> usize

Number of intervals on each binary edge.

Source

pub const fn vertex_count(&self) -> usize

Number of vertices in canonical scalar-field order.

Source

pub fn lattice_coordinates(&self) -> impl ExactSizeIterator + Clone

Lazily iterate canonical integer lattice coordinates.

The iterator is exact-sized and yields i = 0..=n, j = 0..=n-i, and k = n-i-j.

Source

pub fn compositions(&self) -> impl ExactSizeIterator + Clone

Lazily iterate normalized semantic compositions in canonical field order.

Each item is [i/n, j/n, k/n] in A/B/C component order.

Example:

use ternary_contours::RegularTernaryGrid;

let grid = RegularTernaryGrid::new(2)?;
assert_eq!(grid.compositions().next(), Some([0.0, 0.0, 1.0]));
Source

pub fn indexed_compositions(&self) -> impl ExactSizeIterator + Clone

Lazily iterate scalar-field vertex identifiers and normalized compositions.

Every identifier matches the canonical order expected by RegularTernaryScalarField::new.

Trait Implementations§

Source§

impl Clone for RegularTernaryGrid

Source§

fn clone(&self) -> RegularTernaryGrid

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RegularTernaryGrid

Source§

impl Debug for RegularTernaryGrid

Source§

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

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

impl Eq for RegularTernaryGrid

Source§

impl PartialEq for RegularTernaryGrid

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RegularTernaryGrid

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<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 = !

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

fn try_from(value: U) -> Result<T, !>

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.