kcl-ezpz 0.2.18

A constraint solver for KCL and Zoo Design Studio
Documentation
use faer::{
    linalg::svd::SvdError,
    sparse::{CreationError, FaerError, linalg::LuError},
};

use crate::Id;

/// Errors from parsing and executing ezpz's textual representation.
#[derive(thiserror::Error, Debug)]
#[cfg_attr(not(feature = "unstable-exhaustive"), non_exhaustive)]
pub enum TextualError {
    /// No initial guess was given for this label.
    #[error("No guess was given for point {label}")]
    MissingGuess {
        /// The entity that didn't have any guesses
        label: String,
    },
    /// No initial guess was given for this label.
    #[error("You gave a guess for points which weren't defined: {labels:?}")]
    UnusedGuesses {
        /// The entities you gave guesses for which weren't defined.
        labels: Vec<String>,
    },
    /// You referred to an entity that was never defined.
    #[error("You referred to the point {label} but it was never defined")]
    UndefinedPoint {
        /// The undefined point.
        label: String,
    },
}

/// Errors that could occur when running the core Newton-Gauss solve.
#[derive(thiserror::Error, Debug)]
#[cfg_attr(not(feature = "unstable-exhaustive"), non_exhaustive)]
pub enum NonLinearSystemError {
    /// ID was not found.
    #[error("ID {0} not found")]
    NotFound(Id),
    /// There should be exactly 1 guess per variable, but you supplied the wrong number.
    #[error(
        "There should be exactly 1 guess per variable, but you supplied {labels} variables and must {guesses} guesses"
    )]
    WrongNumberGuesses {
        /// How many variables/labels were given.
        labels: usize,
        /// How many guesses were given.
        guesses: usize,
    },
    /// Constraint references a variable that doesn't appear in the initial guesses.
    #[error(
        "Constraint {constraint_id} references variable {variable} but no such variable appears in your initial guesses."
    )]
    MissingGuess {
        /// Which constraint ID referenced a missing variable.
        constraint_id: usize,
        /// Which variable was missing.
        variable: Id,
    },
    /// Faer: could not create a matrix.
    #[error("Could not create matrix: {error}")]
    FaerMatrix {
        /// Underlying error.
        #[from]
        error: CreationError,
    },
    /// Faer: general error.
    #[error("Something went wrong in faer: {error}")]
    Faer {
        /// Underlying error.
        #[from]
        error: FaerError,
    },
    /// Faer: could not solve the matrix in the Newton-Gauss loop.
    #[error("Something went wrong doing matrix solves in faer: {error}")]
    FaerSolve {
        /// Underlying error.
        #[from]
        error: LuError,
    },
    /// Faer: could not decompose Jacobian.
    #[error("Something went wrong doing SVD in faer")]
    FaerSvd(SvdError),
    /// Solver did not find a solution within the allowed number of iterations.
    /// Consider raising the iterations?
    #[error("Could not find a solution in the allowed number of iterations")]
    DidNotConverge,
    /// You provided an empty constraint system.
    #[error("Cannot solve an empty system")]
    EmptySystemNotAllowed,
}