Struct Probability

pub struct Probability(/* private fields */);

A probability in the range [0.0, 1.0] with a default of 0.5.

Implementations

impl Probability

pub fn new(prob: f64) -> Self

Creates a Probability from a f64.

Panics

Panics if the probability is outside interval [0.0, 1.0].

pub fn with<X>(self, and: X) -> (Self, X)

Merges self together with some other argument producing a product type expected by some implementations of A: Arbitrary in A::Parameters. This can be more ergonomic to work with and may help type inference.

pub fn lift<X: Default>(self) -> (Self, X)

Merges self together with some other argument generated with a default value producing a product type expected by some implementations of A: Arbitrary in A::Parameters. This can be more ergonomic to work with and may help type inference.

Trait Implementations

impl Arbitrary for Probability

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = MapInto<RangeInclusive<f64>, Probability>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Probability

fn clone(&self) -> Probability

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Probability

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

Formats the value using the given formatter.

impl Default for Probability

fn default() -> Self

The default probability is 0.5, or 50% chance.

impl From<Probability> for f64

fn from(p: Probability) -> Self

Converts to this type from the input type.

impl From<f64> for Probability

fn from(prob: f64) -> Self

Creates a Probability from a f64.

Panics

Panics if the probability is outside interval [0.0, 1.0].

impl PartialEq for Probability

fn eq(&self, other: &Probability) -> 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 Copy for Probability

impl StructuralPartialEq for Probability

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes