rinia 0.0.2

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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

use approx::assert_relative_eq;

use super::{FloatRepr, FloatScalar, Scalar};

fn scalar_identities<T: Scalar>() -> (T, T) {
    (T::ZERO, T::ONE)
}

fn float_constants<T: FloatScalar>() -> (T, T, T) {
    (T::INFINITY, T::NEG_INFINITY, T::NAN)
}

fn sin_via_floatscalar<T: FloatScalar>(x: T) -> T {
    x.sin()
}

fn round_trip<T: FloatScalar>(value: T) -> T {
    (value + T::ONE) - T::ONE
}

fn from_f32_via_repr<T: FloatRepr>(value: f32) -> T {
    T::from_f32(value)
}

fn from_f64_via_repr<T: FloatRepr>(value: f64) -> T {
    T::from_f64(value)
}

fn from_float_via_repr<T: FloatRepr, V: FloatRepr>(value: V) -> T {
    T::from_float(value)
}

#[test]
fn scalar_constants_match_for_f32_and_f64() {
    assert_eq!(scalar_identities::<f32>(), (0.0, 1.0));
    assert_eq!(scalar_identities::<f64>(), (0.0, 1.0));
}

#[test]
fn float_constants_match_for_f32_and_f64() {
    let (f32_inf, f32_neg_inf, f32_nan) = float_constants::<f32>();
    assert!(f32_inf.is_infinite() && f32_inf.is_sign_positive());
    assert!(f32_neg_inf.is_infinite() && f32_neg_inf.is_sign_negative());
    assert!(f32_nan.is_nan());

    let (f64_inf, f64_neg_inf, f64_nan) = float_constants::<f64>();
    assert!(f64_inf.is_infinite() && f64_inf.is_sign_positive());
    assert!(f64_neg_inf.is_infinite() && f64_neg_inf.is_sign_negative());
    assert!(f64_nan.is_nan());
}

#[test]
fn corefloat_and_approx_work_through_floatscalar_for_f32_and_f64() {
    let sin_zero_f32 = sin_via_floatscalar::<f32>(0.0);
    assert_relative_eq!(sin_zero_f32, 0.0, epsilon = 1.0e-6);

    let sin_zero_f64 = sin_via_floatscalar::<f64>(0.0);
    assert_relative_eq!(sin_zero_f64, 0.0, epsilon = 1.0e-12);
}

#[test]
fn generic_round_trip_works_for_f32_and_f64() {
    let out_f32 = round_trip::<f32>(3.5);
    assert_relative_eq!(out_f32, 3.5, epsilon = 1.0e-6);

    let out_f64 = round_trip::<f64>(3.5);
    assert_relative_eq!(out_f64, 3.5, epsilon = 1.0e-12);
}

#[test]
fn float_repr_as_converters_work_for_f32_and_f64() {
    let x32 = 1.25_f32;
    assert_relative_eq!(x32.as_f32(), 1.25_f32, epsilon = 1.0e-6);
    assert_relative_eq!(x32.as_f64(), 1.25_f64, epsilon = 1.0e-12);

    let x64 = 2.5_f64;
    assert_relative_eq!(x64.as_f32(), 2.5_f32, epsilon = 1.0e-6);
    assert_relative_eq!(x64.as_f64(), 2.5_f64, epsilon = 1.0e-12);
}

#[test]
fn float_repr_from_primitive_converters_work_for_f32_and_f64() {
    let f32_from_f32 = from_f32_via_repr::<f32>(1.25_f32);
    assert_relative_eq!(f32_from_f32, 1.25_f32, epsilon = 1.0e-6);

    let f32_from_f64 = from_f64_via_repr::<f32>(1.25_f64);
    assert_relative_eq!(f32_from_f64, 1.25_f32, epsilon = 1.0e-6);

    let f64_from_f32 = from_f32_via_repr::<f64>(2.5_f32);
    assert_relative_eq!(f64_from_f32, 2.5_f64, epsilon = 1.0e-12);

    let f64_from_f64 = from_f64_via_repr::<f64>(2.5_f64);
    assert_relative_eq!(f64_from_f64, 2.5_f64, epsilon = 1.0e-12);
}

#[test]
fn float_repr_from_float_converter_works_across_f32_and_f64() {
    let f32_from_f64 = from_float_via_repr::<f32, _>(1.25_f64);
    assert_relative_eq!(f32_from_f64, 1.25_f32, epsilon = 1.0e-6);

    let f64_from_f32 = from_float_via_repr::<f64, _>(2.5_f32);
    assert_relative_eq!(f64_from_f32, 2.5_f64, epsilon = 1.0e-12);
}

#[cfg(feature = "std")]
#[test]
fn std_inherent_sin_matches_floatscalar_path_for_f32_and_f64() {
    let x32 = 0.5_f32;
    let std_sin32 = x32.sin();
    let generic_sin32 = sin_via_floatscalar::<f32>(x32);
    assert_relative_eq!(std_sin32, generic_sin32, epsilon = 1.0e-6);

    let x64 = 0.5_f64;
    let std_sin64 = x64.sin();
    let generic_sin64 = sin_via_floatscalar::<f64>(x64);
    assert_relative_eq!(std_sin64, generic_sin64, epsilon = 1.0e-12);
}

#[cfg(not(feature = "std"))]
#[test]
fn non_std_method_sin_still_works_for_f32_and_f64() {
    let x32 = 0.5_f32;
    let sin32 = x32.sin();
    assert_relative_eq!(sin32, sin_via_floatscalar::<f32>(x32), epsilon = 1.0e-6);

    let x64 = 0.5_f64;
    let sin64 = x64.sin();
    assert_relative_eq!(sin64, sin_via_floatscalar::<f64>(x64), epsilon = 1.0e-12);
}