@interstellar-tools/equations 0.2.0 → 0.4.0

package/dist/categories/kepler/solve-kepler-high-eccentricity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"solve-kepler-high-eccentricity.d.ts","sourceRoot":"","sources":["../../../src/categories/kepler/solve-kepler-high-eccentricity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAKpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AAEH,eAAO,MAAM,2BAA2B,GACtC,GAAG,OAAO,EACV,GAAG,MAAM,EACT,gBAAsE,EACtE,kBAAgB,KACf,OAgEF,CAAC"}

package/dist/{solve-kepler-high-eccentricity.js → categories/kepler/solve-kepler-high-eccentricity.js}

@@ -1,10 +1,9 @@
-import { wrapAngle } from './wrap-angle';
+import { wrapAngle } from '../angle/wrap-angle';
+/* node:coverage disable */
 /**
  * Solves **Kepler's Equation** for the **Eccentric Anomaly** ($E$) in highly eccentric orbits
  * ($e > 0.9$) using an iterative numerical approach.
  *
- * ---
- *
  * **Mathematical Explanation:**
  *
  * Kepler's equation for eccentric anomaly ($E$) is:
@@ -55,13 +54,11 @@ import { wrapAngle } from './wrap-angle';
  * 3. **Angle Wrapping (Elliptical Only):**
  *    - The result is wrapped using `wrapAngle()` for consistency.
  *
- * ---
  *
  * **Performance Considerations:**
  * - **Typically converges in fewer than 10 iterations for $e > 0.9$.**
  * - **Time complexity:** $O(1)$ for standard convergence.
  *
- * ---
  *
  * @param {Radians} M - Mean anomaly ($M$) in **radians**.
  * @param {number} e - Orbital eccentricity ($e > 0.9$ for high-eccentricity orbits).
@@ -69,7 +66,6 @@ import { wrapAngle } from './wrap-angle';
  * @param {number} [tolerance=1e-9] - Convergence criterion for stopping the iteration.
  * @returns {Radians} The **eccentric anomaly** ($E$) in **radians** (wrapped to $[-\pi, \pi]$ for elliptical orbits).
  *
- * ---
  *
  * @example
  * ```ts
@@ -89,12 +85,12 @@ import { wrapAngle } from './wrap-angle';
  * console.log(solveKeplerHighEccentricity(M_hyperbolic, e_hyperbolic));
  * ```
  *
- * ---
- *
  * @see [Kepler's Equation (Wikipedia)](https://en.wikipedia.org/wiki/Kepler%27s_equation)
  * @see [Hyperbolic Anomaly (Wikipedia)](https://en.wikipedia.org/wiki/Hyperbolic_trajectory#Hyperbolic_anomaly)
- * @category Solve for Kepler
+ * @group Kepler Solvers
+ *
  */
+/* node:coverage enable */
 export const solveKeplerHighEccentricity = (M, e, maxIter = Math.max(300, Math.floor(5 + 3 * Math.log(1 + Math.abs(M)))), tolerance = 1e-9) => {
     if (e < 0) {
         throw new RangeError(`Invalid eccentricity: ${e}. Must be e ≥ 0.`);

package/dist/categories/kepler/solve-kepler-high-eccentricity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"solve-kepler-high-eccentricity.js","sourceRoot":"","sources":["../../../src/categories/kepler/solve-kepler-high-eccentricity.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,2BAA2B;AAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,0BAA0B;AAC1B,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,CAAU,EACV,CAAS,EACT,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACtE,SAAS,GAAG,IAAI,EACP,EAAE;IACX,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACV,MAAM,IAAI,UAAU,CAAC,yBAAyB,CAAC,kBAAkB,CAAC,CAAC;IACrE,CAAC;IAED,IAAI,CAAS,CAAC;IAEd,gEAAgE;IAChE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACV,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;SAAM,CAAC;QACN,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,SAAS,IAAI,IAAI,GAAG,OAAO,EAAE,CAAC;QACrD,IAAI,EAAU,CAAC;QACf,IAAI,GAAW,CAAC;QAEhB,qCAAqC;QACrC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACV,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAC7B,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QACD,+BAA+B;aAC1B,CAAC;YACJ,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAE3B,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;YACvB,GAAG,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QACtB,CAAC;QAED,oCAAoC;QACpC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAErD,KAAK,GAAG,EAAE,GAAG,GAAG,CAAC;QAEjB,yCAAyC;QACzC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;QAE1D,CAAC,IAAI,KAAK,CAAC;QACX,IAAI,EAAE,CAAC;QAEP,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7B,UAAU,GAAG,CAAC,CAAC;QACjB,CAAC;QAED,iDAAiD;QACjD,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC;YACtB,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACvB,MAAM;QACR,CAAC;IACH,CAAC;IAED,6DAA6D;IAC7D,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACV,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC"}

package/dist/{solve-kepler-newton-raphson.d.ts → categories/kepler/solve-kepler-newton-raphson.d.ts}

@@ -81,7 +81,7 @@ import { Radians } from '@interstellar-tools/types';
  * @see [Kepler's Equation (Wikipedia)](https://en.wikipedia.org/wiki/Kepler%27s_equation)
  * @see [Newton-Raphson Method (Wikipedia)](https://en.wikipedia.org/wiki/Newton%27s_method)
  * @see [Eccentric Anomaly (Wikipedia)](https://en.wikipedia.org/wiki/Mean_anomaly#Eccentric_anomaly)
- * @category Solve for Kepler
+ * @group Kepler Solvers
  */
 export declare const solveKeplerNewtonRaphson: (M: Radians, e: number, maxIter: number, tolerance: number) => Radians;
 //# sourceMappingURL=solve-kepler-newton-raphson.d.ts.map

package/dist/categories/kepler/solve-kepler-newton-raphson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"solve-kepler-newton-raphson.d.ts","sourceRoot":"","sources":["../../../src/categories/kepler/solve-kepler-newton-raphson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG;AACH,eAAO,MAAM,wBAAwB,GACnC,GAAG,OAAO,EACV,GAAG,MAAM,EACT,SAAS,MAAM,EACf,WAAW,MAAM,KAChB,OAwCF,CAAC"}

package/dist/{solve-kepler-newton-raphson.js → categories/kepler/solve-kepler-newton-raphson.js}

@@ -80,7 +80,7 @@
  * @see [Kepler's Equation (Wikipedia)](https://en.wikipedia.org/wiki/Kepler%27s_equation)
  * @see [Newton-Raphson Method (Wikipedia)](https://en.wikipedia.org/wiki/Newton%27s_method)
  * @see [Eccentric Anomaly (Wikipedia)](https://en.wikipedia.org/wiki/Mean_anomaly#Eccentric_anomaly)
- * @category Solve for Kepler
+ * @group Kepler Solvers
  */
 export const solveKeplerNewtonRaphson = (M, e, maxIter, tolerance) => {
     if (e < 0 || e >= 1) {

package/dist/categories/kepler/solve-kepler-newton-raphson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"solve-kepler-newton-raphson.js","sourceRoot":"","sources":["../../../src/categories/kepler/solve-kepler-newton-raphson.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,CAAU,EACV,CAAS,EACT,OAAe,EACf,SAAiB,EACR,EAAE;IACX,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,UAAU,CAAC,yBAAyB,CAAC,2BAA2B,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,CAAS,CAAC;IAEd,sBAAsB;IACtB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACZ,CAAC,GAAG,CAAC,CAAC;IACR,CAAC;SAAM,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;QACpB,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC;SAAM,CAAC;QACN,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,wBAAwB;IAC3C,CAAC;IAED,IAAI,IAAI,GAAG,CAAC,CAAC;IAEb,OAAO,IAAI,GAAG,OAAO,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,gBAAgB;QAExC,oDAAoD;QACpD,IAAI,UAAU,GAAG,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;QAE1D,UAAU,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,GAAG,UAAU,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC;QAEjE,CAAC,IAAI,UAAU,CAAC;QAEhB,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,SAAS,EAAE,CAAC;YACrC,OAAO,CAAC,CAAC,CAAC,YAAY;QACxB,CAAC;QAED,IAAI,EAAE,CAAC;IACT,CAAC;IAED,OAAO,GAAG,CAAC,CAAC,mBAAmB;AACjC,CAAC,CAAC"}

package/dist/{solve-kepler.d.ts → categories/kepler/solve-kepler.d.ts}

@@ -76,7 +76,7 @@ import { Radians } from '@interstellar-tools/types';
  * @see [Newton-Raphson Method (Wikipedia)](https://en.wikipedia.org/wiki/Newton%27s_method)
  * @see [Eccentric Anomaly (Wikipedia)](https://en.wikipedia.org/wiki/Mean_anomaly#Eccentric_anomaly)
  * @see [RangeError](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError)
- * @category Solve for Kepler
+ * @group Kepler Solvers
  */
 export declare const solveKepler: (M: Radians, e: number, maxIter?: number, tolerance?: number) => Radians;
 //# sourceMappingURL=solve-kepler.d.ts.map

package/dist/categories/kepler/solve-kepler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"solve-kepler.d.ts","sourceRoot":"","sources":["../../../src/categories/kepler/solve-kepler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAQpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8EG;AACH,eAAO,MAAM,WAAW,GACtB,GAAG,OAAO,EACV,GAAG,MAAM,EACT,gBAAY,EACZ,kBAAgB,KACf,OAkBF,CAAC"}

package/dist/{solve-kepler.js → categories/kepler/solve-kepler.js}

@@ -1,7 +1,7 @@
+import { wrapAngle } from '../angle/wrap-angle';
 import { solveKeplerBisection } from './solve-kepler-bisection';
 import { solveKeplerHighEccentricity } from './solve-kepler-high-eccentricity';
 import { solveKeplerNewtonRaphson } from './solve-kepler-newton-raphson';
-import { wrapAngle } from './wrap-angle';
 /**
  * Solves **Kepler's Equation** for the **Eccentric Anomaly** ($E$) using an adaptive approach:
  * - **Newton-Raphson method** for fast convergence.
@@ -79,7 +79,7 @@ import { wrapAngle } from './wrap-angle';
  * @see [Newton-Raphson Method (Wikipedia)](https://en.wikipedia.org/wiki/Newton%27s_method)
  * @see [Eccentric Anomaly (Wikipedia)](https://en.wikipedia.org/wiki/Mean_anomaly#Eccentric_anomaly)
  * @see [RangeError](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError)
- * @category Solve for Kepler
+ * @group Kepler Solvers
  */
 export const solveKepler = (M, e, maxIter = 50, tolerance = 1e-9) => {
     if (e < 0 || e >= 1) {

package/dist/categories/kepler/solve-kepler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"solve-kepler.js","sourceRoot":"","sources":["../../../src/categories/kepler/solve-kepler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8EG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,CAAU,EACV,CAAS,EACT,OAAO,GAAG,EAAE,EACZ,SAAS,GAAG,IAAI,EACP,EAAE;IACX,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,UAAU,CAAC,yBAAyB,CAAC,2BAA2B,CAAC,CAAC;IAC9E,CAAC;IAED,wDAAwD;IACxD,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACZ,OAAO,2BAA2B,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IAED,+DAA+D;IAC/D,IAAI,CAAC,GAAG,wBAAwB,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAE3D,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACb,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;AACtB,CAAC,CAAC"}

package/dist/categories/orbits/circular-speed.d.ts

@@ -0,0 +1,42 @@
+/**
+ * **Circular speed** ($ v_c $) for a body in a circular orbit at radius ($ r $).
+ *
+ * **Definition**
+ *
+ * $$
+ * v_c=\sqrt{\frac{\mu}{r}}
+ * $$
+ *
+ * where ($ \mu $) is the standard gravitational parameter and ($ r $) is the distance
+ * from the central body's center to the orbiting body.
+ *
+ * **Units**
+ * - Inputs: ($ r $) in **meters (m)**, ($ \mu $) in **m³/s²**.
+ * - Output: ($ v_c $) in **m/s**.
+ *
+ * ::: info
+ *
+ * - This is the special case of the vis-viva equation for circular orbits (($ a=r $)).
+ * - If you need a non-circular orbit, use `visVivaSpeed(r, a, mu)`.
+ *
+ * :::
+ *
+ * @param {number} r  Orbital radius ($ r $) (m), must be finite and **> 0**.
+ * @param {number} mu Gravitational parameter ($ \mu $) (m³/s²), must be finite and **≥ 0**.
+ * @returns {number} Circular speed ($ v_c $) (m/s).
+ * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error | Error} If inputs are non-finite or out of domain.
+ *
+ * @see {@link visVivaSpeed}
+ *
+ * @example
+ * ```ts
+ * // LEO ~400 km altitude around Earth
+ * const muEarth = 3.986004418e14; // m^3/s^2
+ * const r = 6378e3 + 400e3;       // m
+ * const v = circularSpeed(r, muEarth); // ≈ 7670 m/s
+ * ```
+ *
+ * @group Orbits
+ */
+export declare const circularSpeed: (r: number, mu: number) => number;
+//# sourceMappingURL=circular-speed.d.ts.map

package/dist/categories/orbits/circular-speed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circular-speed.d.ts","sourceRoot":"","sources":["../../../src/categories/orbits/circular-speed.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,eAAO,MAAM,aAAa,GAAI,GAAG,MAAM,EAAE,IAAI,MAAM,KAAG,MAUrD,CAAC"}

package/dist/categories/orbits/circular-speed.js

@@ -0,0 +1,50 @@
+/**
+ * **Circular speed** ($ v_c $) for a body in a circular orbit at radius ($ r $).
+ *
+ * **Definition**
+ *
+ * $$
+ * v_c=\sqrt{\frac{\mu}{r}}
+ * $$
+ *
+ * where ($ \mu $) is the standard gravitational parameter and ($ r $) is the distance
+ * from the central body's center to the orbiting body.
+ *
+ * **Units**
+ * - Inputs: ($ r $) in **meters (m)**, ($ \mu $) in **m³/s²**.
+ * - Output: ($ v_c $) in **m/s**.
+ *
+ * ::: info
+ *
+ * - This is the special case of the vis-viva equation for circular orbits (($ a=r $)).
+ * - If you need a non-circular orbit, use `visVivaSpeed(r, a, mu)`.
+ *
+ * :::
+ *
+ * @param {number} r  Orbital radius ($ r $) (m), must be finite and **> 0**.
+ * @param {number} mu Gravitational parameter ($ \mu $) (m³/s²), must be finite and **≥ 0**.
+ * @returns {number} Circular speed ($ v_c $) (m/s).
+ * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error | Error} If inputs are non-finite or out of domain.
+ *
+ * @see {@link visVivaSpeed}
+ *
+ * @example
+ * ```ts
+ * // LEO ~400 km altitude around Earth
+ * const muEarth = 3.986004418e14; // m^3/s^2
+ * const r = 6378e3 + 400e3;       // m
+ * const v = circularSpeed(r, muEarth); // ≈ 7670 m/s
+ * ```
+ *
+ * @group Orbits
+ */
+export const circularSpeed = (r, mu) => {
+    if (!Number.isFinite(r) || r <= 0) {
+        throw new Error('r must be a finite, positive number (m).');
+    }
+    if (!Number.isFinite(mu) || mu < 0) {
+        throw new Error('mu must be a finite, non-negative number (m^3/s^2).');
+    }
+    return Math.sqrt(mu / r);
+};
+//# sourceMappingURL=circular-speed.js.map

package/dist/categories/orbits/circular-speed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circular-speed.js","sourceRoot":"","sources":["../../../src/categories/orbits/circular-speed.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAS,EAAE,EAAU,EAAU,EAAE;IAC7D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AAC3B,CAAC,CAAC"}

package/dist/categories/orbits/escape-speed.d.ts

@@ -0,0 +1,50 @@
+/**
+ * **Escape speed** ($ v_{\text{esc}} $) - minimum speed to escape a central body's gravity from radius ($ r $) (ignoring drag/perturbations).
+ *
+ * **Definition**
+ *
+ * $$
+ * v_{\text{esc}}=\sqrt{\frac{2\mu}{r}}
+ * $$
+ *
+ * where ($ \mu $) is the standard gravitational parameter and ($ r $) is the distance
+ * from the central body's center.
+ *
+ * **Units**
+ * - Inputs: ($ r $) in **meters (m)**, ($ \mu $) in **m³/s²**.
+ * - Output: ($ v_{\text{esc}} $) in **m/s**.
+ *
+ * ::: info
+ *
+ * - Relationship to circular speed ($ v_c $): ($ v_{\text{esc}}=\sqrt{2}\,v_c $).
+ * - This corresponds to **parabolic** specific energy (($ \varepsilon = 0 $)).
+ * - For general (non-escape) orbital speed use `visVivaSpeed(r, a, mu)`.
+ *
+ * :::
+ *
+ * @param {number} r  Radius ($ r $) (m), distance from the central body’s center (must be finite and **> 0**).
+ * @param {number} mu Gravitational parameter ($ \mu $) (m³/s²), must be finite and **≥ 0**.
+ * @returns {number} Escape speed ($ v_{\text{esc}} $) (m/s).
+ * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error | Error}
+ * If inputs are non-finite or out of domain.
+ *
+ * @example
+ * ```ts
+ * // Near Earth's surface (approx.)
+ * const muEarth = 3.986004418e14;     // m^3/s^2
+ * const rSurface = 6378e3;            // m
+ * const vEsc = escapeSpeed(rSurface, muEarth); // ≈ 11186 m/s
+ * ```
+ *
+ * @example
+ * ```ts
+ * // LEO ~400 km altitude: r = R_E + 400 km
+ * const muEarth = 3.986004418e14;
+ * const rLEO = 6378e3 + 400e3;
+ * const vEsc = escapeSpeed(rLEO, muEarth); // ≈ 10860 m/s
+ * ```
+ *
+ * @group Orbits
+ */
+export declare const escapeSpeed: (r: number, mu: number) => number;
+//# sourceMappingURL=escape-speed.d.ts.map

package/dist/categories/orbits/escape-speed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"escape-speed.d.ts","sourceRoot":"","sources":["../../../src/categories/orbits/escape-speed.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,eAAO,MAAM,WAAW,GAAI,GAAG,MAAM,EAAE,IAAI,MAAM,KAAG,MAUnD,CAAC"}

package/dist/categories/orbits/escape-speed.js

@@ -0,0 +1,58 @@
+/**
+ * **Escape speed** ($ v_{\text{esc}} $) - minimum speed to escape a central body's gravity from radius ($ r $) (ignoring drag/perturbations).
+ *
+ * **Definition**
+ *
+ * $$
+ * v_{\text{esc}}=\sqrt{\frac{2\mu}{r}}
+ * $$
+ *
+ * where ($ \mu $) is the standard gravitational parameter and ($ r $) is the distance
+ * from the central body's center.
+ *
+ * **Units**
+ * - Inputs: ($ r $) in **meters (m)**, ($ \mu $) in **m³/s²**.
+ * - Output: ($ v_{\text{esc}} $) in **m/s**.
+ *
+ * ::: info
+ *
+ * - Relationship to circular speed ($ v_c $): ($ v_{\text{esc}}=\sqrt{2}\,v_c $).
+ * - This corresponds to **parabolic** specific energy (($ \varepsilon = 0 $)).
+ * - For general (non-escape) orbital speed use `visVivaSpeed(r, a, mu)`.
+ *
+ * :::
+ *
+ * @param {number} r  Radius ($ r $) (m), distance from the central body’s center (must be finite and **> 0**).
+ * @param {number} mu Gravitational parameter ($ \mu $) (m³/s²), must be finite and **≥ 0**.
+ * @returns {number} Escape speed ($ v_{\text{esc}} $) (m/s).
+ * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error | Error}
+ * If inputs are non-finite or out of domain.
+ *
+ * @example
+ * ```ts
+ * // Near Earth's surface (approx.)
+ * const muEarth = 3.986004418e14;     // m^3/s^2
+ * const rSurface = 6378e3;            // m
+ * const vEsc = escapeSpeed(rSurface, muEarth); // ≈ 11186 m/s
+ * ```
+ *
+ * @example
+ * ```ts
+ * // LEO ~400 km altitude: r = R_E + 400 km
+ * const muEarth = 3.986004418e14;
+ * const rLEO = 6378e3 + 400e3;
+ * const vEsc = escapeSpeed(rLEO, muEarth); // ≈ 10860 m/s
+ * ```
+ *
+ * @group Orbits
+ */
+export const escapeSpeed = (r, mu) => {
+    if (!Number.isFinite(r) || r <= 0) {
+        throw new Error('r must be a finite, positive number (m).');
+    }
+    if (!Number.isFinite(mu) || mu < 0) {
+        throw new Error('mu must be a finite, non-negative number (m^3/s^2).');
+    }
+    return Math.sqrt((2 * mu) / r);
+};
+//# sourceMappingURL=escape-speed.js.map

package/dist/categories/orbits/escape-speed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"escape-speed.js","sourceRoot":"","sources":["../../../src/categories/orbits/escape-speed.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAS,EAAE,EAAU,EAAU,EAAE;IAC3D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACjC,CAAC,CAAC"}

package/dist/{kepler-period.d.ts → categories/orbits/kepler-period.d.ts}

@@ -39,7 +39,7 @@
  * const T = keplerPeriod(a, muEarth); // ≈ 5550 s (~92.5 min)
  * ```
  *
- * @category Dynamics
+ * @group Orbits
  */
 export declare const keplerPeriod: (a: number, mu: number) => number;
 //# sourceMappingURL=kepler-period.d.ts.map

package/dist/categories/orbits/kepler-period.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kepler-period.d.ts","sourceRoot":"","sources":["../../../src/categories/orbits/kepler-period.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,eAAO,MAAM,YAAY,GAAI,GAAG,MAAM,EAAE,IAAI,MAAM,KAAG,MAYpD,CAAC"}

package/dist/{kepler-period.js → categories/orbits/kepler-period.js}

@@ -39,7 +39,7 @@
  * const T = keplerPeriod(a, muEarth); // ≈ 5550 s (~92.5 min)
  * ```
  *
- * @category Dynamics
+ * @group Orbits
  */
 export const keplerPeriod = (a, mu) => {
     if (!Number.isFinite(a) || a <= 0) {

package/dist/categories/orbits/kepler-period.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kepler-period.js","sourceRoot":"","sources":["../../../src/categories/orbits/kepler-period.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAS,EAAE,EAAU,EAAU,EAAE;IAC5D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;IAE5B,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;AAC1C,CAAC,CAAC"}

package/dist/categories/orbits/peri-apoapsis-radii.d.ts

@@ -0,0 +1,46 @@
+import { PeriApoRadiiType } from '@interstellar-tools/types';
+/**
+ * **Peri/apoapsis radii** from semi-major axis ($ a $) and eccentricity ($ e $).
+ *
+ * **Definitions**
+ *
+ * $$
+ * r_p = a(1-e),\qquad r_a = a(1+e)
+ * $$
+ *
+ * **Conic validity**
+ * - **Elliptic / circular**: ($ a>0,\; 0\le e<1 $) → ($ r_p>0 $) and ($ r_a>0 $).
+ * - **Hyperbolic**: ($ a<0,\; e>1 $) → ($ r_p = a(1-e) = |a|(e-1) > 0 $), **no apoapsis** (unbounded), so ($ r_a = null $).
+ * - **Parabolic**: ($ e=1 $) is **not** defined with finite ($ a $). Use the parabolic form (e.g. ($ r_p = \tfrac{p}{2} $)) or state vectors.
+ *
+ * **Units**
+ * - Inputs: ($ a $) in **meters (m)**, ($ e $) dimensionless.
+ * - Output: ($ r_p, r_a $) in **meters (m)**.
+ *
+ * @param {number} a Semi-major axis ($ a $) (m). Must be finite and **≠ 0**.
+ * @param {number} e Eccentricity ($ e $) (dimensionless). Must be finite and **≥ 0**.
+ * @returns {{ rp: number; ra: number | null }} Object with periapsis `rp` and apoapsis `ra` (or `null` if undefined for hyperbolic).
+ *
+ * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error | Error}
+ * If inputs are invalid or the ($ (a,e) $) pair does not correspond to an ellipse/circle or hyperbola with finite ($ a $).
+ *
+ * @example
+ * ```ts
+ * // Elliptic example (LEO-like)
+ * const a = 7000e3;  // m
+ * const e = 0.01;
+ * const { rp, ra } = periApoapsisRadii(a, e); // rp ≈ 6930 km, ra ≈ 7070 km
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Hyperbolic flyby (no apoapsis)
+ * const a = -50_000e3; // m
+ * const e = 1.2;
+ * const { rp, ra } = periApoapsisRadii(a, e); // rp = |a|(e-1) = 10,000 km, ra = null
+ * ```
+ *
+ * @group Orbits
+ */
+export declare const periApoapsisRadii: (a: number, e: number) => PeriApoRadiiType;
+//# sourceMappingURL=peri-apoapsis-radii.d.ts.map

package/dist/categories/orbits/peri-apoapsis-radii.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"peri-apoapsis-radii.d.ts","sourceRoot":"","sources":["../../../src/categories/orbits/peri-apoapsis-radii.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAG7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAEH,eAAO,MAAM,iBAAiB,GAAI,GAAG,MAAM,EAAE,GAAG,MAAM,KAAG,gBAsDxD,CAAC"}

package/dist/categories/orbits/peri-apoapsis-radii.js

@@ -0,0 +1,85 @@
+/* node:coverage disable */
+/**
+ * **Peri/apoapsis radii** from semi-major axis ($ a $) and eccentricity ($ e $).
+ *
+ * **Definitions**
+ *
+ * $$
+ * r_p = a(1-e),\qquad r_a = a(1+e)
+ * $$
+ *
+ * **Conic validity**
+ * - **Elliptic / circular**: ($ a>0,\; 0\le e<1 $) → ($ r_p>0 $) and ($ r_a>0 $).
+ * - **Hyperbolic**: ($ a<0,\; e>1 $) → ($ r_p = a(1-e) = |a|(e-1) > 0 $), **no apoapsis** (unbounded), so ($ r_a = null $).
+ * - **Parabolic**: ($ e=1 $) is **not** defined with finite ($ a $). Use the parabolic form (e.g. ($ r_p = \tfrac{p}{2} $)) or state vectors.
+ *
+ * **Units**
+ * - Inputs: ($ a $) in **meters (m)**, ($ e $) dimensionless.
+ * - Output: ($ r_p, r_a $) in **meters (m)**.
+ *
+ * @param {number} a Semi-major axis ($ a $) (m). Must be finite and **≠ 0**.
+ * @param {number} e Eccentricity ($ e $) (dimensionless). Must be finite and **≥ 0**.
+ * @returns {{ rp: number; ra: number | null }} Object with periapsis `rp` and apoapsis `ra` (or `null` if undefined for hyperbolic).
+ *
+ * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error | Error}
+ * If inputs are invalid or the ($ (a,e) $) pair does not correspond to an ellipse/circle or hyperbola with finite ($ a $).
+ *
+ * @example
+ * ```ts
+ * // Elliptic example (LEO-like)
+ * const a = 7000e3;  // m
+ * const e = 0.01;
+ * const { rp, ra } = periApoapsisRadii(a, e); // rp ≈ 6930 km, ra ≈ 7070 km
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Hyperbolic flyby (no apoapsis)
+ * const a = -50_000e3; // m
+ * const e = 1.2;
+ * const { rp, ra } = periApoapsisRadii(a, e); // rp = |a|(e-1) = 10,000 km, ra = null
+ * ```
+ *
+ * @group Orbits
+ */
+/* node:coverage enable */
+export const periApoapsisRadii = (a, e) => {
+    if (!Number.isFinite(a) || a === 0) {
+        throw new Error('a must be finite and non-zero (meters).');
+    }
+    if (!Number.isFinite(e) || e < 0) {
+        throw new Error('e must be finite and ≥ 0.');
+    }
+    // Elliptic / circular
+    if (a > 0) {
+        if (e >= 1) {
+            if (e === 1) {
+                throw new Error('Parabolic (e=1) is not defined with finite a. Use parabolic relations (e.g., rp = p/2) or state vectors.');
+            }
+            throw new Error('For a>0 (elliptic/circular), eccentricity must satisfy 0 ≤ e < 1.');
+        }
+        const rp = a * (1 - e);
+        const ra = a * (1 + e);
+        // Both must be positive for a valid ellipse
+        if (!(rp > 0 && ra > 0)) {
+            throw new Error('Computed radii are non-physical for the given (a,e).');
+        }
+        return { rp, ra };
+    }
+    // Hyperbolic
+    // a < 0 requires e > 1 for a valid hyperbola
+    if (e <= 1) {
+        throw new Error('For a<0 (hyperbolic), eccentricity must satisfy e > 1.');
+    }
+    const rp = a * (1 - e); // = |a|(e-1) > 0
+    if (!(rp > 0)) {
+        // tiny negatives due to FP?
+        const tol = Math.abs(1e-14 * Math.abs(a));
+        if (rp > -tol) {
+            return { rp: 0, ra: null };
+        }
+        throw new Error('Computed periapsis radius is non-physical (≤ 0).');
+    }
+    return { rp, ra: null };
+};
+//# sourceMappingURL=peri-apoapsis-radii.js.map

package/dist/categories/orbits/peri-apoapsis-radii.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"peri-apoapsis-radii.js","sourceRoot":"","sources":["../../../src/categories/orbits/peri-apoapsis-radii.ts"],"names":[],"mappings":"AAEA,2BAA2B;AAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,0BAA0B;AAC1B,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAS,EAAE,CAAS,EAAoB,EAAE;IAC1E,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAED,sBAAsB;IACtB,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACV,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,0GAA0G,CAC3G,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;QACJ,CAAC;QAED,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACvB,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAEvB,4CAA4C;QAC5C,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QAC1E,CAAC;QAED,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IACpB,CAAC;IAED,aAAa;IACb,6CAA6C;IAC7C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB;IAEzC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;QACd,4BAA4B;QAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1C,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC;YACd,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;QAC7B,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;AAC1B,CAAC,CAAC"}

package/dist/categories/orbits/specific-angular-momentum-from-elements.d.ts

@@ -0,0 +1,60 @@
+/**
+ * **Specific angular momentum** ($ h $) from **orbital elements**.
+ *
+ * **Definition**
+ *
+ * $$
+ * h=\sqrt{\mu\,a\,(1-e^2)}
+ * $$
+ *
+ * where ($ a $) is the semi-major axis, ($ e $) the eccentricity, and ($ \mu $) the gravitational parameter.
+ *
+ * **Validity by conic**
+ * - **Elliptic**: ($ a>0,\; 0\le e<1 $) → ($ 1-e^2>0 $) ⇒ radicand ($ >0 $).
+ * - **Hyperbolic**: ($ a<0,\; e>1 $) → ($ 1-e^2<0 $) and ($ a<0 $) ⇒ product still ($ >0 $).
+ * - **Parabolic**: ($ e=1 $) is not represented by finite ($ a $). Use state vectors or
+ *   ($ h=\sqrt{2\mu r_p} $) (with periapsis radius ($ r_p $)).
+ *
+ * **Units**
+ * - Inputs: ($ a $) in **m**, ($ e $) dimensionless, ($ \mu $) in **m³/s²**.
+ * - Output: ($ h $) in **m²/s**.
+ *
+ * ::: info
+ *
+ * - This returns the **magnitude** of ($ \mathbf h = \mathbf r \times \mathbf v $).
+ * - For numerical robustness, tiny negative radicands from FP cancellation are clamped to zero.
+ *
+ * :::
+ *
+ * @param {number} a  Semi-major axis ($ a $) (m). Must be finite and **≠ 0** (elliptic ($ a>0 $), hyperbolic ($ a<0 $)).
+ * @param {number} e  Eccentricity ($ e $) (dimensionless). Must be finite and **≥ 0**.
+ * @param {number} mu Gravitational parameter ($ \mu $) (m³/s²). Must be finite and **≥ 0**.
+ * @returns {number} Specific angular momentum ($ h $) (m²/s).
+ *
+ * @throws {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error | Error}
+ * If ($ a $) is non-finite or zero; if ($ e $) is non-finite or negative; if ($ \mu $) is non-finite or negative; or if
+ * ($ \mu\,a\,(1-e^2) < 0 $) beyond a tiny FP tolerance (invalid element set for this formula).
+ *
+ * @example
+ * ```ts
+ * // Near-circular LEO-like elements
+ * const muEarth = 3.986004418e14; // m^3/s^2
+ * const a = 6778e3;               // m
+ * const e = 0.001;
+ * const h = specificAngularMomentumFromElements(a, e, muEarth); // ≈ sqrt(μ a)
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Hyperbolic flyby example
+ * const muEarth = 3.986004418e14; // m^3/s^2
+ * const a = -50000e3;             // m (negative for hyperbola)
+ * const e = 1.2;
+ * const h = specificAngularMomentumFromElements(a, e, muEarth);
+ * ```
+ *
+ * @see {@link specificAngularMomentum} - compute ($ h $) from state vectors ($ (\mathbf r,\mathbf v) $).
+ * @group Orbits
+ */
+export declare const specificAngularMomentumFromElements: (a: number, e: number, mu: number) => number;
+//# sourceMappingURL=specific-angular-momentum-from-elements.d.ts.map

package/dist/categories/orbits/specific-angular-momentum-from-elements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"specific-angular-momentum-from-elements.d.ts","sourceRoot":"","sources":["../../../src/categories/orbits/specific-angular-momentum-from-elements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,eAAO,MAAM,mCAAmC,GAC9C,GAAG,MAAM,EACT,GAAG,MAAM,EACT,IAAI,MAAM,KACT,MAwBF,CAAC"}