ts-fsrs 5.2.1 → 5.2.2

package/dist/index.d.ts

@@ -387,7 +387,7 @@ declare const FSRS5_DEFAULT_DECAY = 0.5;
 declare const FSRS6_DEFAULT_DECAY = 0.1542;
 declare const default_w: readonly number[];
 declare const W17_W18_Ceiling = 2;
-declare const CLAMP_PARAMETERS: (w17_w18_ceiling: number) => number[][];
+declare const CLAMP_PARAMETERS: (w17_w18_ceiling: number, enable_short_term?: boolean) => number[][];
 
 declare class TypeConvert {
     static card<T extends Card | CardInput>(card: T): Card;
@@ -397,7 +397,7 @@ declare class TypeConvert {
     static review_log(log: ReviewLogInput | ReviewLog): ReviewLog;
 }
 
-declare const clipParameters: (parameters: number[], numRelearningSteps: number) => number[];
+declare const clipParameters: (parameters: number[], numRelearningSteps: number, enableShortTerm?: boolean) => number[];
 /**
  * @returns The input if the parameters are valid, throws if they are invalid
  * @example
@@ -409,8 +409,8 @@ declare const clipParameters: (parameters: number[], numRelearningSteps: number)
  *   alert(e);
  * }
  */
-declare const checkParameters: (parameters: number[] | readonly number[]) => number[] | readonly number[];
-declare const migrateParameters: (parameters?: number[] | readonly number[]) => number[];
+declare const checkParameters: (parameters: number[] | readonly number[]) => readonly number[] | number[];
+declare const migrateParameters: (parameters?: number[] | readonly number[], numRelearningSteps?: number, enableShortTerm?: boolean) => number[];
 declare const generatorParameters: (props?: Partial<FSRSParameters>) => FSRSParameters;
 /**
  * Create an empty card

package/dist/index.mjs

@@ -466,7 +466,7 @@ function alea(seed) {
   return prng;
 }
 
-const version="5.2.1";
+const version="5.2.2";
 
 const default_request_retention = 0.9;
 const default_maximum_interval = 36500;
@@ -509,7 +509,7 @@ const default_w = Object.freeze([
   FSRS6_DEFAULT_DECAY
 ]);
 const W17_W18_Ceiling = 2;
-const CLAMP_PARAMETERS = (w17_w18_ceiling) => [
+const CLAMP_PARAMETERS = (w17_w18_ceiling, enable_short_term = default_enable_short_term) => [
   [S_MIN, INIT_S_MAX],
   [S_MIN, INIT_S_MAX],
   [S_MIN, INIT_S_MAX],
@@ -529,18 +529,26 @@ const CLAMP_PARAMETERS = (w17_w18_ceiling) => [
   [1, 6],
   [0, w17_w18_ceiling],
   [0, w17_w18_ceiling],
-  [0, 0.8],
+  [
+    enable_short_term ? 0.01 : 0,
+    0.8
+  ],
   [0.1, 0.8]
 ];
 
-const clipParameters = (parameters, numRelearningSteps) => {
+const clipParameters = (parameters, numRelearningSteps, enableShortTerm = default_enable_short_term) => {
   let w17_w18_ceiling = W17_W18_Ceiling;
   if (Math.max(0, numRelearningSteps) > 1) {
     const value = -(Math.log(parameters[11]) + Math.log(Math.pow(2, parameters[13]) - 1) + parameters[14] * 0.3) / numRelearningSteps;
     w17_w18_ceiling = clamp(+value.toFixed(8), 0.01, 2);
   }
-  const clip = CLAMP_PARAMETERS(w17_w18_ceiling);
-  return clip.map(([min, max], index) => clamp(parameters[index], min, max));
+  const clip = CLAMP_PARAMETERS(w17_w18_ceiling, enableShortTerm).slice(
+    0,
+    parameters.length
+  );
+  return clip.map(
+    ([min, max], index) => clamp(parameters[index] || 0, min, max)
+  );
 };
 const checkParameters = (parameters) => {
   const invalid = parameters.find(
@@ -555,18 +563,30 @@ const checkParameters = (parameters) => {
   }
   return parameters;
 };
-const migrateParameters = (parameters) => {
+const migrateParameters = (parameters, numRelearningSteps = 0, enableShortTerm = default_enable_short_term) => {
   if (parameters === void 0) {
     return [...default_w];
   }
   switch (parameters.length) {
     case 21:
-      return [...parameters];
+      return clipParameters(
+        Array.from(parameters),
+        numRelearningSteps,
+        enableShortTerm
+      );
     case 19:
       console.debug("[FSRS-6]auto fill w from 19 to 21 length");
-      return [...parameters, 0, FSRS5_DEFAULT_DECAY];
+      return clipParameters(
+        Array.from(parameters),
+        numRelearningSteps,
+        enableShortTerm
+      ).concat([0, FSRS5_DEFAULT_DECAY]);
     case 17: {
-      const w = [...parameters];
+      const w = clipParameters(
+        Array.from(parameters),
+        numRelearningSteps,
+        enableShortTerm
+      );
       w[4] = +(w[5] * 2 + w[4]).toFixed(8);
       w[5] = +(Math.log(w[5] * 3 + 1) / 3).toFixed(8);
       w[6] = +(w[6] + 0.5).toFixed(8);
@@ -581,13 +601,18 @@ const migrateParameters = (parameters) => {
 const generatorParameters = (props) => {
   const learning_steps = Array.isArray(props?.learning_steps) ? props.learning_steps : default_learning_steps;
   const relearning_steps = Array.isArray(props?.relearning_steps) ? props.relearning_steps : default_relearning_steps;
-  const w = clipParameters(migrateParameters(props?.w), relearning_steps.length);
+  const enable_short_term = props?.enable_short_term ?? default_enable_short_term;
+  const w = migrateParameters(
+    props?.w,
+    relearning_steps.length,
+    enable_short_term
+  );
   return {
     request_retention: props?.request_retention || default_request_retention,
     maximum_interval: props?.maximum_interval || default_maximum_interval,
     w,
     enable_fuzz: props?.enable_fuzz ?? default_enable_fuzz,
-    enable_short_term: props?.enable_short_term ?? default_enable_short_term,
+    enable_short_term,
     learning_steps,
     relearning_steps
   };
@@ -677,9 +702,10 @@ class FSRSAlgorithm {
             Number(value)
           );
         } else if (prop === "w") {
-          value = clipParameters(
-            migrateParameters(value),
-            target.relearning_steps.length
+          value = migrateParameters(
+            value,
+            target.relearning_steps.length,
+            target.enable_short_term
           );
           _this.forgetting_curve = forgetting_curve.bind(this, value);
           _this.intervalModifier = _this.calculate_interval_modifier(
@@ -1492,9 +1518,10 @@ class FSRS extends FSRSAlgorithm {
         } else if (prop === "enable_short_term") {
           _this.Scheduler = value === true ? BasicScheduler : LongTermScheduler;
         } else if (prop === "w") {
-          value = clipParameters(
-            migrateParameters(value),
-            target.relearning_steps.length
+          value = migrateParameters(
+            value,
+            target.relearning_steps.length,
+            target.enable_short_term
           );
           _this.forgetting_curve = forgetting_curve.bind(this, value);
           _this.intervalModifier = _this.calculate_interval_modifier(