Struct melange::tensor::slice_layout::SliceLayout

pub struct SliceLayout<'a, T> { /* fields omitted */ }

SliceLayout is a very flexible non-contiguous slice-backed layout. It enables the creation of tensors that are views on other tensors becuase it does not own the data. The internal slice can actually point to any contiguous part of memory on the stack or the heap that can be borrowed.

SliceLayout comes with some memory overhead to be able to keep track of how borrowed data is used. It stores:

• the shape
• the actual strides (i.e. product of intrinsic and extrinsic strides)
• the number of elements
• the optimal chunk size (i.e. largest contiguous data pieces)

Note: The intrinsic strides are the cumulative product of the dimensions and the extrinsic strides follow the ususal ML definition.

SliceLayout is the default view layout in Melange and should be prefered unless you have specific needs.

Implementations

impl<'a, T> SliceLayout<'a, T>

pub fn from_slice_unchecked(
    slice: &'a [T],
    shape: Vec<usize>,
    strides: Vec<usize>,
    num_elements: usize,
    opt_chunk_size: usize
) -> Self

Trait Implementations

impl<'a, T: Clone> Clone for SliceLayout<'a, T>

fn clone(&self) -> SliceLayout<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for SliceLayout<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Deref for SliceLayout<'a, T>

type Target = [T]

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, 'b, T> Layout<'b, T> for SliceLayout<'a, T> where
    T: 'static, 

type Iter = StridedChunks<'b, 'b, T>

type View = Self

fn shape(&self) -> Vec<usize>

fn strides(&self) -> Vec<usize>

fn opt_chunk_size(&self) -> usize

fn num_elements(&self) -> usize

fn chunks(&'b self, chunk_size: usize) -> Self::Iter

fn as_view_unchecked(
    &'b self,
    shape: Vec<usize>,
    strides: Vec<usize>,
    num_elements: usize,
    opt_chunk_size: usize
) -> Self::View

impl<'a, T> PartialEq<SliceLayout<'a, T>> for SliceLayout<'a, T> where
    T: Send + Sync + PartialEq + 'static, 

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.