Enum PolyCalError 

pub enum PolyCalError<E> {
    OutOfRangeCertain {
        value: E,
        evaluated: E,
        range: Range<E>,
        kind: Kind,
    },
    OutOfRangeUncertain {
        value: E,
        evaluated: AbsUncertainty<E>,
        range: Range<E>,
        kind: Kind,
    },
    InverseSolver(Error),
    LeastSquares(SolverError),
    NoMinimum {
        scores: Vec<E>,
    },
    InvalidData(String),
    Chebyshev(ChebyshevError),
    FittingFailure {
        dependent: Vec<E>,
        independent: Vec<E>,
    },
}

Variants

OutOfRangeCertain

The input value was outside of the calibration range, so a prediction cannot be reliably made.

In this scenario we return the value anyway because the caller needs to decide what to do. In some scenarios using the value might be acceptable, particularly when the input value was very close to the calibration range. Alternatively if the caller is running an unconstrained optimisation the solver could leave the finite function domain. In that case, as long as the value solved for lies in the function domain at the end of the optimisation there is no harm in leaving it during the solve.

Note though that guarantees around monotonicity are only made within the domain of the polynomial. It is possible a root outside the domain may be found, and it is the responsibility of the caller to check.

Fields

value: E

evaluated: E

range: Range<E>

kind: Kind

OutOfRangeUncertain

The input value was outside of the calibration range, so a prediction cannot be reliably made.

In this scenario we return the value anyway because the caller needs to decide what to do. In some scenarios using the value might be acceptable, particularly when the input value was very close to the calibration range. Alternatively if the caller is running an unconstrained optimisation the solver could leave the finite function domain. In that case, as long as the value solved for lies in the function domain at the end of the optimisation there is no harm in leaving it during the solve.

Note though that guarantees around monotonicity are only made within the domain of the polynomial. It is possible a root outside the domain may be found, and it is the responsibility of the caller to check.

Fields

value: E

evaluated: AbsUncertainty<E>

range: Range<E>

kind: Kind

InverseSolver(Error)

Failure in the underlying inverse solver.

LeastSquares(SolverError)

Failure in the underlying least-squares routine

NoMinimum

There was no minimum found using the requested scoring strategy.

Fields

scores: Vec<E>

InvalidData(String)

Input data contained invalid values, leaving the calculation unable to proceed

Chebyshev(ChebyshevError)

Error in low-level Chebyshev calculation

FittingFailure

Fields

dependent: Vec<E>

independent: Vec<E>

Trait Implementations

impl<E: Debug> Debug for PolyCalError<E>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E> Display for PolyCalError<E>

where E: Display, Range<E>: Debug, Vec<E>: Debug,

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E> Error for PolyCalError<E>

where Self: Debug + Display,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<E> From<Error> for PolyCalError<E>

fn from(source: Error) -> Self

Converts to this type from the input type.