Refactored Rng+RngCore without Clone

juntyr · juntyr · commit 1b5997104c9b · 2023-07-05T06:43:52.000Z
diff --git a/necsim/core/src/cogs/active_lineage_sampler.rs b/necsim/core/src/cogs/active_lineage_sampler.rs
@@ -3,8 +3,8 @@ use core::ops::ControlFlow;
 use necsim_core_bond::{NonNegativeF64, PositiveF64};
 
 use super::{
-    CoalescenceSampler, DispersalSampler, EmigrationExit, EventSampler, Habitat, ImmigrationEntry,
-    LineageStore, MathsCore, Rng, SpeciationProbability, TurnoverRate,
+    Backup, CoalescenceSampler, DispersalSampler, EmigrationExit, EventSampler, Habitat,
+    ImmigrationEntry, LineageStore, MathsCore, Rng, SpeciationProbability, TurnoverRate,
 };
 
 use crate::{lineage::Lineage, simulation::partial::active_lineage_sampler::PartialSimulation};
@@ -24,7 +24,7 @@ pub trait ActiveLineageSampler<
     N: SpeciationProbability<M, H>,
     E: EventSampler<M, H, G, S, X, D, C, T, N>,
     I: ImmigrationEntry<M>,
->: crate::cogs::Backup + core::fmt::Debug
+>: Backup + core::fmt::Debug
 {
     type LineageIterator<'a>: Iterator<Item = &'a Lineage>
     where
diff --git a/necsim/core/src/cogs/coalescence_sampler.rs b/necsim/core/src/cogs/coalescence_sampler.rs
@@ -16,7 +16,7 @@ use crate::{
 #[allow(clippy::inline_always, clippy::inline_fn_without_body)]
 #[contract_trait]
 pub trait CoalescenceSampler<M: MathsCore, H: Habitat<M>, S: LineageStore<M, H>>:
-    crate::cogs::Backup + core::fmt::Debug
+    Backup + core::fmt::Debug
 {
     #[must_use]
     #[debug_requires(habitat.get_habitat_at_location(&location) > 0, "location is habitable")]
diff --git a/necsim/core/src/cogs/dispersal_sampler.rs b/necsim/core/src/cogs/dispersal_sampler.rs
@@ -1,7 +1,7 @@
 use necsim_core_bond::ClosedUnitF64;
 
 use crate::{
-    cogs::{MathsCore, Rng},
+    cogs::{Backup, MathsCore, Rng},
     landscape::Location,
 };
 
@@ -12,7 +12,7 @@ use super::Habitat;
 #[allow(clippy::module_name_repetitions)]
 #[contract_trait]
 pub trait DispersalSampler<M: MathsCore, H: Habitat<M>, G: Rng<M>>:
-    crate::cogs::Backup + core::fmt::Debug
+    Backup + core::fmt::Debug
 {
     #[must_use]
     #[debug_requires(habitat.is_location_habitable(location), "location is habitable")]
diff --git a/necsim/core/src/cogs/emigration_exit.rs b/necsim/core/src/cogs/emigration_exit.rs
@@ -1,7 +1,7 @@
 use necsim_core_bond::{NonNegativeF64, PositiveF64};
 
 use crate::{
-    cogs::{Habitat, LineageStore, MathsCore, Rng},
+    cogs::{Backup, Habitat, LineageStore, MathsCore, Rng},
     landscape::{IndexedLocation, Location},
     lineage::GlobalLineageReference,
     simulation::partial::emigration_exit::PartialSimulation,
@@ -15,7 +15,7 @@ use crate::{
 #[allow(clippy::no_effect_underscore_binding)]
 #[contract_trait]
 pub trait EmigrationExit<M: MathsCore, H: Habitat<M>, G: Rng<M>, S: LineageStore<M, H>>:
-    crate::cogs::Backup + core::fmt::Debug
+    Backup + core::fmt::Debug
 {
     #[must_use]
     #[debug_ensures(match &ret {
diff --git a/necsim/core/src/cogs/event_sampler.rs b/necsim/core/src/cogs/event_sampler.rs
@@ -1,8 +1,8 @@
 use necsim_core_bond::PositiveF64;
 
 use super::{
-    CoalescenceSampler, DispersalSampler, EmigrationExit, Habitat, LineageStore, MathsCore, Rng,
-    SpeciationProbability, TurnoverRate,
+    Backup, CoalescenceSampler, DispersalSampler, EmigrationExit, Habitat, LineageStore, MathsCore,
+    Rng, SpeciationProbability, TurnoverRate,
 };
 use crate::{
     event::{DispersalEvent, SpeciationEvent},
@@ -28,7 +28,7 @@ pub trait EventSampler<
     C: CoalescenceSampler<M, H, S>,
     T: TurnoverRate<M, H>,
     N: SpeciationProbability<M, H>,
->: crate::cogs::Backup + core::fmt::Debug
+>: Backup + core::fmt::Debug
 {
     #[must_use]
     fn sample_event_for_lineage_at_event_time_or_emigrate<
diff --git a/necsim/core/src/cogs/habitat.rs b/necsim/core/src/cogs/habitat.rs
@@ -2,15 +2,15 @@ use necsim_core_bond::OffByOneU64;
 
 use crate::landscape::{IndexedLocation, LandscapeExtent, Location};
 
-use super::{MathsCore, Rng};
+use super::{Backup, MathsCore, Rng};
 
 #[allow(
     clippy::inline_always,
     clippy::inline_fn_without_body,
     clippy::no_effect_underscore_binding
 )]
 #[contract_trait]
-pub trait Habitat<M: MathsCore>: crate::cogs::Backup + core::fmt::Debug + Sized {
+pub trait Habitat<M: MathsCore>: Backup + core::fmt::Debug {
     type LocationIterator<'a>: Iterator<Item = Location> + 'a
     where
         Self: 'a;
diff --git a/necsim/core/src/cogs/immigration_entry.rs b/necsim/core/src/cogs/immigration_entry.rs
@@ -1,10 +1,10 @@
 use crate::lineage::MigratingLineage;
 
-use super::MathsCore;
+use super::{Backup, MathsCore};
 
 #[allow(clippy::inline_always, clippy::inline_fn_without_body)]
 #[contract_trait]
-pub trait ImmigrationEntry<M: MathsCore>: crate::cogs::Backup + core::fmt::Debug {
+pub trait ImmigrationEntry<M: MathsCore>: Backup + core::fmt::Debug {
     #[must_use]
     fn next_optional_immigration(&mut self) -> Option<MigratingLineage>;
 
diff --git a/necsim/core/src/cogs/lineage_reference.rs b/necsim/core/src/cogs/lineage_reference.rs
@@ -1,9 +1,9 @@
 use core::hash::Hash;
 
-use super::{Habitat, MathsCore};
+use super::{Backup, Habitat, MathsCore};
 
 #[allow(clippy::module_name_repetitions)]
 pub trait LineageReference<M: MathsCore, H: Habitat<M>>:
-    crate::cogs::Backup + PartialEq + Eq + Hash + core::fmt::Debug
+    Backup + PartialEq + Eq + Hash + core::fmt::Debug
 {
 }
diff --git a/necsim/core/src/cogs/lineage_store.rs b/necsim/core/src/cogs/lineage_store.rs
@@ -1,16 +1,14 @@
 use core::ops::Index;
 
-use super::{Habitat, LineageReference, MathsCore};
+use super::{Backup, Habitat, LineageReference, MathsCore};
 use crate::{
     landscape::{IndexedLocation, Location},
     lineage::{GlobalLineageReference, Lineage},
 };
 
 #[allow(clippy::inline_always, clippy::inline_fn_without_body)]
 #[contract_trait]
-pub trait LineageStore<M: MathsCore, H: Habitat<M>>:
-    crate::cogs::Backup + Sized + core::fmt::Debug
-{
+pub trait LineageStore<M: MathsCore, H: Habitat<M>>: Backup + Sized + core::fmt::Debug {
     type LocalLineageReference: LineageReference<M, H>;
 
     #[must_use]
diff --git a/necsim/core/src/cogs/rng.rs b/necsim/core/src/cogs/rng.rs
@@ -7,7 +7,7 @@ use crate::{
     landscape::IndexedLocation,
 };
 
-pub trait Rng<M: MathsCore>: Backup + Clone + core::fmt::Debug {
+pub trait Rng<M: MathsCore>: Backup + core::fmt::Debug {
     type Generator: RngCore;
     type Sampler;
 
@@ -21,9 +21,7 @@ pub trait Rng<M: MathsCore>: Backup + Clone + core::fmt::Debug {
 }
 
 #[allow(clippy::module_name_repetitions)]
-pub trait RngCore:
-    crate::cogs::Backup + Sized + Clone + core::fmt::Debug + Serialize + DeserializeOwned
-{
+pub trait RngCore: Backup + Sized + core::fmt::Debug + Serialize + DeserializeOwned {
     type Seed: AsMut<[u8]> + Default + Sized;
 
     #[must_use]
diff --git a/necsim/core/src/cogs/speciation_probability.rs b/necsim/core/src/cogs/speciation_probability.rs
@@ -1,15 +1,13 @@
 use necsim_core_bond::ClosedUnitF64;
 
 use crate::{
-    cogs::{Habitat, MathsCore},
+    cogs::{Backup, Habitat, MathsCore},
     landscape::Location,
 };
 
 #[allow(clippy::inline_always, clippy::inline_fn_without_body)]
 #[contract_trait]
-pub trait SpeciationProbability<M: MathsCore, H: Habitat<M>>:
-    crate::cogs::Backup + core::fmt::Debug
-{
+pub trait SpeciationProbability<M: MathsCore, H: Habitat<M>>: Backup + core::fmt::Debug {
     #[must_use]
     #[debug_requires(
         habitat.is_location_habitable(location),
diff --git a/necsim/core/src/cogs/turnover_rate.rs b/necsim/core/src/cogs/turnover_rate.rs
@@ -1,15 +1,13 @@
 use necsim_core_bond::NonNegativeF64;
 
 use crate::{
-    cogs::{Habitat, MathsCore},
+    cogs::{Backup, Habitat, MathsCore},
     landscape::Location,
 };
 
 #[allow(clippy::inline_always, clippy::inline_fn_without_body)]
 #[contract_trait]
-pub trait TurnoverRate<M: MathsCore, H: Habitat<M>>:
-    crate::cogs::Backup + core::fmt::Debug
-{
+pub trait TurnoverRate<M: MathsCore, H: Habitat<M>>: Backup + core::fmt::Debug {
     #[must_use]
     #[debug_requires(
         habitat.is_location_habitable(location),
diff --git a/necsim/core/src/simulation/builder.rs b/necsim/core/src/simulation/builder.rs
@@ -287,4 +287,37 @@ impl<
     pub fn immigration_entry_mut(&mut self) -> &mut I {
         &mut self.immigration_entry
     }
+
+    pub fn deconstruct(self) -> SimulationBuilder<M, H, G, S, X, D, C, T, N, E, I, A> {
+        let Simulation {
+            maths,
+            habitat,
+            lineage_store,
+            dispersal_sampler,
+            coalescence_sampler,
+            turnover_rate,
+            speciation_probability,
+            emigration_exit,
+            event_sampler,
+            active_lineage_sampler,
+            rng,
+            immigration_entry,
+            migration_balance: _,
+        } = self;
+
+        SimulationBuilder {
+            maths,
+            habitat,
+            lineage_store,
+            dispersal_sampler,
+            coalescence_sampler,
+            turnover_rate,
+            speciation_probability,
+            emigration_exit,
+            event_sampler,
+            active_lineage_sampler,
+            rng,
+            immigration_entry,
+        }
+    }
 }
diff --git a/necsim/impls/cuda/src/cogs/rng.rs b/necsim/impls/cuda/src/cogs/rng.rs
@@ -3,7 +3,7 @@ use core::marker::PhantomData;
 use const_type_layout::TypeGraphLayout;
 use rust_cuda::safety::StackOnly;
 
-use necsim_core::cogs::{MathsCore, Rng};
+use necsim_core::cogs::{Backup, MathsCore, Rng};
 
 #[allow(clippy::module_name_repetitions)]
 #[derive(Debug, rust_cuda::common::LendRustToCuda)]
@@ -16,15 +16,6 @@ where
     marker: PhantomData<M>,
 }
 
-impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> Clone for CudaRng<M, R> {
-    fn clone(&self) -> Self {
-        Self {
-            inner: self.inner.clone(),
-            marker: PhantomData::<M>,
-        }
-    }
-}
-
 impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> From<R> for CudaRng<M, R> {
     #[must_use]
     #[inline]
@@ -37,11 +28,21 @@ impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> From<R> for C
 }
 
 impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> CudaRng<M, R> {
-    pub fn into(self) -> R {
+    pub fn into_inner(self) -> R {
         self.inner
     }
 }
 
+#[contract_trait]
+impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> Backup for CudaRng<M, R> {
+    unsafe fn backup_unchecked(&self) -> Self {
+        Self {
+            inner: self.inner.backup_unchecked(),
+            marker: PhantomData::<M>,
+        }
+    }
+}
+
 impl<M: MathsCore, R: Rng<M> + StackOnly + ~const TypeGraphLayout> Rng<M> for CudaRng<M, R> {
     type Generator = R::Generator;
     type Sampler = R::Sampler;
diff --git a/necsim/impls/cuda/src/lib.rs b/necsim/impls/cuda/src/lib.rs
@@ -16,7 +16,7 @@ extern crate alloc;
 #[macro_use]
 extern crate const_type_layout;
 
-#[cfg_attr(target_os = "cuda", macro_use)]
+#[macro_use]
 extern crate contracts;
 
 pub mod cogs;
diff --git a/necsim/impls/no-std/src/cogs/active_lineage_sampler/alias/sampler/indexed/tests.rs b/necsim/impls/no-std/src/cogs/active_lineage_sampler/alias/sampler/indexed/tests.rs
@@ -1079,7 +1079,7 @@ fn debug_display_sampler() {
 }
 
 // GRCOV_EXCL_START
-#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, serde::Serialize, serde::Deserialize)]
 struct DummyRng(Vec<f64>);
 
 impl DummyRng {
diff --git a/necsim/impls/no-std/src/cogs/active_lineage_sampler/alias/sampler/stack/tests.rs b/necsim/impls/no-std/src/cogs/active_lineage_sampler/alias/sampler/stack/tests.rs
@@ -578,7 +578,7 @@ fn debug_display_sampler() {
 }
 
 // GRCOV_EXCL_START
-#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, serde::Serialize, serde::Deserialize)]
 struct DummyRng(Vec<f64>);
 
 impl DummyRng {
diff --git a/necsim/impls/no-std/src/cogs/origin_sampler/mod.rs b/necsim/impls/no-std/src/cogs/origin_sampler/mod.rs
@@ -20,16 +20,14 @@ use pre_sampler::OriginPreSampler;
 /// `Lineage`s produced by the sampler's iterator must have
 /// * unique global references
 pub trait UntrustedOriginSampler<'h, M: MathsCore>:
-    core::fmt::Debug + core::iter::Iterator<Item = Lineage>
+    Sized + core::fmt::Debug + core::iter::Iterator<Item = Lineage>
 {
     type Habitat: 'h + Habitat<M>;
     type PreSampler: Iterator<Item = u64>;
 
     fn habitat(&self) -> &'h Self::Habitat;
 
-    fn into_pre_sampler(self) -> OriginPreSampler<M, Self::PreSampler>
-    where
-        Self: Sized;
+    fn into_pre_sampler(self) -> OriginPreSampler<M, Self::PreSampler>;
 
     fn full_upper_bound_size_hint(&self) -> u64;
 }
diff --git a/necsim/impls/no-std/src/cogs/rng/rand.rs b/necsim/impls/no-std/src/cogs/rng/rand.rs
@@ -6,7 +6,7 @@ use rand_core::{RngCore as RandRngCore, SeedableRng as RandSeedableRng};
 use serde::{de::DeserializeOwned, Deserialize, Deserializer, Serialize, Serializer};
 
 #[allow(clippy::module_name_repetitions)]
-#[derive(Clone, TypeLayout)]
+#[derive(TypeLayout)]
 #[repr(transparent)]
 pub struct RandRng<G: RandRngCore + RandSeedableRng + Clone + Serialize + DeserializeOwned> {
     inner: G,
@@ -58,7 +58,9 @@ impl<G: RandRngCore + RandSeedableRng + Clone + Serialize + DeserializeOwned> Ba
     for RandRng<G>
 {
     unsafe fn backup_unchecked(&self) -> Self {
-        self.clone()
+        Self {
+            inner: self.inner.clone(),
+        }
     }
 }
 
diff --git a/necsim/impls/no-std/src/cogs/rng/seahash.rs b/necsim/impls/no-std/src/cogs/rng/seahash.rs
@@ -3,7 +3,7 @@ use necsim_core::cogs::{Backup, PrimeableRng, RngCore};
 use serde::{Deserialize, Serialize};
 
 #[allow(clippy::module_name_repetitions, clippy::unsafe_derive_deserialize)]
-#[derive(Clone, Debug, Serialize, Deserialize, TypeLayout)]
+#[derive(Debug, Serialize, Deserialize, TypeLayout)]
 #[serde(deny_unknown_fields)]
 pub struct SeaHash {
     seed: u64,
@@ -15,7 +15,12 @@ pub struct SeaHash {
 #[contract_trait]
 impl Backup for SeaHash {
     unsafe fn backup_unchecked(&self) -> Self {
-        self.clone()
+        Self {
+            seed: self.seed,
+            location: self.location,
+            time: self.time,
+            offset: self.offset,
+        }
     }
 }
 
diff --git a/necsim/impls/no-std/src/cogs/rng/simple.rs b/necsim/impls/no-std/src/cogs/rng/simple.rs
@@ -13,7 +13,7 @@ use necsim_core::cogs::{
 };
 use necsim_core_bond::{ClosedOpenUnitF64, ClosedUnitF64, NonNegativeF64, OpenClosedUnitF64};
 
-#[derive(Clone, Debug, TypeLayout)]
+#[derive(Debug, TypeLayout)]
 #[allow(clippy::module_name_repetitions)]
 #[layout(free = "M")]
 #[repr(transparent)]
@@ -32,7 +32,7 @@ impl<M: MathsCore, R: RngCore> From<R> for SimpleRng<M, R> {
 }
 
 impl<M: MathsCore, R: RngCore> SimpleRng<M, R> {
-    pub fn into(self) -> R {
+    pub fn into_inner(self) -> R {
         self.inner
     }
 }
diff --git a/necsim/impls/no-std/src/cogs/rng/wyhash.rs b/necsim/impls/no-std/src/cogs/rng/wyhash.rs
diff --git a/necsim/impls/no-std/src/decomposition/mod.rs b/necsim/impls/no-std/src/decomposition/mod.rs
diff --git a/necsim/impls/std/src/cogs/rng/pcg.rs b/necsim/impls/std/src/cogs/rng/pcg.rs
diff --git a/rustcoalescence/algorithms/cuda/src/launch.rs b/rustcoalescence/algorithms/cuda/src/launch.rs
diff --git a/rustcoalescence/algorithms/gillespie/src/event_skipping/launch.rs b/rustcoalescence/algorithms/gillespie/src/event_skipping/launch.rs
diff --git a/rustcoalescence/algorithms/gillespie/src/gillespie/classical/launch.rs b/rustcoalescence/algorithms/gillespie/src/gillespie/classical/launch.rs
diff --git a/rustcoalescence/algorithms/gillespie/src/gillespie/turnover/launch.rs b/rustcoalescence/algorithms/gillespie/src/gillespie/turnover/launch.rs
diff --git a/rustcoalescence/algorithms/independent/src/launch.rs b/rustcoalescence/algorithms/independent/src/launch.rs
diff --git a/rustcoalescence/algorithms/src/lib.rs b/rustcoalescence/algorithms/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ use crate::{`
`16`	`16`	`#[allow(clippy::inline_always, clippy::inline_fn_without_body)]`
`17`	`17`	`#[contract_trait]`
`18`	`18`	`pub trait CoalescenceSampler<M: MathsCore, H: Habitat<M>, S: LineageStore<M, H>>:`
`19`		`- crate::cogs::Backup + core::fmt::Debug`
	`19`	`+ Backup + core::fmt::Debug`
`20`	`20`	`{`
`21`	`21`	`#[must_use]`
`22`	`22`	`#[debug_requires(habitat.get_habitat_at_location(&location) > 0, "location is habitable")]`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`use core::hash::Hash;`
`2`	`2`
`3`		`-use super::{Habitat, MathsCore};`
	`3`	`+use super::{Backup, Habitat, MathsCore};`
`4`	`4`
`5`	`5`	`#[allow(clippy::module_name_repetitions)]`
`6`	`6`	`pub trait LineageReference<M: MathsCore, H: Habitat<M>>:`
`7`		`- crate::cogs::Backup + PartialEq + Eq + Hash + core::fmt::Debug`
	`7`	`+ Backup + PartialEq + Eq + Hash + core::fmt::Debug`
`8`	`8`	`{`
`9`	`9`	`}`