1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

use necsim_core::{
    cogs::{Habitat, MathsCore},
    lineage::Lineage,
};

pub mod decomposition;
pub mod in_memory;
pub mod non_spatial;
pub mod pre_sampler;
pub mod resuming;
pub mod singleton_demes;
pub mod spatially_implicit;

use pre_sampler::OriginPreSampler;

#[allow(clippy::inline_always, clippy::inline_fn_without_body)]
#[contract_trait]
#[allow(clippy::module_name_repetitions)]
/// `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>
{
    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 full_upper_bound_size_hint(&self) -> u64;
}

/// # Safety
/// `Lineage`s produced by the sampler's iterator must have
/// * unique global references
/// * unique indexed locations
/// * valid indexed locations (i.e. inside habitable demes)
#[allow(clippy::module_name_repetitions)]
pub unsafe trait TrustedOriginSampler<'h, M: MathsCore>:
    UntrustedOriginSampler<'h, M>
{
}