summaryrefslogtreecommitdiff
path: root/rand/rand_distr/src/unit_sphere.rs
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2020-01-02 08:32:06 -0800
committerDaniel Mueller <deso@posteo.net>2020-01-02 08:32:06 -0800
commitfd091b04316db9dc5fafadbd6bdbe60b127408a9 (patch)
treef202270f7ae5cedc513be03833a26148d9b5e219 /rand/rand_distr/src/unit_sphere.rs
parent8161cdb26f98e65b39c603ddf7a614cc87c77a1c (diff)
downloadnitrocli-fd091b04316db9dc5fafadbd6bdbe60b127408a9.tar.gz
nitrocli-fd091b04316db9dc5fafadbd6bdbe60b127408a9.tar.bz2
Update nitrokey crate to 0.4.0
This change finally updates the version of the nitrokey crate that we consume to 0.4.0. Along with that we update rand_core, one of its dependencies, to 0.5.1. Further more we add cfg-if in version 0.1.10 and getrandom in version 0.1.13, both of which are now new (non-development) dependencies. Import subrepo nitrokey/:nitrokey at e81057037e9b4f370b64c0a030a725bc6bdfb870 Import subrepo cfg-if/:cfg-if at 4484a6faf816ff8058088ad857b0c6bb2f4b02b2 Import subrepo getrandom/:getrandom at d661aa7e1b8cc80b47dabe3d2135b3b47d2858af Import subrepo rand/:rand at d877ed528248b52d947e0484364a4e1ae59ca502
Diffstat (limited to 'rand/rand_distr/src/unit_sphere.rs')
-rw-r--r--rand/rand_distr/src/unit_sphere.rs94
1 files changed, 94 insertions, 0 deletions
diff --git a/rand/rand_distr/src/unit_sphere.rs b/rand/rand_distr/src/unit_sphere.rs
new file mode 100644
index 0000000..8e0c361
--- /dev/null
+++ b/rand/rand_distr/src/unit_sphere.rs
@@ -0,0 +1,94 @@
+// Copyright 2018-2019 Developers of the Rand project.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use rand::Rng;
+use crate::{Distribution, Uniform, uniform::SampleUniform};
+use crate::utils::Float;
+
+/// Samples uniformly from the surface of the unit sphere in three dimensions.
+///
+/// Implemented via a method by Marsaglia[^1].
+///
+///
+/// # Example
+///
+/// ```
+/// use rand_distr::{UnitSphere, Distribution};
+///
+/// let v: [f64; 3] = UnitSphere.sample(&mut rand::thread_rng());
+/// println!("{:?} is from the unit sphere surface.", v)
+/// ```
+///
+/// [^1]: Marsaglia, George (1972). [*Choosing a Point from the Surface of a
+/// Sphere.*](https://doi.org/10.1214/aoms/1177692644)
+/// Ann. Math. Statist. 43, no. 2, 645--646.
+#[derive(Clone, Copy, Debug)]
+pub struct UnitSphere;
+
+impl<N: Float + SampleUniform> Distribution<[N; 3]> for UnitSphere {
+ #[inline]
+ fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> [N; 3] {
+ let uniform = Uniform::new(N::from(-1.), N::from(1.));
+ loop {
+ let (x1, x2) = (uniform.sample(rng), uniform.sample(rng));
+ let sum = x1*x1 + x2*x2;
+ if sum >= N::from(1.) {
+ continue;
+ }
+ let factor = N::from(2.) * (N::from(1.0) - sum).sqrt();
+ return [x1 * factor, x2 * factor, N::from(1.) - N::from(2.)*sum];
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use crate::Distribution;
+ use super::UnitSphere;
+
+ /// Assert that two numbers are almost equal to each other.
+ ///
+ /// On panic, this macro will print the values of the expressions with their
+ /// debug representations.
+ macro_rules! assert_almost_eq {
+ ($a:expr, $b:expr, $prec:expr) => (
+ let diff = ($a - $b).abs();
+ if diff > $prec {
+ panic!(format!(
+ "assertion failed: `abs(left - right) = {:.1e} < {:e}`, \
+ (left: `{}`, right: `{}`)",
+ diff, $prec, $a, $b));
+ }
+ );
+ }
+
+ #[test]
+ fn norm() {
+ let mut rng = crate::test::rng(1);
+ for _ in 0..1000 {
+ let x: [f64; 3] = UnitSphere.sample(&mut rng);
+ assert_almost_eq!(x[0]*x[0] + x[1]*x[1] + x[2]*x[2], 1., 1e-15);
+ }
+ }
+
+ #[test]
+ fn value_stability() {
+ let mut rng = crate::test::rng(2);
+ let expected = [
+ [0.03247542860231647, -0.7830477442152738, 0.6211131755296027],
+ [-0.09978440840914075, 0.9706650829833128, -0.21875184231323952],
+ [0.2735582468624679, 0.9435374242279655, -0.1868234852870203],
+ ];
+ let samples: [[f64; 3]; 3] = [
+ UnitSphere.sample(&mut rng),
+ UnitSphere.sample(&mut rng),
+ UnitSphere.sample(&mut rng),
+ ];
+ assert_eq!(samples, expected);
+ }
+}