rand_distr

Struct Triangular

Source
pub struct Triangular<F>
where F: Float, Standard: Distribution<F>,
{ /* private fields */ }
Expand description

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.

Triangular distribution

§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§

Source§

impl<F> Triangular<F>
where F: Float, Standard: Distribution<F>,

Source

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§

Source§

impl<F> Clone for Triangular<F>
where F: Float + Clone, Standard: Distribution<F>,

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F> Debug for Triangular<F>
where F: Float + Debug, Standard: Distribution<F>,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, F> Deserialize<'de> for Triangular<F>
where F: Float + Deserialize<'de>, Standard: Distribution<F>,

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<F> Distribution<F> for Triangular<F>
where F: Float, Standard: Distribution<F>,

Source§

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> F

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

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>
where R: Rng, Self: Sized,

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

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>
where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more
Source§

impl<F> PartialEq for Triangular<F>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<F> Serialize for Triangular<F>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<F> Copy for Triangular<F>
where F: Float + Copy, Standard: Distribution<F>,

Source§

impl<F> StructuralPartialEq for Triangular<F>
where F: Float, Standard: Distribution<F>,

Auto Trait Implementations§

§

impl<F> Freeze for Triangular<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for Triangular<F>
where F: RefUnwindSafe,

§

impl<F> Send for Triangular<F>
where F: Send,

§

impl<F> Sync for Triangular<F>
where F: Sync,

§

impl<F> Unpin for Triangular<F>
where F: Unpin,

§

impl<F> UnwindSafe for Triangular<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,