Struct mdarray::Layout

pub struct Layout<D: Dim, F: Format> { /* private fields */ }

Array layout, including rank, element order and storage format.

Implementations

impl<D: Dim, F: Format> Layout<D, F>

pub fn is_contiguous(self) -> bool

Returns true if the array strides are consistent with contiguous memory layout.

pub fn is_empty(self) -> bool

Returns true if the array contains no elements.

pub fn is_uniformly_strided(self) -> bool

Returns true if the array strides are consistent with uniformly strided memory layout.

pub fn len(self) -> usize

Returns the number of elements in the array.

pub fn shape(self) -> D::Shape

Returns the shape of the array.

pub fn size(self, dim: usize) -> usize

Returns the number of elements in the specified dimension.

Panics

Panics if the dimension is out of bounds.

pub fn stride(self, dim: usize) -> isize

Returns the distance between elements in the specified dimension.

Panics

Panics if the dimension is out of bounds.

pub fn strides(self) -> D::Strides

Returns the distance between elements in each dimension.

impl<D: Dim> Layout<D, Dense>

pub fn new(shape: D::Shape) -> Self

Creates a new, dense array layout with the specified shape.

impl<D: Dim> Layout<D, Flat>

pub fn new(shape: D::Shape, inner_stride: isize) -> Self

Creates a new, flat array layout with the specified shape and inner stride.

impl<D: Dim> Layout<D, General>

pub fn new(shape: D::Shape, outer_strides: <D::Lower as Dim>::Strides) -> Self

Creates a new, general array layout with the specified shape and outer strides.

impl<D: Dim> Layout<D, Strided>

pub fn new(shape: D::Shape, strides: D::Strides) -> Self

Creates a new, strided array layout with the specified shape and strides.

Trait Implementations

impl<D: Dim, F: Format> Clone for Layout<D, F>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Dim, F: Format> Debug for Layout<D, F>

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

Formats the value using the given formatter.

impl<D: Dim, F: Format> Default for Layout<D, F>

fn default() -> Self

Returns the “default value” for a type.

impl<T, D: Dim> SpanIndex<T, Layout<D, Dense>> for (Bound<usize>, Bound<usize>)

type Output = [T]

Array element or subslice type.

impl<T, D: Dim> SpanIndex<T, Layout<D, Dense>> for Range<usize>

type Output = [T]

Array element or subslice type.

impl<T, D: Dim> SpanIndex<T, Layout<D, Dense>> for RangeFrom<usize>

type Output = [T]

Array element or subslice type.

impl<T, D: Dim> SpanIndex<T, Layout<D, Dense>> for RangeFull

type Output = [T]

Array element or subslice type.

impl<T, D: Dim> SpanIndex<T, Layout<D, Dense>> for RangeInclusive<usize>

type Output = [T]

Array element or subslice type.

impl<T, D: Dim> SpanIndex<T, Layout<D, Dense>> for RangeTo<usize>

type Output = [T]

Array element or subslice type.

impl<T, D: Dim> SpanIndex<T, Layout<D, Dense>> for RangeToInclusive<usize>

type Output = [T]

Array element or subslice type.

impl<T, S: Shape, D: Dim<Shape = S>, F: Format> SpanIndex<T, Layout<D, F>> for S

type Output = T

Array element or subslice type.

impl<T, D: Dim, F: Uniform> SpanIndex<T, Layout<D, F>> for usize

type Output = T

Array element or subslice type.

impl<D: Dim, F: Format> Copy for Layout<D, F>