siderust 0.7.0

High-precision astronomy and satellite mechanics in Rust.
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright (C) 2026 Vallés Puig, Ramon

//! # Error taxonomy for gridded tables
//!
//! ## Scientific scope
//!
//! Errors raised when constructing or evaluating a typed gridded table.
//! They cover invariants the typed containers enforce — axis/value
//! shape agreement, minimum sample count per axis, strict monotonicity
//! of each axis (either ascending or descending) — and out-of-domain
//! queries that the configured boundary policy turns into surfaced
//! errors. These are infrastructure errors, not physical failure modes.
//!
//! ## Technical scope
//!
//! [`TableError`] enumerates: `ShapeMismatch`, `TooFewSamples`,
//! `NotMonotonic`, `OutOfRange`. Implements [`core::fmt::Display`].
//!
//! ## References
//!
//! None — error infrastructure.

use core::fmt;

/// Errors returned by [`Grid1D`](super::Grid1D), [`Grid2D`](super::Grid2D),
/// and the [`algo`](super::algo) kernels.
#[derive(Debug, Clone, PartialEq)]
pub enum TableError {
    /// Axis and table dimensions disagree.
    ShapeMismatch {
        expected_x: usize,
        expected_y: usize,
        actual_rows: usize,
        actual_cols: usize,
    },
    /// One of the axis arrays is shorter than two samples.
    TooFewSamples { axis: &'static str, len: usize },
    /// An axis is not strictly monotonic (equal consecutive values or a
    /// direction change after the first step).
    NotMonotonic { axis: &'static str, at_index: usize },
    /// Evaluation point falls outside the sampled domain and the
    /// active [`OutOfRange::Error`](super::OutOfRange::Error) policy
    /// surfaces the failure.
    OutOfRange {
        axis: &'static str,
        value: f64,
        lo: f64,
        hi: f64,
    },
}

impl fmt::Display for TableError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            TableError::ShapeMismatch {
                expected_x,
                expected_y,
                actual_rows,
                actual_cols,
            } => write!(
                f,
                "table shape mismatch: expected {expected_y}×{expected_x}, got {actual_rows}×{actual_cols}"
            ),
            TableError::TooFewSamples { axis, len } => {
                write!(f, "{axis} axis has too few samples ({len}); need ≥ 2")
            }
            TableError::NotMonotonic { axis, at_index } => write!(
                f,
                "{axis} axis is not strictly monotonic at index {at_index}"
            ),
            TableError::OutOfRange { axis, value, lo, hi } => write!(
                f,
                "{axis} value {value} is outside the sampled domain [{lo}, {hi}]"
            ),
        }
    }
}

impl std::error::Error for TableError {}