Struct necsim_impls_no_std::cogs::coalescence_sampler::conditional::ConditionalCoalescenceSampler

pub struct ConditionalCoalescenceSampler<M: MathsCore, H: Habitat<M>, S: GloballyCoherentLineageStore<M, H>>(/* private fields */);

Implementations

impl<M: MathsCore, H: Habitat<M>, S: GloballyCoherentLineageStore<M, H>> ConditionalCoalescenceSampler<M, H, S>

pub fn sample_coalescence_at_location( &self, location: Location, habitat: &H, lineage_store: &S, coalescence_rng_sample: CoalescenceRngSample ) -> (IndexedLocation, GlobalLineageReference)

pub fn get_coalescence_probability_at_location( &self, location: &Location, habitat: &H, lineage_store: &S, lineage_store_includes_self: bool ) -> ClosedUnitF64

Contracts

Pre-condition - debug: location is habitable

• habitat.get_habitat_at_location(location) > 0

Trait Implementations

impl<M: MathsCore, H: Habitat<M>, S: GloballyCoherentLineageStore<M, H>> Backup for ConditionalCoalescenceSampler<M, H, S>

unsafe fn backup_unchecked(&self) -> Self

fn backup(&self) -> BackedUp<Self>

impl<M: MathsCore, H: Habitat<M>, S: GloballyCoherentLineageStore<M, H>> CoalescenceSampler<M, H, S> for ConditionalCoalescenceSampler<M, H, S>

fn sample_interaction_at_location( &self, location: Location, habitat: &H, lineage_store: &S, coalescence_rng_sample: CoalescenceRngSample ) -> (IndexedLocation, LineageInteraction)

Contracts

impl<M: Debug + MathsCore, H: Debug + Habitat<M>, S: Debug + GloballyCoherentLineageStore<M, H>> Debug for ConditionalCoalescenceSampler<M, H, S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<M: MathsCore, H: Habitat<M>, S: GloballyCoherentLineageStore<M, H>> Default for ConditionalCoalescenceSampler<M, H, S>

fn default() -> Self

Returns the “default value” for a type.

impl<M: MathsCore, H: Habitat<M>, G: RngCore<M>, S: GloballyCoherentLineageStore<M, H>, X: EmigrationExit<M, H, G, S>, D: SeparableDispersalSampler<M, H, G>, T: TurnoverRate<M, H>, N: SpeciationProbability<M, H>> EventSampler<M, H, G, S, X, D, ConditionalCoalescenceSampler<M, H, S>, T, N> for ConditionalGillespieEventSampler<M, H, G, S, X, D, T, N>

fn sample_event_for_lineage_at_event_time_or_emigrate<Q, Aux, FS, FD, FE>( &mut self, lineage: Lineage, event_time: PositiveF64, simulation: &mut PartialSimulation<M, H, G, S, X, D, C, T, N>, rng: &mut G, handler: EventHandler<FS, FD, FE>, auxiliary: Aux ) -> Q

where FS: FnOnce(SpeciationEvent, Aux) -> Q, FD: FnOnce(DispersalEvent, Aux) -> Q, FE: FnOnce(Aux) -> Q,

impl<M: MathsCore, H: Habitat<M>, G: RngCore<M>, S: GloballyCoherentLineageStore<M, H>, X: EmigrationExit<M, H, G, S>, D: SeparableDispersalSampler<M, H, G>, T: TurnoverRate<M, H>, N: SpeciationProbability<M, H>> GillespieEventSampler<M, H, G, S, X, D, ConditionalCoalescenceSampler<M, H, S>, T, N> for ConditionalGillespieEventSampler<M, H, G, S, X, D, T, N>

fn get_event_rate_at_location( &self, location: &Location, habitat: &H, lineage_store: &S, dispersal_sampler: &D, coalescence_sampler: &C, turnover_rate: &T, speciation_probability: &N ) -> NonNegativeF64

Pre: all lineages must be active in the lineage store