weighted-list 0.6.1

Data structures for weighted randomisation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

use std::*;

use num_traits as nums;


/// Any numerical type, such as `u32`, `usize`, `f64`. The type `W` of item weights in a [`WeightedList<V,W>`](crate::WeightedList) must implement this trait.
pub trait Weight:
      Copy
    + nums::NumAssign
    + nums::NumCast
    + PartialOrd
    + iter::Sum
    + fmt::Debug
{}

/// Auto implementation for all types that fulfil the trait’s requirements.
impl<Type> Weight for Type where Type:
      Copy
    + nums::NumAssign
    + nums::NumCast
    + PartialOrd
    + iter::Sum
    + fmt::Debug
{}


/// An error returned when failing to cast one numeric type to another, which may be required for certain [`WeightedList`](crate::WeightedList) operations.
#[derive(Debug)]
pub struct NumCastError(pub(crate) &'static str);

impl std::fmt::Display for NumCastError
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
    {
        write!(f, "{}", self.0)
    }
}

impl std::error::Error for NumCastError {}