Struct ProbabilityThreshold 

pub struct ProbabilityThreshold { /* private fields */ }

PBIL can be considered done when all probabilities are above this threshold or below the inverse.

Implementations

impl ProbabilityThreshold

pub fn new(value: Probability) -> Result<Self, InvalidProbabilityThresholdError>

Return a new ‘ConvergedThreshold’ if given a valid value.

pub fn into_inner(self) -> Probability

Unwrap ‘ConvergedThreshold’ into inner value.

pub fn upper_bound(&self) -> Probability

Return the threshold upper bound.

pub fn lower_bound(&self) -> Probability

Return the threshold lower bound.

Trait Implementations

impl Clone for ProbabilityThreshold

fn clone(&self) -> ProbabilityThreshold

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProbabilityThreshold

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

Formats the value using the given formatter.

impl Default for ProbabilityThreshold

fn default() -> Self

Returns the “default value” for a type.

impl From<ProbabilityThreshold> for Probability

fn from(x: ProbabilityThreshold) -> Self

Converts to this type from the input type.

impl LowerBounded for ProbabilityThreshold

fn min_value() -> Self

Returns the smallest finite number this type can represent

impl Ord for ProbabilityThreshold

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ProbabilityThreshold

fn eq(&self, other: &Self) -> 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 PartialOrd for ProbabilityThreshold

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<Probability> for ProbabilityThreshold

type Error = InvalidProbabilityThresholdError

The type returned in the event of a conversion error.

fn try_from(value: Probability) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperBounded for ProbabilityThreshold

fn max_value() -> Self

Returns the largest finite number this type can represent

impl Copy for ProbabilityThreshold

impl Eq for ProbabilityThreshold