Backup of partial refactoring of Rng not a subtrait of RngCore

Author: juntyr

necsim/core/src/cogs/rng.rs

@@ -3,11 +3,11 @@ use core::{convert::AsMut, ptr::copy_nonoverlapping};
 use serde::{de::DeserializeOwned, Serialize};
 
 use crate::{
-    cogs::{DistributionCore, DistributionSampler, Habitat, MathsCore},
+    cogs::{Backup, DistributionCore, DistributionSampler, Habitat, MathsCore},
     landscape::IndexedLocation,
 };
 
-pub trait Rng<M: MathsCore>: RngCore {
+pub trait Rng<M: MathsCore>: Backup + Clone + core::fmt::Debug {
     type Generator: RngCore;
     type Sampler;
 
@@ -17,7 +17,7 @@ pub trait Rng<M: MathsCore>: RngCore {
     #[must_use]
     fn map_generator<F: FnOnce(Self::Generator) -> Self::Generator>(self, map: F) -> Self;
 
-    fn with_rng<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q;
+    fn with<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q;
 }
 
 #[allow(clippy::module_name_repetitions)]
@@ -121,6 +121,6 @@ where
 {
     #[must_use]
     fn sample_with(&mut self, params: D::Parameters) -> D::Sample {
-        self.with_rng(|rng, samplers| samplers.sample_with(rng, samplers, params))
+        self.with(|rng, samplers| samplers.sample_with(rng, samplers, params))
     }
 }

necsim/impls/cuda/src/cogs/rng.rs

@@ -1,11 +1,9 @@
 use core::marker::PhantomData;
 
-use necsim_core::cogs::{MathsCore, Rng, RngCore};
-
 use const_type_layout::TypeGraphLayout;
 use rust_cuda::safety::StackOnly;
 
-use serde::{Deserialize, Deserializer, Serialize, Serializer};
+use necsim_core::cogs::{MathsCore, Rng};
 
 #[allow(clippy::module_name_repetitions)]
 #[derive(Debug, rust_cuda::common::LendRustToCuda)]
@@ -38,22 +36,9 @@ impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> From<R> for C
     }
 }
 
-impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> RngCore for CudaRng<M, R> {
-    type Seed = <R as RngCore>::Seed;
-
-    #[must_use]
-    #[inline]
-    fn from_seed(seed: Self::Seed) -> Self {
-        Self {
-            inner: R::from_seed(seed),
-            marker: PhantomData::<M>,
-        }
-    }
-
-    #[must_use]
-    #[inline]
-    fn sample_u64(&mut self) -> u64 {
-        self.inner.sample_u64()
+impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> CudaRng<M, R> {
+    pub fn into(self) -> R {
+        self.inner
     }
 }
 
@@ -74,26 +59,7 @@ impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> Rng<M> for Cu
         }
     }
 
-    fn with_rng<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q {
-        self.inner.with_rng(inner)
-    }
-}
-
-impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> Serialize for CudaRng<M, R> {
-    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
-        self.inner.serialize(serializer)
-    }
-}
-
-impl<'de, M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> Deserialize<'de>
-    for CudaRng<M, R>
-{
-    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
-        let inner = R::deserialize(deserializer)?;
-
-        Ok(Self {
-            inner,
-            marker: PhantomData::<M>,
-        })
+    fn with<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q {
+        self.inner.with(inner)
     }
 }

necsim/impls/no-std/src/cogs/active_lineage_sampler/alias/sampler/indexed/mod.rs

@@ -12,7 +12,7 @@ use hashbrown::HashMap;
 
 use necsim_core::cogs::{
     distribution::{IndexU128, IndexU64, IndexUsize, Length},
-    Backup, Distribution, MathsCore, Rng, Samples,
+    Backup, Distribution, MathsCore, Rng, RngCore, Samples,
 };
 use necsim_core_bond::{NonNegativeF64, PositiveF64};
 
@@ -67,7 +67,7 @@ impl<E: Eq + Hash + Backup> RejectionSamplingGroup<E> {
                 rng,
                 Length(NonZeroUsize::new_unchecked(self.weights.len())),
             );
-            let height = rng.sample_u64() >> 11;
+            let height = rng.generator().sample_u64() >> 11;
 
             // 53rd bit of weight is always 1, so sampling chance >= 50%
             if height < self.weights[index] {

necsim/impls/no-std/src/cogs/active_lineage_sampler/alias/sampler/indexed/tests.rs

@@ -191,7 +191,7 @@ fn sample_single_group() {
 
     let mut tally = [0_u64; 6];
 
-    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::seed_from_u64(24897);
+    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::from(WyHash::seed_from_u64(24897));
 
     for _ in 0..N {
         let (maybe_group, sample) = group.sample_pop(&mut lookup, &mut rng);
@@ -906,7 +906,7 @@ fn add_update_event_full() {
 fn sample_single_group_full() {
     const N: usize = 10_000_000;
 
-    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::seed_from_u64(471_093);
+    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::from(WyHash::seed_from_u64(471_093));
 
     let mut sampler = DynamicAliasMethodIndexedSampler::with_capacity(6);
 
@@ -955,7 +955,7 @@ fn sample_single_group_full() {
 fn sample_three_groups_full() {
     const N: usize = 10_000_000;
 
-    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::seed_from_u64(739_139);
+    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::from(WyHash::seed_from_u64(739_139));
 
     let mut sampler = DynamicAliasMethodIndexedSampler::with_capacity(6);
 
@@ -1001,7 +1001,7 @@ fn sample_three_groups_full() {
 fn sample_three_groups_full_reverse() {
     const N: usize = 10_000_000;
 
-    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::seed_from_u64(248_971);
+    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::from(WyHash::seed_from_u64(248_971));
 
     let mut sampler = DynamicAliasMethodIndexedSampler::with_capacity(6);
 
@@ -1123,7 +1123,7 @@ impl Rng<IntrinsicsMathsCore> for DummyRng {
         map(self)
     }
 
-    fn with_rng<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q {
+    fn with<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q {
         let samplers = DummyDistributionSamplers;
 
         inner(self, &samplers)

necsim/impls/no-std/src/cogs/active_lineage_sampler/alias/sampler/stack/mod.rs

@@ -9,7 +9,7 @@ use core::{
 
 use necsim_core::cogs::{
     distribution::{IndexU128, IndexU64, IndexUsize, Length},
-    Backup, Distribution, MathsCore, Rng, Samples,
+    Backup, Distribution, MathsCore, Rng, RngCore, Samples,
 };
 use necsim_core_bond::{NonNegativeF64, PositiveF64};
 
@@ -60,7 +60,7 @@ impl<E: Eq + Hash + Backup> RejectionSamplingGroup<E> {
                 rng,
                 Length(NonZeroUsize::new_unchecked(self.weights.len())),
             );
-            let height = rng.sample_u64() >> 11;
+            let height = rng.generator().sample_u64() >> 11;
 
             // 53rd bit of weight is always 1, so sampling chance >= 50%
             if height < self.weights[index] {

necsim/impls/no-std/src/cogs/active_lineage_sampler/alias/sampler/stack/tests.rs

@@ -105,7 +105,7 @@ fn sample_single_group() {
 
     let mut tally = [0_u64; 6];
 
-    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::seed_from_u64(24897);
+    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::from(WyHash::seed_from_u64(24897));
 
     for _ in 0..N {
         let (maybe_group, sample) = group.sample_pop(&mut rng);
@@ -405,7 +405,7 @@ fn add_remove_event_full() {
 fn sample_single_group_full() {
     const N: usize = 10_000_000;
 
-    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::seed_from_u64(471_093);
+    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::from(WyHash::seed_from_u64(471_093));
 
     let mut sampler = DynamicAliasMethodStackSampler::with_capacity(6);
 
@@ -454,7 +454,7 @@ fn sample_single_group_full() {
 fn sample_three_groups_full() {
     const N: usize = 10_000_000;
 
-    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::seed_from_u64(739_139);
+    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::from(WyHash::seed_from_u64(739_139));
 
     let mut sampler = DynamicAliasMethodStackSampler::with_capacity(6);
 
@@ -500,7 +500,7 @@ fn sample_three_groups_full() {
 fn sample_three_groups_full_reverse() {
     const N: usize = 10_000_000;
 
-    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::seed_from_u64(248_971);
+    let mut rng = SimpleRng::<IntrinsicsMathsCore, WyHash>::from(WyHash::seed_from_u64(248_971));
 
     let mut sampler = DynamicAliasMethodStackSampler::with_capacity(6);
 
@@ -622,7 +622,7 @@ impl Rng<IntrinsicsMathsCore> for DummyRng {
         map(self)
     }
 
-    fn with_rng<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q {
+    fn with<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q {
         let samplers = DummyDistributionSamplers;
 
         inner(self, &samplers)

necsim/impls/no-std/src/cogs/habitat/almost_infinite.rs

@@ -1,7 +1,7 @@
 use core::{fmt, marker::PhantomData};
 
 use necsim_core::{
-    cogs::{Backup, Habitat, MathsCore, Rng, UniformlySampleableHabitat},
+    cogs::{Backup, Habitat, MathsCore, Rng, RngCore, UniformlySampleableHabitat},
     landscape::{IndexedLocation, LandscapeExtent, Location},
 };
 use necsim_core_bond::{OffByOneU32, OffByOneU64};
@@ -82,7 +82,7 @@ impl<M: MathsCore, G: Rng<M>> UniformlySampleableHabitat<M, G> for AlmostInfinit
     #[must_use]
     #[inline]
     fn sample_habitable_indexed_location(&self, rng: &mut G) -> IndexedLocation {
-        let index = rng.sample_u64();
+        let index = rng.generator().sample_u64();
 
         IndexedLocation::new(
             Location::new(

necsim/impls/no-std/src/cogs/rng/simple.rs

@@ -3,8 +3,6 @@ use core::{
     num::{NonZeroU128, NonZeroU32, NonZeroU64, NonZeroUsize},
 };
 
-use serde::{Deserialize, Deserializer, Serialize, Serializer};
-
 use necsim_core::cogs::{
     distribution::{
         Bernoulli, Exponential, IndexU128, IndexU32, IndexU64, IndexUsize, Lambda, Length, Normal,
@@ -23,20 +21,18 @@ pub struct SimpleRng<M: MathsCore, R: RngCore> {
     marker: PhantomData<M>,
 }
 
-impl<M: MathsCore, R: RngCore> Serialize for SimpleRng<M, R> {
-    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
-        self.inner.serialize(serializer)
+impl<M: MathsCore, R: RngCore> From<R> for SimpleRng<M, R> {
+    fn from(inner: R) -> Self {
+        Self {
+            inner,
+            marker: PhantomData::<M>,
+        }
     }
 }
 
-impl<'de, M: MathsCore, R: RngCore> Deserialize<'de> for SimpleRng<M, R> {
-    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
-        let inner = R::deserialize(deserializer)?;
-
-        Ok(Self {
-            inner,
-            marker: PhantomData::<M>,
-        })
+impl<M: MathsCore, R: RngCore> SimpleRng<M, R> {
+    pub fn into(self) -> R {
+        self.inner
     }
 }
 
@@ -50,23 +46,6 @@ impl<M: MathsCore, R: RngCore> Backup for SimpleRng<M, R> {
     }
 }
 
-impl<M: MathsCore, R: RngCore> RngCore for SimpleRng<M, R> {
-    type Seed = R::Seed;
-
-    #[must_use]
-    fn from_seed(seed: Self::Seed) -> Self {
-        Self {
-            inner: R::from_seed(seed),
-            marker: PhantomData::<M>,
-        }
-    }
-
-    #[must_use]
-    fn sample_u64(&mut self) -> u64 {
-        self.inner.sample_u64()
-    }
-}
-
 impl<M: MathsCore, R: RngCore> Rng<M> for SimpleRng<M, R> {
     type Generator = R;
     type Sampler = SimplerDistributionSamplers<M, R>;
@@ -84,7 +63,7 @@ impl<M: MathsCore, R: RngCore> Rng<M> for SimpleRng<M, R> {
         }
     }
 
-    fn with_rng<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q {
+    fn with<F: FnOnce(&mut Self::Generator, &Self::Sampler) -> Q, Q>(&mut self, inner: F) -> Q {
         let samplers = SimplerDistributionSamplers {
             _marker: PhantomData::<(M, R)>,
         };

rustcoalescence/algorithms/cuda/src/launch.rs

@@ -58,13 +58,13 @@ pub fn initialise_and_simulate<
     Error: From<CudaError>,
 >(
     args: &CudaArguments,
-    rng: CudaRng<M, SimpleRng<M, WyHash>>,
+    rng: WyHash,
     scenario: O,
     pre_sampler: OriginPreSampler<M, I>,
     pause_before: Option<NonNegativeF64>,
     local_partition: &mut P,
     lineage_store_sampler_initialiser: L,
-) -> Result<SimulationOutcome<M, CudaRng<M, SimpleRng<M, WyHash>>>, Error>
+) -> Result<SimulationOutcome<WyHash>, Error>
 where
     O::Habitat: RustToCuda,
     O::DispersalSampler<
@@ -120,6 +120,8 @@ where
         R::ReportDispersal,
     >,
 {
+    let rng = CudaRng::from(SimpleRng::from(rng));
+
     let (
         habitat,
         dispersal_sampler,
@@ -236,8 +238,7 @@ where
                 .into_iter()
                 .chain(passthrough.into_iter())
                 .collect(),
-            rng: simulation.rng_mut().clone(),
-            marker: PhantomData::<M>,
+            rng: simulation.rng_mut().clone().into().into(),
         }),
     }
 }