Class FSRS
Hierarchy
- FSRSAlgorithm
- FSRS
Index
Constructors
Properties
Accessors
Methods
apply_
Constructors
constructor
- new FSRS(param): FSRS
Parameters
param: Partial<FSRSParameters>
Returns FSRS
Properties
Protected interval
interval
Protected param
Protected Optional seed
seed?: string
Accessors
interval_
- get interval_modifier(): number
Returns number
parameters
- get parameters(): FSRSParameters
Returns FSRSParameters
- set parameters(params): void
Parameters
params: Partial<FSRSParameters>
Returns void
Methods
apply_
- apply_
fuzz(ivl, elapsed_days, enable_fuzz?): int Parameters
ivl: number
The interval to be fuzzed.
-elapsed_days: number
t days since the last review
-Optionalenable_fuzz: booleanThis adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.
+FSRS | TS-FSRS Class FSRS
Hierarchy (view full)
- FSRSAlgorithm
- FSRS
Index
Constructors
Properties
Accessors
Methods
apply_fuzz +calculate_ interval_ modifier +constrain_ difficulty +forget +forgetting_ curve +get_ retrievability +init_ difficulty +init_ ds +init_ stability +mean_ reversion +next_ difficulty +next_ ds +next_ forget_ stability +next_ interval +next_ recall_ stability +pre Process Card +pre Process Date +pre Process Log +repeat +reschedule +rollback + Constructors
constructor
- new FSRS(param): FSRS
Parameters
- param: Partial<FSRSParameters>
Returns FSRS
Properties
ProtectedintervalModifier intervalModifier: number ProtectedparamProtectedOptionalseedseed?: stringAccessors
interval_
modifier - get interval_modifier(): number
Returns number
parameters
- get parameters(): FSRSParameters
Get the parameters of the algorithm.
+Returns FSRSParameters
- set parameters(params): void
Set the parameters of the algorithm.
+Parameters
- params: Partial<FSRSParameters>
Partial
+
Returns void
- params: Partial<FSRSParameters>
Methods
apply_
fuzz - apply_
fuzz(ivl, elapsed_days, enable_fuzz?): int If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.
+Parameters
- ivl: number
The interval to be fuzzed.
+ - elapsed_days: number
t days since the last review
+ Optionalenable_fuzz: booleanThis adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.
Returns int
- The fuzzed interval.
- ivl: number
calculate_
interval_ modifier - calculate_
interval_ modifier(request_retention): number Ref: https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm#fsrs-45 -The formula used is: I(r,s) = (r^(1/DECAY) - 1) * s / FACTOR
-Parameters
request_retention: number
0<request_retention<=1,Requested retention rate
-
Returns number
constrain_
difficulty forget
- forget<R>(card, now, reset_count?, afterHandler?): R
Type Parameters
R = RecordLogItem
Parameters
card: Card | CardInput
Card to be processed
-now: DateInput
Current time or scheduled time
-reset_count: boolean = false
Should the review count information(reps,lapses) be reset. (Optional)
-OptionalafterHandler: ((recordLogItem) => R)Convert the result to another type. (Optional)
-- (recordLogItem): R
Parameters
recordLogItem: RecordLogItem
Returns R
Returns R
Example
const now = new Date();
const f = fsrs();
const emptyCard = createEmptyCard(now);
const scheduling_cards = f.repeat(emptyCard, now);
const { card, log } = scheduling_cards[Rating.Hard];
const forgetCard = f.forget(card, new Date(), true); +calculate_
interval_ modifier - calculate_
interval_ modifier(request_retention): number Parameters
- request_retention: number
0<request_retention<=1,Requested retention rate
+
Returns number
See
https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm#fsrs-45
+The formula used is: $$I(r,s) = (r^{\frac{1}{DECAY}} - 1) / FACTOR \times s$$
+Throws
Requested retention rate should be in the range (0,1]
+- request_retention: number
constrain_
difficulty forget
- forget<R>(card, now, reset_count?, afterHandler?): R
Type Parameters
- R = RecordLogItem
Parameters
- card: Card | CardInput
Card to be processed
+ - now: DateInput
Current time or scheduled time
+ - reset_count: boolean = false
Should the review count information(reps,lapses) be reset. (Optional)
+ OptionalafterHandler: ((recordLogItem) => R)Convert the result to another type. (Optional)
+- (recordLogItem): R
Parameters
- recordLogItem: RecordLogItem
Returns R
Returns R
Example
const now = new Date();
const f = fsrs();
const emptyCard = createEmptyCard(now);
const scheduling_cards = f.repeat(emptyCard, now);
const { card, log } = scheduling_cards[Rating.Hard];
const forgetCard = f.forget(card, new Date(), true);Example
-interface RepeatRecordLog {
card: CardUnChecked; //see method: createEmptyCard
log: RevLogUnchecked; //see method: fsrs.repeat()
}
function forgetAfterHandler(recordLogItem: RecordLogItem): RepeatRecordLog {
return {
card: {
...(recordLogItem.card as Card & { cid: string }),
due: recordLogItem.card.due.getTime(),
state: State[recordLogItem.card.state] as StateType,
last_review: recordLogItem.card.last_review
? recordLogItem.card.last_review!.getTime()
: null,
},
log: {
...recordLogItem.log,
cid: (recordLogItem.card as Card & { cid: string }).cid,
due: recordLogItem.log.due.getTime(),
review: recordLogItem.log.review.getTime(),
state: State[recordLogItem.log.state] as StateType,
rating: Rating[recordLogItem.log.rating] as RatingType,
},
};
}
const now = new Date();
const f = fsrs();
const emptyCardFormAfterHandler = createEmptyCard(now, cardAfterHandler); //see method: createEmptyCard
const repeatFormAfterHandler = f.repeat(emptyCardFormAfterHandler, now, repeatAfterHandler); //see method: fsrs.repeat()
const { card } = repeatFormAfterHandler[Rating.Hard];
const forgetFromAfterHandler = f.forget(card, date_scheduler(now, 1, true), false, forgetAfterHandler);
forgetting_
curve - forgetting_
curve(elapsed_days, stability): number The formula used is : -$$R(t,S) = (1 + FACTOR \times \frac{t}{9 \cdot S})^{DECAY},$$
-Parameters
elapsed_days: number
t days since the last review
-stability: number
Stability (interval when R=90%)
+
forgetting_
curve - forgetting_
curve(elapsed_days, stability): number The formula used is : +$$R(t,S) = (1 + \text{FACTOR} \times \frac{t}{9 \cdot S})^{\text{DECAY}}$$
+Parameters
- elapsed_days: number
t days since the last review
+ - stability: number
Stability (interval when R=90%)
Returns number
r Retrievability (probability of recall)
-- elapsed_days: number
get_
retrievability init_
difficulty - init_
difficulty(g): number The formula used is : -$$D_0(G) = w_4 - (G-3) \cdot w_5$$ -$$\min {\max {D_0(G),1},10}$$ -where the D_0(3)=w_4 when the first rating is good.
-Parameters
g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
-
Returns number
Difficulty D \in [1,10]
-
init_
ds init_
stability - init_
stability(g): number The formula used is : -S_0(G) = w_{G-1} -\max {S_0,0.1}
-Parameters
g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
+get_
retrievability init_
difficulty - init_
difficulty(g): number The formula used is : +$$D_0(G) = w_4 - (G-3) \cdot w_5 $$ +$$D_0 = \min \lbrace \max \lbrace D_0(G),1 \rbrace,10 \rbrace$$ +where the $$D_0(3)=w_4$$ when the first rating is good.
+Parameters
- g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
+
Returns number
Difficulty $$D \in [1,10]$$
+- g: Grade
init_
ds init_
stability - init_
stability(g): number The formula used is : +$$ S_0(G) = w_{G-1}$$ +$$S_0 = \max \lbrace S_0,0.1\rbrace $$
+Parameters
- g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
Returns number
Stability (interval when R=90%)
-- g: Grade
mean_
reversion - mean_
reversion(init, current): number The formula used is : -$$w_7 \cdot init +(1 - w_7) \cdot current$$
-Parameters
init: number
$$w_2 : D_0(3) = w_2 + (R-2) \cdot w_3= w_2$$
-current: number
$$D - w_6 \cdot (R - 2)$$
+mean_
reversion next_
difficulty - next_
difficulty(d, g): number The formula used is : -$$next_d = D - w_6 \cdot (R - 2)$$ -$$D^\prime(D,R) = w_5 \cdot D_0(2) +(1 - w_5) \cdot next_d$$
-Parameters
d: number
Difficulty D \in [1,10]
-g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
-
Returns number
next_D
-
next_
ds - next_
ds(s, last_d, last_s, retrievability): void - \ No newline at end of file diff --git a/classes/FSRSAlgorithm.html b/classes/FSRSAlgorithm.html index 11492fc..57126a8 100644 --- a/classes/FSRSAlgorithm.html +++ b/classes/FSRSAlgorithm.html @@ -1,87 +1,93 @@ -
Updates the difficulty and stability values of the scheduling card based on the last difficulty, +
next_
difficulty - next_
difficulty(d, g): number The formula used is : +$$\text{next}_d = D - w_6 \cdot (R - 2)$$ +$$D^\prime(D,R) = w_5 \cdot D_0(2) +(1 - w_5) \cdot \text{next}_d$$
+Parameters
- d: number
Difficulty $$D \in [1,10]$$
+ - g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
+
Returns number
$$\text{next}_D$$
+- d: number
next_
ds - next_
ds(s, last_d, last_s, retrievability): void Updates the difficulty and stability values of the scheduling card based on the last difficulty, last stability, and the current retrievability.
-Parameters
s: SchedulingCard
scheduling Card
-last_d: number
Difficulty
-last_s: number
Stability
-retrievability: number
Retrievability
-
Returns void
next_
forget_ stability - next_
forget_ stability(d, s, r): number The formula used is : -$$S^\prime_f(D,S,R) = w_11\cdot D^{-w_{12}}\cdot ((S+1)^{w_{13}}-1) \cdot e^{w_{14}\cdot(1-R)}.$$
-Parameters
d: number
Difficulty D \in [1,10]
-s: number
Stability (interval when R=90%)
-r: number
Retrievability (probability of recall)
+Parameters
- s: SchedulingCard
scheduling Card
+ - last_d: number
Difficulty
+ - last_s: number
Stability
+ - retrievability: number
Retrievability
+
Returns void
- s: SchedulingCard
next_
forget_ stability - next_
forget_ stability(d, s, r): number The formula used is : +$$S^\prime_f(D,S,R) = w_{11}\cdot D^{-w_{12}}\cdot ((S+1)^{w_{13}}-1) \cdot e^{w_{14}\cdot(1-R)}$$
+Parameters
- d: number
Difficulty D \in [1,10]
+ - s: number
Stability (interval when R=90%)
+ - r: number
Retrievability (probability of recall)
Returns number
S^\prime_f new stability after forgetting
-- d: number
next_
interval - next_
interval(s, elapsed_days, enable_fuzz?): int Ref: - constructor(param: Partial
-) - this.intervalModifier = 9 * (1 / this.param.request_retention - 1); Parameters
s: number
Stability (interval when R=90%)
-elapsed_days: number
t days since the last review
-enable_fuzz: boolean = ...
This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.
-
Returns int
next_
recall_ stability - next_
recall_ stability(d, s, r, g): number The formula used is : -$$S^\prime_r(D,S,R,G) = S\cdot(e^{w_8}\cdot (11-D)\cdot S^{-w_9}\cdot(e^{w_10\cdot(1-R)}-1)\cdot w_15(if G=2) \cdot w_16(if G=4)+1)$$
-Parameters
d: number
Difficulty D \in [1,10]
-s: number
Stability (interval when R=90%)
-r: number
Retrievability (probability of recall)
-g: Grade
Grade (Rating[0.again,1.hard,2.good,3.easy])
+next_
interval - next_
interval(s, elapsed_days, enable_fuzz?): int Parameters
- s: number
Stability (interval when R=90%)
+ - elapsed_days: number
t days since the last review
+ - enable_fuzz: boolean = ...
This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.
+
Returns int
See
The formula used is : FSRSAlgorithm.calculate_interval_modifier
+- s: number
next_
recall_ stability - next_
recall_ stability(d, s, r, g): number The formula used is : +$$S^\prime_r(D,S,R,G) = S\cdot(e^{w_8}\cdot (11-D)\cdot S^{-w_9}\cdot(e^{w_{10}\cdot(1-R)}-1)\cdot w_{15}(\text{if} G=2) \cdot w_{16}(\text{if} G=4)+1)$$
+Parameters
- d: number
Difficulty D \in [1,10]
+ - s: number
Stability (interval when R=90%)
+ - r: number
Retrievability (probability of recall)
+ - g: Grade
Grade (Rating[0.again,1.hard,2.good,3.easy])
Returns number
S^\prime_r new stability after recall
-- d: number
PrivatepreProcess Card PrivatepreProcess Date - pre
Process Date(_date): Date Parameters
_date: DateInput
Returns Date
PrivatepreProcess Log - pre
Process Log(_log): ReviewLog Parameters
_log: ReviewLog | ReviewLogInput
Returns ReviewLog
repeat
- repeat<R>(card, now, afterHandler?): R
Type Parameters
R = RecordLog
Parameters
Returns R
Example
const card: Card = createEmptyCard(new Date());
const f = fsrs();
const recordLog = f.repeat(card, new Date()); +PrivatepreProcess Card PrivatepreProcess Date - pre
Process Date(_date): Date Parameters
- _date: DateInput
Returns Date
PrivatepreProcess Log - pre
Process Log(_log): ReviewLog Parameters
- _log: ReviewLog | ReviewLogInput
Returns ReviewLog
repeat
- repeat<R>(card, now, afterHandler?): R
Type Parameters
- R = RecordLog
Parameters
Returns R
Example
const card: Card = createEmptyCard(new Date());
const f = fsrs();
const recordLog = f.repeat(card, new Date());Example
-interface RevLogUnchecked
extends Omit<ReviewLog, "due" | "review" | "state" | "rating"> {
cid: string;
due: Date | number;
state: StateType;
review: Date | number;
rating: RatingType;
}
interface RepeatRecordLog {
card: CardUnChecked; //see method: createEmptyCard
log: RevLogUnchecked;
}
function repeatAfterHandler(recordLog: RecordLog) {
const record: { [key in Grade]: RepeatRecordLog } = {} as {
[key in Grade]: RepeatRecordLog;
};
for (const grade of Grades) {
record[grade] = {
card: {
...(recordLog[grade].card as Card & { cid: string }),
due: recordLog[grade].card.due.getTime(),
state: State[recordLog[grade].card.state] as StateType,
last_review: recordLog[grade].card.last_review
? recordLog[grade].card.last_review!.getTime()
: null,
},
log: {
...recordLog[grade].log,
cid: (recordLog[grade].card as Card & { cid: string }).cid,
due: recordLog[grade].log.due.getTime(),
review: recordLog[grade].log.review.getTime(),
state: State[recordLog[grade].log.state] as StateType,
rating: Rating[recordLog[grade].log.rating] as RatingType,
},
};
}
return record;
}
const card: Card = createEmptyCard(new Date(), cardAfterHandler); //see method: createEmptyCard
const f = fsrs();
const recordLog = f.repeat(card, new Date(), repeatAfterHandler);
reschedule
- reschedule<T>(cards, options?): T[]
Type Parameters
Parameters
cards: T[]
scheduled card collection
-options: RescheduleOptions = {}
Reschedule options,fuzz is enabled by default.If the type of due is not Date, please implement dataHandler.
-
Returns T[]
Example
type CardType = Card & {
cid: number;
};
const reviewCard: CardType = {
cid: 1,
due: new Date("2024-03-17 04:43:02"),
stability: 48.26139059062234,
difficulty: 5.67,
elapsed_days: 18,
scheduled_days: 51,
reps: 8,
lapses: 1,
state: State.Review,
last_review: new Date("2024-01-26 04:43:02"),
};
const f = fsrs();
const reschedule_cards = f.reschedule([reviewCard]); +
reschedule
- reschedule<T>(cards, options?): T[]
Type Parameters
Parameters
- cards: T[]
scheduled card collection
+ - options: RescheduleOptions = {}
Reschedule options,fuzz is enabled by default.If the type of due is not Date, please implement dataHandler.
+
Returns T[]
Example
-type CardType = Card & {
cid: number;
};
const reviewCard: CardType = {
cid: 1,
due: new Date("2024-03-17 04:43:02"),
stability: 48.26139059062234,
difficulty: 5.67,
elapsed_days: 18,
scheduled_days: 51,
reps: 8,
lapses: 1,
state: State.Review,
last_review: new Date("2024-01-26 04:43:02"),
};
const f = fsrs();
const reschedule_cards = f.reschedule([reviewCard]);- cards: T[]
rollback
- rollback<R>(card, log, afterHandler?): R
Type Parameters
R = Card
Parameters
card: Card | CardInput
Card to be processed
-log: ReviewLogInput
last review log
-OptionalafterHandler: ((prevCard) => R)Convert the result to another type. (Optional)
-- (prevCard): R
Parameters
prevCard: Card
Returns R
Returns R
Example
const now = new Date();
const f = fsrs();
const emptyCardFormAfterHandler = createEmptyCard(now);
const repeatFormAfterHandler = f.repeat(emptyCardFormAfterHandler, now);
const { card, log } = repeatFormAfterHandler[Rating.Hard];
const rollbackFromAfterHandler = f.rollback(card, log); +
rollback
- rollback<R>(card, log, afterHandler?): R
Type Parameters
- R = Card
Parameters
Returns R
Example
const now = new Date();
const f = fsrs();
const emptyCardFormAfterHandler = createEmptyCard(now);
const repeatFormAfterHandler = f.repeat(emptyCardFormAfterHandler, now);
const { card, log } = repeatFormAfterHandler[Rating.Hard];
const rollbackFromAfterHandler = f.rollback(card, log);Example
-const now = new Date();
const f = fsrs();
const emptyCardFormAfterHandler = createEmptyCard(now, cardAfterHandler); //see method: createEmptyCard
const repeatFormAfterHandler = f.repeat(emptyCardFormAfterHandler, now, repeatAfterHandler); //see method: fsrs.repeat()
const { card, log } = repeatFormAfterHandler[Rating.Hard];
const rollbackFromAfterHandler = f.rollback(card, log, cardAfterHandler);
\ No newline at end of file +Generated using TypeDoc
- next_
FSRSAlgorithm | ts-fsrs Class FSRSAlgorithm
Hierarchy
- FSRSAlgorithm
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new FSRSAlgorithm(params): FSRSAlgorithm
Parameters
params: Partial<FSRSParameters>
Returns FSRSAlgorithm
Properties
ProtectedintervalModifier intervalModifier: number ProtectedparamProtectedOptionalseedseed?: stringAccessors
interval_
modifier - get interval_modifier(): number
Returns number
parameters
- get parameters(): FSRSParameters
Returns FSRSParameters
- set parameters(params): void
Parameters
params: Partial<FSRSParameters>
Returns void
Methods
apply_
fuzz - apply_
fuzz(ivl, elapsed_days, enable_fuzz?): int If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.
-Parameters
ivl: number
The interval to be fuzzed.
-elapsed_days: number
t days since the last review
-Optionalenable_fuzz: booleanThis adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.
+FSRSAlgorithm | TS-FSRS Class FSRSAlgorithm
Hierarchy (view full)
- FSRSAlgorithm
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new FSRSAlgorithm(params): FSRSAlgorithm
Parameters
- params: Partial<FSRSParameters>
Returns FSRSAlgorithm
Properties
ProtectedintervalModifier intervalModifier: number ProtectedparamProtectedOptionalseedseed?: stringAccessors
interval_
modifier - get interval_modifier(): number
Returns number
parameters
- get parameters(): FSRSParameters
Get the parameters of the algorithm.
+Returns FSRSParameters
- set parameters(params): void
Set the parameters of the algorithm.
+Parameters
- params: Partial<FSRSParameters>
Partial
+
Returns void
- params: Partial<FSRSParameters>
Methods
apply_
fuzz - apply_
fuzz(ivl, elapsed_days, enable_fuzz?): int If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.
+Parameters
- ivl: number
The interval to be fuzzed.
+ - elapsed_days: number
t days since the last review
+ Optionalenable_fuzz: booleanThis adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.
Returns int
- The fuzzed interval.
- ivl: number
calculate_
interval_ modifier - calculate_
interval_ modifier(request_retention): number Ref: https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm#fsrs-45 -The formula used is: I(r,s) = (r^(1/DECAY) - 1) * s / FACTOR
-Parameters
request_retention: number
0<request_retention<=1,Requested retention rate
-
Returns number
constrain_
difficulty forgetting_
curve - forgetting_
curve(elapsed_days, stability): number The formula used is : -$$R(t,S) = (1 + FACTOR \times \frac{t}{9 \cdot S})^{DECAY},$$
-Parameters
elapsed_days: number
t days since the last review
-stability: number
Stability (interval when R=90%)
+calculate_
interval_ modifier - calculate_
interval_ modifier(request_retention): number Parameters
- request_retention: number
0<request_retention<=1,Requested retention rate
+
Returns number
See
https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm#fsrs-45
+The formula used is: $$I(r,s) = (r^{\frac{1}{DECAY}} - 1) / FACTOR \times s$$
+Throws
Requested retention rate should be in the range (0,1]
+- request_retention: number
constrain_
difficulty forgetting_
curve - forgetting_
curve(elapsed_days, stability): number The formula used is : +$$R(t,S) = (1 + \text{FACTOR} \times \frac{t}{9 \cdot S})^{\text{DECAY}}$$
+Parameters
- elapsed_days: number
t days since the last review
+ - stability: number
Stability (interval when R=90%)
Returns number
r Retrievability (probability of recall)
-- elapsed_days: number
init_
difficulty - init_
difficulty(g): number The formula used is : -$$D_0(G) = w_4 - (G-3) \cdot w_5$$ -$$\min {\max {D_0(G),1},10}$$ -where the D_0(3)=w_4 when the first rating is good.
-Parameters
g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
-
Returns number
Difficulty D \in [1,10]
-
init_
ds init_
stability - init_
stability(g): number The formula used is : -S_0(G) = w_{G-1} -\max {S_0,0.1}
-Parameters
g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
+init_
difficulty - init_
difficulty(g): number The formula used is : +$$D_0(G) = w_4 - (G-3) \cdot w_5 $$ +$$D_0 = \min \lbrace \max \lbrace D_0(G),1 \rbrace,10 \rbrace$$ +where the $$D_0(3)=w_4$$ when the first rating is good.
+Parameters
- g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
+
Returns number
Difficulty $$D \in [1,10]$$
+- g: Grade
init_
ds init_
stability - init_
stability(g): number The formula used is : +$$ S_0(G) = w_{G-1}$$ +$$S_0 = \max \lbrace S_0,0.1\rbrace $$
+Parameters
- g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
Returns number
Stability (interval when R=90%)
-- g: Grade
mean_
reversion - mean_
reversion(init, current): number The formula used is : -$$w_7 \cdot init +(1 - w_7) \cdot current$$
-Parameters
init: number
$$w_2 : D_0(3) = w_2 + (R-2) \cdot w_3= w_2$$
-current: number
$$D - w_6 \cdot (R - 2)$$
+mean_
reversion next_
difficulty - next_
difficulty(d, g): number The formula used is : -$$next_d = D - w_6 \cdot (R - 2)$$ -$$D^\prime(D,R) = w_5 \cdot D_0(2) +(1 - w_5) \cdot next_d$$
-Parameters
d: number
Difficulty D \in [1,10]
-g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
-
Returns number
next_D
-
next_
ds - next_
ds(s, last_d, last_s, retrievability): void - \ No newline at end of file diff --git a/classes/SchedulingCard.html b/classes/SchedulingCard.html index fd8104e..4fed4fa 100644 --- a/classes/SchedulingCard.html +++ b/classes/SchedulingCard.html @@ -1,12 +1,15 @@ -
Updates the difficulty and stability values of the scheduling card based on the last difficulty, +
next_
difficulty - next_
difficulty(d, g): number The formula used is : +$$\text{next}_d = D - w_6 \cdot (R - 2)$$ +$$D^\prime(D,R) = w_5 \cdot D_0(2) +(1 - w_5) \cdot \text{next}_d$$
+Parameters
- d: number
Difficulty $$D \in [1,10]$$
+ - g: Grade
Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]
+
Returns number
$$\text{next}_D$$
+- d: number
next_
ds - next_
ds(s, last_d, last_s, retrievability): void Updates the difficulty and stability values of the scheduling card based on the last difficulty, last stability, and the current retrievability.
-Parameters
s: SchedulingCard
scheduling Card
-last_d: number
Difficulty
-last_s: number
Stability
-retrievability: number
Retrievability
-
Returns void
next_
forget_ stability - next_
forget_ stability(d, s, r): number The formula used is : -$$S^\prime_f(D,S,R) = w_11\cdot D^{-w_{12}}\cdot ((S+1)^{w_{13}}-1) \cdot e^{w_{14}\cdot(1-R)}.$$
-Parameters
d: number
Difficulty D \in [1,10]
-s: number
Stability (interval when R=90%)
-r: number
Retrievability (probability of recall)
+Parameters
- s: SchedulingCard
scheduling Card
+ - last_d: number
Difficulty
+ - last_s: number
Stability
+ - retrievability: number
Retrievability
+
Returns void
- s: SchedulingCard
next_
forget_ stability - next_
forget_ stability(d, s, r): number The formula used is : +$$S^\prime_f(D,S,R) = w_{11}\cdot D^{-w_{12}}\cdot ((S+1)^{w_{13}}-1) \cdot e^{w_{14}\cdot(1-R)}$$
+Parameters
- d: number
Difficulty D \in [1,10]
+ - s: number
Stability (interval when R=90%)
+ - r: number
Retrievability (probability of recall)
Returns number
S^\prime_f new stability after forgetting
-- d: number
next_
interval - next_
interval(s, elapsed_days, enable_fuzz?): int Ref: - constructor(param: Partial
-) - this.intervalModifier = 9 * (1 / this.param.request_retention - 1); Parameters
s: number
Stability (interval when R=90%)
-elapsed_days: number
t days since the last review
-enable_fuzz: boolean = ...
This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.
-
Returns int
next_
recall_ stability - next_
recall_ stability(d, s, r, g): number The formula used is : -$$S^\prime_r(D,S,R,G) = S\cdot(e^{w_8}\cdot (11-D)\cdot S^{-w_9}\cdot(e^{w_10\cdot(1-R)}-1)\cdot w_15(if G=2) \cdot w_16(if G=4)+1)$$
-Parameters
d: number
Difficulty D \in [1,10]
-s: number
Stability (interval when R=90%)
-r: number
Retrievability (probability of recall)
-g: Grade
Grade (Rating[0.again,1.hard,2.good,3.easy])
+next_
interval - next_
interval(s, elapsed_days, enable_fuzz?): int Parameters
- s: number
Stability (interval when R=90%)
+ - elapsed_days: number
t days since the last review
+ - enable_fuzz: boolean = ...
This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.
+
Returns int
See
The formula used is : FSRSAlgorithm.calculate_interval_modifier
+- s: number
next_
recall_ stability - next_
recall_ stability(d, s, r, g): number The formula used is : +$$S^\prime_r(D,S,R,G) = S\cdot(e^{w_8}\cdot (11-D)\cdot S^{-w_9}\cdot(e^{w_{10}\cdot(1-R)}-1)\cdot w_{15}(\text{if} G=2) \cdot w_{16}(\text{if} G=4)+1)$$
+Parameters
- d: number
Difficulty D \in [1,10]
+ - s: number
Stability (interval when R=90%)
+ - r: number
Retrievability (probability of recall)
+ - g: Grade
Grade (Rating[0.again,1.hard,2.good,3.easy])
Returns number
S^\prime_r new stability after recall
-- d: number
Privateparams_handler_ proxy - params_
handler_ proxy(): ProxyHandler<FSRSParameters> Returns ProxyHandler<FSRSParameters>
Privateupdate_parameters - update_
parameters(params): void Parameters
params: Partial<FSRSParameters>
Returns void
- next_
\ No newline at end of file +Generated using TypeDoc
Privateparams_handler_ proxy - params_
handler_ proxy(): ProxyHandler<FSRSParameters> Returns ProxyHandler<FSRSParameters>
Privateupdate_parameters - update_
parameters(params): void Parameters
- params: Partial<FSRSParameters>
Returns void
SchedulingCard | ts-fsrs Class SchedulingCard
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Scheduling Card(card, now): SchedulingCard Parameters
card: Card
now: Date
Returns SchedulingCard
Properties
again
easy
good
hard
last_
elapsed_ days last_elapsed_ days: number last_
review last_review: Date Methods
Privatecopyrecord_
log schedule
- schedule(now, hard_interval, good_interval, easy_interval): SchedulingCard
Parameters
now: Date
hard_interval: number
good_interval: number
easy_interval: number
Returns SchedulingCard
update_
state - update_
state(state): SchedulingCard Parameters
state: State
Returns SchedulingCard
\ No newline at end of file +Generated using TypeDoc
SchedulingCard | TS-FSRS \ No newline at end of file diff --git a/enums/Rating.html b/enums/Rating.html index 5a69276..3d83ebc 100644 --- a/enums/Rating.html +++ b/enums/Rating.html @@ -1,6 +1,9 @@ -Class SchedulingCard
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Scheduling Card(card, now): SchedulingCard Parameters
- card: Card
- now: Date
Returns SchedulingCard
Properties
again
easy
good
hard
last_
elapsed_ days last_elapsed_ days: number last_
review last_review: Date Methods
Privatecopyrecord_
log schedule
- schedule(now, hard_interval, good_interval, easy_interval): SchedulingCard
Parameters
- now: Date
- hard_interval: number
- good_interval: number
- easy_interval: number
Returns SchedulingCard
update_
state - update_
state(state): SchedulingCard Parameters
- state: State
Returns SchedulingCard
Rating | ts-fsrs \ No newline at end of file +Generated using TypeDoc
Rating | TS-FSRS \ No newline at end of file diff --git a/enums/State.html b/enums/State.html index be9297f..798d183 100644 --- a/enums/State.html +++ b/enums/State.html @@ -1,5 +1,8 @@ -State | ts-fsrs \ No newline at end of file +Generated using TypeDoc
State | TS-FSRS \ No newline at end of file diff --git a/functions/createEmptyCard.html b/functions/createEmptyCard.html index cec7db7..cd9e41d 100644 --- a/functions/createEmptyCard.html +++ b/functions/createEmptyCard.html @@ -1,8 +1,11 @@ -createEmptyCard | ts-fsrs \ No newline at end of file diff --git a/functions/date_diff.html b/functions/date_diff.html index 2816059..cd00c64 100644 --- a/functions/date_diff.html +++ b/functions/date_diff.html @@ -1 +1,4 @@ -Function createEmptyCard
- create
Empty Card<R>(now?, afterHandler?): R Create an empty card
-Type Parameters
R = Card
Parameters
Returns R
Example
const card: Card = createEmptyCard(new Date()); +createEmptyCard | TS-FSRS Function createEmptyCard
- create
Empty Card<R>(now?, afterHandler?): R Create an empty card
+Type Parameters
- R = Card
Parameters
Returns R
Example
const card: Card = createEmptyCard(new Date());Example
-interface CardUnChecked
extends Omit<Card, "due" | "last_review" | "state"> {
cid: string;
due: Date | number;
last_review: Date | null | number;
state: StateType;
}
function cardAfterHandler(card: Card) {
return {
...card,
cid: "test001",
state: State[card.state],
last_review: card.last_review ?? null,
} as CardUnChecked;
}
const card: CardUnChecked = createEmptyCard(new Date(), cardAfterHandler);
\ No newline at end of file +Generated using TypeDoc
date_diff | ts-fsrs \ No newline at end of file +Generated using TypeDoc
date_diff | TS-FSRS \ No newline at end of file diff --git a/functions/date_scheduler.html b/functions/date_scheduler.html index 782882d..064d809 100644 --- a/functions/date_scheduler.html +++ b/functions/date_scheduler.html @@ -1,6 +1,9 @@ -date_scheduler | ts-fsrs Function date_scheduler
- date_
scheduler(now, t, isDay?): Date 计算日期和时间的偏移，并返回一个新的日期对象。
-Parameters
now: DateInput
当前日期和时间
-t: number
时间偏移量，当 isDay 为 true 时表示天数，为 false 时表示分钟
-OptionalisDay: boolean（可选）是否按天数单位进行偏移，默认为 false，表示按分钟单位计算偏移
-
Returns Date
偏移后的日期和时间对象
-
\ No newline at end of file +Generated using TypeDoc
date_scheduler | TS-FSRS \ No newline at end of file diff --git a/functions/fixDate.html b/functions/fixDate.html index 36d6600..69aa456 100644 --- a/functions/fixDate.html +++ b/functions/fixDate.html @@ -1 +1,4 @@ -Function date_scheduler
- date_
scheduler(now, t, isDay?): Date 计算日期和时间的偏移，并返回一个新的日期对象。
+Parameters
- now: DateInput
当前日期和时间
+ - t: number
时间偏移量，当 isDay 为 true 时表示天数，为 false 时表示分钟
+ OptionalisDay: boolean（可选）是否按天数单位进行偏移，默认为 false，表示按分钟单位计算偏移
+
Returns Date
偏移后的日期和时间对象
+- now: DateInput
fixDate | ts-fsrs \ No newline at end of file +Generated using TypeDoc
fixDate | TS-FSRS \ No newline at end of file diff --git a/functions/fixRating.html b/functions/fixRating.html index 30b6c58..905e5a5 100644 --- a/functions/fixRating.html +++ b/functions/fixRating.html @@ -1 +1,4 @@ - fixRating | ts-fsrs \ No newline at end of file +Generated using TypeDoc
fixRating | TS-FSRS \ No newline at end of file diff --git a/functions/fixState.html b/functions/fixState.html index 458dfa4..de46beb 100644 --- a/functions/fixState.html +++ b/functions/fixState.html @@ -1 +1,4 @@ - fixState | ts-fsrs \ No newline at end of file +Generated using TypeDoc
fixState | TS-FSRS \ No newline at end of file diff --git a/functions/formatDate.html b/functions/formatDate.html index 1e1cc6f..e83ab46 100644 --- a/functions/formatDate.html +++ b/functions/formatDate.html @@ -1 +1,4 @@ - formatDate | ts-fsrs Function formatDate
- format
Date(dateInput): string Parameters
dateInput: DateInput
Returns string
\ No newline at end of file +Generated using TypeDoc
formatDate | TS-FSRS \ No newline at end of file diff --git a/functions/fsrs-1.html b/functions/fsrs-1.html index 6fff9ec..950c858 100644 --- a/functions/fsrs-1.html +++ b/functions/fsrs-1.html @@ -1,9 +1,12 @@ -Function formatDate
- format
Date(dateInput): string Parameters
- dateInput: DateInput
Returns string
fsrs | ts-fsrs \ No newline at end of file diff --git a/functions/generatorParameters.html b/functions/generatorParameters.html index c3490e1..bd6e7b2 100644 --- a/functions/generatorParameters.html +++ b/functions/generatorParameters.html @@ -1 +1,4 @@ -Function fsrs
- fsrs(params?): FSRS
Create a new instance of TS-FSRS
-Parameters
Optionalparams: Partial<FSRSParameters>FSRSParameters
+fsrs | TS-FSRS Function fsrs
- fsrs(params?): FSRS
Create a new instance of TS-FSRS
+Parameters
Optionalparams: Partial<FSRSParameters>FSRSParameters
Returns FSRS
Example
const f = fsrs();Example
const params: FSRSParameters = generatorParameters({ maximum_interval: 1000 });
const f = fsrs(params);Example
-const f = fsrs({ maximum_interval: 1000 });
\ No newline at end of file +Generated using TypeDoc
generatorParameters | ts-fsrs Function generatorParameters
- generator
Parameters(props?): FSRSParameters Parameters
Optionalprops: Partial<FSRSParameters>
Returns FSRSParameters
\ No newline at end of file +Generated using TypeDoc
generatorParameters | TS-FSRS \ No newline at end of file diff --git a/functions/get_fuzz_range.html b/functions/get_fuzz_range.html index 2b14227..1c146a6 100644 --- a/functions/get_fuzz_range.html +++ b/functions/get_fuzz_range.html @@ -1 +1,4 @@ -Function generatorParameters
- generator
Parameters(props?): FSRSParameters Parameters
Optionalprops: Partial<FSRSParameters>
Returns FSRSParameters
get_fuzz_range | ts-fsrs \ No newline at end of file +Generated using TypeDoc
get_fuzz_range | TS-FSRS \ No newline at end of file diff --git a/functions/show_diff_message.html b/functions/show_diff_message.html index ecb0392..9b3e9d0 100644 --- a/functions/show_diff_message.html +++ b/functions/show_diff_message.html @@ -1 +1,4 @@ -show_diff_message | ts-fsrs \ No newline at end of file +Generated using TypeDoc
show_diff_message | TS-FSRS \ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html new file mode 100644 index 0000000..9fcaf5a --- /dev/null +++ b/hierarchy.html @@ -0,0 +1,4 @@ +TS-FSRS \ No newline at end of file diff --git a/index.html b/index.html index 6afbff3..e1c88ff 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,7 @@ -ts-fsrs \ No newline at end of file diff --git a/interfaces/Card.html b/interfaces/Card.html index 7609e70..95d63de 100644 --- a/interfaces/Card.html +++ b/interfaces/Card.html @@ -1,10 +1,13 @@ -ts-fsrs
Introduction | 简体中文 ｜はじめに
+TS-FSRS TS-FSRS
Introduction | 简体中文 ｜はじめに
About The
6. Understanding Log Attributes:
Each
ReviewLogobject contains various attributes that determine the review record information associated with the card, used for analysis, undoing the review, and optimization (WIP).
-type ReviewLog = {
rating: Rating; // Rating of the review (Again, Hard, Good, Easy)
state: State; // State of the review (New, Learning, Review, Relearning)
due: Date; // Date of the last scheduling
stability: number; // Stability of the card before the review
difficulty: number; // Difficulty of the card before the review
elapsed_days: number; // Number of days elapsed since the last review
last_elapsed_days: number; // Number of days between the last two reviews
scheduled_days: number; // Number of days until the next review
review: Date; // Date of the review
}\ No newline at end of file +Generated using TypeDoc
Card | ts-fsrs Interface Card
interface Card {
difficulty: number;
due: Date;
elapsed_days: number;
lapses: number;
last_review?: Date;
reps: number;
scheduled_days: number;
stability: number;
state: State;
}Index
Properties
Properties
difficulty
difficulty: numberdue
due: Dateelapsed_
days elapsed_days: number lapses
lapses: numberOptionallast_review last_review?: Date reps
reps: numberscheduled_
days scheduled_days: number stability
stability: numberstate
\ No newline at end of file +Generated using TypeDoc
Card | TS-FSRS \ No newline at end of file diff --git a/interfaces/CardInput.html b/interfaces/CardInput.html index b9ddeaf..3892de6 100644 --- a/interfaces/CardInput.html +++ b/interfaces/CardInput.html @@ -1,10 +1,13 @@ -Interface Card
interface Card {
difficulty: number;
due: Date;
elapsed_days: number;
lapses: number;
last_review?: Date;
reps: number;
scheduled_days: number;
stability: number;
state: State;
}Index
Properties
Properties
difficulty
difficulty: numberdue
due: Dateelapsed_
days elapsed_days: number lapses
lapses: numberOptionallast_review last_review?: Date reps
reps: numberscheduled_
days scheduled_days: number stability
stability: numberstate
CardInput | ts-fsrs Interface CardInput
interface CardInput {
difficulty: number;
due: DateInput;
elapsed_days: number;
lapses: number;
last_review?: null | DateInput;
reps: number;
scheduled_days: number;
stability: number;
state: StateType | State;
}Hierarchy
- Omit<Card, "state" | "due" | "last_review">
- CardInput
Index
Properties
Properties
difficulty
difficulty: numberdue
elapsed_
days elapsed_days: number lapses
lapses: numberOptionallast_review reps
reps: numberscheduled_
days scheduled_days: number stability
stability: numberstate
\ No newline at end of file +Generated using TypeDoc
CardInput | TS-FSRS \ No newline at end of file diff --git a/interfaces/FSRSParameters.html b/interfaces/FSRSParameters.html index a82317e..12c20f4 100644 --- a/interfaces/FSRSParameters.html +++ b/interfaces/FSRSParameters.html @@ -1,5 +1,8 @@ -Interface CardInput
interface CardInput {
difficulty: number;
due: DateInput;
elapsed_days: number;
lapses: number;
last_review?: null | DateInput;
reps: number;
scheduled_days: number;
stability: number;
state: StateType | State;
}Hierarchy
- Omit<Card, "state" | "due" | "last_review">
- CardInput
Index
Properties
Properties
difficulty
difficulty: numberdue
elapsed_
days elapsed_days: number lapses
lapses: numberOptionallast_review reps
reps: numberscheduled_
days scheduled_days: number stability
stability: numberstate
FSRSParameters | ts-fsrs Interface FSRSParameters
interface FSRSParameters {
enable_fuzz: boolean;
maximum_interval: number;
request_retention: number;
w: number[];
}Index
Properties
Properties
enable_
fuzz enable_fuzz: boolean maximum_
interval maximum_interval: number request_
retention request_retention: number w
w: number[]\ No newline at end of file +Generated using TypeDoc
FSRSParameters | TS-FSRS \ No newline at end of file diff --git a/interfaces/ReviewLog.html b/interfaces/ReviewLog.html index 706b84b..2e80b38 100644 --- a/interfaces/ReviewLog.html +++ b/interfaces/ReviewLog.html @@ -1,10 +1,13 @@ -Interface FSRSParameters
interface FSRSParameters {
enable_fuzz: boolean;
maximum_interval: number;
request_retention: number;
w: number[];
}Index
Properties
Properties
enable_
fuzz enable_fuzz: boolean maximum_
interval maximum_interval: number request_
retention request_retention: number w
w: number[]ReviewLog | ts-fsrs Interface ReviewLog
interface ReviewLog {
difficulty: number;
due: Date;
elapsed_days: number;
last_elapsed_days: number;
rating: Rating;
review: Date;
scheduled_days: number;
stability: number;
state: State;
}Index
Properties
Properties
difficulty
difficulty: numberdue
due: Dateelapsed_
days elapsed_days: number last_
elapsed_ days last_elapsed_ days: number rating
review
review: Datescheduled_
days scheduled_days: number stability
stability: numberstate
\ No newline at end of file +Generated using TypeDoc
ReviewLog | TS-FSRS \ No newline at end of file diff --git a/interfaces/ReviewLogInput.html b/interfaces/ReviewLogInput.html index 561f5a2..0e3c5ad 100644 --- a/interfaces/ReviewLogInput.html +++ b/interfaces/ReviewLogInput.html @@ -1,10 +1,13 @@ -Interface ReviewLog
interface ReviewLog {
difficulty: number;
due: Date;
elapsed_days: number;
last_elapsed_days: number;
rating: Rating;
review: Date;
scheduled_days: number;
stability: number;
state: State;
}Index
Properties
Properties
difficulty
difficulty: numberdue
due: Dateelapsed_
days elapsed_days: number last_
elapsed_ days last_elapsed_ days: number rating
review
review: Datescheduled_
days scheduled_days: number stability
stability: numberstate
ReviewLogInput | ts-fsrs Interface ReviewLogInput
interface ReviewLogInput {
difficulty: number;
due: DateInput;
elapsed_days: number;
last_elapsed_days: number;
rating: RatingType | Rating;
review: DateInput;
scheduled_days: number;
stability: number;
state: StateType | State;
}Hierarchy
- Omit<ReviewLog, "rating" | "state" | "due" | "review">
- ReviewLogInput
Index
Properties
Properties
difficulty
difficulty: numberdue
elapsed_
days elapsed_days: number last_
elapsed_ days last_elapsed_ days: number rating
review
scheduled_
days scheduled_days: number stability
stability: numberstate
\ No newline at end of file +Generated using TypeDoc
ReviewLogInput | TS-FSRS \ No newline at end of file diff --git a/modules.html b/modules.html index e084603..6045230 100644 --- a/modules.html +++ b/modules.html @@ -1,39 +1,42 @@ -Interface ReviewLogInput
interface ReviewLogInput {
difficulty: number;
due: DateInput;
elapsed_days: number;
last_elapsed_days: number;
rating: RatingType | Rating;
review: DateInput;
scheduled_days: number;
stability: number;
state: StateType | State;
}Hierarchy
- Omit<ReviewLog, "rating" | "state" | "due" | "review">
- ReviewLogInput
Index
Properties
Properties
difficulty
difficulty: numberdue
elapsed_
days elapsed_days: number last_
elapsed_ days last_elapsed_ days: number rating
review
scheduled_
days scheduled_days: number stability
stability: numberstate
ts-fsrs ts-fsrs
Index
Enumerations
Classes
Interfaces
Type Aliases
Variables
Functions
\ No newline at end of file +Generated using TypeDoc
TS-FSRS \ No newline at end of file diff --git a/types/DateInput.html b/types/DateInput.html index 0f34bf3..04c281b 100644 --- a/types/DateInput.html +++ b/types/DateInput.html @@ -1 +1,4 @@ -TS-FSRS
Index
Enumerations
Classes
Interfaces
Type Aliases
Variables
Functions
DateInput | ts-fsrs Type alias DateInput
DateInput: Date | number | string \ No newline at end of file +Generated using TypeDoc
DateInput | TS-FSRS \ No newline at end of file diff --git a/types/Grade.html b/types/Grade.html index 55758d4..ff8cbb7 100644 --- a/types/Grade.html +++ b/types/Grade.html @@ -1 +1,4 @@ -Type alias DateInput
DateInput: Date | number | string Grade | ts-fsrs Type alias Grade
\ No newline at end of file +Generated using TypeDoc
Grade | TS-FSRS \ No newline at end of file diff --git a/types/RatingType.html b/types/RatingType.html index f458972..d5b7753 100644 --- a/types/RatingType.html +++ b/types/RatingType.html @@ -1 +1,4 @@ -Type alias Grade
RatingType | ts-fsrs Type alias RatingType
RatingType: "Manual" | "Again" | "Hard" | "Good" | "Easy" \ No newline at end of file +Generated using TypeDoc
RatingType | TS-FSRS \ No newline at end of file diff --git a/types/RecordLog.html b/types/RecordLog.html index 172200b..f4b2823 100644 --- a/types/RecordLog.html +++ b/types/RecordLog.html @@ -1 +1,4 @@ -Type alias RatingType
RatingType: "Manual" | "Again" | "Hard" | "Good" | "Easy" RecordLog | ts-fsrs Type alias RecordLog
\ No newline at end of file +Generated using TypeDoc
RecordLog | TS-FSRS \ No newline at end of file diff --git a/types/RecordLogItem.html b/types/RecordLogItem.html index 3708943..aa87060 100644 --- a/types/RecordLogItem.html +++ b/types/RecordLogItem.html @@ -1 +1,4 @@ -Type alias RecordLog
RecordLogItem | ts-fsrs \ No newline at end of file +Generated using TypeDoc
RecordLogItem | TS-FSRS \ No newline at end of file diff --git a/types/StateType.html b/types/StateType.html index de00cbd..f4c38d1 100644 --- a/types/StateType.html +++ b/types/StateType.html @@ -1 +1,4 @@ -StateType | ts-fsrs Type alias StateType
StateType: "New" | "Learning" | "Review" | "Relearning" \ No newline at end of file +Generated using TypeDoc
StateType | TS-FSRS \ No newline at end of file diff --git a/types/double.html b/types/double.html index f659b43..2d80604 100644 --- a/types/double.html +++ b/types/double.html @@ -1 +1,4 @@ -Type alias StateType
StateType: "New" | "Learning" | "Review" | "Relearning" double | ts-fsrs Type alias double
double: number & {
__double__: void;
}Type declaration
__double__: void
\ No newline at end of file +Generated using TypeDoc
double | TS-FSRS \ No newline at end of file diff --git a/types/int.html b/types/int.html index af9c9ef..c09fb5f 100644 --- a/types/int.html +++ b/types/int.html @@ -1 +1,4 @@ -Type alias double
double: number & {
__double__: void;
}Type declaration
__double__: void
int | ts-fsrs Type alias int
int: number & {
__int__: void;
}Type declaration
__int__: void
\ No newline at end of file +Generated using TypeDoc
int | TS-FSRS \ No newline at end of file diff --git a/types/unit.html b/types/unit.html index 2622eb4..a664bc5 100644 --- a/types/unit.html +++ b/types/unit.html @@ -1 +1,4 @@ -Type alias int
int: number & {
__int__: void;
}Type declaration
__int__: void
unit | ts-fsrs Type alias unit
unit: "days" | "minutes"\ No newline at end of file +Generated using TypeDoc
unit | TS-FSRS \ No newline at end of file diff --git a/variables/DECAY.html b/variables/DECAY.html index fe531b0..27813b4 100644 --- a/variables/DECAY.html +++ b/variables/DECAY.html @@ -1 +1,6 @@ -Type alias unit
unit: "days" | "minutes"DECAY | ts-fsrs Variable DECAY
ConstDECAY: number = -0.5\ No newline at end of file +Generated using TypeDoc
DECAY | TS-FSRS \ No newline at end of file diff --git a/variables/FACTOR.html b/variables/FACTOR.html index 08a02ed..ebb8010 100644 --- a/variables/FACTOR.html +++ b/variables/FACTOR.html @@ -1 +1,8 @@ -Variable DECAY
ConstDECAY: number = -0.5Default
+DECAY = -0.5 +FACTOR | ts-fsrs Variable FACTOR
ConstFACTOR: number = ...\ No newline at end of file +Generated using TypeDoc
FACTOR | TS-FSRS \ No newline at end of file diff --git a/variables/FSRSVersion.html b/variables/FSRSVersion.html index 443ec15..c964ee8 100644 --- a/variables/FSRSVersion.html +++ b/variables/FSRSVersion.html @@ -1 +1,4 @@ -Variable FACTOR
ConstFACTOR: number = ...FACTOR = Math.pow(0.9, 1 / DECAY) - 1= 19 / 81
+$$\text{FACTOR} = \frac{19}{81}$$
+Default
+FACTOR = 19 / 81 +FSRSVersion | ts-fsrs Variable FSRSVersion
ConstFSRSVersion: string = "3.5.4"\ No newline at end of file +Generated using TypeDoc
FSRSVersion | TS-FSRS \ No newline at end of file diff --git a/variables/Grades.html b/variables/Grades.html index 3a16a79..73ff7e8 100644 --- a/variables/Grades.html +++ b/variables/Grades.html @@ -1 +1,4 @@ -Variable FSRSVersion
ConstFSRSVersion: string = "3.5.4"Grades | ts-fsrs Variable Grades
Const\ No newline at end of file +Generated using TypeDoc
Grades | TS-FSRS \ No newline at end of file diff --git a/variables/default_enable_fuzz.html b/variables/default_enable_fuzz.html index 49d2f04..ac46e2d 100644 --- a/variables/default_enable_fuzz.html +++ b/variables/default_enable_fuzz.html @@ -1 +1,4 @@ -Variable Grades
Constdefault_enable_fuzz | ts-fsrs Variable default_enable_fuzz
Constdefault_enable_ fuzz: false = false \ No newline at end of file +Generated using TypeDoc
default_enable_fuzz | TS-FSRS \ No newline at end of file diff --git a/variables/default_maximum_interval.html b/variables/default_maximum_interval.html index aeb5e4b..ed5a5cc 100644 --- a/variables/default_maximum_interval.html +++ b/variables/default_maximum_interval.html @@ -1 +1,4 @@ -Variable default_enable_fuzz
Constdefault_enable_ fuzz: false = false default_maximum_interval | ts-fsrs Variable default_maximum_interval
Constdefault_maximum_ interval: 36500 = 36500 \ No newline at end of file +Generated using TypeDoc
default_maximum_interval | TS-FSRS \ No newline at end of file diff --git a/variables/default_request_retention.html b/variables/default_request_retention.html index 8b36930..7184d56 100644 --- a/variables/default_request_retention.html +++ b/variables/default_request_retention.html @@ -1 +1,4 @@ -Variable default_maximum_interval
Constdefault_maximum_ interval: 36500 = 36500 default_request_retention | ts-fsrs Variable default_request_retention
Constdefault_request_ retention: 0.9 = 0.9 \ No newline at end of file +Generated using TypeDoc
default_request_retention | TS-FSRS \ No newline at end of file diff --git a/variables/default_w.html b/variables/default_w.html index ab0bc2f..bdcf1a1 100644 --- a/variables/default_w.html +++ b/variables/default_w.html @@ -1 +1,4 @@ -Variable default_request_retention
Constdefault_request_ retention: 0.9 = 0.9 default_w | ts-fsrs Variable default_w
Constdefault_w: number[] = ... \ No newline at end of file +Generated using TypeDoc
default_w | TS-FSRS \ No newline at end of fileVariable default_w
Constdefault_w: number[] = ... - next_
- next_
- init_
- calculate_
- next_
- next_
- init_
- FSRSAlgorithm
If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.
-