numbat 1.23.0

A statically typed programming language for scientific computations with first class support for physical dimensions and units.
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

use core::scalar
use core::functions

@description("Returns true if the input is `NaN`.")
@url("https://doc.rust-lang.org/std/primitive.f64.html#method.is_nan")
@example("is_nan(37)")
@example("is_nan(NaN)")
fn is_nan<T: Dim>(n: T) -> Bool

@description("Returns true if the input is positive infinity or negative infinity.")
@url("https://doc.rust-lang.org/std/primitive.f64.html#method.is_infinite")
@example("is_infinite(37)")
@example("is_infinite(-inf)")
fn is_infinite<T: Dim>(n: T) -> Bool

@description("Returns true if the input is neither infinite nor `NaN`.")
@example("is_finite(37)")
@example("is_finite(-inf)")
fn is_finite<T: Dim>(n: T) -> Bool = !is_nan(n) && !is_infinite(n)

@description("Returns true if the input is 0 (zero).")
@example("is_zero(37)")
@example("is_zero(0)")
fn is_zero<D: Dim>(value: D) -> Bool = value == 0

@description("Returns true unless the input is 0 (zero).")
@example("is_nonzero(37)")
@example("is_nonzero(0)")
fn is_nonzero<D: Dim>(value: D) -> Bool = !is_zero(value)

@description("Returns true if the input is an integer.")
@example("is_integer(3)")
@example("is_integer(pi)")
fn is_integer(x: Scalar) -> Bool = is_zero(fract(x))