Struct ppca::Dataset

pub struct Dataset {
    pub data: Arc<Vec<MaskedSample>>,
    pub weights: Vec<f64>,
}

Represents a dataset. This is a wrapper over a 2D array of dimensions (n_samples, n_features).

Note

All arrays involved have to be of data type float64.

Fields

data: Arc<Vec<MaskedSample>>

The data rows of this dataset.

weights: Vec<f64>

The weights associated with each sample. Use this only if you are using the PPCA as a component of a greater EM scheme (or otherwise know what you are doing). Else, let the package set it automatically to 1.

Implementations

impl Dataset

pub fn new(data: Vec<MaskedSample>) -> Dataset

Creates a new dataset from a set of masked samples.

pub fn new_with_weights(data: Vec<MaskedSample>, weights: Vec<f64>) -> Dataset

Creates a new dataset from a set of weighted masked samples.

pub fn with_weights(&self, weights: Vec<f64>) -> Dataset

Creates a new dataset with the same sample, but with different weights. This operation is cheap, since it does not clone the dataset (it’s protected by an Arc).

pub fn len(&self) -> usize

The lenght of this dataset.

pub fn is_empty(&self) -> bool

Whether this dataset is empty.

pub fn output_size(&self) -> Option<usize>

The number of dimensions in each sample. Returns None if dataset is empty.

pub fn empty_dimensions(&self) -> Vec<usize>

Lists the dimensions which as masked in all samples in this dataset.

Trait Implementations

impl Clone for Dataset

fn clone(&self) -> Dataset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dataset

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Dataset

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

Deserialize this value from the given Serde deserializer.

impl From<Vec<MaskedSample, Global>> for Dataset

fn from(value: Vec<MaskedSample>) -> Self

Converts to this type from the input type.

impl FromIterator<(MaskedSample, f64)> for Dataset

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

Creates a value from an iterator.

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, f64)> for Dataset

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

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

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 Serialize for Dataset

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

Serialize this value into the given Serde serializer.