mathhook-core 0.2.0

Core mathematical engine for MathHook - expressions, algebra, and solving
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! Mathematical constants

use serde::{Deserialize, Serialize};

/// Common mathematical constants
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
pub enum MathConstant {
    Pi,
    E,
    I,
    Infinity,
    NegativeInfinity,
    Undefined,
    GoldenRatio,
    EulerGamma,
    TribonacciConstant,
}

impl MathConstant {
    /// Get the approximate floating-point value of the constant
    ///
    /// # Examples
    ///
    /// ```rust
    /// use mathhook_core::MathConstant;
    ///
    /// assert!((MathConstant::Pi.to_f64() - std::f64::consts::PI).abs() < 1e-10);
    /// assert!((MathConstant::E.to_f64() - std::f64::consts::E).abs() < 1e-10);
    /// ```
    pub fn to_f64(self) -> f64 {
        match self {
            MathConstant::Pi => std::f64::consts::PI,
            MathConstant::E => std::f64::consts::E,
            MathConstant::I => f64::NAN,
            MathConstant::Infinity => f64::INFINITY,
            MathConstant::NegativeInfinity => f64::NEG_INFINITY,
            MathConstant::Undefined => f64::NAN,
            MathConstant::GoldenRatio => 1.618033988749895,
            MathConstant::EulerGamma => 0.5772156649015329,
            MathConstant::TribonacciConstant => 1.839286755214161,
        }
    }
}

/// Epsilon value for floating-point comparisons
///
/// Used to handle floating-point precision errors.
/// Two floats are considered equal if their absolute difference is less than EPSILON.
pub const EPSILON: f64 = 1e-10;