fix: add missing A and B in class type (#24)

mljs · Nov 1, 2024 · 1daf65e · 1daf65e
1 parent 3e932b6
commit 1daf65e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ Exponential Regression.
 
 ## Usage
 
-This calculates parameters A and B for the equation `y = A * e^(B * x)`.
+This calculates parameters A and B for the equation `y = B * e^(A * x)`.
 
 ```js
 import { ExponentialRegression } from 'ml-regression-exponential';

diff --git a/regression-exponential.d.ts b/regression-exponential.d.ts
@@ -6,6 +6,16 @@ export interface ExponentialRegressionModel {
   B: number;
 }
 export declare class ExponentialRegression extends BaseRegression {
+  /**
+   * The exponent coefficient `A` in the equation `y = B * e^(A * x)`.
+   */
+  A: number;
+
+  /**
+   * The coefficient `B` in the equation `y = B * e^(A * x)`.
+   */
+  B: number;
+
   constructor(x: number[], y: number[]);
 
   static load(model: ExponentialRegressionModel): ExponentialRegression;