Morph MORPH
SIGN IN SIGN UP
ziglang / zig UNCLAIMED

Moved to Codeberg

0 0 0 Zig
Normal View History Raw
std.math: Add documentation for all functions and algorithm sources
2019-05-01 18:15:57 +12:00
// Ported from musl, which is licensed under the MIT license:
// https://git.musl-libc.org/cgit/musl/tree/COPYRIGHT
Add math special case tests and general fixes - Should cover special case inputs for most functions - Fixed a number of runtime panicking behaviour reliant on shift overflow/division by zero etc.
2017-06-20 23:01:04 +12:00
//
std.math: Add documentation for all functions and algorithm sources
2019-05-01 18:15:57 +12:00
// https://git.musl-libc.org/cgit/musl/tree/src/math/roundf.c
// https://git.musl-libc.org/cgit/musl/tree/src/math/round.c
Add math special case tests and general fixes - Should cover special case inputs for most functions - Fixed a number of runtime panicking behaviour reliant on shift overflow/division by zero etc.
2017-06-20 23:01:04 +12:00
std.debug.assert: remove special case for test builds Previously, std.debug.assert would `@panic` in test builds, if the assertion failed. Now, it's always `unreachable`. This makes release mode test builds more accurately test the actual code that will be run. However this requires tests to call `std.testing.expect` rather than `std.debug.assert` to make sure output is correct. Here is the explanation of when to use either one, copied from the assert doc comments: Inside a test block, it is best to use the `std.testing` module rather than assert, because assert may not detect a test failure in ReleaseFast and ReleaseSafe mode. Outside of a test block, assert is the correct function to use. closes #1304
2019-02-08 18:18:47 -05:00
const expect = std.testing.expect;
rename std lib files to new convention
2019-03-02 16:46:04 -05:00
const std = @import("../std.zig");
move std/debug.zig to a subdirectory self hosted compiler parser tests do some fuzz testing
2017-12-23 22:08:53 -05:00
const math = std.math;
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
std.math: Add documentation for all functions and algorithm sources
2019-05-01 18:15:57 +12:00
/// Returns x rounded to the nearest integer, rounding half away from zero.
///
/// Special Cases:
/// - round(+-0) = +-0
/// - round(+-inf) = +-inf
/// - round(nan) = nan
run zig fmt on std lib and self hosted
2020-07-11 14:09:04 +03:00
pub fn round(x: anytype) @TypeOf(x) {
Replace @typeOf with @TypeOf in all zig source This change was mostly made with `zig fmt` and this also modified some whitespace. Note that in some files, `zig fmt` produced incorrect code, so the change was made manually.
2019-12-09 21:56:19 +01:00
const T = @TypeOf(x);
explicitly return from blocks instead of last statement being expression value closes #629
2017-12-22 00:50:30 -05:00
return switch (T) {
std.math: remove unnecessary inline calls and workaround windows 32 bit test failure See #537
2017-12-22 13:14:07 -05:00
f32 => round32(x),
f64 => round64(x),
Improve f128 standard library support * Add functions: floor128, ceil128, trunc128 and round128 * Add corresponding tests
2020-06-17 18:18:45 +02:00
f128 => round128(x),
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
else => @compileError("round not implemented for " ++ @typeName(T)),
explicitly return from blocks instead of last statement being expression value closes #629
2017-12-22 00:50:30 -05:00
};
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
}
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 04:10:11 -05:00
fn round32(x_: f32) f32 {
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
var x = x_;
const u = @bitCast(u32, x);
const e = (u >> 23) & 0xFF;
var y: f32 = undefined;
partial conversion to post-fix pointer deref using zig fmt
2018-05-10 00:29:49 -04:00
if (e >= 0x7F + 23) {
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
return x;
}
if (u >> 31 != 0) {
x = -x;
}
partial conversion to post-fix pointer deref using zig fmt
2018-05-10 00:29:49 -04:00
if (e < 0x7F - 1) {
forceEval() -> doNotOptimizeAway()
2020-08-26 01:48:51 +02:00
math.doNotOptimizeAway(x + math.f32_toint);
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
return 0 * @bitCast(f32, u);
}
Default to strict IEEE floating point Closes #1227.
2018-08-23 21:42:09 +12:00
y = x + math.f32_toint - math.f32_toint - x;
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
if (y > 0.5) {
y = y + x - 1;
} else if (y <= -0.5) {
y = y + x + 1;
} else {
y = y + x;
}
if (u >> 31 != 0) {
explicitly return from blocks instead of last statement being expression value closes #629
2017-12-22 00:50:30 -05:00
return -y;
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
} else {
explicitly return from blocks instead of last statement being expression value closes #629
2017-12-22 00:50:30 -05:00
return y;
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
}
}
syntax: functions require return type. remove `->` The purpose of this is: * Only one way to do things * Changing a function with void return type to return a possible error becomes a 1 character change, subtly encouraging people to use errors. See #632 Here are some imperfect sed commands for performing this update: remove arrow: ``` sed -i 's/\(\bfn\b.*\)-> /\1/g' $(find . -name "*.zig") ``` add void: ``` sed -i 's/\(\bfn\b.*\))\s*{/\1) void {/g' $(find ../ -name "*.zig") ``` Some cleanup may be necessary, but this should do the bulk of the work.
2018-01-25 04:10:11 -05:00
fn round64(x_: f64) f64 {
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
var x = x_;
const u = @bitCast(u64, x);
const e = (u >> 52) & 0x7FF;
var y: f64 = undefined;
partial conversion to post-fix pointer deref using zig fmt
2018-05-10 00:29:49 -04:00
if (e >= 0x3FF + 52) {
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
return x;
}
if (u >> 63 != 0) {
x = -x;
}
partial conversion to post-fix pointer deref using zig fmt
2018-05-10 00:29:49 -04:00
if (e < 0x3ff - 1) {
forceEval() -> doNotOptimizeAway()
2020-08-26 01:48:51 +02:00
math.doNotOptimizeAway(x + math.f64_toint);
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
return 0 * @bitCast(f64, u);
}
Default to strict IEEE floating point Closes #1227.
2018-08-23 21:42:09 +12:00
y = x + math.f64_toint - math.f64_toint - x;
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
if (y > 0.5) {
y = y + x - 1;
} else if (y <= -0.5) {
y = y + x + 1;
} else {
y = y + x;
}
if (u >> 63 != 0) {
explicitly return from blocks instead of last statement being expression value closes #629
2017-12-22 00:50:30 -05:00
return -y;
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
} else {
explicitly return from blocks instead of last statement being expression value closes #629
2017-12-22 00:50:30 -05:00
return y;
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
}
}
Improve f128 standard library support * Add functions: floor128, ceil128, trunc128 and round128 * Add corresponding tests
2020-06-17 18:18:45 +02:00
fn round128(x_: f128) f128 {
var x = x_;
const u = @bitCast(u128, x);
const e = (u >> 112) & 0x7FFF;
var y: f128 = undefined;
if (e >= 0x3FFF + 112) {
return x;
}
if (u >> 127 != 0) {
x = -x;
}
if (e < 0x3FFF - 1) {
forceEval() -> doNotOptimizeAway()
2020-08-26 01:48:51 +02:00
math.doNotOptimizeAway(x + math.f64_toint);
Improve f128 standard library support * Add functions: floor128, ceil128, trunc128 and round128 * Add corresponding tests
2020-06-17 18:18:45 +02:00
return 0 * @bitCast(f128, u);
}
y = x + math.f128_toint - math.f128_toint - x;
if (y > 0.5) {
y = y + x - 1;
} else if (y <= -0.5) {
y = y + x + 1;
} else {
y = y + x;
}
if (u >> 127 != 0) {
return -y;
} else {
return y;
}
}
workaround for llvm bug See #393 for details
2017-06-19 14:36:33 -04:00
test "math.round" {
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(round(@as(f32, 1.3)) == round32(1.3));
try expect(round(@as(f64, 1.3)) == round64(1.3));
try expect(round(@as(f128, 1.3)) == round128(1.3));
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
}
workaround for llvm bug See #393 for details
2017-06-19 14:36:33 -04:00
test "math.round32" {
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(round32(1.3) == 1.0);
try expect(round32(-1.3) == -1.0);
try expect(round32(0.2) == 0.0);
try expect(round32(1.8) == 2.0);
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
}
workaround for llvm bug See #393 for details
2017-06-19 14:36:33 -04:00
test "math.round64" {
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(round64(1.3) == 1.0);
try expect(round64(-1.3) == -1.0);
try expect(round64(0.2) == 0.0);
try expect(round64(1.8) == 2.0);
Add math library This covers the majority of the functions as covered by the C99 specification for a math library. Code is adapted primarily from musl libc, with the pow and standard trigonometric functions adapted from the Go stdlib. Changes: - Remove assert expose in index and import as needed. - Add float log function and merge with existing base 2 integer implementation. See https://github.com/tiehuis/zig-fmath. See #374.
2017-06-16 20:26:10 +12:00
}
Add math special case tests and general fixes - Should cover special case inputs for most functions - Fixed a number of runtime panicking behaviour reliant on shift overflow/division by zero etc.
2017-06-20 23:01:04 +12:00
Improve f128 standard library support * Add functions: floor128, ceil128, trunc128 and round128 * Add corresponding tests
2020-06-17 18:18:45 +02:00
test "math.round128" {
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(round128(1.3) == 1.0);
try expect(round128(-1.3) == -1.0);
try expect(round128(0.2) == 0.0);
try expect(round128(1.8) == 2.0);
Improve f128 standard library support * Add functions: floor128, ceil128, trunc128 and round128 * Add corresponding tests
2020-06-17 18:18:45 +02:00
}
Add math special case tests and general fixes - Should cover special case inputs for most functions - Fixed a number of runtime panicking behaviour reliant on shift overflow/division by zero etc.
2017-06-20 23:01:04 +12:00
test "math.round32.special" {
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(round32(0.0) == 0.0);
try expect(round32(-0.0) == -0.0);
try expect(math.isPositiveInf(round32(math.inf(f32))));
try expect(math.isNegativeInf(round32(-math.inf(f32))));
try expect(math.isNan(round32(math.nan(f32))));
Add math special case tests and general fixes - Should cover special case inputs for most functions - Fixed a number of runtime panicking behaviour reliant on shift overflow/division by zero etc.
2017-06-20 23:01:04 +12:00
}
test "math.round64.special" {
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(round64(0.0) == 0.0);
try expect(round64(-0.0) == -0.0);
try expect(math.isPositiveInf(round64(math.inf(f64))));
try expect(math.isNegativeInf(round64(-math.inf(f64))));
try expect(math.isNan(round64(math.nan(f64))));
Add math special case tests and general fixes - Should cover special case inputs for most functions - Fixed a number of runtime panicking behaviour reliant on shift overflow/division by zero etc.
2017-06-20 23:01:04 +12:00
}
Improve f128 standard library support * Add functions: floor128, ceil128, trunc128 and round128 * Add corresponding tests
2020-06-17 18:18:45 +02:00
test "math.round128.special" {
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(round128(0.0) == 0.0);
try expect(round128(-0.0) == -0.0);
try expect(math.isPositiveInf(round128(math.inf(f128))));
try expect(math.isNegativeInf(round128(-math.inf(f128))));
try expect(math.isNan(round128(math.nan(f128))));
Improve f128 standard library support * Add functions: floor128, ceil128, trunc128 and round128 * Add corresponding tests
2020-06-17 18:18:45 +02:00
}
Reference in New Issue Copy Permalink