bop-lang 0.3.0

A small, embeddable, dynamically-typed programming language with zero dependencies
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

//! Tiny `f64` math facade that works on both the default (std)
//! build and the `no_std` opt-in. `core::f64` doesn't expose
//! `sqrt` / `sin` / `cos` / etc. — those methods live in
//! `std::f64`'s platform-dependent math library — so the no_std
//! build has to forward to the pure-Rust `libm` crate instead.
//! The std build stays dep-free and calls the native `f64`
//! methods directly.
//!
//! Every bop math builtin and `ops::div` / `ops::rem`'s float
//! path goes through here rather than calling `x.sqrt()` /
//! `libm::sqrt(x)` at the point of use, so the rest of the
//! codebase stays `#[cfg]`-free.
//!
//! ## Feature
//!
//! The only math-related feature is `no_std`. Leave it off (the
//! default) to get `std::f64`'s native math with no external
//! deps. Enable it — with `default-features = false, features =
//! ["no_std"]` — when targeting bare-metal / embedded / edge
//! wasm. `no_std` pulls in the tiny pure-Rust `libm` crate.

#![allow(dead_code)]

/// `√x`.
#[inline]
pub fn sqrt(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.sqrt()
    }
    #[cfg(feature = "no_std")]
    {
        libm::sqrt(x)
    }
}

/// `sin(x)` (radians).
#[inline]
pub fn sin(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.sin()
    }
    #[cfg(feature = "no_std")]
    {
        libm::sin(x)
    }
}

/// `cos(x)` (radians).
#[inline]
pub fn cos(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.cos()
    }
    #[cfg(feature = "no_std")]
    {
        libm::cos(x)
    }
}

/// `tan(x)` (radians).
#[inline]
pub fn tan(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.tan()
    }
    #[cfg(feature = "no_std")]
    {
        libm::tan(x)
    }
}

/// `⌊x⌋` — largest integer ≤ x, as a float.
#[inline]
pub fn floor(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.floor()
    }
    #[cfg(feature = "no_std")]
    {
        libm::floor(x)
    }
}

/// `⌈x⌉` — smallest integer ≥ x, as a float.
#[inline]
pub fn ceil(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.ceil()
    }
    #[cfg(feature = "no_std")]
    {
        libm::ceil(x)
    }
}

/// Round half-away-from-zero (matches `f64::round`).
#[inline]
pub fn round(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.round()
    }
    #[cfg(feature = "no_std")]
    {
        libm::round(x)
    }
}

/// Truncate toward zero — drop the fractional part.
#[inline]
pub fn trunc(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.trunc()
    }
    #[cfg(feature = "no_std")]
    {
        libm::trunc(x)
    }
}

/// `base ** exp` for floats.
#[inline]
pub fn powf(base: f64, exp: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        base.powf(exp)
    }
    #[cfg(feature = "no_std")]
    {
        libm::pow(base, exp)
    }
}

/// Natural log.
#[inline]
pub fn ln(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.ln()
    }
    #[cfg(feature = "no_std")]
    {
        libm::log(x)
    }
}

/// `e^x`.
#[inline]
pub fn exp(x: f64) -> f64 {
    #[cfg(not(feature = "no_std"))]
    {
        x.exp()
    }
    #[cfg(feature = "no_std")]
    {
        libm::exp(x)
    }
}