Struct ppca::MaskedSample

pub struct MaskedSample { /* private fields */ }

A data sample with potentially missing values.

Implementations

impl MaskedSample

pub fn mask_non_finite(data: DVector<f64>) -> MaskedSample

Creates a masked sample from a vector, masking all elements which are not finite (e.g., NaN and inf).

pub fn new(data: DVector<f64>, mask: Mask) -> MaskedSample

Creates a masked sample from data and a mask. The value is considered missing if its index in the masked is set to false.

pub fn unmasked(data: DVector<f64>) -> MaskedSample

Creates a sample without any masked values.

pub fn data_vector(&self) -> DVector<f64>

Returns the data vector associated with this sample.

pub fn is_empty(&self) -> bool

Returns true if all values are masked.

pub fn mask(&self) -> &Mask

Returns the mask of this sample. The value is considered missing if its index in the masked is set to false.

pub fn is_set(&self, idx: usize) -> bool

Returns whether the idx dimension in this sample is set.

Panics

This function panics if idx is out of bounds.

pub fn masked_vector(&self) -> DVector<f64>

Returns the data vector associated with this sample, subsitituting all masked values by NaN.

Trait Implementations

impl Clone for MaskedSample

fn clone(&self) -> MaskedSample

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaskedSample

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MaskedSample

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromIterator<MaskedSample> for Dataset

fn from_iter<T>(iter: T) -> Selfwhere T: IntoIterator<Item = MaskedSample>,

Creates a value from an iterator.

impl FromParallelIterator<MaskedSample> for Dataset

fn from_par_iter<T>(iter: T) -> Selfwhere T: IntoParallelIterator<Item = MaskedSample>,

Creates an instance of the collection from the parallel iterator par_iter.

impl Index<usize> for MaskedSample

type Output = f64

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Serialize for MaskedSample

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

Serialize this value into the given Serde serializer.