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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
use core::ops::ControlFlow;

use necsim_core::{
    cogs::{
        ActiveLineageSampler, CoalescenceSampler, DispersalSampler, EmigrationExit, EventSampler,
        Habitat, ImmigrationEntry, LineageStore, MathsCore, RngCore, SpeciationProbability,
        TurnoverRate,
    },
    lineage::Lineage,
    simulation::partial::active_lineage_sampler::PartialSimulation,
};
use necsim_core_bond::{NonNegativeF64, PositiveF64};

use super::RestartFixUpActiveLineageSampler;

impl<
        M: MathsCore,
        H: Habitat<M>,
        G: RngCore<M>,
        S: LineageStore<M, H>,
        X: EmigrationExit<M, H, G, S>,
        D: DispersalSampler<M, H, G>,
        C: CoalescenceSampler<M, H, S>,
        T: TurnoverRate<M, H>,
        N: SpeciationProbability<M, H>,
        E: EventSampler<M, H, G, S, X, D, C, T, N>,
        I: ImmigrationEntry<M>,
        A: ActiveLineageSampler<M, H, G, S, X, D, C, T, N, E, I>,
    > ActiveLineageSampler<M, H, G, S, X, D, C, T, N, E, I>
    for RestartFixUpActiveLineageSampler<M, H, G, S, X, D, C, T, N, E, I, A>
{
    type LineageIterator<'a> = impl Iterator<Item = &'a Lineage> where H: 'a, G: 'a, S: 'a, X: 'a, D: 'a, C: 'a, T: 'a, N: 'a, E: 'a, I: 'a, A: 'a;

    #[must_use]
    fn number_active_lineages(&self) -> usize {
        // All pre- and post-conditions are maintained
        self.__contracts_impl_number_active_lineages()
    }

    #[must_use]
    fn __contracts_impl_number_active_lineages(&self) -> usize {
        self.fixable_lineages.len() + self.inner.number_active_lineages()
    }

    #[must_use]
    fn iter_active_lineages_ordered<'a>(
        &'a self,
        habitat: &'a H,
        lineage_store: &'a S,
    ) -> Self::LineageIterator<'a> {
        // All pre- and post-conditions are maintained
        self.__contracts_impl_iter_active_lineages_ordered(habitat, lineage_store)
    }

    #[must_use]
    fn __contracts_impl_iter_active_lineages_ordered<'a>(
        &'a self,
        habitat: &'a H,
        lineage_store: &'a S,
    ) -> Self::LineageIterator<'a> {
        self.fixable_lineages.iter().chain(
            self.inner
                .iter_active_lineages_ordered(habitat, lineage_store),
        )
    }

    #[must_use]
    fn get_last_event_time(&self) -> NonNegativeF64 {
        // All pre- and post-conditions are maintained
        self.__contracts_impl_get_last_event_time()
    }

    #[must_use]
    fn __contracts_impl_get_last_event_time(&self) -> NonNegativeF64 {
        if self.fixable_lineages.is_empty() {
            self.inner.get_last_event_time()
        } else {
            self.restart_time.into()
        }
    }

    #[must_use]
    #[debug_ensures(match ret {
        Some(_) => {
            self.number_active_lineages() ==
            old(self.number_active_lineages()) - 1
        },
        None => {
            self.number_active_lineages() ==
            old(self.number_active_lineages())
        },
    }, "removes an active lineage if `Some(_)` returned")]
    #[debug_ensures(
        old(self.number_active_lineages()) != 0 || ret.is_none(),
        "returns `None` if no lineages are left"
    )]
    #[debug_ensures(if let Some((ref _lineage, event_time)) = ret {
        self.get_last_event_time() == event_time
    } else { true }, "updates the time of the last event")]
    fn pop_active_lineage_and_event_time<F: FnOnce(PositiveF64) -> ControlFlow<(), ()>>(
        &mut self,
        simulation: &mut PartialSimulation<M, H, G, S, X, D, C, T, N, E>,
        rng: &mut G,
        early_peek_stop: F,
    ) -> Option<(Lineage, PositiveF64)> {
        // Explicitly circumvent the postcondition that the next event time is
        //  after the previous last event time
        self.__contracts_impl_pop_active_lineage_and_event_time(simulation, rng, early_peek_stop)
    }

    #[must_use]
    fn __contracts_impl_pop_active_lineage_and_event_time<
        F: FnOnce(PositiveF64) -> ControlFlow<(), ()>,
    >(
        &mut self,
        simulation: &mut PartialSimulation<M, H, G, S, X, D, C, T, N, E>,
        rng: &mut G,
        early_peek_stop: F,
    ) -> Option<(Lineage, PositiveF64)> {
        if self.fixable_lineages.is_empty() {
            return self
                .inner
                .pop_active_lineage_and_event_time(simulation, rng, early_peek_stop);
        }

        if early_peek_stop(self.restart_time).is_break() {
            return None;
        }

        // Safety: We just checked that there is at least one fixable lineage
        let fixable_lineage = unsafe { self.fixable_lineages.pop().unwrap_unchecked() };

        Some((fixable_lineage, self.restart_time))
    }

    #[allow(clippy::no_effect_underscore_binding)]
    #[debug_ensures(
        self.number_active_lineages() == old(self.number_active_lineages()) + 1,
        "adds an active lineage"
    )]
    #[debug_ensures(
        self.get_last_event_time() == old(lineage.last_event_time),
        "updates the time of the last event"
    )]
    fn push_active_lineage(
        &mut self,
        lineage: Lineage,
        simulation: &mut PartialSimulation<M, H, G, S, X, D, C, T, N, E>,
        rng: &mut G,
    ) {
        // All pre- and post-conditions are maintained
        self.__contracts_impl_push_active_lineage(lineage, simulation, rng);
    }

    fn __contracts_impl_push_active_lineage(
        &mut self,
        lineage: Lineage,
        simulation: &mut PartialSimulation<M, H, G, S, X, D, C, T, N, E>,
        rng: &mut G,
    ) {
        self.inner.push_active_lineage(lineage, simulation, rng);
    }
}