Struct rstat::SimplexVector

pub struct SimplexVector(_);

Probability vector constrainted to the unit simplex.

Methods

impl SimplexVector

pub fn new(ps: Vec<f64>) -> Result<SimplexVector, Error>

Construct a new probability vector on the unit simplex.

pub fn new_unchecked<I>(ps: I) -> SimplexVector where
    I: IntoIterator<Item = f64>, 

Construct a new probability vector without enforcing constraints.

pub fn unwrap(self) -> Vec<f64>

Unwrap and return the inner Vec<f64> instance.

pub fn sample_index<R: Rng + ?Sized>(&self, rng: &mut R) -> usize

Sample a probability-weighted random index from the vector.

Trait Implementations

impl Clone for SimplexVector

fn clone(&self) -> SimplexVector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SimplexVector

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

Formats the value using the given formatter.

impl Deref for SimplexVector

type Target = [f64]

The resulting type after dereferencing.

fn deref(&self) -> &[f64]

Dereferences the value.

impl Param for SimplexVector

type Value = Vec<f64>

fn value(&self) -> &Vec<f64>

Returns a reference to the parameter's value.

fn into_value(self) -> Vec<f64>

Converts the parameter into it's value.

fn constraints() -> Constraints<Vec<f64>>

Returns the constraints associated with this parameter type.

impl TryFrom<Vec<f64>> for SimplexVector

type Error = Error

The type returned in the event of a conversion error.

fn try_from(ps: Vec<f64>) -> Result<SimplexVector, Error>

Performs the conversion.