Skip to main content

LayoutDescriptor

Struct LayoutDescriptor 

Source
pub struct LayoutDescriptor {
    pub shape: TensorShape,
    pub strides: Vec<usize>,
    pub byte_offset: usize,
    pub element_size_bytes: usize,
    pub order: LayoutOrder,
}
Expand description

Complete memory layout descriptor for a tensor.

Fields§

§shape: TensorShape

Logical shape of the tensor.

§strides: Vec<usize>

Stride (in elements, not bytes) for each dimension.

§byte_offset: usize

Byte offset from the start of the backing buffer to element [0,…,0].

§element_size_bytes: usize

Size of a single element in bytes (e.g. 4 for f32, 8 for f64).

§order: LayoutOrder

Memory ordering of this layout.

Implementations§

Source§

impl LayoutDescriptor

Source

pub fn row_major_strides(dims: &[usize]) -> Vec<usize>

Compute row-major (C-style) strides for dims.

The last dimension has stride 1; each preceding stride equals the product of all following dimensions. For [3, 4, 5] the result is [20, 5, 1].

Source

pub fn col_major_strides(dims: &[usize]) -> Vec<usize>

Compute column-major (Fortran-style) strides for dims.

The first dimension has stride 1; each following stride equals the product of all preceding dimensions. For [3, 4, 5] the result is [1, 3, 12].

Source

pub fn new( shape: TensorShape, order: LayoutOrder, element_size_bytes: usize, ) -> Self

Create a new layout descriptor.

Strides are computed from order; byte_offset starts at 0.

Source

pub fn linear_index(&self, indices: &[usize]) -> Option<usize>

Compute the flat (linear) element index for the given multi-dimensional indices.

Returns None when:

  • indices.len() != ndim, or
  • any indices[i] >= shape.dims[i].
Source

pub fn byte_offset_for(&self, indices: &[usize]) -> Option<usize>

Compute the byte offset into the backing buffer for indices.

Returns None under the same conditions as linear_index.

Source

pub fn is_contiguous(&self) -> bool

Returns true if this layout has row-major (C-contiguous) strides.

Source

pub fn total_bytes(&self) -> usize

Total bytes occupied by all elements.

Source

pub fn transposed(&self) -> Self

Return a new LayoutDescriptor representing the transpose of this layout.

Dimension and stride order are reversed; memory ordering is flipped (RowMajorColMajor).

Trait Implementations§

Source§

impl Clone for LayoutDescriptor

Source§

fn clone(&self) -> LayoutDescriptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LayoutDescriptor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more