summaryrefslogtreecommitdiff
path: root/org-fc-sm2.el
blob: 82005373278bd74b0d7f04edc0fcbb60a43801bc (about) (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
;;; Configuration

(defcustom org-fc-sm2-changes
  '((again . -0.3)
    (hard . -0.15)
    (good . 0.0)
    (easy . 0.15))
  "Changes to a cards ease depending on its rating"
  :type 'list
  :group 'org-fc)

(defcustom org-fc-sm2-fixed-intervals
  '(0.0 0.01 1.0 6.0)
  "Hard-coded intervals for the first few card boxes, values are in days"
  :type 'list
  :group 'org-fc)

(defcustom org-fc-sm2-ease-min 1.3 "Lower bound for a cards ease"
  :type 'float
  :group 'org-fc)
(defcustom org-fc-sm2-ease-initial 2.5 "Initial ease"
  :type 'float
  :group 'org-fc)
(defcustom org-fc-sm2-ease-max 5.0 "Upper bound for a cards ease"
  :type 'float
  :group 'org-fc)

(defcustom org-fc-sm2-fuzz-min 0.9
  "Lower bound for random interval fuzz factor"
  :type 'float
  :group 'org-fc)
(defcustom org-fc-sm2-fuzz-max 1.1
  "Upper bound for random interval fuzz factor"
  :type 'float
  :group 'org-fc)

(defun org-fc-sm2-fuzz (interval)
  "Multiply INTERVAL by a random factor between
`org-fc-sm2-fuzz-min' and `org-fc-sm2-fuzz-max'"
  (*
   interval
   (+ org-fc-sm2-fuzz-min
      (cl-random (- org-fc-sm2-fuzz-max org-fc-sm2-fuzz-min)))))

;;; Parameter Calculation

(defun org-fc-sm2-next-box (box rating)
  "Calculate the next box of a card, based on the review rating."
  (cond
   ;; If a card is rated easy, skip the learning phase
   ((and (eq box 0) (eq rating 'easy)) 2)
   ;; If the review failed, go back to box 0
   ((eq rating 'again) 0)
   ;; Otherwise, move forward one box
   (t (1+ box))))

(defun org-fc-sm2-next-ease (ease box rating)
  "Calculate the next ease of a card, based on the review rating."
  (if (< box 2)
      ease
    (min
     (max
      (+ ease (alist-get rating org-fc-sm2-changes))
      org-fc-sm2-ease-min)
     org-fc-sm2-ease-max)))

(defun org-fc-sm2--next-interval (interval next-box next-ease)
  "Calculate the next interval of a card."
  (if (< next-box (length org-fc-sm2-fixed-intervals))
      (nth next-box org-fc-sm2-fixed-intervals)
    (org-fc-sm2-fuzz (* next-ease interval))))

(defun org-fc-sm2-next-parameters (ease box interval rating)
  "Calculate the next parameters of a card, based on the review rating."
  (let* ((next-ease (org-fc-sm2-next-ease ease box rating))
         (next-box (org-fc-sm2-next-box box rating))
         (next-interval (org-fc-sm2--next-interval interval next-box next-ease)))
    (list next-ease next-box next-interval)))

;;; Exports

(provide 'org-fc-sm2)