Struct CatTable 

pub struct CatTable { /* private fields */ }

A struct representing a categorical dataset.

Implementations

impl CatTable

pub fn new(states: States, values: Array2<CatType>) -> Self

Creates a new categorical dataset.

Arguments

• states - The variables states.
• values - The values of the variables.

Notes

• Labels and states will be sorted in alphabetical order.

Panics

• If the variable labels are not unique.
• If the variable states are not unique.
• If the number of variable states is higher than CatType::MAX.
• If the number of variables is different from the number of values columns.
• If the variables values are not smaller than the number of states.

Returns

A new categorical dataset instance.

pub const fn states(&self) -> &States

Returns the states of the variables in the categorical distribution.

Returns

A reference to the vector of states.

pub const fn shape(&self) -> &Array1<usize>

Returns the shape of the set of states in the categorical distribution.

Returns

A reference to the array of shape.

Trait Implementations

impl Clone for CatTable

fn clone(&self) -> CatTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CsvIO for CatTable

fn from_csv(csv: &str) -> Self

Create an instance of the type from a CSV string.

fn to_csv(&self) -> String

Convert the instance to a CSV string.

fn read_csv(path: &str) -> Self

Create an instance of the type from a CSV file.

fn write_csv(&self, path: &str)

Write the instance to a CSV file.

impl Dataset for CatTable

type Values = ArrayBase<OwnedRepr<u8>, Dim<[usize; 2]>>

The type of the values.

fn values(&self) -> &Self::Values

The values of the dataset.

fn sample_size(&self) -> f64

The sample size.

impl Debug for CatTable

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

Formats the value using the given formatter.

impl Display for CatTable

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

Formats the value using the given formatter.

impl Labelled for CatTable

fn labels(&self) -> &Labels

Returns the labels of the variables.

fn label_to_index(&self, x: &str) -> usize

Return the variable index for a given label.

fn index_to_label(&self, x: usize) -> &str

Return the label for a given variable index.

fn index_to(&self, x: usize, other: &Labels) -> usize

Maps an index from this model to another model with the same label.

fn indices_to(&self, x: &Set<usize>, other: &Labels) -> Set<usize>

Maps a set of indices from this model to another model with the same labels.

fn index_from(&self, x: usize, other: &Labels) -> usize

Maps an index from another model to this model with the same label.

fn indices_from(&self, x: &Set<usize>, other: &Labels) -> Set<usize>

Maps a set of indices from another model to this model with the same labels.