mirrors/zig
1
0
Fork 0
mirror of https://codeberg.org/ziglang/zig.git synced 2025-12-06 05:44:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

langref: clarify functionality of the round builtin (#19503)

Browse source 
A test has also been added to demonstrate the expected behavior.

* std.math: update round doc comment to match the builtin
This commit is contained in:
T 2024-08-14 10:29:45 -07:00 • committed by GitHub
parent b7a1ef3e19
commit eb7f318ea8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/langref.html.in
View file

@ -5618,9 +5618,11 @@ fn cmpxchgWeakButNotAtomic(comptime T: type, ptr: *T, expected_value: T, new_val
{#header_open|@round#} {#header_open|@round#}
<pre>{#syntax#}@round(value: anytype) @TypeOf(value){#endsyntax#}</pre> <pre>{#syntax#}@round(value: anytype) @TypeOf(value){#endsyntax#}</pre>
<p> <p>
Rounds the given floating point number to an integer, away from zero. Uses a dedicated hardware instruction Rounds the given floating point number to the nearest integer. If two integers are equally close, rounds away from zero.
when available. Uses a dedicated hardware instruction when available.
</p> </p>
{#code|test_round_builtin.zig#}
<p> <p>
Supports {#link|Floats#} and {#link|Vectors#} of floats. Supports {#link|Floats#} and {#link|Vectors#} of floats.
</p> </p>

10
doc/langref/test_round_builtin.zig Normal file
View file

@ -0,0 +1,10 @@
const expect = @import("std").testing.expect;
test "@round" {
try expect(@round(1.4) == 1);
try expect(@round(1.5) == 2);
try expect(@round(-1.4) == -1);
try expect(@round(-2.5) == -3);
}
// test

3
lib/std/math.zig
View file

@ -1140,7 +1140,8 @@ test ByteAlignedInt {
try testing.expect(ByteAlignedInt(u129) == u136); try testing.expect(ByteAlignedInt(u129) == u136);
} }
/// Rounds the given floating point number to an integer, away from zero. /// Rounds the given floating point number to the nearest integer.
/// If two integers are equally close, rounds away from zero.
/// Uses a dedicated hardware instruction when available. /// Uses a dedicated hardware instruction when available.
/// This is the same as calling the builtin @round /// This is the same as calling the builtin @round
pub inline fn round(value: anytype) @TypeOf(value) { pub inline fn round(value: anytype) @TypeOf(value) {