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 duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnitSphere

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

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<UnitSphere, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F> Distribution<[F; 3]> for UnitSphere

where F: Float + SampleUniform,

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

where R: Rng + ?Sized,

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

fn sample_iter<R>(self, rng: R) -> Iter<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) -> Map<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Map sampled values to type S

impl Serialize for UnitSphere

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for UnitSphere