mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2026-02-20 08:14:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5678 from antlilja/float-testing

Browse Source 
Add functions for testing floats with margins and epsilons to standard library
This commit is contained in:
Andrew Kelley 2020-07-26 05:54:30 +00:00 committed by GitHub
commit 40d81a8364
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 53 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
lib/std/testing.zig
View File

@ -171,6 +171,59 @@ test "expectEqual.union(enum)" {
expectEqual(a10, a10);
}
/// This function is intended to be used only in tests. When the actual value is not
/// within the margin of the expected value,
/// prints diagnostics to stderr to show exactly how they are not equal, then aborts.
/// The types must be floating point
pub fn expectWithinMargin(expected: var, actual: @TypeOf(expected), margin: @TypeOf(expected)) void {
std.debug.assert(margin >= 0.0);
switch (@typeInfo(@TypeOf(actual))) {
.Float,
.ComptimeFloat,
=> {
if (@fabs(expected - actual) > margin) {
std.debug.panic("actual {}, not within margin {} of expected {}", .{ actual, margin, expected });
}
},
else => @compileError("Unable to compare non floating point values"),
}
}
test "expectWithinMargin.f32" {
const x: f32 = 12.0;
const y: f32 = 12.06;
expectWithinMargin(x, y, 0.1);
}
/// This function is intended to be used only in tests. When the actual value is not
/// within the epsilon of the expected value,
/// prints diagnostics to stderr to show exactly how they are not equal, then aborts.
/// The types must be floating point
pub fn expectWithinEpsilon(expected: var, actual: @TypeOf(expected), epsilon: @TypeOf(expected)) void {
std.debug.assert(epsilon >= 0.0 and epsilon <= 1.0);
const margin = epsilon * expected;
switch (@typeInfo(@TypeOf(actual))) {
.Float,
.ComptimeFloat,
=> {
if (@fabs(expected - actual) > margin) {
std.debug.panic("actual {}, not within epsilon {}, of expected {}", .{ actual, epsilon, expected });
}
},
else => @compileError("Unable to compare non floating point values"),
}
}
test "expectWithinEpsilon.f32" {
const x: f32 = 12.0;
const y: f32 = 13.2;
expectWithinEpsilon(x, y, 0.1);
}
/// This function is intended to be used only in tests. When the two slices are not
/// equal, prints diagnostics to stderr to show exactly how they are not equal,
/// then aborts.