Struct StridedLayout 

#[non_exhaustive]
pub struct StridedLayout {
    pub strides: Vec<i64>,
}

Descriptor for the strided layout.

The strided layout generalises row-major and column-major by allowing an arbitrary stride per dimension. Negative strides (reversed dimension) and zero strides (broadcast dimension) are both valid.

strides are in logical elements, not bytes.

Examples

use hurray_core::layout::{LayoutDescriptor, StridedLayout};

// Row-major strides for a 3×4 tensor: [4, 1]
let layout = LayoutDescriptor::Strided(StridedLayout::new(vec![4, 1]));
assert_eq!(layout.tag(), 0x03);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

strides: Vec<i64>

Per-dimension strides in logical elements.

Positive: forward; negative: reversed; zero: broadcast (virtual) dimension. strides.len() MUST equal the tensor rank (validated by [LayoutDescriptor::validate_against_shape]).

Implementations

impl StridedLayout

pub fn new(strides: Vec<i64>) -> Self

Creates a new StridedLayout with the given per-dimension strides.

No rank validation is performed here — call [LayoutDescriptor::validate_against_shape] to check that strides.len() == shape.rank().

Examples

use hurray_core::layout::StridedLayout;

// Reversed first dimension of a 3×4 tensor (row-major with rows reversed).
let s = StridedLayout::new(vec![-4, 1]);
assert_eq!(s.strides, &[-4, 1]);

Trait Implementations

impl Clone for StridedLayout

fn clone(&self) -> StridedLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StridedLayout

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

Formats the value using the given formatter.

impl ElementAddress for StridedLayout

fn element_offset(&self, index: &[u64], shape: &Shape) -> Result<u64>

Returns the linear element offset (in logical elements) for the given index.

impl Eq for StridedLayout

impl Hash for StridedLayout

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 PartialEq for StridedLayout

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