Struct rand::distributions::UnitCircle

pub struct UnitCircle { /* fields omitted */ }

Samples uniformly from the edge of the unit circle in two dimensions.

Implemented via a method by von Neumann¹.

Example

use rand::distributions::{UnitCircle, Distribution};

let circle = UnitCircle::new();
let v = circle.sample(&mut rand::thread_rng());
println!("{:?} is from the unit circle.", v)

---

1. von Neumann, J. (1951) Various Techniques Used in Connection with Random Digits. NBS Appl. Math. Ser., No. 12. Washington, DC: U.S. Government Printing Office, pp. 36-38. ↩

Methods

impl UnitCircle

pub fn new() -> UnitCircle

Construct a new UnitCircle distribution.

Trait Implementations

impl Distribution<[f64; 2]> for UnitCircle

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> [f64; 2]

Generate a random value of T, using rng as the source of randomness.

Important traits for DistIter<'a, D, R, T>

impl<'a, D, R, T> Iterator for DistIter<'a, D, R, T> where
    D: Distribution<T>,
    R: Rng + 'a,  type Item = T;

fn sample_iter<'a, R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T> where     Self: Sized,     R: Rng,

Create an iterator that generates random values of T, using rng as the source of randomness.

impl Clone for UnitCircle

fn clone(&self) -> UnitCircle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for UnitCircle

impl Debug for UnitCircle

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

Formats the value using the given formatter.