     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
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67

    // Copyright 2018 Developers of the Rand project.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! The Pareto distribution.
    #![allow(deprecated)]

    use crate::Rng;
    use crate::distributions::{Distribution, OpenClosed01};

    /// Samples floating-point numbers according to the Pareto distribution
    #[deprecated(since="0.7.0", note="moved to rand_distr crate")]
    #[derive(Clone, Copy, Debug)]
    pub struct Pareto {
        scale: f64,
        inv_neg_shape: f64,
    }

    impl Pareto {
        /// Construct a new Pareto distribution with given `scale` and `shape`.
        ///
        /// In the literature, `scale` is commonly written as x<sub>m</sub> or k and
        /// `shape` is often written as α.
        ///
        /// # Panics
        ///
        /// `scale` and `shape` have to be non-zero and positive.
        pub fn new(scale: f64, shape: f64) -> Pareto {
            assert!((scale > 0.) & (shape > 0.));
            Pareto { scale, inv_neg_shape: -1.0 / shape }
        }
    }

    impl Distribution<f64> for Pareto {
        fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64 {
            let u: f64 = rng.sample(OpenClosed01);
            self.scale * u.powf(self.inv_neg_shape)
        }
    }

    #[cfg(test)]
    mod tests {
        use crate::distributions::Distribution;
        use super::Pareto;

        #[test]
        #[should_panic]
        fn invalid() {
            Pareto::new(0., 0.);
        }

        #[test]
        fn sample() {
            let scale = 1.0;
            let shape = 2.0;
            let d = Pareto::new(scale, shape);
            let mut rng = crate::test::rng(1);
            for _ in 0..1000 {
                let r = d.sample(&mut rng);
                assert!(r >= scale);
            }
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)