Struct CooLayout 

#[non_exhaustive]
pub struct CooLayout {
    pub nnz: u64,
    pub is_sorted: bool,
}

Descriptor for the COO (Coordinate list) sparse layout.

A COO tensor stores non-zero elements as (index_tuple, value) pairs. It requires two buffers:

Buffer	Contents
0 — values	Non-zero element values; nnz elements of the tensor element type.
1 — indices	Index tuples as uint64; nnz × rank elements, stored row-major: indices[i * rank + d] is coordinate d of non-zero i.

The byte_offset field in the common descriptor header MUST be 0 for COO tensors (no meaningful “first element at a fixed offset”).

Examples

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

let layout = LayoutDescriptor::Coo(CooLayout::new(3, true));
assert_eq!(layout.tag(), 0x06);
assert_eq!(layout.buffer_count().map(|n| n.get()), Some(2));

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.

nnz: u64

Number of stored (non-zero) elements. MAY be 0 for an empty sparse tensor.

is_sorted: bool

true if non-zeros are stored in lexicographic index order (dimension 0 major); false if no ordering guarantee is made.

Implementations

impl CooLayout

pub fn new(nnz: u64, is_sorted: bool) -> Self

Creates a new CooLayout.

Examples

use hurray_core::layout::CooLayout;

let c = CooLayout::new(42, true);
assert_eq!(c.nnz, 42);
assert!(c.is_sorted);

Trait Implementations

impl Clone for CooLayout

fn clone(&self) -> CooLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CooLayout

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

Formats the value using the given formatter.

impl Eq for CooLayout

impl Hash for CooLayout

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 CooLayout

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