ootk 4.0.0-1 → 4.0.0-2

package/CHANGELOG.md

@@ -3,7 +3,15 @@
 This is an automatic changelog that automatically records all changes made to the project. Generated from Git commit
 messages, it details updates like bug fixes and new features, providing a clear history of the project's development.
 
-#### [4.0.0-1](https://github.com/thkruz/ootk/compare/v4.0.0-0...4.0.0-1)
+#### [4.0.0-2](https://github.com/thkruz/ootk/compare/v4.0.0-1...4.0.0-2)
+
+- refactor: :recycle: move derivative from ootk-core [`9a9b50d`](https://github.com/thkruz/ootk/commit/9a9b50d4402b24398d920ae4ef0a76a7d19edabf)
+- build: :arrow_up: bump ootk-core [`efc4aa0`](https://github.com/thkruz/ootk/commit/efc4aa0caf7182afd9fbba7e29a50a8defd16ebe)
+- test: :white_check_mark: update snapshots [`ca95ad6`](https://github.com/thkruz/ootk/commit/ca95ad65be2de3f818390585a7bc1749ca7bf918)
+
+#### [v4.0.0-1](https://github.com/thkruz/ootk/compare/v4.0.0-0...v4.0.0-1)
+
+> 17 January 2024 
 
 - feat: :sparkles: integrate ootk-core v1.0.7 [`101eeb6`](https://github.com/thkruz/ootk/commit/101eeb6a21008ce198832818154fa0442691e4ad)
 - refactor: :recycle: refactor to match latest ootk-core [`ae37922`](https://github.com/thkruz/ootk/commit/ae3792283571c69ff0d6406188d0c7219215c56f)

package/dist/utils/functions.d.ts

@@ -0,0 +1,8 @@
+import { DifferentiableFunction } from '../main';
+/**
+ * Calculates the derivative of a differentiable function.
+ * @param f The differentiable function.
+ * @param h The step size for numerical differentiation. Default value is 1e-3.
+ * @returns The derivative function.
+ */
+export declare function derivative(f: DifferentiableFunction, h?: number): DifferentiableFunction;

package/dist/utils/functions.js

@@ -0,0 +1,18 @@
+/**
+ * Calculates the derivative of a differentiable function.
+ * @param f The differentiable function.
+ * @param h The step size for numerical differentiation. Default value is 1e-3.
+ * @returns The derivative function.
+ */
+export function derivative(f, h = 1e-3) {
+    /**
+     * @param x The value at which to calculate the derivative.
+     * @returns The derivative of the function at the given value.
+     */
+    function df(x) {
+        const hh = h * 0.5;
+        return (f(x + hh) - f(x - hh)) / h;
+    }
+    return df;
+}
+//# sourceMappingURL=functions.js.map

package/dist/utils/functions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../src/utils/functions.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,CAAyB,EAAE,CAAC,GAAG,IAAI;IAC5D;;;OAGG;IACH,SAAS,EAAE,CAAC,CAAS;QACnB,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC;QAEnB,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/dist/utils/index.d.ts

@@ -1 +1,2 @@
 export * from './jacobian';
+export * from './functions';

package/dist/utils/index.js

@@ -1,2 +1,3 @@
 export * from './jacobian';
+export * from './functions';
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/dist/utils/jacobian.d.ts

@@ -8,4 +8,4 @@ import { JacobianFunction } from '../types/types';
  * @param step The step size for numerical differentiation (default: 1e-5).
  * @returns The Jacobian matrix.
  */
-export declare function jacobian(f: JacobianFunction, m: number, x0: Float64Array, step?: number): Matrix;
+export declare const jacobian: (f: JacobianFunction, m: number, x0: Float64Array, step?: number) => Matrix;

package/dist/utils/jacobian.js

@@ -8,7 +8,7 @@ import { array2d, Matrix, Vector } from 'ootk-core';
  * @param step The step size for numerical differentiation (default: 1e-5).
  * @returns The Jacobian matrix.
  */
-export function jacobian(f, m, x0, step = 0.00001) {
+export const jacobian = (f, m, x0, step = 0.00001) => {
     const n = x0.length;
     const j = array2d(m, n, 0);
     const h = 0.5 * step;
@@ -25,5 +25,5 @@ export function jacobian(f, m, x0, step = 0.00001) {
         }
     }
     return new Matrix(j);
-}
+};
 //# sourceMappingURL=jacobian.js.map

package/dist/utils/jacobian.js.map

@@ -1 +1 @@
-{"version":3,"file":"jacobian.js","sourceRoot":"","sources":["../../src/utils/jacobian.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAGpD,uDAAuD;AAEvD;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,CAAmB,EAAE,CAAS,EAAE,EAAgB,EAAE,IAAI,GAAG,OAAO;IACvF,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IACpB,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,MAAM,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC1B,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;QAEtB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACX,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE7B,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;QAEtB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACX,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE7B,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAE3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SAC1B;KACF;IAED,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC"}
+{"version":3,"file":"jacobian.js","sourceRoot":"","sources":["../../src/utils/jacobian.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAGpD,uDAAuD;AAEvD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAmB,EAAE,CAAS,EAAE,EAAgB,EAAE,IAAI,GAAG,OAAO,EAAU,EAAE;IACnG,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;IACpB,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,MAAM,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC1B,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;QAEtB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACX,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE7B,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;QAEtB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACX,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAE7B,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAE3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SAC1B;KACF;IAED,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ootk",
-  "version": "4.0.0-1",
+  "version": "4.0.0-2",
   "type": "module",
   "module": "dist/main.js",
   "description": "Orbital Object Toolkit including Multiple Propagators, Initial Orbit Determination, and Maneuver Calculations.",
@@ -53,7 +53,7 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "ootk-core": "^1.0.7"
+    "ootk-core": "^1.0.8"
   },
   "homepage": "https://github.com/thkruz/ootk"
 }

package/src/utils/functions.ts

@@ -0,0 +1,21 @@
+import { DifferentiableFunction } from '../main';
+
+/**
+ * Calculates the derivative of a differentiable function.
+ * @param f The differentiable function.
+ * @param h The step size for numerical differentiation. Default value is 1e-3.
+ * @returns The derivative function.
+ */
+export function derivative(f: DifferentiableFunction, h = 1e-3): DifferentiableFunction {
+  /**
+   * @param x The value at which to calculate the derivative.
+   * @returns The derivative of the function at the given value.
+   */
+  function df(x: number): number {
+    const hh = h * 0.5;
+
+    return (f(x + hh) - f(x - hh)) / h;
+  }
+
+  return df;
+}

package/src/utils/index.ts

@@ -1 +1,2 @@
 export * from './jacobian';
+export * from './functions';

package/src/utils/jacobian.ts

@@ -11,7 +11,7 @@ import { JacobianFunction } from '../types/types';
  * @param step The step size for numerical differentiation (default: 1e-5).
  * @returns The Jacobian matrix.
  */
-export function jacobian(f: JacobianFunction, m: number, x0: Float64Array, step = 0.00001): Matrix {
+export const jacobian = (f: JacobianFunction, m: number, x0: Float64Array, step = 0.00001): Matrix => {
   const n = x0.length;
   const j = array2d(m, n, 0);
   const h = 0.5 * step;
@@ -35,4 +35,4 @@ export function jacobian(f: JacobianFunction, m: number, x0: Float64Array, step
   }
 
   return new Matrix(j);
-}
+};