authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2022-03-17 17:22:57-07:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2022-03-17 17:22:57-07:00
log73e51133c3a143b8838e7f7fed599a33aca1b1f1
tree0172ba552977209ef1865e7c6c4fd873278f0871
parent291f5055f4b169e53414913e5ac077cd99ace978

langref: small clarification of `@reduce`


1 files changed, 7 insertions(+), 6 deletions(-)

doc/langref.html.in+7-6
......@@ -9352,22 +9352,23 @@ test "vector @splat" {
93529352 {#header_close#}
93539353
93549354 {#header_open|@reduce#}
9355 <pre>{#syntax#}@reduce(comptime op: std.builtin.ReduceOp, value: anytype) std.meta.Child(value){#endsyntax#}</pre>
9355 <pre>{#syntax#}@reduce(comptime op: std.builtin.ReduceOp, value: anytype) E{#endsyntax#}</pre>
93569356 <p>
9357 Transforms a {#link|vector|Vectors#} into a scalar value by performing a
9358 sequential horizontal reduction of its elements using the specified operator {#syntax#}op{#endsyntax#}.
9357 Transforms a {#link|vector|Vectors#} into a scalar value (of type <code>E</code>)
9358 by performing a sequential horizontal reduction of its elements using the
9359 specified operator {#syntax#}op{#endsyntax#}.
93599360 </p>
93609361 <p>
93619362 Not every operator is available for every vector element type:
93629363 </p>
93639364 <ul>
9365 <li>Every operator is available for {#link|integer|Integers#} vectors.</li>
93649366 <li>{#syntax#}.And{#endsyntax#}, {#syntax#}.Or{#endsyntax#},
9365 {#syntax#}.Xor{#endsyntax#} are available for
9367 {#syntax#}.Xor{#endsyntax#} are additionally available for
93669368 {#syntax#}bool{#endsyntax#} vectors,</li>
93679369 <li>{#syntax#}.Min{#endsyntax#}, {#syntax#}.Max{#endsyntax#},
93689370 {#syntax#}.Add{#endsyntax#}, {#syntax#}.Mul{#endsyntax#} are
9369 available for {#link|floating point|Floats#} vectors,</li>
9370 <li>Every operator is available for {#link|integer|Integers#} vectors.</li>
9371 additionally available for {#link|floating point|Floats#} vectors,</li>
93719372 </ul>
93729373 <p>
93739374 Note that {#syntax#}.Add{#endsyntax#} and {#syntax#}.Mul{#endsyntax#}