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

Implementations§

source§

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

source

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

source

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§

source§

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>

source§

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 Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

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,

source§

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>

source§

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

Auto Trait Implementations§

§

impl<M, H, S> Freeze for ConditionalCoalescenceSampler<M, H, S>

§

impl<M, H, S> RefUnwindSafe for ConditionalCoalescenceSampler<M, H, S>

§

impl<M, H, S> Send for ConditionalCoalescenceSampler<M, H, S>
where H: Send, S: Send,

§

impl<M, H, S> Sync for ConditionalCoalescenceSampler<M, H, S>
where H: Sync, S: Sync,

§

impl<M, H, S> Unpin for ConditionalCoalescenceSampler<M, H, S>
where M: Unpin, H: Unpin, S: Unpin,

§

impl<M, H, S> UnwindSafe for ConditionalCoalescenceSampler<M, H, S>
where M: UnwindSafe, H: UnwindSafe, S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> ExtractDiscriminant for T

§

type Discriminant = <T as ExtractDiscriminantSpec<<T as DiscriminantKind>::Discriminant>>::Ty

The type of the discriminant, which must satisfy the trait bounds required by core::mem::Discriminant. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Erased for T

source§

impl<T> PortableBitSemantics for T
where T: PortableBitSemantics + ?Sized,

source§

impl<T> StackOnly for T
where T: StackOnly,