Enum MeasureName 

pub enum MeasureName {
    Normal,
    Exponential,
    Pareto,
    Beta,
    LogNormal,
    Gamma,
    Uniform01,
}

Named continuous distribution. A closed enum, per comprehension_forms.md §10.7.5’s “User-defined extensions” non-goal: a new distribution is a coordinated addition to it.

Variants

Normal

The normal distribution.

Exponential

The exponential distribution.

Pareto

The Pareto distribution.

Beta

The beta distribution.

LogNormal

The log-normal distribution.

Gamma

The gamma distribution.

Uniform01

The uniform distribution on [0, 1].

Implementations

impl MeasureName

pub fn is_proper_probability_measure(self) -> bool

All currently-named distributions are proper probability measures (unit total mass). V8 accepts them on any interval that matches the distribution’s support.

pub fn parameter_names(self) -> &'static [&'static str]

The distribution’s parameters, in the order a Source::Distribution’s params lists them:

Measure	Parameters	Support
Normal	mean, stddev	(-∞, ∞)
Exponential	rate	[0, ∞)
Pareto	scale, shape	[scale, ∞)
Beta	alpha, beta	[0, 1]
LogNormal	mean, stddev (of the log)	(0, ∞)
Gamma	shape, scale	[0, ∞)
Uniform01	none	[0, 1]

pub fn default_params(self) -> &'static [f64]

The standard parameters, used when a source names the measure without parameters: Normal(0, 1), Exponential(1), Pareto(1, 1), Beta(1, 1), LogNormal(0, 1), Gamma(1, 1).

pub fn resolve_params(self, params: &[f64]) -> Result<Vec<f64>, String>

The parameters as the sampler takes them: params when it has the measure’s count, the standard parameters when it is empty, and an error naming the expected parameters otherwise.

pub fn text(self) -> &'static str

The measure’s name in comprehension source text, the spelling a clause writes: normal(0, 1), log_normal(0, 0.5).

pub fn from_text(name: &str) -> Option<MeasureName>

The measure a source-text name denotes, or None when the name is not one of the closed set (comprehension_forms.md §10.7.5): the caller reads the text as something else, a generator call for one.

pub fn support(self, params: &[f64]) -> Interval

The measure’s own support under params, the interval a source that names no narrower one draws from. A Pareto’s support starts at its scale; every other measure’s is fixed.

Trait Implementations

impl Clone for MeasureName

fn clone(&self) -> MeasureName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MeasureName

impl Debug for MeasureName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MeasureName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MeasureName

impl Hash for MeasureName

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MeasureName

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MeasureName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MeasureName