keplerian 0.2.1

Domain-agnostic Keplerian dynamics: typed anomaly solvers, elements, propagation, Lambert, and transfer search.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

//! Unified error type for Lambert solving.
//!
//! ## Scientific scope
//! This module classifies numerical and geometric failure modes of Lambert's
//! two-point boundary-value problem.
//!
//! ## Technical scope
//! [`LambertError`] is shared by both typed public entry points and the
//! crate-private raw numeric backend.
//!
//! ## References
//! - Izzo, D. (2014). *Revisiting Lambert's Problem*.

/// Errors returned by the Lambert solver.
#[derive(Debug, Clone, thiserror::Error, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum LambertError {
    /// Gravitational parameter must be strictly positive (km³/s²).
    #[error("non-positive gravitational parameter ({0})")]
    NonPositiveMu(f64),
    /// Time of flight must be a finite, strictly positive duration.
    #[error("non-positive time of flight ({0} s)")]
    NonPositiveTof(f64),
    /// Initial or final position vector has effectively zero magnitude.
    #[error("zero-magnitude position vector")]
    ZeroPosition,
    /// `r1`, `r2` and the origin are collinear, so the chord/transfer plane is undefined.
    #[error("collinear positions: chord cannot be resolved unambiguously")]
    Collinear,
    /// The requested revolution count exceeds the maximum permitted by the supplied time of flight.
    #[error("requested {requested} revolutions exceeds N_max = {max} for the given TOF")]
    RevolutionsExceedNMax {
        /// Number of revolutions requested by the caller.
        requested: u32,
        /// Largest physically admissible revolution count.
        max: u32,
    },
    /// Householder iteration failed to converge within the iteration cap.
    #[error("Householder iteration failed to converge (residual = {residual:e})")]
    DidNotConverge {
        /// Final residual `|T(x) − T*|` in non-dimensional units.
        residual: f64,
    },
}