Enum DiffStatus 

pub enum DiffStatus {
    Ok,
    InvalidPoint,
    NotFinite,
    DegenerateStep,
    DimensionMismatch,
}

Why a derivative or Jacobian entry is, or is not, trustworthy.

Units

Dimensionless — a status code.

Variants

Ok

The difference quotient was formed from finite evaluations with a non-degenerate step. The value is usable.

InvalidPoint

The point x itself was not finite, so no step could be taken.

NotFinite

At least one function evaluation returned a non-finite value, or the difference quotient itself came out non-finite (overflow in the subtraction, for instance).

DegenerateStep

The step collapsed: relative_step was zero, negative or non-finite, or x + h rounded back to x so the realised step was exactly zero. The quotient would have been a division by zero.

DimensionMismatch

The vector function returned a different number of components than the point has, so the Jacobian is not square and cannot be assembled.

Only reachable from jacobian and its batched form; the square restriction is documented on jacobian.

Implementations

impl DiffStatus

pub fn is_ok(self) -> bool

Whether the value this status accompanies may be used.

pub fn label(self) -> &'static str

A short human-readable label, for log lines and benchmark tables.

Trait Implementations

impl Clone for DiffStatus

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for DiffStatus

impl Debug for DiffStatus

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

Formats the value using the given formatter.

impl Eq for DiffStatus

impl Hash for DiffStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DiffStatus

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DiffStatus