Enum rgsl::Value

pub enum Value {
    Success,
    Failure,
    Continue,
    Domain,
    Range,
    Fault,
    Invalid,
    Failed,
    Factorization,
    Sanity,
    NoMemory,
    BadFunction,
    RunAway,
    MaxIteration,
    ZeroDiv,
    BadTolerance,
    Tolerance,
    UnderFlow,
    OverFlow,
    Loss,
    Round,
    BadLength,
    NotSquare,
    Singularity,
    Diverge,
    Unsupported,
    Unimplemented,
    Cache,
    Table,
    NoProgress,
    NoProgressJacobian,
    ToleranceF,
    ToleranceX,
    ToleranceG,
    EOF,
    Unknown(i32),
}

Variants

Success

Failure

Continue

iteration has not converged

Domain

input domain error, e.g sqrt(-1)

Range

output range error, e.g. exp(1e100)

Fault

invalid pointer

Invalid

invalid argument supplied by user

Failed

generic failure

Factorization

factorization failed

Sanity

sanity check failed - shouldn’t happen

NoMemory

malloc failed

BadFunction

problem with user-supplied function

RunAway

iterative process is out of control

MaxIteration

exceeded max number of iterations

ZeroDiv

tried to divide by zero

BadTolerance

user specified an invalid tolerance

Tolerance

failed to reach the specified tolerance

UnderFlow

underflow

OverFlow

overflow

Loss

loss of accuracy

Round

failed because of roundoff error

BadLength

matrix, vector lengths are not conformant

NotSquare

matrix not square

Singularity

apparent singularity detected

Diverge

integral or series is divergent

Unsupported

requested feature is not supported by the hardware

Unimplemented

requested feature not (yet) implemented

Cache

cache limit exceeded

Table

table limit exceeded

NoProgress

iteration is not making progress towards solution

NoProgressJacobian

jacobian evaluations are not improving the solution

ToleranceF

cannot reach the specified tolerance in F

ToleranceX

cannot reach the specified tolerance in X

ToleranceG

cannot reach the specified tolerance in gradient

EOF

cannot reach the specified tolerance in gradient

Unknown(i32)

Unknown value.

Implementations

impl Value

pub fn is_success(self) -> bool

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Value

impl Debug for Value

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

Formats the value using the given formatter.

impl PartialEq<Value> for Value

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Value> for Value

fn partial_cmp(&self, other: &Value) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Value