Struct IdxInc 

pub struct IdxInc<'n, I: Index = usize> { /* private fields */ }

lifetime branded partition index.

safety

the type’s safety invariant is that all instances of this type are valid partition places for Dim<'n> and less than or equal to i::signed::max.

Implementations

impl<'n> IdxInc<'n>

pub const ZERO: Self

zero index

impl<'n, I: Index> IdxInc<'n, I>

pub const unsafe fn new_unbound(idx: I) -> Self

create new branded value with an arbitrary brand.

safety

see struct safety invariant.

pub unsafe fn new_unchecked(idx: I, dim: Dim<'n>) -> Self

create new branded value with the same brand as Dim.

safety

the behavior is undefined unless idx <= dim.

pub fn new_checked(idx: I, dim: Dim<'n>) -> Self

create new branded value with the same brand as Dim.

panics

panics unless idx <= dim.

pub const fn unbound(self) -> I

returns the unconstrained value.

pub fn zx(self) -> IdxInc<'n>

zero-extends the internal value into a usize.

impl<'n> IdxInc<'n>

pub fn to( self, upper: IdxInc<'n>, ) -> impl Clone + ExactSizeIterator + DoubleEndedIterator<Item = Idx<'n>>

returns an iterator over the indices between self and to.

pub fn range_to( self, upper: IdxInc<'n>, ) -> impl Clone + ExactSizeIterator + DoubleEndedIterator<Item = Idx<'n>>

returns an iterator over the indices between self and to.

Trait Implementations

impl<'n, I: Clone + Index> Clone for IdxInc<'n, I>

fn clone(&self) -> IdxInc<'n, I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Index> Debug for IdxInc<'_, I>

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

Formats the value using the given formatter.

impl<I: Index> Deref for IdxInc<'_, I>

type Target = I

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'n> From<Dim<'n>> for IdxInc<'n>

fn from(value: Dim<'n>) -> Self

Converts to this type from the input type.

impl<'n, I: Index> From<Idx<'n, I>> for IdxInc<'n, I>

fn from(value: Idx<'n, I>) -> Self

Converts to this type from the input type.

impl<'n, I: Ord + Index> Ord for IdxInc<'n, I>

fn cmp(&self, other: &IdxInc<'n, I>) -> 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<'n, I: Index> PartialEq<Dim<'n>> for IdxInc<'n, I>

fn eq(&self, other: &Dim<'n>) -> 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<'n, I: PartialEq + Index> PartialEq for IdxInc<'n, I>

fn eq(&self, other: &IdxInc<'n, I>) -> 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<'n, I: Index> PartialOrd<Dim<'n>> for IdxInc<'n, I>

fn partial_cmp(&self, other: &Dim<'n>) -> 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<'n, I: PartialOrd + Index> PartialOrd for IdxInc<'n, I>

fn partial_cmp(&self, other: &IdxInc<'n, I>) -> 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<I: Index> Unbind<I> for IdxInc<'_, I>

unsafe fn new_unbound(idx: I) -> Self

creates new value

fn unbound(self) -> I

returns the unbound value, unconstrained by safety invariants

impl<'n, I: Copy + Index> Copy for IdxInc<'n, I>

impl<'n, I: Eq + Index> Eq for IdxInc<'n, I>

impl<'n, I: Index> StructuralPartialEq for IdxInc<'n, I>