summaryrefslogtreecommitdiff
path: root/gnosis-algorithm.el
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-01-18 04:14:25 +0200
committerThanos Apollo <[email protected]>2024-01-18 04:14:25 +0200
commitfd42525da74189c7c6d1eddd17fa15cfcc643cbd (patch)
tree435ab13f748df14c46b76f761a35135889dc6a4b /gnosis-algorithm.el
parent6b036ca26e43069fd38585b29d9225aa6cf0593b (diff)
parent5fcd13b74a7e40be8ef3f53f1f33824e9b59b814 (diff)
Merge branch 'version-0.1.3' to master0.1.3
- Add documentation - Fix docstrings & types of custom vars Improve algorithm implementation - Adjust next ef and interval depending on consecutive & total failures/successes - Fix bugs for custom reviews where last-interv would be 0
Diffstat (limited to 'gnosis-algorithm.el')
-rw-r--r--gnosis-algorithm.el51
1 files changed, 35 insertions, 16 deletions
diff --git a/gnosis-algorithm.el b/gnosis-algorithm.el
index e6a2b1f..596bc7c 100644
--- a/gnosis-algorithm.el
+++ b/gnosis-algorithm.el
@@ -41,7 +41,7 @@ Note: `gnosis-algorithm-interval' is ignored after 10 TOTAL reviews or
when ef is above > 3.0, which should only be the case for customized
notes/review sessions."
:group 'gnosis
- :type 'list)
+ :type '(list integer))
(defcustom gnosis-algorithm-ef '(0.3 0.3 1.3)
"Gnosis easiness factor.
@@ -52,7 +52,7 @@ Third item : Starting total ef
Note: Starting total ef should not be above 3.0"
:group 'gnosis
- :type 'list)
+ :type '(list float))
(defcustom gnosis-algorithm-ff 0.5
"Gnosis forgetting factor.
@@ -97,23 +97,24 @@ The structure of the given date is (YEAR MONTH DAY)."
(+ ef (car gnosis-algorithm-ef)))
(t (error "Invalid quality score passed to gnosis-algorithm-e-factor"))))
-;; This should be further tested for notes with last-interval of 0 when success 0
-;; For future versions of this algorithm, we should also calculate
-;; failures in row to have "leech" like notes as well.
-;; TODO: Use initial-interval value instead gnosis-algorithm-interval
-(defun gnosis-algorithm-next-interval (last-interval n ef success ff successful-reviews)
+
+(cl-defun gnosis-algorithm-next-interval (&key last-interval review-num ef success failure-factor successful-reviews successful-reviews-c fails-c fails-t initial-interval)
"Calculate next interval.
- LAST-INTERVAL : The number of days since the item was last reviewed.
-- N : Number of times the item has been reviewed.
+-review-num: Number of times the item has been reviewed.
- EF : Easiness Factor.
- SUCCESS : Success of the recall, ranges from 0 (unsuccessful) to 1
(successful).
- FF: Failure factor
- SUCCESSFUL-REVIEWS : Number of successful reviews.
+- SUCCESSFULL-REVIEWS-C: Successful reviews in a row.
+- FAILS-C: Failed reviews in a row.
+- FAILS-T: Total failed reviews.
+- INITIAL-INTERVAL: Initial intervals for successful reviews.
Returns a list of: (INTERVAL N EF) where,
- Next review date in (yyyy mm dd) format.
-- N : Incremented by 1.
+- REVIEW-NUM: Incremented by 1.
- EF : Modified based on the recall success for the item."
(cl-assert (and (>= success 0)
(<= success 1)))
@@ -132,23 +133,41 @@ Returns a list of: (INTERVAL N EF) where,
;; First successful review -> first interval
((and (= successful-reviews 0)
(= success 1)
- (< n 10)
+ (< review-num 10)
(< ef 3.0))
- (car gnosis-algorithm-interval))
+ (car initial-interval))
;; Second successful review -> second interval
((and (= successful-reviews 1)
- (< n 10)
+ (< review-num 10)
(= success 1)
- (< ef 3.0))
- (cadr gnosis-algorithm-interval))
+ (< ef 3.0)
+ (= fails-c 0)
+ (cadr initial-interval)))
+ ;; When successful-reviews-c is above 3, use 150% or 180%
+ ;; of ef depending on the value of successful-reviews
+ ((and (= success 1)
+ (>= successful-reviews-c 3))
+ (* (* ef (if (>= successful-reviews 10) 1.8 1.5)) last-interval))
+ ((and (= success 0)
+ (> fails-c 3))
+ ;; When fails-c is above 3, use 150% or 180% of
+ ;; failure-factor depending on the value of total failed
+ ;; reviews. It should not be above 0.8
+ (* (max (min 0.8 (* failure-factor (if (>= fails-t 10) 1.8 1.5)))
+ failure-factor)
+ last-interval))
;; For custom review sessions.
+ ;; When successful-reviews-c is above 0, multiply its value
+ ;; with ef
((and (= last-interval 0)
(= success 1))
- (* ef 1))
+ (* ef (if (> successful-reviews-c 0)
+ successful-reviews-c
+ 1)))
;; For everything else
(t (if (= success 1)
(* ef last-interval)
- (* ff last-interval))))))
+ (* failure-factor last-interval))))))
(list (gnosis-algorithm-date (round interval)) next-ef)))
(provide 'gnosis-algorithm)