Rename NaturalCompare and math_helpers

Author: pitdicker

src/distributions/float.rs

@@ -13,7 +13,7 @@
 use core::mem;
 use Rng;
 use distributions::{Distribution, Standard};
-use distributions::math_helpers::CastFromInt;
+use distributions::utils::CastFromInt;
 #[cfg(feature="simd_support")]
 use core::simd::*;
 

src/distributions/mod.rs

@@ -214,8 +214,8 @@ mod float;
 mod integer;
 #[cfg(feature="std")]
 mod log_gamma;
-mod math_helpers;
 mod other;
+mod utils;
 #[cfg(feature="std")]
 mod ziggurat_tables;
 #[cfg(feature="std")]

src/distributions/uniform.rs

@@ -116,7 +116,7 @@ use std::time::Duration;
 use Rng;
 use distributions::Distribution;
 use distributions::float::IntoFloat;
-use distributions::math_helpers::{WideningMultiply, NaturalCompare};
+use distributions::utils::{WideningMultiply, CompareAll};
 
 #[cfg(feature="simd_support")]
 use core::simd::*;
@@ -517,7 +517,7 @@ macro_rules! uniform_float_impl {
             {
                 let low = *low_b.borrow();
                 let high = *high_b.borrow();
-                assert!(low.cmp_lt(high),
+                assert!(low.all_lt(high),
                         "Uniform::new called with `low >= high`");
                 let scale = high - low;
                 let offset = low - scale;
@@ -533,7 +533,7 @@ macro_rules! uniform_float_impl {
             {
                 let low = *low_b.borrow();
                 let high = *high_b.borrow();
-                assert!(low.cmp_le(high),
+                assert!(low.all_le(high),
                         "Uniform::new_inclusive called with `low > high`");
                 let scale = high - low;
                 let offset = low - scale;
@@ -562,7 +562,7 @@ macro_rules! uniform_float_impl {
             {
                 let low = *low_b.borrow();
                 let high = *high_b.borrow();
-                assert!(low.cmp_lt(high),
+                assert!(low.all_lt(high),
                         "Uniform::sample_single called with low >= high");
                 let scale = high - low;
                 let offset = low - scale;

src/distributions/math_helpers.rs renamed to src/distributions/utils.rs

@@ -125,29 +125,32 @@ macro_rules! simd_float_from_int {
 #[cfg(feature="simd_support")] simd_float_from_int! { f64x8, u64x8 }
 
 
-/// `PartialOrd` for vectors compares lexicographically. We want natural order.
+/// `PartialOrd` for vectors compares lexicographically. We want to compare all
+/// the individual SIMD lanes instead, and get the combined result over all
+/// lanes. This is possible using something like `a.lt(b).all()`, but we
+/// implement it as a trait so we can write the same code for `f32` and `f64`.
 /// Only the comparison functions we need are implemented.
-pub trait NaturalCompare {
-    fn cmp_lt(self, other: Self) -> bool;
-    fn cmp_le(self, other: Self) -> bool;
+pub trait CompareAll {
+    fn all_lt(self, other: Self) -> bool;
+    fn all_le(self, other: Self) -> bool;
 }
 
-impl NaturalCompare for f32 {
-    fn cmp_lt(self, other: Self) -> bool { self < other }
-    fn cmp_le(self, other: Self) -> bool { self <= other }
+impl CompareAll for f32 {
+    fn all_lt(self, other: Self) -> bool { self < other }
+    fn all_le(self, other: Self) -> bool { self <= other }
 }
 
-impl NaturalCompare for f64 {
-    fn cmp_lt(self, other: Self) -> bool { self < other }
-    fn cmp_le(self, other: Self) -> bool { self <= other }
+impl CompareAll for f64 {
+    fn all_lt(self, other: Self) -> bool { self < other }
+    fn all_le(self, other: Self) -> bool { self <= other }
 }
 
 #[cfg(feature="simd_support")]
 macro_rules! simd_less_then {
     ($ty:ident) => {
-        impl NaturalCompare for $ty {
-            fn cmp_lt(self, other: Self) -> bool { self.lt(other).all() }
-            fn cmp_le(self, other: Self) -> bool { self.le(other).all() }
+        impl CompareAll for $ty {
+            fn all_lt(self, other: Self) -> bool { self.lt(other).all() }
+            fn all_le(self, other: Self) -> bool { self.le(other).all() }
         }
     }
 }