Struct Dim 

pub struct Dim<'n> { /* private fields */ }

lifetime branded length

safety

the type’s safety invariant is that all instances of this type with the same lifetime correspond to the same length.

Implementations

impl<'n> Dim<'n>

pub fn with<R>(dim: usize, f: impl for<'dim> FnOnce(Dim<'dim>) -> R) -> R

create new branded value with the value dim.

pub const unsafe fn new_unbound(dim: usize) -> Self

create new branded value with an arbitrary brand.

safety

see struct safety invariant.

pub fn new(dim: usize, guard: Guard<'n>) -> Self

create new branded value with a unique brand.

pub const fn unbound(self) -> usize

returns the unconstrained value.

pub const fn partition<'head, 'tail>( self, midpoint: IdxInc<'n>, head: Guard<'head>, tail: Guard<'tail>, ) -> Partition<'head, 'tail, 'n>

partitions self into two segments as specifiedd by the midpoint.

pub fn head_partition<'head, 'tail>( self, head: Dim<'head>, tail: Guard<'tail>, ) -> Partition<'head, 'tail, 'n>

partitions self into two segments.

pub fn advance(self, start: Idx<'n>, len: usize) -> IdxInc<'n>

returns start advanced by len units, saturated to self

pub fn indices( self, ) -> impl Clone + ExactSizeIterator + DoubleEndedIterator<Item = Idx<'n>>

returns an iterator over the indices between 0 and self.

pub fn par_indices(self) -> impl IndexedParallelIterator<Item = Idx<'n>>

returns an iterator over the indices between 0 and self.

impl<'size> Dim<'size>

pub fn check<I: Index>(self, idx: I) -> Idx<'size, I>

check that the index is bounded by self, or panic otherwise.

pub fn idx<I: Index>(self, idx: I) -> Idx<'size, I>

check that the index is bounded by self, or panic otherwise.

pub fn idx_inc<I: Index>(self, idx: I) -> IdxInc<'size, I>

check that the index is bounded by self, or panic otherwise.

pub fn try_check<I: Index>(self, idx: I) -> Option<Idx<'size, I>>

check that the index is bounded by self, or return none otherwise.

Methods from Deref<Target = usize>

pub const MIN: usize = 0usize

pub const MAX: usize = 18_446_744_073_709_551_615usize

pub const BITS: u32 = 64u32

Trait Implementations

impl<'n> Clone for Dim<'n>

fn clone(&self) -> Dim<'n>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, 'N, T, Rs: Stride> ColIndex<<Dim<'N> as ShapeIdx>::Idx<usize>> for ColMut<'a, T, Dim<'N>, Rs>

type Target = &'a mut T

sliced view type

fn get(this: Self, row: Idx<Dim<'N>>) -> Self::Target

slice this using row

unsafe fn get_unchecked(this: Self, row: Idx<Dim<'N>>) -> Self::Target

slice this using row, without bound checks

impl<'a, 'N, T, Rs: Stride> ColIndex<<Dim<'N> as ShapeIdx>::Idx<usize>> for ColRef<'a, T, Dim<'N>, Rs>

type Target = &'a T

sliced view type

fn get(this: Self, row: Idx<Dim<'N>>) -> Self::Target

slice this using row

unsafe fn get_unchecked(this: Self, row: Idx<Dim<'N>>) -> Self::Target

slice this using row, without bound checks

impl Debug for Dim<'_>

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

Formats the value using the given formatter.

impl Deref for Dim<'_>

type Target = usize

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<'a, 'M, 'N, T, Rs: Stride, Cs: Stride> MatIndex<<Dim<'M> as ShapeIdx>::Idx<usize>, <Dim<'N> as ShapeIdx>::Idx<usize>> for MatMut<'a, T, Dim<'M>, Dim<'N>, Rs, Cs>

type Target = &'a mut T

sliced view type

fn get(this: Self, row: Idx<Dim<'M>>, col: Idx<Dim<'N>>) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: Idx<Dim<'M>>, col: Idx<Dim<'N>>, ) -> Self::Target

slice this using row and col without bound checks

impl<'a, 'M, 'N, T, Rs: Stride, Cs: Stride> MatIndex<<Dim<'M> as ShapeIdx>::Idx<usize>, <Dim<'N> as ShapeIdx>::Idx<usize>> for MatRef<'a, T, Dim<'M>, Dim<'N>, Rs, Cs>

type Target = &'a T

sliced view type

fn get(this: Self, row: Idx<Dim<'M>>, col: Idx<Dim<'N>>) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: Idx<Dim<'M>>, col: Idx<Dim<'N>>, ) -> Self::Target

slice this using row and col without bound checks

impl<'a, 'M, T, Rs: Stride, Cs: Stride> MatIndex<<Dim<'M> as ShapeIdx>::Idx<usize>, <usize as ShapeIdx>::Idx<usize>> for MatMut<'a, T, Dim<'M>, usize, Rs, Cs>

type Target = &'a mut T

sliced view type

fn get(this: Self, row: Idx<Dim<'M>>, col: Idx<usize>) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: Idx<Dim<'M>>, col: Idx<usize>, ) -> Self::Target

slice this using row and col without bound checks

impl<'a, 'M, T, Rs: Stride, Cs: Stride> MatIndex<<Dim<'M> as ShapeIdx>::Idx<usize>, <usize as ShapeIdx>::Idx<usize>> for MatRef<'a, T, Dim<'M>, usize, Rs, Cs>

type Target = &'a T

sliced view type

fn get(this: Self, row: Idx<Dim<'M>>, col: Idx<usize>) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: Idx<Dim<'M>>, col: Idx<usize>, ) -> Self::Target

slice this using row and col without bound checks

impl<'a, 'N, C: Shape, T, Rs: Stride, Cs: Stride, ColRange: IntoRange<IdxInc<C>, Len<C>: 'a>> MatIndex<<Dim<'N> as ShapeIdx>::Idx<usize>, ColRange> for MatMut<'a, T, Dim<'N>, C, Rs, Cs>

type Target = Row<Mut<'a, T, <ColRange as IntoRange<<C as ShapeIdx>::IdxInc<usize>>>::Len<C>, Cs>>

sliced view type

fn get(this: Self, row: Idx<Dim<'N>>, col: ColRange) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: Idx<Dim<'N>>, col: ColRange, ) -> Self::Target

slice this using row and col without bound checks

impl<'a, 'N, C: Shape, T, Rs: Stride, Cs: Stride, ColRange: IntoRange<IdxInc<C>, Len<C>: 'a>> MatIndex<<Dim<'N> as ShapeIdx>::Idx<usize>, ColRange> for MatRef<'a, T, Dim<'N>, C, Rs, Cs>

type Target = Row<Ref<'a, T, <ColRange as IntoRange<<C as ShapeIdx>::IdxInc<usize>>>::Len<C>, Cs>>

sliced view type

fn get(this: Self, row: Idx<Dim<'N>>, col: ColRange) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: Idx<Dim<'N>>, col: ColRange, ) -> Self::Target

slice this using row and col without bound checks

impl<'a, 'N, T, Rs: Stride, Cs: Stride> MatIndex<<usize as ShapeIdx>::Idx<usize>, <Dim<'N> as ShapeIdx>::Idx<usize>> for MatMut<'a, T, usize, Dim<'N>, Rs, Cs>

type Target = &'a mut T

sliced view type

fn get(this: Self, row: Idx<usize>, col: Idx<Dim<'N>>) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: Idx<usize>, col: Idx<Dim<'N>>, ) -> Self::Target

slice this using row and col without bound checks

impl<'a, 'N, T, Rs: Stride, Cs: Stride> MatIndex<<usize as ShapeIdx>::Idx<usize>, <Dim<'N> as ShapeIdx>::Idx<usize>> for MatRef<'a, T, usize, Dim<'N>, Rs, Cs>

type Target = &'a T

sliced view type

fn get(this: Self, row: Idx<usize>, col: Idx<Dim<'N>>) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: Idx<usize>, col: Idx<Dim<'N>>, ) -> Self::Target

slice this using row and col without bound checks

impl<'a, 'N, R: Shape, T, Rs: Stride, Cs: Stride, RowRange: IntoRange<IdxInc<R>, Len<R>: 'a>> MatIndex<RowRange, <Dim<'N> as ShapeIdx>::Idx<usize>> for MatMut<'a, T, R, Dim<'N>, Rs, Cs>

type Target = Col<Mut<'a, T, <RowRange as IntoRange<<R as ShapeIdx>::IdxInc<usize>>>::Len<R>, Rs>>

sliced view type

fn get(this: Self, row: RowRange, col: Idx<Dim<'N>>) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: RowRange, col: Idx<Dim<'N>>, ) -> Self::Target

slice this using row and col without bound checks

impl<'a, 'N, R: Shape, T, Rs: Stride, Cs: Stride, RowRange: IntoRange<IdxInc<R>, Len<R>: 'a>> MatIndex<RowRange, <Dim<'N> as ShapeIdx>::Idx<usize>> for MatRef<'a, T, R, Dim<'N>, Rs, Cs>

type Target = Col<Ref<'a, T, <RowRange as IntoRange<<R as ShapeIdx>::IdxInc<usize>>>::Len<R>, Rs>>

sliced view type

fn get(this: Self, row: RowRange, col: Idx<Dim<'N>>) -> Self::Target

slice this using row and col

unsafe fn get_unchecked( this: Self, row: RowRange, col: Idx<Dim<'N>>, ) -> Self::Target

slice this using row and col without bound checks

impl Ord for Dim<'_>

fn cmp(&self, other: &Self) -> 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 Idx<'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: 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 PartialEq for Dim<'_>

fn eq(&self, other: &Self) -> 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 Idx<'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: 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 PartialOrd for Dim<'_>

fn partial_cmp(&self, other: &Self) -> 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<'a, 'N, T, Cs: Stride> RowIndex<<Dim<'N> as ShapeIdx>::Idx<usize>> for RowMut<'a, T, Dim<'N>, Cs>

type Target = &'a mut T

sliced view type

fn get(this: Self, col: Idx<Dim<'N>>) -> Self::Target

slice this using col

unsafe fn get_unchecked(this: Self, col: Idx<Dim<'N>>) -> Self::Target

slice this using col without bound checks

impl<'a, 'N, T, Cs: Stride> RowIndex<<Dim<'N> as ShapeIdx>::Idx<usize>> for RowRef<'a, T, Dim<'N>, Cs>

type Target = &'a T

sliced view type

fn get(this: Self, col: Idx<Dim<'N>>) -> Self::Target

slice this using col

unsafe fn get_unchecked(this: Self, col: Idx<Dim<'N>>) -> Self::Target

slice this using col without bound checks

impl<'dim> Shape for Dim<'dim>

const IS_BOUND: bool = true

whether the types involved have any safety invariants

fn bind<'n>(self, guard: Guard<'n>) -> Dim<'n>

bind the current value using a invariant lifetime guard

fn cast_idx_slice<I: Index>(slice: &[Idx<Self, I>]) -> &[I]

cast a slice of bound values to unbound values

fn cast_idx_inc_slice<I: Index>(slice: &[IdxInc<Self, I>]) -> &[I]

cast a slice of bound values to unbound values

fn start() -> IdxInc<Self>

returns the index 0, which is always valid

fn next(idx: Idx<Self>) -> IdxInc<Self>

returns the incremented value, as an inclusive index

fn end(self) -> IdxInc<Self>

returns the last value, equal to the dimension

fn idx(self, idx: usize) -> Option<Idx<Self>>

checks if the index is valid, returning Some(_) in that case

fn idx_inc(self, idx: usize) -> Option<IdxInc<Self>>

checks if the index is valid, returning Some(_) in that case

fn checked_idx(self, idx: usize) -> Idx<Self>

checks if the index is valid, and panics otherwise

fn checked_idx_inc(self, idx: usize) -> IdxInc<Self>

checks if the index is valid, and panics otherwise

unsafe fn unchecked_idx(self, idx: usize) -> Idx<Self>

assumes the index is valid

unsafe fn unchecked_idx_inc(self, idx: usize) -> IdxInc<Self>

assumes the index is valid

fn indices( from: IdxInc<Self>, to: IdxInc<Self>, ) -> impl Clone + ExactSizeIterator + DoubleEndedIterator<Item = Idx<Self>>

returns an iterator over the indices between from and to

impl<'dim> ShapeIdx for Dim<'dim>

type Idx<I: Index> = Idx<'dim, I>

type that can be used to index into a range

type IdxInc<I: Index> = IdxInc<'dim, I>

type that can be used to partition a range

type MaybeIdx<I: Index> = MaybeIdx<'dim, I>

either an index or a negative value

impl Unbind for Dim<'_>

unsafe fn new_unbound(idx: usize) -> Self

creates new value

fn unbound(self) -> usize

returns the unbound value, unconstrained by safety invariants

impl<'n> Copy for Dim<'n>

impl Eq for Dim<'_>