Struct rand_distr::UnitCircle

pub struct UnitCircle;

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

Implemented via a method by von Neumann¹.

Example

use rand_distr::{UnitCircle, Distribution};

let v: [f64; 2] = UnitCircle.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. ↩

Trait Implementations

impl Clone for UnitCircle

fn clone(&self) -> UnitCircle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnitCircle

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

Formats the value using the given formatter.

impl<F: Float + SampleUniform> Distribution<[F; 2]> for UnitCircle

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

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

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>where
    R: Rng,

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

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>where
    F: Fn(T) -> S,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl Copy for UnitCircle