authorgravatar for twostepted@gmail.comTravis Staloch <twostepted@gmail.com> 2021-09-09 13:07:59-07:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2021-09-28 17:03:43-07:00
log1d86eae5269edcac5f32d166f13ed27483f07688
treec17aa788fc57e0b5ad7e0b7b278bd85ed02e8d1b
parent0f246257be5029e7bb73ac9a5ff356171007bc7a

sat-arithmetic: langref - remove syntax disclaimer

1 files changed, 4 insertions(+), 8 deletions(-)

doc/langref.html.in+4-8
...@@ -7241,8 +7241,7 @@ fn readFile(allocator: *Allocator, filename: []const u8) ![]u8 {...@@ -7241,8 +7241,7 @@ fn readFile(allocator: *Allocator, filename: []const u8) ![]u8 {
7241 Returns {#syntax#}a + b{#endsyntax#}. The result will be clamped between the type maximum and minimum.7241 Returns {#syntax#}a + b{#endsyntax#}. The result will be clamped between the type maximum and minimum.
7242 </p>7242 </p>
7243 <p>7243 <p>
7244 Once <a href="https://github.com/ziglang/zig/issues/1284">Saturating arithmetic</a>.7244 The syntax {#syntax#}a +| b{#endsyntax#} is equivalent to calling {#syntax#}@addWithSaturation(a, b){#endsyntax#}.
7245 is completed, the syntax {#syntax#}a +| b{#endsyntax#} will be equivalent to calling {#syntax#}@addWithSaturation(a, b){#endsyntax#}.
7246 </p>7245 </p>
7247 {#header_close#}7246 {#header_close#}
7248 {#header_open|@alignCast#}7247 {#header_open|@alignCast#}
...@@ -8372,8 +8371,7 @@ test "@wasmMemoryGrow" {...@@ -8372,8 +8371,7 @@ test "@wasmMemoryGrow" {
8372 Returns {#syntax#}a * b{#endsyntax#}. The result will be clamped between the type maximum and minimum.8371 Returns {#syntax#}a * b{#endsyntax#}. The result will be clamped between the type maximum and minimum.
8373 </p>8372 </p>
8374 <p>8373 <p>
8375 Once <a href="https://github.com/ziglang/zig/issues/1284">Saturating arithmetic</a>.8374 The syntax {#syntax#}a *| b{#endsyntax#} is equivalent to calling {#syntax#}@mulWithSaturation(a, b){#endsyntax#}.
8376 is completed, the syntax {#syntax#}a *| b{#endsyntax#} will be equivalent to calling {#syntax#}@mulWithSaturation(a, b){#endsyntax#}.
8377 </p>8375 </p>
8378 <p>8376 <p>
8379 NOTE: Currently there is a bug in the llvm.smul.fix.sat intrinsic which affects {#syntax#}@mulWithSaturation{#endsyntax#} of signed integers. 8377 NOTE: Currently there is a bug in the llvm.smul.fix.sat intrinsic which affects {#syntax#}@mulWithSaturation{#endsyntax#} of signed integers.
...@@ -8629,8 +8627,7 @@ test "@setRuntimeSafety" {...@@ -8629,8 +8627,7 @@ test "@setRuntimeSafety" {
8629 Returns {#syntax#}a << b{#endsyntax#}. The result will be clamped between type minimum and maximum. 8627 Returns {#syntax#}a << b{#endsyntax#}. The result will be clamped between type minimum and maximum.
8630 </p>8628 </p>
8631 <p>8629 <p>
8632 Once <a href="https://github.com/ziglang/zig/issues/1284">Saturating arithmetic</a>.8630 The syntax {#syntax#}a <<| b{#endsyntax#} is equivalent to calling {#syntax#}@shlWithSaturation(a, b){#endsyntax#}.
8633 is completed, the syntax {#syntax#}a <<| b{#endsyntax#} will be equivalent to calling {#syntax#}@shlWithSaturation(a, b){#endsyntax#}.
8634 </p>8631 </p>
8635 <p>8632 <p>
8636 Unlike other @shl builtins, shift_amt doesn't need to be a Log2T as saturated overshifting is well defined. 8633 Unlike other @shl builtins, shift_amt doesn't need to be a Log2T as saturated overshifting is well defined.
...@@ -8954,8 +8951,7 @@ fn doTheTest() !void {...@@ -8954,8 +8951,7 @@ fn doTheTest() !void {
8954 Returns {#syntax#}a - b{#endsyntax#}. The result will be clamped between the type maximum and minimum. 8951 Returns {#syntax#}a - b{#endsyntax#}. The result will be clamped between the type maximum and minimum.
8955 </p>8952 </p>
8956 <p>8953 <p>
8957 Once <a href="https://github.com/ziglang/zig/issues/1284">Saturating arithmetic</a>.8954 The syntax {#syntax#}a -| b{#endsyntax#} is equivalent to calling {#syntax#}@subWithSaturation(a, b){#endsyntax#}.
8958 is completed, the syntax {#syntax#}a -| b{#endsyntax#} will be equivalent to calling {#syntax#}@subWithSaturation(a, b){#endsyntax#}.
8959 </p>8955 </p>
8960 {#header_close#}8956 {#header_close#}
89618957