Struct UnitBall

pub struct UnitBall;

Samples uniformly from the volume of the unit ball in three dimensions.

Implemented via rejection sampling.

For a distribution that samples only from the surface of the unit ball, see UnitSphere.

For a similar distribution in two dimensions, see UnitDisc.

Plot

The following plot shows the unit ball in three dimensions. This distribution samples individual points from the entire volume of the ball.

Example

use rand_distr::{UnitBall, Distribution};

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

Trait Implementations

impl Clone for UnitBall

fn clone(&self) -> UnitBall

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnitBall

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnitBall

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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 UnitBall

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 UnitBall