aboutsummaryrefslogtreecommitdiff
path: root/src/space_repetition.rs
blob: e2ab382e7b2a34e0c422b70695c2f11694111fd4 (plain)
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
// SM2-Anki
// https://gist.github.com/riceissa/1ead1b9881ffbb48793565ce69d7dbdd

use crate::model::difficulty::{Difficulty, Difficulty::*};
use serde::{Deserialize, Serialize};

// Learning
const LEARNING_INTERVALS: [f32; 2] = [
    1.0 / 60.0 / 24.0,  // 1 minute (in days)
    10.0 / 60.0 / 24.0, // 10 minutes (in days)
];

// Ease
const EASE_INIT: f32 = 2.5;
const EASE_MIN: f32 = 1.3;

// Interval
const INTERVAL_INIT: f32 = 1.0;
const INTERVAL_INIT_EASY: f32 = 4.0;
const INTERVAL_MIN: f32 = 0.1;
const INTERVAL_MAX: f32 = 36500.0;

// Learned
const EASE_AGAIN_SUB: f32 = 0.2;
const EASE_HARD_SUB: f32 = 0.15;
const EASE_EASY_ADD: f32 = 0.15;
const INTERVAL_AGAIN_MUL: f32 = 0.7;
const INTERVAL_HARD_MUL: f32 = 1.2;
const INTERVAL_EASY_MUL: f32 = 1.3;

// Relearning
const RELEARNING_INTERVALS: [f32; 1] = [
    10.0 / 60.0 / 24.0, // 10 minutes (in days)
];

#[derive(Debug, PartialEq, Deserialize, Serialize)]
pub enum State {
    Learning {
        step: usize,
    },
    Learned {
        ease: f32,     // ratio
        interval: f32, // in days
    },
    Relearning {
        step: usize,
        ease: f32,
        interval: f32,
    },
}

pub fn init() -> State {
    State::Learning { step: 0 }
}

impl State {
    pub fn get_interval_seconds(&self) -> u64 {
        let days = match self {
            State::Learning { step } => LEARNING_INTERVALS[*step],
            State::Learned { interval, .. } => *interval,
            State::Relearning { step, .. } => RELEARNING_INTERVALS[*step],
        };
        (days * 24.0 * 60.0 * 60.0).round() as u64
    }

    pub fn difficulties(&self) -> Vec<Difficulty> {
        match self {
            State::Learning { .. } => [Again, Good, Easy].to_vec(),
            State::Learned { .. } => [Again, Hard, Good, Easy].to_vec(),
            State::Relearning { .. } => [Again, Good].to_vec(),
        }
    }
}

pub fn update(state: State, difficulty: Difficulty) -> State {
    match state {
        State::Learning { step } => match difficulty {
            Again => State::Learning { step: 0 },
            Good => {
                let new_step = step + 1;
                if new_step < LEARNING_INTERVALS.len() {
                    State::Learning { step: new_step }
                } else {
                    State::Learned {
                        ease: EASE_INIT,
                        interval: INTERVAL_INIT,
                    }
                }
            }
            Easy => State::Learned {
                ease: EASE_INIT,
                interval: INTERVAL_INIT_EASY,
            },
            _ => panic!("Learning is incompatible with {:?}", difficulty),
        },
        State::Learned { ease, interval } => match difficulty {
            Again => State::Relearning {
                step: 0,
                ease: clamp_ease(ease - EASE_AGAIN_SUB),
                interval: clamp_interval(interval * INTERVAL_AGAIN_MUL),
            },
            Hard => State::Learned {
                ease: clamp_ease(ease - EASE_HARD_SUB),
                interval: clamp_interval(interval * INTERVAL_HARD_MUL),
            },
            Good => State::Learned {
                ease,
                interval: clamp_interval(interval * ease),
            },
            Easy => State::Learned {
                ease: clamp_ease(ease + EASE_EASY_ADD),
                interval: clamp_interval(interval * ease * INTERVAL_EASY_MUL),
            },
        },
        State::Relearning {
            step,
            ease,
            interval,
        } => match difficulty {
            Again => State::Relearning {
                step: 0,
                ease,
                interval,
            },
            Good => {
                let new_step = step + 1;
                if new_step < RELEARNING_INTERVALS.len() {
                    State::Relearning {
                        step: new_step,
                        ease,
                        interval,
                    }
                } else {
                    State::Learned { ease, interval }
                }
            }
            _ => panic!("Relearning is incompatible with {:?}.", difficulty),
        },
    }
}

fn clamp_ease(f: f32) -> f32 {
    if f < EASE_MIN {
        EASE_MIN
    } else {
        f
    }
}

fn clamp_interval(i: f32) -> f32 {
    if i < INTERVAL_MIN {
        INTERVAL_MIN
    } else if i > INTERVAL_MAX {
        INTERVAL_MAX
    } else {
        i
    }
}

#[cfg(test)]
mod tests {
    use super::{State::*, *};

    #[test]
    fn learning_again() {
        assert_eq!(update(Learning { step: 1 }, Again), Learning { step: 0 });
    }

    #[test]
    fn learning_good() {
        assert_eq!(update(Learning { step: 0 }, Good), Learning { step: 1 });

        assert_eq!(
            update(
                Learning {
                    step: LEARNING_INTERVALS.len() - 1
                },
                Good
            ),
            Learned {
                ease: EASE_INIT,
                interval: INTERVAL_INIT
            }
        );
    }

    #[test]
    fn learning_easy() {
        assert_eq!(
            update(Learning { step: 0 }, Easy),
            Learned {
                ease: EASE_INIT,
                interval: INTERVAL_INIT_EASY
            }
        );
    }

    #[test]
    fn learned_again() {
        assert_eq!(
            update(
                Learned {
                    ease: EASE_MIN,
                    interval: INTERVAL_MIN
                },
                Again
            ),
            Relearning {
                step: 0,
                ease: EASE_MIN,
                interval: INTERVAL_MIN
            }
        );

        assert_eq!(
            update(
                Learned {
                    ease: EASE_INIT,
                    interval: INTERVAL_INIT
                },
                Again
            ),
            Relearning {
                step: 0,
                ease: EASE_INIT - EASE_AGAIN_SUB,
                interval: INTERVAL_INIT * INTERVAL_AGAIN_MUL
            }
        );
    }

    #[test]
    fn learned_hard() {
        assert_eq!(
            update(
                Learned {
                    ease: EASE_MIN,
                    interval: INTERVAL_MAX
                },
                Hard
            ),
            Learned {
                ease: EASE_MIN,
                interval: INTERVAL_MAX
            }
        );

        assert_eq!(
            update(
                Learned {
                    ease: EASE_INIT,
                    interval: INTERVAL_INIT
                },
                Hard
            ),
            Learned {
                ease: EASE_INIT - EASE_HARD_SUB,
                interval: INTERVAL_INIT * INTERVAL_HARD_MUL
            }
        );
    }

    #[test]
    fn learned_good() {
        assert_eq!(
            update(
                Learned {
                    ease: EASE_INIT,
                    interval: INTERVAL_MAX
                },
                Good
            ),
            Learned {
                ease: EASE_INIT,
                interval: INTERVAL_MAX
            }
        );

        assert_eq!(
            update(
                Learned {
                    ease: EASE_INIT,
                    interval: INTERVAL_INIT
                },
                Good
            ),
            Learned {
                ease: EASE_INIT,
                interval: INTERVAL_INIT * EASE_INIT
            }
        );
    }

    #[test]
    fn learned_easy() {
        assert_eq!(
            update(
                Learned {
                    ease: EASE_INIT,
                    interval: INTERVAL_MAX
                },
                Easy
            ),
            Learned {
                ease: EASE_INIT + EASE_EASY_ADD,
                interval: INTERVAL_MAX
            }
        );

        assert_eq!(
            update(
                Learned {
                    ease: EASE_INIT,
                    interval: INTERVAL_INIT
                },
                Easy
            ),
            Learned {
                ease: EASE_INIT + EASE_EASY_ADD,
                interval: INTERVAL_INIT * EASE_INIT * INTERVAL_EASY_MUL
            }
        );
    }

    #[test]
    fn relearning_again() {
        let ease = EASE_INIT + EASE_EASY_ADD;
        let interval = INTERVAL_INIT * ease;
        assert_eq!(
            update(
                Relearning {
                    step: 1,
                    ease,
                    interval,
                },
                Again
            ),
            Relearning {
                step: 0,
                ease,
                interval
            }
        );
    }

    #[test]
    fn relearning_good() {
        let ease = EASE_INIT + EASE_EASY_ADD;
        let interval = INTERVAL_INIT * ease;
        assert_eq!(
            update(
                Relearning {
                    step: RELEARNING_INTERVALS.len() - 1,
                    ease,
                    interval,
                },
                Good
            ),
            Learned { ease, interval }
        );
    }
}