Struct CsrLayout 

#[non_exhaustive]
pub struct CsrLayout {
    pub nnz: u64,
}

Descriptor for the CSR (Compressed Sparse Row) sparse layout.

CSR is defined only for rank-2 tensors. A conforming implementation MUST reject a CSR descriptor whose tensor rank is not 2 (checked by [LayoutDescriptor::validate_against_shape]).

Three buffers are required:

Buffer	Contents
0 — values	Non-zero values in row-major order; nnz elements.
1 — col_indices	Column index of each non-zero; nnz uint64 elements.
2 — row_ptr	Row pointer array; nrows + 1 uint64 elements where nrows = shape[0].

The byte_offset field MUST be 0 for CSR tensors.

Examples

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

let layout = LayoutDescriptor::Csr(CsrLayout::new(5));
assert_eq!(layout.tag(), 0x07);
assert_eq!(layout.buffer_count().map(|n| n.get()), Some(3));

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 matrix.

Implementations

impl CsrLayout

pub fn new(nnz: u64) -> Self

Creates a new CsrLayout.

Examples

use hurray_core::layout::CsrLayout;

let c = CsrLayout::new(5);
assert_eq!(c.nnz, 5);

Trait Implementations

impl Clone for CsrLayout

fn clone(&self) -> CsrLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CsrLayout

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

Formats the value using the given formatter.

impl Eq for CsrLayout

impl Hash for CsrLayout

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 CsrLayout

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