Enum lace_codebook::ColType

pub enum ColType {
    Continuous {
        hyper: Option<NixHyper>,
        prior: Option<NormalInvChiSquared>,
    },
    Categorical {
        k: usize,
        hyper: Option<CsdHyper>,
        value_map: ValueMap,
        prior: Option<SymmetricDirichlet>,
    },
    Count {
        hyper: Option<PgHyper>,
        prior: Option<Gamma>,
    },
}

Stores metadata for the specific column types

Variants

Continuous

Fields

hyper: Option<NixHyper>

prior: Option<NormalInvChiSquared>

The normal inverse chi-squared prior on components in this column. If set, the hyper prior will be ignored and the prior parameters will not be updated during inference.

Univariate continuous (Gaussian) data model

Categorical

Fields

k: usize

The number of values this column can take on. For example, if values in the column are binary, k would be 2.

hyper: Option<CsdHyper>

value_map: ValueMap

Store the category type and a map from usize index to category (and the reverse).

prior: Option<SymmetricDirichlet>

The normal gamma prior on components in this column. If set, the hyper prior will be ignored and the prior parameters will not be updated during inference.

Categorical data up to 256 instances

Count

Fields

hyper: Option<PgHyper>

prior: Option<Gamma>

The normal gamma prior on components in this column. If set, the hyper prior will be ignored and the prior parameters will not be updated during inference.

Discrete count-type data in [0, ∞)

Implementations

impl ColType

pub fn is_continuous(&self) -> bool

pub fn is_categorical(&self) -> bool

pub fn is_count(&self) -> bool

pub fn value_map(&self) -> Option<&ValueMap>

Return the value map if the type is categorical and a value map exists.

pub fn ignore_hyper(&self) -> bool

Return true if the prior is set, in which case the hyper prior should be ignored, and the prior parameters should not be updated.

Trait Implementations

impl Clone for ColType

fn clone(&self) -> ColType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColType

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ColType> for ColType

fn eq(&self, other: &ColType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ColType

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ColType