[dev.simd] simd: correct SumAbsDiff documentation

Change-Id: I6bb093615f12bbac5ea4c013a1c47cd5d338fe43
Reviewed-on: https://go-review.googlesource.com/c/go/+/698516
Reviewed-by: David Chase <drchase@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>

diff --git a/src/simd/_gen/simdgen/ops/MLOps/categories.yaml b/src/simd/_gen/simdgen/ops/MLOps/categories.yaml
index 8e1ffeb131ac6c315fdd53df0ded848ff44a0e76..772a7b3cf67d92f763a117ada8bd50668ea26c36 100644 (file)
--- a/src/simd/_gen/simdgen/ops/MLOps/categories.yaml
+++ b/src/simd/_gen/simdgen/ops/MLOps/categories.yaml
@@ -49,5 +49,5 @@
   commutative: false
   documentation: !string |-
     // NAME sums the absolute distance of the two input vectors, each adjacent 8 bytes as a group. The output sum will
-    // be a vector of word-sized elements whose each 8*n-th element contains the sum of the n-th input group.
+    // be a vector of word-sized elements whose each 4*n-th element contains the sum of the n-th input group. The other elements in the result vector are zeroed.
     // This method could be seen as the norm of the L1 distance of each adjacent 8-byte vector group of the two input vectors.

diff --git a/src/simd/ops_amd64.go b/src/simd/ops_amd64.go
index e600f7c1a0c9b92a2aac990a134bffb0005984cc..bce30aa2cb71cecdd1021aeb318246337dd9ffd3 100644 (file)
--- a/src/simd/ops_amd64.go
+++ b/src/simd/ops_amd64.go
@@ -6819,21 +6819,21 @@ func (x Uint16x32) SubSaturated(y Uint16x32) Uint16x32
 /* SumAbsDiff */
 
 // SumAbsDiff sums the absolute distance of the two input vectors, each adjacent 8 bytes as a group. The output sum will
-// be a vector of word-sized elements whose each 8*n-th element contains the sum of the n-th input group.
+// be a vector of word-sized elements whose each 4*n-th element contains the sum of the n-th input group. The other elements in the result vector are zeroed.
 // This method could be seen as the norm of the L1 distance of each adjacent 8-byte vector group of the two input vectors.
 //
 // Asm: VPSADBW, CPU Feature: AVX
 func (x Uint8x16) SumAbsDiff(y Uint8x16) Uint16x8
 
 // SumAbsDiff sums the absolute distance of the two input vectors, each adjacent 8 bytes as a group. The output sum will
-// be a vector of word-sized elements whose each 8*n-th element contains the sum of the n-th input group.
+// be a vector of word-sized elements whose each 4*n-th element contains the sum of the n-th input group. The other elements in the result vector are zeroed.
 // This method could be seen as the norm of the L1 distance of each adjacent 8-byte vector group of the two input vectors.
 //
 // Asm: VPSADBW, CPU Feature: AVX2
 func (x Uint8x32) SumAbsDiff(y Uint8x32) Uint16x16
 
 // SumAbsDiff sums the absolute distance of the two input vectors, each adjacent 8 bytes as a group. The output sum will
-// be a vector of word-sized elements whose each 8*n-th element contains the sum of the n-th input group.
+// be a vector of word-sized elements whose each 4*n-th element contains the sum of the n-th input group. The other elements in the result vector are zeroed.
 // This method could be seen as the norm of the L1 distance of each adjacent 8-byte vector group of the two input vectors.
 //
 // Asm: VPSADBW, CPU Feature: AVX512