Struct Triangular

pub struct Triangular<F>
where
    F: Float,
    StandardUniform: Distribution<F>,
{ /* private fields */ }

The triangular distribution Triangular(min, max, mode).

A continuous probability distribution parameterised by a range, and a mode (most likely value) within that range.

The probability density function is triangular. For a similar distribution with a smooth PDF, see the Pert distribution.

Plot

The following plot shows the triangular distribution with various values of min, max, and mode.

Example

use rand_distr::{Triangular, Distribution};

let d = Triangular::new(0., 5., 2.5).unwrap();
let v = d.sample(&mut rand::rng());
println!("{} is from a triangular distribution", v);

Implementations

impl<F> Triangular<F>

where F: Float, StandardUniform: Distribution<F>,

pub fn new(min: F, max: F, mode: F) -> Result<Triangular<F>, TriangularError>

Set up the Triangular distribution with defined min, max and mode.

Trait Implementations

impl<F> Clone for Triangular<F>

where F: Clone + Float, StandardUniform: Distribution<F>,

fn clone(&self) -> Triangular<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F> Debug for Triangular<F>

where F: Debug + Float, StandardUniform: Distribution<F>,

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for Triangular<F>

where F: Float + Deserialize<'de>, StandardUniform: Distribution<F>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F> Distribution<F> for Triangular<F>

where F: Float, StandardUniform: Distribution<F>,

fn sample<R>(&self, rng: &mut R) -> F

where R: Rng + ?Sized,

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> Iter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> Map<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Map sampled values to type S

impl<F> PartialEq for Triangular<F>

where F: PartialEq + Float, StandardUniform: Distribution<F>,

fn eq(&self, other: &Triangular<F>) -> bool

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

const 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<F> Serialize for Triangular<F>

where F: Float + Serialize, StandardUniform: Distribution<F>,

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<F> Copy for Triangular<F>

where F: Copy + Float, StandardUniform: Distribution<F>,

impl<F> StructuralPartialEq for Triangular<F>

where F: Float, StandardUniform: Distribution<F>,