Trait Scalar 

pub trait Scalar:
    Signed
    + Pow<Self, Output = Self, Output = Self>
    + Pow<i32>
    + FromPrimitive
    + ToPrimitive
    + Display
    + Debug
    + Copy
    + PartialEq
    + PartialOrd
    + AddAssign
    + SubAssign
    + MulAssign
    + DivAssign
    + Send
    + Sync
    + 'static {
    const EPSILON: Self;
    const INFINITY: Self;
    const NAN: Self;

    // Required methods
    fn is_nan(self) -> bool;
    fn sqrt(self) -> Self;
    fn exp(self) -> Self;
    fn sin(self) -> Self;
    fn cos(self) -> Self;
    fn max(self, other: Self) -> Self;
}

A scalar type suitable for numerical computations in ODE solvers.

This trait aggregates the crate-local numeric requirements shared across diffsol.

Implementations

DiffSol provides implementations for f64 and f32.

Examples

use diffsol_la::Scalar;

fn compute<T: Scalar>(x: T, y: T) -> T {
    x * x + y
}

Required Associated Constants

const EPSILON: Self

Machine epsilon for this scalar type (smallest representable positive value such that 1.0 + EPSILON != 1.0).

const INFINITY: Self

Positive infinity value for this scalar type.

const NAN: Self

Not-a-Number (NaN) value for this scalar type.

Required Methods

fn is_nan(self) -> bool

Check if this value is NaN.

fn sqrt(self) -> Self

Square root.

fn exp(self) -> Self

Exponential.

fn sin(self) -> Self

Sine.

fn cos(self) -> Self

Cosine.

fn max(self, other: Self) -> Self

Maximum of two values.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Scalar for f32

const EPSILON: f32 = f32::EPSILON

const INFINITY: f32 = f32::INFINITY

const NAN: f32 = f32::NAN

fn is_nan(self) -> bool

fn sqrt(self) -> f32

fn exp(self) -> f32

fn sin(self) -> f32

fn cos(self) -> f32

fn max(self, other: f32) -> f32

impl Scalar for f64

const EPSILON: f64 = f64::EPSILON

const INFINITY: f64 = f64::INFINITY

const NAN: f64 = f64::NAN

fn is_nan(self) -> bool

fn sqrt(self) -> f64

fn exp(self) -> f64

fn sin(self) -> f64

fn cos(self) -> f64

fn max(self, other: f64) -> f64

Implementors