Struct HyperbolicDisk 

pub struct HyperbolicDisk {
    pub disk_radius: PositiveReal,
    pub point: Hyperbolic<3>,
}

Randomly distribute points locally on a hyperboloid.

HyperbolicDisk is a uniform distribution of points within distance r of a point on the 2-dimensional hyperboloid.

Example

use hoomd_manifold::{
    Hyperbolic, HyperbolicAngle, HyperbolicDisk, HyperbolicRotate,
    HyperbolicRotationMatrix, Minkowski,
};
use hoomd_vector::Metric;
use rand::{RngExt, SeedableRng, distr::Distribution, rngs::StdRng};

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

let v: HyperbolicAngle = rng.random();
let matrix = HyperbolicRotationMatrix::from(v);
let origin = Minkowski::from([0.0, 0.0, 1.0]);
let random_point = Hyperbolic::from_minkowski_coordinates(
    matrix.hyperbolic_rotate(&origin),
);

let r = 0.1;
let mut rng_2 = StdRng::seed_from_u64(239);
let disk = HyperbolicDisk {
    disk_radius: r.try_into()?,
    point: random_point,
};
let transformed_random_point: Hyperbolic<3> = disk.sample(&mut rng_2);

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

Fields

disk_radius: PositiveReal

Max distance away from point.

point: Hyperbolic<3>

The center of the disk.

Trait Implementations

impl Clone for HyperbolicDisk

fn clone(&self) -> HyperbolicDisk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperbolicDisk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HyperbolicDisk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Distribution<Hyperbolic<3>> for HyperbolicDisk

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

Sample a random point in the hyperbolic disk.

The implementation translates Minkowski 3-vector point along the Hyperbolic by maximum distance of disk_radius. Note that because SO(2,1) is non-Abelian, the point must be transformed to the cusp before a trial move is applied (and then the point is transformed back). This ensures that the max distance translated by the trial move does not exceed disk_radius.

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 PartialEq for HyperbolicDisk

fn eq(&self, other: &HyperbolicDisk) -> 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 Serialize for HyperbolicDisk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HyperbolicDisk