Struct Layout

pub struct Layout { /* private fields */ }

Implementations

impl Layout

pub fn new(shape: Shape, stride: Vec<usize>, start_offset: usize) -> Self

pub fn contiguous_with_offset<S: Into<Shape>>( shape: S, start_offset: usize, ) -> Self

pub fn contiguous<S: Into<Shape>>(shape: S) -> Self

pub fn dims(&self) -> &[usize]

pub fn dim<D: Dim>(&self, dim: D) -> Result<usize>

The dimension size for a specified dimension index.

pub fn shape(&self) -> &Shape

pub fn stride(&self) -> &[usize]

pub fn start_offset(&self) -> usize

pub fn contiguous_offsets(&self) -> Option<(usize, usize)>

Returns the appropriate start and stop offset if the data is stored in a C contiguous (aka row major) way.

pub fn is_contiguous(&self) -> bool

Returns true if the data is stored in a C contiguous (aka row major) way. Note that this does not implies that the start offset is 0 or that there are no extra elements at the end of the storage.

pub fn is_fortran_contiguous(&self) -> bool

Returns true if the data is stored in a Fortran contiguous (aka column major) way.

pub fn narrow(&self, dim: usize, start: usize, len: usize) -> Result<Self>

pub fn transpose(&self, dim1: usize, dim2: usize) -> Result<Self>

pub fn permute(&self, idxs: &[usize]) -> Result<Self>

pub fn broadcast_as<S: Into<Shape>>(&self, shape: S) -> Result<Self>

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl PartialEq for Layout

fn eq(&self, other: &Layout) -> 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 Eq for Layout

impl StructuralPartialEq for Layout