Struct MaskValues 

pub struct MaskValues { /* private fields */ }

Represents the values of a Mask that contains some true and some false elements.

Implementations

impl MaskValues

pub fn len(&self) -> usize

Returns the length of the mask.

pub fn is_empty(&self) -> bool

Returns true if the mask is empty i.e., it’s length is 0.

pub fn density(&self) -> f64

Returns the density of the mask.

pub fn true_count(&self) -> usize

Returns the true count of the mask.

pub fn bit_buffer(&self) -> &BitBuffer

Returns the boolean buffer representation of the mask.

pub fn into_bit_buffer(self) -> BitBuffer

Returns the boolean buffer representation of the mask.

pub fn value(&self, index: usize) -> bool

Returns the boolean value at a given index.

pub fn indices(&self) -> &[usize]

Constructs an indices vector from one of the other representations.

pub fn cached_indices(&self) -> Option<&[usize]>

Returns cached index positions when this mask already has them materialized.

Unlike Self::indices, this does not build the index vector from another representation.

pub fn slices(&self) -> &[(usize, usize)]

Constructs a slices vector from one of the other representations.

pub fn cached_slices(&self) -> Option<&[(usize, usize)]>

Returns cached true-value ranges when this mask already has them materialized.

Unlike Self::slices, this does not build the slice vector from another representation.

pub fn threshold_iter(&self, threshold: f64) -> MaskIter<'_>

Return an iterator over either indices or slices of the mask based on a density threshold.

Trait Implementations

impl Debug for MaskValues

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MaskValues

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MaskValues

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.