From 0f44f999d1d4c5e77213fba8398394bea735e166 Mon Sep 17 00:00:00 2001 From: ishiko732 Date: Fri, 1 Dec 2023 07:36:09 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20ishiko73?= =?UTF-8?q?2/ts-fsrs@83f48effe21fb272cbad9387dcb7ae0c7754f4b5=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/FSRS.html | 26 ++++++++++++------------ classes/SchedulingCard.html | 4 ++-- enums/Rating.html | 4 ++-- enums/State.html | 4 ++-- example.html | 2 +- functions/createEmptyCard.html | 2 +- functions/date_diff.html | 2 +- functions/date_scheduler.html | 2 +- functions/fixDate.html | 2 +- functions/fixRating.html | 2 +- functions/fixState.html | 2 +- functions/formatDate.html | 2 +- functions/fsrs-1.html | 2 +- functions/generatorParameters.html | 2 +- functions/show_diff_message.html | 2 +- interfaces/Card.html | 4 ++-- interfaces/FSRSParameters.html | 4 ++-- interfaces/ReviewLog.html | 4 ++-- types/CardInput.html | 2 +- types/DateInput.html | 2 +- types/Grade.html | 2 +- types/RatingType.html | 2 +- types/RecordLog.html | 2 +- types/RecordLogItem.html | 2 +- types/StateType.html | 2 +- types/double.html | 2 +- types/int.html | 2 +- variables/FSRSVersion.html | 2 +- variables/Grades.html | 2 +- variables/default_enable_fuzz.html | 2 +- variables/default_maximum_interval.html | 2 +- variables/default_request_retention.html | 2 +- variables/default_w.html | 2 +- 33 files changed, 51 insertions(+), 51 deletions(-) diff --git a/classes/FSRS.html b/classes/FSRS.html index 37fd5db..3e335fb 100644 --- a/classes/FSRS.html +++ b/classes/FSRS.html @@ -1,4 +1,4 @@ -FSRS | ts-fsrs

Class FSRS

Hierarchy

  • FSRSAlgorithm
    • FSRS

Constructors

constructor +FSRS | ts-fsrs

Class FSRS

Hierarchy

  • FSRSAlgorithm
    • FSRS

Constructors

Properties

Methods

apply_fuzz @@ -20,62 +20,62 @@ preProcessLog repeat rollback -

Constructors

Properties

seed?: string

Methods

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    +

Constructors

Properties

seed?: string

Methods

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    Parameters

    • ivl: number

      The interval to be fuzzed.

    Returns number

    • The fuzzed interval.
    -
  • The formula used is : +

  • The formula used is : $$\min {\max {D_0,1},10}$$

    Parameters

    • difficulty: number

      D \in [1,10]

      -

    Returns number

  • The formula used is : +

Returns number

  • The formula used is : $$R(t,S) = (1 + \frac{t}{9 \cdot S})^{-1},$$

    Parameters

    • t: number

      t days since the last review

    • s: number

      Stability (interval when R=90%)

    Returns number

    r Retrievability (probability of recall)

    -
  • Parameters

    Returns undefined | string

  • The formula used is : +

  • Parameters

    Returns undefined | string

  • 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]

    -
  • The formula used is : +

  • 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]

    Returns number

    Stability (interval when R=90%)

    -
  • The formula used is : +

  • 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)$$

    Returns number

    difficulty

    -
  • The formula used is : +

  • 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

    -
  • Updates the difficulty and stability values of the scheduling card based on the last difficulty, +

  • 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

  • The formula used is : +

Returns void

Returns int

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/SchedulingCard.html b/classes/SchedulingCard.html index dbda7db..320cb33 100644 --- a/classes/SchedulingCard.html +++ b/classes/SchedulingCard.html @@ -1,4 +1,4 @@ -SchedulingCard | ts-fsrs

Class SchedulingCard

Hierarchy

  • SchedulingCard

Constructors

constructor +SchedulingCard | ts-fsrs

Class SchedulingCard

Hierarchy

  • SchedulingCard

Constructors

Properties

Constructors

Properties

again: Card
easy: Card
good: Card
hard: Card
last_elapsed_days: number
last_review: Date

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

again: Card
easy: Card
good: Card
hard: Card
last_elapsed_days: number
last_review: Date

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/Rating.html b/enums/Rating.html index 3159af1..8bd11f0 100644 --- a/enums/Rating.html +++ b/enums/Rating.html @@ -1,6 +1,6 @@ -Rating | ts-fsrs

Enumeration Rating

Enumeration Members

Again +Rating | ts-fsrs

Enumeration Rating

Enumeration Members

Enumeration Members

Again: 1
Easy: 4
Good: 3
Hard: 2
Manual: 0

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Again: 1
Easy: 4
Good: 3
Hard: 2
Manual: 0

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/State.html b/enums/State.html index e53ea7c..229f61e 100644 --- a/enums/State.html +++ b/enums/State.html @@ -1,5 +1,5 @@ -State | ts-fsrs

Enumeration State

Enumeration Members

Learning +State | ts-fsrs

Enumeration State

Enumeration Members

Enumeration Members

Learning: 1
New: 0
Relearning: 3
Review: 2

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

Learning: 1
New: 0
Relearning: 3
Review: 2

Generated using TypeDoc

\ No newline at end of file diff --git a/example.html b/example.html index 85158a0..3af6f19 100644 --- a/example.html +++ b/example.html @@ -9,7 +9,7 @@ TS-FSRS example diff --git a/functions/createEmptyCard.html b/functions/createEmptyCard.html index f929053..230bd0c 100644 --- a/functions/createEmptyCard.html +++ b/functions/createEmptyCard.html @@ -1 +1 @@ -createEmptyCard | ts-fsrs

Function createEmptyCard

Generated using TypeDoc

\ No newline at end of file +createEmptyCard | ts-fsrs

Function createEmptyCard

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/date_diff.html b/functions/date_diff.html index 2fcf5e8..faa18a6 100644 --- a/functions/date_diff.html +++ b/functions/date_diff.html @@ -1 +1 @@ -date_diff | ts-fsrs

Function date_diff

  • Parameters

    • now: Date
    • pre: Date
    • unit: unit

    Returns number

Generated using TypeDoc

\ No newline at end of file +date_diff | ts-fsrs

Function date_diff

  • Parameters

    • now: Date
    • pre: Date
    • unit: unit

    Returns number

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/date_scheduler.html b/functions/date_scheduler.html index 26a03d5..50aaed6 100644 --- a/functions/date_scheduler.html +++ b/functions/date_scheduler.html @@ -3,4 +3,4 @@
  • t: number

    时间偏移量,当 isDay 为 true 时表示天数,为 false 时表示分钟

  • Optional isDay: boolean

    (可选)是否按天数单位进行偏移,默认为 false,表示按分钟单位计算偏移

  • Returns Date

    偏移后的日期和时间对象

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/fixDate.html b/functions/fixDate.html index 70f7466..2e7982e 100644 --- a/functions/fixDate.html +++ b/functions/fixDate.html @@ -1 +1 @@ -fixDate | ts-fsrs

    Function fixDate

    • Parameters

      • value: unknown

      Returns Date

    Generated using TypeDoc

    \ No newline at end of file +fixDate | ts-fsrs

    Function fixDate

    • Parameters

      • value: unknown

      Returns Date

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/fixRating.html b/functions/fixRating.html index 95054d1..768c4c4 100644 --- a/functions/fixRating.html +++ b/functions/fixRating.html @@ -1 +1 @@ -fixRating | ts-fsrs

    Function fixRating

    Generated using TypeDoc

    \ No newline at end of file +fixRating | ts-fsrs

    Function fixRating

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/fixState.html b/functions/fixState.html index d3f261f..c187028 100644 --- a/functions/fixState.html +++ b/functions/fixState.html @@ -1 +1 @@ -fixState | ts-fsrs

    Function fixState

    Generated using TypeDoc

    \ No newline at end of file +fixState | ts-fsrs

    Function fixState

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/formatDate.html b/functions/formatDate.html index aefa757..6ac3269 100644 --- a/functions/formatDate.html +++ b/functions/formatDate.html @@ -1 +1 @@ -formatDate | ts-fsrs

    Function formatDate

    • Parameters

      • date: Date

      Returns string

    Generated using TypeDoc

    \ No newline at end of file +formatDate | ts-fsrs

    Function formatDate

    • Parameters

      • date: Date

      Returns string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/fsrs-1.html b/functions/fsrs-1.html index 42278ac..63a5218 100644 --- a/functions/fsrs-1.html +++ b/functions/fsrs-1.html @@ -1 +1 @@ -fsrs | ts-fsrs

    Function fsrs

    Generated using TypeDoc

    \ No newline at end of file +fsrs | ts-fsrs

    Function fsrs

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/generatorParameters.html b/functions/generatorParameters.html index 1ee4290..19aa158 100644 --- a/functions/generatorParameters.html +++ b/functions/generatorParameters.html @@ -1 +1 @@ -generatorParameters | ts-fsrs

    Function generatorParameters

    Generated using TypeDoc

    \ No newline at end of file +generatorParameters | ts-fsrs

    Function generatorParameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/show_diff_message.html b/functions/show_diff_message.html index 521a6d5..ebdf24f 100644 --- a/functions/show_diff_message.html +++ b/functions/show_diff_message.html @@ -1 +1 @@ -show_diff_message | ts-fsrs

    Function show_diff_message

    • Parameters

      • due: Date
      • last_review: Date
      • Optional unit: boolean
      • timeUnit: string[] = TIMEUNITFORMAT

      Returns string

    Generated using TypeDoc

    \ No newline at end of file +show_diff_message | ts-fsrs

    Function show_diff_message

    • Parameters

      • due: Date
      • last_review: Date
      • Optional unit: boolean
      • timeUnit: string[] = TIMEUNITFORMAT

      Returns string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Card.html b/interfaces/Card.html index 480f156..bff53fd 100644 --- a/interfaces/Card.html +++ b/interfaces/Card.html @@ -1,4 +1,4 @@ -Card | ts-fsrs

    Interface Card

    Hierarchy

    • Card

    Properties

    difficulty +Card | ts-fsrs

    Interface Card

    Hierarchy

    • Card

    Properties

    difficulty: number
    due: Date
    elapsed_days: number
    lapses: number
    last_review?: Date
    reps: number
    scheduled_days: number
    stability: number
    state: State

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    difficulty: number
    due: Date
    elapsed_days: number
    lapses: number
    last_review?: Date
    reps: number
    scheduled_days: number
    stability: number
    state: State

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/FSRSParameters.html b/interfaces/FSRSParameters.html index bd27618..9975968 100644 --- a/interfaces/FSRSParameters.html +++ b/interfaces/FSRSParameters.html @@ -1,5 +1,5 @@ -FSRSParameters | ts-fsrs

    Interface FSRSParameters

    Hierarchy

    • FSRSParameters

    Properties

    enable_fuzz +FSRSParameters | ts-fsrs

    Interface FSRSParameters

    Hierarchy

    • FSRSParameters

    Properties

    enable_fuzz: boolean
    maximum_interval: number
    request_retention: number
    w: number[]

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    enable_fuzz: boolean
    maximum_interval: number
    request_retention: number
    w: number[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/ReviewLog.html b/interfaces/ReviewLog.html index 911bfbd..a2bb151 100644 --- a/interfaces/ReviewLog.html +++ b/interfaces/ReviewLog.html @@ -1,4 +1,4 @@ -ReviewLog | ts-fsrs

    Interface ReviewLog

    Hierarchy

    • ReviewLog

    Properties

    difficulty +ReviewLog | ts-fsrs

    Interface ReviewLog

    Hierarchy

    • ReviewLog

    Properties

    difficulty: number
    due: Date
    elapsed_days: number
    last_elapsed_days: number
    rating: Rating
    review: Date
    scheduled_days: number
    stability: number
    state: State

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    difficulty: number
    due: Date
    elapsed_days: number
    last_elapsed_days: number
    rating: Rating
    review: Date
    scheduled_days: number
    stability: number
    state: State

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CardInput.html b/types/CardInput.html index 837df43..826dd76 100644 --- a/types/CardInput.html +++ b/types/CardInput.html @@ -1 +1 @@ -CardInput | ts-fsrs

    Type alias CardInput

    CardInput: Card & {
        state: StateType | State;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +CardInput | ts-fsrs

    Type alias CardInput

    CardInput: Card & {
        state: StateType | State;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/DateInput.html b/types/DateInput.html index 8b12ebc..dfaabb7 100644 --- a/types/DateInput.html +++ b/types/DateInput.html @@ -1 +1 @@ -DateInput | ts-fsrs

    Type alias DateInput

    DateInput: Date | number | string

    Generated using TypeDoc

    \ No newline at end of file +DateInput | ts-fsrs

    Type alias DateInput

    DateInput: Date | number | string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Grade.html b/types/Grade.html index 8e3c4a0..099713e 100644 --- a/types/Grade.html +++ b/types/Grade.html @@ -1 +1 @@ -Grade | ts-fsrs

    Type alias Grade

    Grade: ExcludeManual<Rating>

    Generated using TypeDoc

    \ No newline at end of file +Grade | ts-fsrs

    Type alias Grade

    Grade: ExcludeManual<Rating>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/RatingType.html b/types/RatingType.html index a137cfc..fb5a8b1 100644 --- a/types/RatingType.html +++ b/types/RatingType.html @@ -1 +1 @@ -RatingType | ts-fsrs

    Type alias RatingType

    RatingType: "Again" | "Hard" | "Good" | "Easy"

    Generated using TypeDoc

    \ No newline at end of file +RatingType | ts-fsrs

    Type alias RatingType

    RatingType: "Again" | "Hard" | "Good" | "Easy"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/RecordLog.html b/types/RecordLog.html index c456c27..be69539 100644 --- a/types/RecordLog.html +++ b/types/RecordLog.html @@ -1 +1 @@ -RecordLog | ts-fsrs

    Type alias RecordLog

    RecordLog: {
        [key in Grade]: RecordLogItem
    }

    Generated using TypeDoc

    \ No newline at end of file +RecordLog | ts-fsrs

    Type alias RecordLog

    RecordLog: {
        [key in Grade]: RecordLogItem
    }

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/RecordLogItem.html b/types/RecordLogItem.html index 123dd05..cc2e0ac 100644 --- a/types/RecordLogItem.html +++ b/types/RecordLogItem.html @@ -1 +1 @@ -RecordLogItem | ts-fsrs

    Type alias RecordLogItem

    RecordLogItem: {
        card: Card;
        log: ReviewLog;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +RecordLogItem | ts-fsrs

    Type alias RecordLogItem

    RecordLogItem: {
        card: Card;
        log: ReviewLog;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/StateType.html b/types/StateType.html index 532bf72..7f55f45 100644 --- a/types/StateType.html +++ b/types/StateType.html @@ -1 +1 @@ -StateType | ts-fsrs

    Type alias StateType

    StateType: "New" | "Learning" | "Review" | "Relearning"

    Generated using TypeDoc

    \ No newline at end of file +StateType | ts-fsrs

    Type alias StateType

    StateType: "New" | "Learning" | "Review" | "Relearning"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/double.html b/types/double.html index 06c0c24..7ac8dd9 100644 --- a/types/double.html +++ b/types/double.html @@ -1 +1 @@ -double | ts-fsrs

    Type alias double

    double: number & {
        __double__: void;
    }

    Type declaration

    • __double__: void

    Generated using TypeDoc

    \ No newline at end of file +double | ts-fsrs

    Type alias double

    double: number & {
        __double__: void;
    }

    Type declaration

    • __double__: void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/int.html b/types/int.html index ff6a543..b3d2bea 100644 --- a/types/int.html +++ b/types/int.html @@ -1 +1 @@ -int | ts-fsrs

    Type alias int

    int: number & {
        __int__: void;
    }

    Type declaration

    • __int__: void

    Generated using TypeDoc

    \ No newline at end of file +int | ts-fsrs

    Type alias int

    int: number & {
        __int__: void;
    }

    Type declaration

    • __int__: void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/FSRSVersion.html b/variables/FSRSVersion.html index b36a1bb..aceff68 100644 --- a/variables/FSRSVersion.html +++ b/variables/FSRSVersion.html @@ -1 +1 @@ -FSRSVersion | ts-fsrs

    Variable FSRSVersionConst

    FSRSVersion: string = "3.1.3"

    Generated using TypeDoc

    \ No newline at end of file +FSRSVersion | ts-fsrs

    Variable FSRSVersionConst

    FSRSVersion: string = "3.2.0"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/Grades.html b/variables/Grades.html index 0c1eedd..7511d2d 100644 --- a/variables/Grades.html +++ b/variables/Grades.html @@ -1 +1 @@ -Grades | ts-fsrs

    Variable GradesConst

    Grades: Grade[] = ...

    Generated using TypeDoc

    \ No newline at end of file +Grades | ts-fsrs

    Variable GradesConst

    Grades: Grade[] = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/default_enable_fuzz.html b/variables/default_enable_fuzz.html index d42b8af..955a99b 100644 --- a/variables/default_enable_fuzz.html +++ b/variables/default_enable_fuzz.html @@ -1 +1 @@ -default_enable_fuzz | ts-fsrs

    Variable default_enable_fuzzConst

    default_enable_fuzz: false = false

    Generated using TypeDoc

    \ No newline at end of file +default_enable_fuzz | ts-fsrs

    Variable default_enable_fuzzConst

    default_enable_fuzz: false = false

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/default_maximum_interval.html b/variables/default_maximum_interval.html index 717dac9..304a51d 100644 --- a/variables/default_maximum_interval.html +++ b/variables/default_maximum_interval.html @@ -1 +1 @@ -default_maximum_interval | ts-fsrs

    Variable default_maximum_intervalConst

    default_maximum_interval: 36500 = 36500

    Generated using TypeDoc

    \ No newline at end of file +default_maximum_interval | ts-fsrs

    Variable default_maximum_intervalConst

    default_maximum_interval: 36500 = 36500

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/default_request_retention.html b/variables/default_request_retention.html index 2e04d97..0e08206 100644 --- a/variables/default_request_retention.html +++ b/variables/default_request_retention.html @@ -1 +1 @@ -default_request_retention | ts-fsrs

    Variable default_request_retentionConst

    default_request_retention: 0.9 = 0.9

    Generated using TypeDoc

    \ No newline at end of file +default_request_retention | ts-fsrs

    Variable default_request_retentionConst

    default_request_retention: 0.9 = 0.9

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/default_w.html b/variables/default_w.html index 658a9fb..cf3e213 100644 --- a/variables/default_w.html +++ b/variables/default_w.html @@ -1 +1 @@ -default_w | ts-fsrs

    Variable default_wConst

    default_w: number[] = ...

    Generated using TypeDoc

    \ No newline at end of file +default_w | ts-fsrs

    Variable default_wConst

    default_w: number[] = ...

    Generated using TypeDoc

    \ No newline at end of file