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

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

//! # Error taxonomy for sampled spectra
//!
//! ## Scientific scope
//!
//! Errors raised when constructing or evaluating a
//! [`crate::spectra::SampledSpectrum`]. They cover invariants that the
//! typed container enforces — co-indexed length, minimum sample count,
//! strict monotonicity of the wavelength axis — and out-of-domain
//! queries that the configured boundary policy turns into surfaced
//! errors. These are infrastructure errors, not physical failure modes.
//!
//! ## Technical scope
//!
//! [`SpectrumError`] enumerates: `LengthMismatch`, `TooFewSamples`,
//! `NotMonotonic`, `OutOfRange`, `Parse`. Implements [`core::fmt::Display`].
//!
//! ## References
//!
//! None — error infrastructure.

use core::fmt;

/// Reasons a [`crate::spectra::SampledSpectrum`] operation can fail.
#[derive(Debug, Clone, PartialEq)]
pub enum SpectrumError {
    /// `xs` and `ys` had different lengths.
    LengthMismatch { xs: usize, ys: usize },
    /// Fewer than two samples were provided.
    TooFewSamples(usize),
    /// `xs` was not strictly monotonically increasing.
    NotMonotonic { index: usize },
    /// A query was outside the spectrum's domain and the configured
    /// [`crate::spectra::OutOfRange`] policy was [`crate::spectra::OutOfRange::Error`].
    OutOfRange { x: f64, lo: f64, hi: f64 },
    /// A loader failed to parse an input source.
    Parse(String),
}

impl fmt::Display for SpectrumError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            SpectrumError::LengthMismatch { xs, ys } => {
                write!(f, "spectrum length mismatch: xs.len()={xs}, ys.len()={ys}")
            }
            SpectrumError::TooFewSamples(n) => {
                write!(f, "spectrum needs at least 2 samples (got {n})")
            }
            SpectrumError::NotMonotonic { index } => {
                write!(f, "spectrum xs not strictly increasing at index {index}")
            }
            SpectrumError::OutOfRange { x, lo, hi } => {
                write!(f, "spectrum query x={x} outside domain [{lo}, {hi}]")
            }
            SpectrumError::Parse(msg) => write!(f, "spectrum parse error: {msg}"),
        }
    }
}

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