Struct Layout

pub struct Layout { /* private fields */ }

The layout describes the memory layout of a tensor.

Implementations

impl Layout

pub unsafe fn new( offset: usize, shape: impl IntoShape, strides: impl IntoStride, ) -> Self

pub fn contiguous(shape: impl IntoShape) -> Self

Create a new layout with a contiguous stride.

pub fn scalar() -> Self

Create a new layout with a scalar stride.

pub fn broadcast_as(&self, shape: impl IntoShape) -> ShapeResult<Self>

Broadcast the layout to a new shape.

The new shape must have the same or higher rank than the current shape.

pub fn is_contiguous(&self) -> bool

Determine if the current layout is contiguous or not.

pub fn is_scalar(&self) -> bool

Checks to see if the layout is empy; i.e. a scalar of Rank(0)

pub fn is_square(&self) -> bool

A function for determining if the layout is square. An n-dimensional object is square if all of its dimensions are equal.

pub fn iter(&self) -> LayoutIter

pub fn offset(&self) -> usize

Peek the offset of the layout.

pub fn offset_from_low_addr_ptr_to_logical_ptr(&self) -> usize

Returns the offset from the lowest-address element to the logically first element.

pub fn rank(&self) -> Rank

Return the rank (number of dimensions) of the layout.

pub fn remove_axis(&self, axis: Axis) -> Self

Remove an axis from the current layout, returning the new layout.

pub fn reshape(&mut self, shape: impl IntoShape)

Reshape the layout to a new shape.

pub fn reverse(&mut self)

Reverse the order of the axes.

pub fn reverse_axes(self) -> Layout

Reverse the order of the axes.

pub const fn shape(&self) -> &Shape

Get a reference to the shape of the layout.

pub fn size(&self) -> usize

Get a reference to the number of elements in the layout.

pub const fn strides(&self) -> &Stride

Get a reference to the stride of the layout.

pub fn swap_axes(&self, a: Axis, b: Axis) -> Layout

Swap the axes of the layout.

pub fn transpose(&self) -> Layout

Transpose the layout.

pub fn with_offset(self, offset: usize) -> Self

pub fn with_shape_c(self, shape: impl IntoShape) -> Self

pub unsafe fn with_shape_unchecked(self, shape: impl IntoShape) -> Self

pub unsafe fn with_strides_unchecked(self, stride: impl IntoStride) -> Self

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate 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<'de> Deserialize<'de> for Layout

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Layout

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Layout

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Layout

impl StructuralPartialEq for Layout