diff options
| author | Marc Tiehuis <marctiehuis@gmail.com> | 2019-05-02 19:05:26 +1200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-02 19:05:26 +1200 |
| commit | f950ec0c16de6dba8a541b1a6453ebe431430782 (patch) | |
| tree | 47df2ed19eece69d35a60eeff8c26511cfe996e3 /std/math/modf.zig | |
| parent | c00c18de6a5e436b1c362c06d6e5259c8f731a90 (diff) | |
| parent | 3370e60dd96828db6f9d1da36e71064303e97de6 (diff) | |
| download | zig-f950ec0c16de6dba8a541b1a6453ebe431430782.tar.gz zig-f950ec0c16de6dba8a541b1a6453ebe431430782.zip | |
Merge pull request #2397 from ziglang/std.math
Review std/math and update documentation
Diffstat (limited to 'std/math/modf.zig')
| -rw-r--r-- | std/math/modf.zig | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/std/math/modf.zig b/std/math/modf.zig index e5a4964e63..92194d4c75 100644 --- a/std/math/modf.zig +++ b/std/math/modf.zig @@ -1,7 +1,8 @@ -// Special Cases: +// Ported from musl, which is licensed under the MIT license: +// https://git.musl-libc.org/cgit/musl/tree/COPYRIGHT // -// - modf(+-inf) = +-inf, nan -// - modf(nan) = nan, nan +// https://git.musl-libc.org/cgit/musl/tree/src/math/modff.c +// https://git.musl-libc.org/cgit/musl/tree/src/math/modf.c const std = @import("../std.zig"); const math = std.math; @@ -17,6 +18,12 @@ fn modf_result(comptime T: type) type { pub const modf32_result = modf_result(f32); pub const modf64_result = modf_result(f64); +/// Returns the integer and fractional floating-point numbers that sum to x. The sign of each +/// result is the same as the sign of x. +/// +/// Special Cases: +/// - modf(+-inf) = +-inf, nan +/// - modf(nan) = nan, nan pub fn modf(x: var) modf_result(@typeOf(x)) { const T = @typeOf(x); return switch (T) { |