Struct SphericalDisk 

pub struct SphericalDisk<const N: usize> {
    pub disk_radius: PositiveReal,
    pub point: Spherical<N>,
}

Randomly distribute points locally on a sphere.

SphericalDisk is a uniform distribution of points within distance r of a point on the 2-sphere with a given radius.

Example

use hoomd_manifold::{Spherical, SphericalDisk};
use hoomd_vector::{Cartesian, Metric};
use rand::{Rng, SeedableRng, distr::Distribution, rngs::StdRng};

let mut rng = StdRng::seed_from_u64(12);

let sample_disk =
    SphericalDisk {
        disk_radius: 0.5_f64.try_into()?,
        point: Spherical::<3>::from_cartesian_coordinates(Cartesian::from(
            [0.01, 0.01, -(1.0 - 2.0 * (0.01_f64).powi(2)).sqrt()],
        )),
    };
let random_point: Spherical<3> = sample_disk.sample(&mut rng);

let disk = SphericalDisk {
    disk_radius: 0.1_f64.try_into()?,
    point: random_point,
};
let transformed_random_point: Spherical<3> = disk.sample(&mut rng);

assert!(0.1 > random_point.distance(&transformed_random_point));

Fields

disk_radius: PositiveReal

Max distance away from point.

point: Spherical<N>

The center of the disk.

Trait Implementations

impl<const N: usize> Clone for SphericalDisk<N>

fn clone(&self) -> SphericalDisk<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for SphericalDisk<N>

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

Formats the value using the given formatter.

impl<'de, const N: usize> Deserialize<'de> for SphericalDisk<N>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Distribution<Spherical<3>> for SphericalDisk<3>

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Spherical<3>

Translates 3-dimensional cartesian vector named “point” along the surface of a sphere by maximum distance of r.

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 Distribution<Spherical<4>> for SphericalDisk<4>

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Spherical<4>

Translates 3-dimensional cartesian vector named “point” along the surface of a sphere by maximum distance of r.

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<const N: usize> PartialEq for SphericalDisk<N>

fn eq(&self, other: &SphericalDisk<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const N: usize> Serialize for SphericalDisk<N>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> StructuralPartialEq for SphericalDisk<N>