ff14451b4a
Comparisons with absolute epsilons are usually useful when comparing numbers to zero, for non-zero numbers it's advised to switch to relative epsilons instead to obtain meaningful results (check [1] for more details). The new API introduces approxEqAbs and approxEqRel, where the former aliases and deprecated the old `approxEq`, allowing the user to pick the right tool for the job. The documentation is meant to guide the user in the choice of the correct alternative. [1] https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/
20 lines
738 B
Zig
20 lines
738 B
Zig
// SPDX-License-Identifier: MIT
|
|
// Copyright (c) 2015-2020 Zig Contributors
|
|
// This file is part of [zig](https://ziglang.org/), which is MIT licensed.
|
|
// The MIT license requires this copyright notice to be included in all copies
|
|
// and substantial portions of the software.
|
|
const math = @import("../math.zig");
|
|
|
|
/// Returns the machine epsilon for type T.
|
|
/// This is the smallest value of type T that satisfies the inequality 1.0 +
|
|
/// epsilon != 1.0.
|
|
pub fn epsilon(comptime T: type) T {
|
|
return switch (T) {
|
|
f16 => math.f16_epsilon,
|
|
f32 => math.f32_epsilon,
|
|
f64 => math.f64_epsilon,
|
|
f128 => math.f128_epsilon,
|
|
else => @compileError("epsilon not implemented for " ++ @typeName(T)),
|
|
};
|
|
}
|