Struct StatisticsMask 

pub struct StatisticsMask(pub u32);

Bitmask identifying which statistics fields contain valid data.

A reader MUST check the relevant bit before using any statistics field. Fields whose bit is not set MUST be treated as unknown.

Bits 6–31 are reserved and MUST be 0. A reader MUST reject a descriptor whose computed_mask has any reserved bit set.

Examples

use hurray_core::descriptor::StatisticsMask;

let mask = StatisticsMask(StatisticsMask::NNZ_VALID | StatisticsMask::VALUE_RANGE_VALID);
assert!(mask.nnz_valid());
assert!(mask.value_range_valid());
assert!(!mask.sparsity_valid());

Tuple Fields

0: u32

Implementations

impl StatisticsMask

pub const NNZ_VALID: u32

Bit 0: nnz field is valid.

pub const SPARSITY_VALID: u32

Bit 1: sparsity_ratio field is valid.

pub const VALUE_RANGE_VALID: u32

Bit 2: value_min, value_max, value_abs_max are valid.

pub const VALUE_STATS_VALID: u32

Bit 3: value_mean, value_stddev are valid.

pub const NM_SPARSITY_VALID: u32

Bit 4: nm_n, nm_m are valid.

pub const NAN_INF_VALID: u32

Bit 5: has_nan, has_inf are valid.

pub fn nnz_valid(self) -> bool

Returns true if the NNZ_VALID bit is set.

pub fn sparsity_valid(self) -> bool

Returns true if the SPARSITY_VALID bit is set.

pub fn value_range_valid(self) -> bool

Returns true if the VALUE_RANGE_VALID bit is set.

pub fn value_stats_valid(self) -> bool

Returns true if the VALUE_STATS_VALID bit is set.

pub fn nm_sparsity_valid(self) -> bool

Returns true if the NM_SPARSITY_VALID bit is set.

pub fn nan_inf_valid(self) -> bool

Returns true if the NAN_INF_VALID bit is set.

Trait Implementations

impl Clone for StatisticsMask

fn clone(&self) -> StatisticsMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StatisticsMask

impl Debug for StatisticsMask

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

Formats the value using the given formatter.

impl Eq for StatisticsMask

impl PartialEq for StatisticsMask

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