Struct UnitSphere

pub struct UnitSphere;

Samples uniformly from the surface of the unit sphere in three dimensions.

Implemented via a method by Marsaglia¹.

For a distribution that also samples from the interior of the sphere, see UnitBall.

For a similar distribution in two dimensions, see UnitCircle.

Plot

The following plot shows the unit sphere as a wireframe. The wireframe is meant to illustrate that this distribution samples from the surface of the sphere only, not from the interior.

Example

use rand_distr::{UnitSphere, Distribution};

let v: [f64; 3] = UnitSphere.sample(&mut rand::rng());
println!("{:?} is from the unit sphere surface.", v)

---

1. Marsaglia, George (1972). Choosing a Point from the Surface of a Sphere. Ann. Math. Statist. 43, no. 2, 645–646. ↩

Trait Implementations

impl Clone for UnitSphere

fn clone(&self) -> UnitSphere

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnitSphere

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnitSphere

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Float + SampleUniform> Distribution<[F; 3]> for UnitSphere

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

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, Self: Sized,

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, Self: Sized,

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

impl Serialize for UnitSphere

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for UnitSphere