rinia 0.0.6

Portable scalar abstractions for game and simulation math.
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

use core::{
    fmt::Debug,
    ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Neg, Sub, SubAssign},
};

use approx::{AbsDiffEq, RelativeEq, UlpsEq};
use core_maths::CoreFloat;

use super::type_lists::with_all_scalar_types;
use crate::ops::{HasScalar, One, Select, Zero};

/// A trait representing a scalar type with the minimal set of operations and constants required
/// for mathematical computations.
pub trait Scalar:
    Copy
    + Debug
    + HasScalar
    + Zero
    + One
    + Select
    + PartialEq
    + PartialOrd
    + ScalarCasts
    + Add<Output = Self>
    + AddAssign
    + Sub<Output = Self>
    + SubAssign
    + Mul<Output = Self>
    + MulAssign
    + Div<Output = Self>
    + DivAssign
{
    /// The maximum finite value for the scalar type.
    const MAX: Self;

    /// The minimum finite value for the scalar type.
    const MIN: Self;

    /// Converts a value of type `T` into the implementing scalar type.
    #[inline]
    fn from_scalar<T: Scalar>(value: T) -> Self
    where
        Self: ScalarCast<T>,
    {
        <Self as ScalarCast<T>>::from_scalar_impl(value)
    }

    /// Converts the implementing scalar type into a value of type `T`.
    #[inline]
    fn as_scalar<T: Scalar>(&self) -> T
    where
        Self: ScalarCast<T>,
    {
        <Self as ScalarCast<T>>::as_scalar_impl(self)
    }
}

/// A trait representing a floating-point scalar type with additional constants and operations.
pub trait FloatScalar:
    Scalar
    + CoreFloat
    + Neg<Output = Self>
    + AbsDiffEq<Epsilon = Self>
    + RelativeEq<Epsilon = Self>
    + UlpsEq<Epsilon = Self>
{
    /// Infinity for the scalar type.
    const INFINITY: Self;

    /// Negative infinity for the scalar type.
    const NEG_INFINITY: Self;

    /// NaN (Not a Number) for the scalar type.
    const NAN: Self;

    /// Checks if the scalar value is NaN (Not a Number).
    fn is_nan(self) -> bool;

    /// Checks if the scalar value is finite (not infinite or NaN).
    fn is_finite(self) -> bool;

    /// Checks if the scalar value is infinite (positive or negative infinity).
    fn is_infinite(self) -> bool;
}

/// A trait representing an integer scalar type.
pub trait IntScalar: Scalar + Ord + Eq {}

/// A trait representing an unsigned integer scalar type.
pub trait UIntScalar: IntScalar {}

/// A trait representing a signed integer scalar type.
pub trait SIntScalar: IntScalar + Neg<Output = Self> {}

/// A trait for converting between different scalar types.
pub trait ScalarCast<T>: Sized {
    fn from_scalar_impl(value: T) -> Self;
    fn as_scalar_impl(&self) -> T;
}

macro_rules! define_scalar_casts_trait {
    ($($ty:ty),+ $(,)?) => {
        pub trait ScalarCasts: $(ScalarCast<$ty> +)+ {}

        impl<T> ScalarCasts for T where T: $(ScalarCast<$ty> +)+ {}
    };
}

with_all_scalar_types!(define_scalar_casts_trait);