MORPH
SIGN IN SIGN UP
ziglang / zig UNCLAIMED

Moved to Codeberg

42802 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
//
// https://git.musl-libc.org/cgit/musl/tree/src/math/logf.c
// https://git.musl-libc.org/cgit/musl/tree/src/math/log.c
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;
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;
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 the logarithm of x for the provided base.
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
pub fn log(comptime T: type, base: T, x: T) T {
bit shifting safety * add u3, u4, u5, u6, u7 and i3, i4, i5, i6, i7 * shift operations shift amount parameter type is integer with log2 bit width of other param - This enforces not violating undefined behavior on shift amount >= bit width with the type system * clean up math.log, math.ln, math.log2, math.log10 closes #403
2017-08-19 01:32:15 -04:00
if (base == 2) {
return math.log2(x);
} else if (base == 10) {
return math.log10(x);
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 02:35:53 +01:00
} else if ((@typeInfo(T) == .float or @typeInfo(T) == .comptime_float) and base == math.e) {
compiler-rt: math functions reorg * unify the logic for exporting math functions from compiler-rt, with the appropriate suffixes and prefixes. - add all missing f128 and f80 exports. Functions with missing implementations call other functions and have TODO comments. - also add f16 functions * move math functions from freestanding libc to compiler-rt (#7265) * enable all the f128 and f80 code in the stage2 compiler and behavior tests (#11161). * update std lib to use builtins rather than `std.math`.
2022-04-26 10:13:55 -07:00
return @log(x);
bit shifting safety * add u3, u4, u5, u6, u7 and i3, i4, i5, i6, i7 * shift operations shift amount parameter type is integer with log2 bit width of other param - This enforces not violating undefined behavior on shift amount >= bit width with the type system * clean up math.log, math.ln, math.log2, math.log10 closes #403
2017-08-19 01:32:15 -04:00
}
remove integer and float casting syntax * add `@intCast` * add `@floatCast` * add `@floatToInt` * add `@intToFloat` See #1061
2018-06-17 02:57:07 -04:00
const float_base = math.lossyCast(f64, base);
remove usages of `@typeId`, `@memberCount`, `@memberName` and `@memberType`
2020-02-24 23:03:30 +02:00
switch (@typeInfo(T)) {
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 02:35:53 +01:00
.comptime_float => {
compiler-rt: math functions reorg * unify the logic for exporting math functions from compiler-rt, with the appropriate suffixes and prefixes. - add all missing f128 and f80 exports. Functions with missing implementations call other functions and have TODO comments. - also add f16 functions * move math functions from freestanding libc to compiler-rt (#7265) * enable all the f128 and f80 code in the stage2 compiler and behavior tests (#11161). * update std lib to use builtins rather than `std.math`.
2022-04-26 10:13:55 -07:00
return @as(comptime_float, @log(@as(f64, x)) / @log(float_base));
bit shifting safety * add u3, u4, u5, u6, u7 and i3, i4, i5, i6, i7 * shift operations shift amount parameter type is integer with log2 bit width of other param - This enforces not violating undefined behavior on shift amount >= bit width with the type system * clean up math.log, math.ln, math.log2, math.log10 closes #403
2017-08-19 01:32:15 -04:00
},
std.math.log_int: implement integer logarithm without using float math
2023-09-14 21:33:56 +02:00
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 02:35:53 +01:00
.comptime_int => {
fix #17142, wrong comptime log_int computation
2024-01-12 17:28:56 +01:00
return @as(comptime_int, math.log_int(comptime_int, base, x));
bit shifting safety * add u3, u4, u5, u6, u7 and i3, i4, i5, i6, i7 * shift operations shift amount parameter type is integer with log2 bit width of other param - This enforces not violating undefined behavior on shift amount >= bit width with the type system * clean up math.log, math.ln, math.log2, math.log10 closes #403
2017-08-19 01:32:15 -04:00
},
Compile error for signed integer math Output compile errors when signed integer types are used on functions where the answer might've been a complex number but that functionality hasn't been implemented. This applies to sqrt, log, log2, log10 and ln. A test which used a signed integer was also changed to use an unsigned integer instead.
2021-04-02 14:52:47 +02:00
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 02:35:53 +01:00
.int => |IntType| switch (IntType.signedness) {
AstGen: use reachableExpr for return operand Related: #9630
2021-11-24 14:47:33 -07:00
.signed => @compileError("log not implemented for signed integers"),
std.math.log_int: implement integer logarithm without using float math
2023-09-14 21:33:56 +02:00
.unsigned => return @as(T, math.log_int(T, base, 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
},
std: update `std.builtin.Type` fields to follow naming conventions The compiler actually doesn't need any functional changes for this: Sema does reification based on the tag indices of `std.builtin.Type` already! So, no zig1.wasm update is necessary. This change is necessary to disallow name clashes between fields and decls on a type, which is a prerequisite of #9938.
2024-08-28 02:35:53 +01:00
.float => {
bit shifting safety * add u3, u4, u5, u6, u7 and i3, i4, i5, i6, i7 * shift operations shift amount parameter type is integer with log2 bit width of other param - This enforces not violating undefined behavior on shift amount >= bit width with the type system * clean up math.log, math.ln, math.log2, math.log10 closes #403
2017-08-19 01:32:15 -04:00
switch (T) {
all: migrate code to new cast builtin syntax Most of this migration was performed automatically with `zig fmt`. There were a few exceptions which I had to manually fix: * `@alignCast` and `@addrSpaceCast` cannot be automatically rewritten * `@truncate`'s fixup is incorrect for vectors * Test cases are not formatted, and their error locations change
2023-06-22 18:46:56 +01:00
f32 => return @as(f32, @floatCast(@log(@as(f64, x)) / @log(float_base))),
compiler-rt: math functions reorg * unify the logic for exporting math functions from compiler-rt, with the appropriate suffixes and prefixes. - add all missing f128 and f80 exports. Functions with missing implementations call other functions and have TODO comments. - also add f16 functions * move math functions from freestanding libc to compiler-rt (#7265) * enable all the f128 and f80 code in the stage2 compiler and behavior tests (#11161). * update std lib to use builtins rather than `std.math`.
2022-04-26 10:13:55 -07:00
f64 => return @log(x) / @log(float_base),
bit shifting safety * add u3, u4, u5, u6, u7 and i3, i4, i5, i6, i7 * shift operations shift amount parameter type is integer with log2 bit width of other param - This enforces not violating undefined behavior on shift amount >= bit width with the type system * clean up math.log, math.ln, math.log2, math.log10 closes #403
2017-08-19 01:32:15 -04:00
else => @compileError("log 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
},
workaround for llvm bug See #393 for details
2017-06-19 14:36:33 -04:00
else => {
@compileError("log expects integer or float, found '" ++ @typeName(T) ++ "'");
},
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
}
}
Remove redundant test name prefixes now that test names are fully qualified Follow up to #19079, which made test names fully qualified. This fixes tests that now-redundant information in their test names. For example here's a fully qualified test name before the changes in this commit: "priority_queue.test.std.PriorityQueue: shrinkAndFree" and the same test's name after the changes in this commit: "priority_queue.test.shrinkAndFree"
2024-02-25 23:31:53 -08:00
test "log integer" {
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(log(u8, 2, 0x1) == 0);
try expect(log(u8, 2, 0x2) == 1);
try expect(log(u16, 2, 0x72) == 6);
try expect(log(u32, 2, 0xFFFFFF) == 23);
try expect(log(u64, 2, 0x7FF0123456789ABC) == 62);
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
}
Remove redundant test name prefixes now that test names are fully qualified Follow up to #19079, which made test names fully qualified. This fixes tests that now-redundant information in their test names. For example here's a fully qualified test name before the changes in this commit: "priority_queue.test.std.PriorityQueue: shrinkAndFree" and the same test's name after the changes in this commit: "priority_queue.test.shrinkAndFree"
2024-02-25 23:31:53 -08:00
test "log float" {
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
const epsilon = 0.000001;
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(math.approxEqAbs(f32, log(f32, 6, 0.23947), -0.797723, epsilon));
try expect(math.approxEqAbs(f32, log(f32, 89, 0.23947), -0.318432, epsilon));
try expect(math.approxEqAbs(f64, log(f64, 123897, 12389216414), 1.981724596, epsilon));
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
}
Remove redundant test name prefixes now that test names are fully qualified Follow up to #19079, which made test names fully qualified. This fixes tests that now-redundant information in their test names. For example here's a fully qualified test name before the changes in this commit: "priority_queue.test.std.PriorityQueue: shrinkAndFree" and the same test's name after the changes in this commit: "priority_queue.test.shrinkAndFree"
2024-02-25 23:31:53 -08:00
test "log float_special" {
std: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(log(f32, 2, 0.2301974) == math.log2(@as(f32, 0.2301974)));
try expect(log(f32, 10, 0.2301974) == math.log10(@as(f32, 0.2301974)));
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: update usage of std.testing
2021-05-04 20:47:26 +03:00
try expect(log(f64, 2, 213.23019799993) == math.log2(@as(f64, 213.23019799993)));
try expect(log(f64, 10, 213.23019799993) == math.log10(@as(f64, 213.23019799993)));
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
}
Reference in New Issue Copy Permalink