src/librand/distributions/mod.rs

   1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Sampling from random distributions.
  12 //!
  13 //! This is a generalization of `Rand` to allow parameters to control the
  14 //! exact properties of the generated values, e.g. the mean and standard
  15 //! deviation of a normal distribution. The `Sample` trait is the most
  16 //! general, and allows for generating values that change some state
  17 //! internally. The `IndependentSample` trait is for generating values
  18 //! that do not need to record state.
  19
  20 #[cfg(not(test))] // only necessary for no_std
  21 use core::num::Float;
  22
  23 use core::marker::PhantomData;
  24
  25 use {Rand, Rng};
  26
  27 pub use self::range::Range;
  28 pub use self::gamma::{ChiSquared, FisherF, Gamma, StudentT};
  29 pub use self::normal::{LogNormal, Normal};
  30 pub use self::exponential::Exp;
  31
  32 pub mod range;
  33 pub mod gamma;
  34 pub mod normal;
  35 pub mod exponential;
  36
  37 /// Types that can be used to create a random instance of `Support`.
  38 pub trait Sample<Support> {
  39     /// Generate a random value of `Support`, using `rng` as the
  40     /// source of randomness.
  41     fn sample<R: Rng>(&mut self, rng: &mut R) -> Support;
  42 }
  43
  44 /// `Sample`s that do not require keeping track of state.
  45 ///
  46 /// Since no state is recorded, each sample is (statistically)
  47 /// independent of all others, assuming the `Rng` used has this
  48 /// property.
  49 // FIXME maybe having this separate is overkill (the only reason is to
  50 // take &self rather than &mut self)? or maybe this should be the
  51 // trait called `Sample` and the other should be `DependentSample`.
  52 pub trait IndependentSample<Support>: Sample<Support> {
  53     /// Generate a random value.
  54     fn ind_sample<R: Rng>(&self, &mut R) -> Support;
  55 }
  56
  57 /// A wrapper for generating types that implement `Rand` via the
  58 /// `Sample` & `IndependentSample` traits.
  59 pub struct RandSample<Sup> {
  60     _marker: PhantomData<Sup>,
  61 }
  62
  63 impl<Sup> RandSample<Sup> {
  64     pub fn new() -> RandSample<Sup> {
  65         RandSample { _marker: PhantomData }
  66     }
  67 }
  68
  69 impl<Sup: Rand> Sample<Sup> for RandSample<Sup> {
  70     fn sample<R: Rng>(&mut self, rng: &mut R) -> Sup {
  71         self.ind_sample(rng)
  72     }
  73 }
  74
  75 impl<Sup: Rand> IndependentSample<Sup> for RandSample<Sup> {
  76     fn ind_sample<R: Rng>(&self, rng: &mut R) -> Sup {
  77         rng.gen()
  78     }
  79 }
  80
  81 /// A value with a particular weight for use with `WeightedChoice`.
  82 pub struct Weighted<T> {
  83     /// The numerical weight of this item
  84     pub weight: usize,
  85     /// The actual item which is being weighted
  86     pub item: T,
  87 }
  88
  89 /// A distribution that selects from a finite collection of weighted items.
  90 ///
  91 /// Each item has an associated weight that influences how likely it
  92 /// is to be chosen: higher weight is more likely.
  93 ///
  94 /// The `Clone` restriction is a limitation of the `Sample` and
  95 /// `IndependentSample` traits. Note that `&T` is (cheaply) `Clone` for
  96 /// all `T`, as is `usize`, so one can store references or indices into
  97 /// another vector.
  98 pub struct WeightedChoice<'a, T: 'a> {
  99     items: &'a mut [Weighted<T>],
 100     weight_range: Range<usize>,
 101 }
 102
 103 impl<'a, T: Clone> WeightedChoice<'a, T> {
 104     /// Create a new `WeightedChoice`.
 105     ///
 106     /// Panics if:
 107     /// - `v` is empty
 108     /// - the total weight is 0
 109     /// - the total weight is larger than a `usize` can contain.
 110     pub fn new(items: &'a mut [Weighted<T>]) -> WeightedChoice<'a, T> {
 111         // strictly speaking, this is subsumed by the total weight == 0 case
 112         assert!(!items.is_empty(),
 113                 "WeightedChoice::new called with no items");
 114
 115         let mut running_total = 0_usize;
 116
 117         // we convert the list from individual weights to cumulative
 118         // weights so we can binary search. This *could* drop elements
 119         // with weight == 0 as an optimisation.
 120         for item in &mut *items {
 121             running_total = match running_total.checked_add(item.weight) {
 122                 Some(n) => n,
 123                 None => {
 124                     panic!("WeightedChoice::new called with a total weight larger than a usize \
 125                             can contain")
 126                 }
 127             };
 128
 129             item.weight = running_total;
 130         }
 131         assert!(running_total != 0,
 132                 "WeightedChoice::new called with a total weight of 0");
 133
 134         WeightedChoice {
 135             items: items,
 136             // we're likely to be generating numbers in this range
 137             // relatively often, so might as well cache it
 138             weight_range: Range::new(0, running_total),
 139         }
 140     }
 141 }
 142
 143 impl<'a, T: Clone> Sample<T> for WeightedChoice<'a, T> {
 144     fn sample<R: Rng>(&mut self, rng: &mut R) -> T {
 145         self.ind_sample(rng)
 146     }
 147 }
 148
 149 impl<'a, T: Clone> IndependentSample<T> for WeightedChoice<'a, T> {
 150     fn ind_sample<R: Rng>(&self, rng: &mut R) -> T {
 151         // we want to find the first element that has cumulative
 152         // weight > sample_weight, which we do by binary since the
 153         // cumulative weights of self.items are sorted.
 154
 155         // choose a weight in [0, total_weight)
 156         let sample_weight = self.weight_range.ind_sample(rng);
 157
 158         // short circuit when it's the first item
 159         if sample_weight < self.items[0].weight {
 160             return self.items[0].item.clone();
 161         }
 162
 163         let mut idx = 0;
 164         let mut modifier = self.items.len();
 165
 166         // now we know that every possibility has an element to the
 167         // left, so we can just search for the last element that has
 168         // cumulative weight <= sample_weight, then the next one will
 169         // be "it". (Note that this greatest element will never be the
 170         // last element of the vector, since sample_weight is chosen
 171         // in [0, total_weight) and the cumulative weight of the last
 172         // one is exactly the total weight.)
 173         while modifier > 1 {
 174             let i = idx + modifier / 2;
 175             if self.items[i].weight <= sample_weight {
 176                 // we're small, so look to the right, but allow this
 177                 // exact element still.
 178                 idx = i;
 179                 // we need the `/ 2` to round up otherwise we'll drop
 180                 // the trailing elements when `modifier` is odd.
 181                 modifier += 1;
 182             } else {
 183                 // otherwise we're too big, so go left. (i.e. do
 184                 // nothing)
 185             }
 186             modifier /= 2;
 187         }
 188         return self.items[idx + 1].item.clone();
 189     }
 190 }
 191
 192 mod ziggurat_tables;
 193
 194 /// Sample a random number using the Ziggurat method (specifically the
 195 /// ZIGNOR variant from Doornik 2005). Most of the arguments are
 196 /// directly from the paper:
 197 ///
 198 /// * `rng`: source of randomness
 199 /// * `symmetric`: whether this is a symmetric distribution, or one-sided with P(x < 0) = 0.
 200 /// * `X`: the $x_i$ abscissae.
 201 /// * `F`: precomputed values of the PDF at the $x_i$, (i.e. $f(x_i)$)
 202 /// * `F_DIFF`: precomputed values of $f(x_i) - f(x_{i+1})$
 203 /// * `pdf`: the probability density function
 204 /// * `zero_case`: manual sampling from the tail when we chose the
 205 ///    bottom box (i.e. i == 0)
 206 // the perf improvement (25-50%) is definitely worth the extra code
 207 // size from force-inlining.
 208 #[inline(always)]
 209 fn ziggurat<R: Rng, P, Z>(rng: &mut R,
 210                           symmetric: bool,
 211                           x_tab: ziggurat_tables::ZigTable,
 212                           f_tab: ziggurat_tables::ZigTable,
 213                           mut pdf: P,
 214                           mut zero_case: Z)
 215                           -> f64
 216     where P: FnMut(f64) -> f64,
 217           Z: FnMut(&mut R, f64) -> f64
 218 {
 219     const SCALE: f64 = (1u64 << 53) as f64;
 220     loop {
 221         // reimplement the f64 generation as an optimisation suggested
 222         // by the Doornik paper: we have a lot of precision-space
 223         // (i.e. there are 11 bits of the 64 of a u64 to use after
 224         // creating a f64), so we might as well reuse some to save
 225         // generating a whole extra random number. (Seems to be 15%
 226         // faster.)
 227         //
 228         // This unfortunately misses out on the benefits of direct
 229         // floating point generation if an RNG like dSMFT is
 230         // used. (That is, such RNGs create floats directly, highly
 231         // efficiently and overload next_f32/f64, so by not calling it
 232         // this may be slower than it would be otherwise.)
 233         // FIXME: investigate/optimise for the above.
 234         let bits: u64 = rng.gen();
 235         let i = (bits & 0xff) as usize;
 236         let f = (bits >> 11) as f64 / SCALE;
 237
 238         // u is either U(-1, 1) or U(0, 1) depending on if this is a
 239         // symmetric distribution or not.
 240         let u = if symmetric { 2.0 * f - 1.0 } else { f };
 241         let x = u * x_tab[i];
 242
 243         let test_x = if symmetric { x.abs() } else { x };
 244
 245         // algebraically equivalent to |u| < x_tab[i+1]/x_tab[i] (or u < x_tab[i+1]/x_tab[i])
 246         if test_x < x_tab[i + 1] {
 247             return x;
 248         }
 249         if i == 0 {
 250             return zero_case(rng, u);
 251         }
 252         // algebraically equivalent to f1 + DRanU()*(f0 - f1) < 1
 253         if f_tab[i + 1] + (f_tab[i] - f_tab[i + 1]) * rng.gen::<f64>() < pdf(x) {
 254             return x;
 255         }
 256     }
 257 }
 258
 259 #[cfg(test)]
 260 mod tests {
 261     use {Rand, Rng};
 262     use super::{IndependentSample, RandSample, Sample, Weighted, WeightedChoice};
 263
 264     #[derive(PartialEq, Debug)]
 265     struct ConstRand(usize);
 266     impl Rand for ConstRand {
 267         fn rand<R: Rng>(_: &mut R) -> ConstRand {
 268             ConstRand(0)
 269         }
 270     }
 271
 272     // 0, 1, 2, 3, ...
 273     struct CountingRng {
 274         i: u32,
 275     }
 276     impl Rng for CountingRng {
 277         fn next_u32(&mut self) -> u32 {
 278             self.i += 1;
 279             self.i - 1
 280         }
 281         fn next_u64(&mut self) -> u64 {
 282             self.next_u32() as u64
 283         }
 284     }
 285
 286     #[test]
 287     fn test_rand_sample() {
 288         let mut rand_sample = RandSample::<ConstRand>::new();
 289
 290         assert_eq!(rand_sample.sample(&mut ::test::rng()), ConstRand(0));
 291         assert_eq!(rand_sample.ind_sample(&mut ::test::rng()), ConstRand(0));
 292     }
 293     #[test]
 294     #[rustfmt_skip]
 295     fn test_weighted_choice() {
 296         // this makes assumptions about the internal implementation of
 297         // WeightedChoice, specifically: it doesn't reorder the items,
 298         // it doesn't do weird things to the RNG (so 0 maps to 0, 1 to
 299         // 1, internally; modulo a modulo operation).
 300
 301         macro_rules! t {
 302             ($items:expr, $expected:expr) => {{
 303                 let mut items = $items;
 304                 let wc = WeightedChoice::new(&mut items);
 305                 let expected = $expected;
 306
 307                 let mut rng = CountingRng { i: 0 };
 308
 309                 for &val in &expected {
 310                     assert_eq!(wc.ind_sample(&mut rng), val)
 311                 }
 312             }}
 313         }
 314
 315         t!(vec![Weighted { weight: 1, item: 10 }],
 316            [10]);
 317
 318         // skip some
 319         t!(vec![Weighted { weight: 0, item: 20 },
 320                 Weighted { weight: 2, item: 21 },
 321                 Weighted { weight: 0, item: 22 },
 322                 Weighted { weight: 1, item: 23 }],
 323            [21, 21, 23]);
 324
 325         // different weights
 326         t!(vec![Weighted { weight: 4, item: 30 },
 327                 Weighted { weight: 3, item: 31 }],
 328            [30, 30, 30, 30, 31, 31, 31]);
 329
 330         // check that we're binary searching
 331         // correctly with some vectors of odd
 332         // length.
 333         t!(vec![Weighted { weight: 1, item: 40 },
 334                 Weighted { weight: 1, item: 41 },
 335                 Weighted { weight: 1, item: 42 },
 336                 Weighted { weight: 1, item: 43 },
 337                 Weighted { weight: 1, item: 44 }],
 338            [40, 41, 42, 43, 44]);
 339         t!(vec![Weighted { weight: 1, item: 50 },
 340                 Weighted { weight: 1, item: 51 },
 341                 Weighted { weight: 1, item: 52 },
 342                 Weighted { weight: 1, item: 53 },
 343                 Weighted { weight: 1, item: 54 },
 344                 Weighted { weight: 1, item: 55 },
 345                 Weighted { weight: 1, item: 56 }],
 346            [50, 51, 52, 53, 54, 55, 56]);
 347     }
 348
 349     #[test]
 350     #[should_panic]
 351     fn test_weighted_choice_no_items() {
 352         WeightedChoice::<isize>::new(&mut []);
 353     }
 354     #[test]
 355     #[should_panic]
 356     #[rustfmt_skip]
 357     fn test_weighted_choice_zero_weight() {
 358         WeightedChoice::new(&mut [Weighted { weight: 0, item: 0 },
 359                                   Weighted { weight: 0, item: 1 }]);
 360     }
 361     #[test]
 362     #[should_panic]
 363     #[rustfmt_skip]
 364     fn test_weighted_choice_weight_overflows() {
 365         let x = (!0) as usize / 2; // x + x + 2 is the overflow
 366         WeightedChoice::new(&mut [Weighted { weight: x, item: 0 },
 367                                   Weighted { weight: 1, item: 1 },
 368                                   Weighted { weight: x, item: 2 },
 369                                   Weighted { weight: 1, item: 3 }]);
 370     }
 371 }