optica 0.1.0

Fast participating-media and optics foundation: typed rays, optical coefficients, phase functions, spectra, and optical-depth integration.
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

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

//! Error types for sampled-spectrum operations.

use alloc::string::String;

/// Errors produced while constructing or querying a sampled spectrum.
///
/// # Examples
///
/// ```rust
/// use optica::spectrum::SpectrumError;
///
/// let error = SpectrumError::TooFewSamples(1);
/// assert!(error.to_string().contains("too few"));
/// ```
#[derive(Debug, Clone, PartialEq, thiserror::Error)]
#[non_exhaustive]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum SpectrumError {
    /// The `xs` and `ys` slices have different lengths.
    #[error("length mismatch: xs has {xs} elements, ys has {ys}")]
    LengthMismatch {
        /// Number of x samples supplied.
        xs: usize,
        /// Number of y samples supplied.
        ys: usize,
    },
    /// The spectrum has fewer than two samples (interpolation requires ≥ 2).
    #[error("spectrum has too few samples ({0}); need ≥ 2")]
    TooFewSamples(usize),
    /// The x-axis is not strictly monotonically increasing at the given index.
    #[error("x-axis is not strictly increasing at index {index}")]
    NotMonotonic {
        /// Index where monotonicity fails.
        index: usize,
    },
    /// Query point is outside the spectrum's x-axis range when `OutOfRange::Error` is active.
    #[error("query {x} is outside [{lo}, {hi}]")]
    OutOfRange {
        /// Query x value.
        x: f64,
        /// Axis lower bound.
        lo: f64,
        /// Axis upper bound.
        hi: f64,
    },
    /// Failed to parse a spectrum from text data.
    #[error("parse error: {0}")]
    Parse(String),
    /// A computed or supplied value violated a domain invariant
    /// (e.g. zero or non-finite divisor in normalization).
    #[error("invalid value: {what}")]
    InvalidValue {
        /// Human-readable explanation of the violated invariant.
        what: String,
    },
}