Struct ViewDescriptor 

pub struct ViewDescriptor {
    pub base_offset: usize,
    pub shape: Vec<usize>,
    pub strides: Vec<usize>,
}

Describes a logical view into a flat buffer via an offset, shape, and strides.

The flat index of element (i₀, i₁, …, iₙ₋₁) is:

base_offset + Σ iₖ * strides[k]

Examples

use ipfrs_tensorlogic::slice_view::ViewDescriptor;

// 2×3 row-major view starting at element 0
let desc = ViewDescriptor {
    base_offset: 0,
    shape: vec![2, 3],
    strides: vec![3, 1],
};
assert_eq!(desc.flat_index(&[1, 2]), Some(5));
assert!(desc.is_contiguous());

Fields

base_offset: usize

Starting element index in the flat backing buffer.

shape: Vec<usize>

Logical shape of the view.

strides: Vec<usize>

Logical strides (one per dimension).

Implementations

impl ViewDescriptor

pub fn ndim(&self) -> usize

Number of dimensions.

pub fn total_elements(&self) -> usize

Total number of logical elements (product of shape; 1 for a scalar).

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

Compute the flat index for a multi-dimensional index tuple.

Returns None if:

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

pub fn is_contiguous(&self) -> bool

Returns true if the view is C (row-major) contiguous.

A view is contiguous when strides[ndim-1] == 1 and each preceding stride equals the product of the following shape dimensions.

Trait Implementations

impl Clone for ViewDescriptor

fn clone(&self) -> ViewDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ViewDescriptor

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

Formats the value using the given formatter.

impl Eq for ViewDescriptor

impl PartialEq for ViewDescriptor

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