Struct Dist

pub struct Dist {
    pub dist: DistType,
    pub start: f64,
    pub max: f64,
}

A distribution used in a State. Can be sampled to get a value. The value is clamped to the range [start, max] if both are set.

Fields

dist: DistType

The type of distribution.

start: f64

The starting value that the sampled value is added to.

max: f64

The maximum value that can be sampled (including starting value).

Implementations

impl Dist

pub fn new(dist: DistType, start: f64, max: f64) -> Self

Create a new Dist.

pub fn validate(&self) -> Result<(), Error>

Validate that the parameters are valid for the set DistType.

pub fn sample<R: RngCore>(self, rng: &mut R) -> f64

Sample the distribution. May panic if not valid (see Self::validate()).

Trait Implementations

impl Clone for Dist

fn clone(&self) -> Dist

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dist

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

Formats the value using the given formatter.

impl Default for Dist

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Dist

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Dist

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

Formats the value using the given formatter.

impl PartialEq for Dist

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Dist

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Dist

impl StructuralPartialEq for Dist