Struct cont_arith_code::distribution::categorical::TruncatedCategorical

pub struct TruncatedCategorical {
    pub ln_ps: Vec<f64>,
    /* private fields */
}

Fields

ln_ps: Vec<f64>

Implementations

impl TruncatedCategorical

pub fn new(ln_ps: Vec<f64>) -> TruncatedCategorical

Construction given a vector of log-probabilities

pub fn normalize(&mut self)

Trait Implementations

impl Clone for TruncatedCategorical

fn clone(&self) -> TruncatedCategorical

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TruncatedCategorical

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

Formats the value using the given formatter.

impl PartialEq for TruncatedCategorical

fn eq(&self, other: &TruncatedCategorical) -> 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 PartialOrd for TruncatedCategorical

fn partial_cmp(&self, other: &TruncatedCategorical) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TruncatedDistribution for TruncatedCategorical

fn quantile(&self, cp: f64) -> (i64, f64)

Given a cumulative probability [0-1), return the category/bin in which it falls (intervals are inclusive of lower-bound, exclusive of upper-bount, i.e. [lo,hi)). Cumulative probability is counted from self.lo_split (our zero) up to self.hi_split (our one). Returns the index of the bin and where (as a ratio) the cumulative probability falls within that bin. Ratio on lo and hi bounds are counted relative to their respective prior split.

fn is_resolved(&self) -> bool

Assumes input is trimmed

fn truncate(&mut self, cp: f64, s: i64, s_rem: f64, bit: bool)

Split the remaining probability mass with the given bit (false:0:left :: true:1:right) at the given cumulative probability, which we already know splits at index s with remainder s_rem.

fn lo(&self) -> i64

Return the index of the lower-bound of the interval of the truncation.

fn hi(&self) -> i64

Return the index of the upper-bound of the interval of the truncation.

impl StructuralPartialEq for TruncatedCategorical