Struct Layout 

pub struct Layout<T> { /* private fields */ }

The layout for Strided.

This struct ensures that the Self::cstride is greater than or equal to Self::ncols and that the addressable span is valid for elements of type T. In particular, the linear length does not overflow usize::MAX and its size in bytes does not exceed isize::MAX.

The linear length of Strided is given by the formula

self.nrows.saturating_sub(1) * self.cstride + self.nrows.min(1) * self.ncols

This allows the last row to occupy less than a full stride.

Implementations

impl<T> Layout<T>

pub fn new( nrows: usize, ncols: usize, cstride: usize, ) -> Result<Self, LayoutError>

Construct a new Layout.

Errors if:

• cstride < ncols.
• The computation of the linear length overflows usize::MAX.
• The number of bytes required for the full span exceeds isize::MAX.

pub fn nrows(&self) -> usize

Return the number of rows.

pub fn ncols(&self) -> usize

Return the number of columns.

pub fn cstride(&self) -> usize

Return the stride between subsequent rows.

pub fn linear_length(&self) -> usize

Return the length of the addressable span described by this Layout, including gaps between rows.

Trait Implementations

impl<T> Clone for Layout<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Copy for Layout<T>

impl<T: Debug> Debug for Layout<T>

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

Formats the value using the given formatter.

impl<T> From<Layout<T>> for Layout<T>

fn from(layout: Layout<T>) -> Self

Converts to this type from the input type.