Enum rgsl::Value

source · [−]

pub enum Value {
Show 36 variants    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

source

impl Value

source

pub fn is_success(self) -> bool

Trait Implementations

source

impl Clone for Value

source

fn clone(&self) -> Value

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Value

source

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

Formats the value using the given formatter. Read more

source

impl PartialEq<Value> for Value

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<Value> for Value

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl Copy for Value

source

impl StructuralPartialEq for Value

Auto Trait Implementations

impl RefUnwindSafe for Value

impl Send for Value

impl Sync for Value

impl Unpin for Value

impl UnwindSafe for Value

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum rgsl::Value

Variants

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)

Implementations

impl Value

pub fn is_success(self) -> bool

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

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

impl Debug for Value

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

impl PartialEq<Value> for Value

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

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

impl PartialOrd<Value> for Value

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

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

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

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

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

impl Copy for Value

impl StructuralPartialEq for Value

Auto Trait Implementations

impl RefUnwindSafe for Value

impl Send for Value

impl Sync for Value

impl Unpin for Value

impl UnwindSafe for Value

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

`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)`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,