Enum WeightError

#[non_exhaustive]
pub enum WeightError {
    InvalidInput,
    InvalidWeight,
    InsufficientNonZero,
    Overflow,
}

Errors returned by WeightedIndex::new, WeightedIndex::update_weights and other weighted distributions

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidInput

The input weight sequence is empty, too long, or wrongly ordered

InvalidWeight

A weight is negative, too large for the distribution, or not a valid number

InsufficientNonZero

Not enough non-zero weights are available to sample values

When attempting to sample a single value this implies that all weights are zero. When attempting to sample amount values this implies that less than amount weights are greater than zero.

Overflow

Overflow when calculating the sum of weights

Trait Implementations

impl Clone for WeightError

fn clone(&self) -> WeightError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WeightError

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

Formats the value using the given formatter.

impl Display for WeightError

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

Formats the value using the given formatter.

impl Error for WeightError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for WeightError

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

impl Eq for WeightError

impl StructuralPartialEq for WeightError