Skip to content

Commit 14fff24

Browse files
committed
doc: fix simd doc
1 parent 578bfa9 commit 14fff24

9 files changed

Lines changed: 1 addition & 105 deletions

File tree

docs/data/simd-clamp.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,6 @@ signatures:
4242

4343
Clamps each element in a collection between min and max values using SIMD instructions. The suffix (x2, x4, x8, x16, x32, x64) indicates the number of lanes processed simultaneously.
4444

45-
## Requirements
46-
47-
- **Go 1.26+** with `GOEXPERIMENT=simd`
48-
- **amd64** architecture only
49-
50-
### CPU compatibility
51-
52-
| SIMD variant | Lanes | Required flags | Typical CPUs |
53-
| ------------ | ----- | -------------- | ------------------------------ |
54-
| AVX (xN) | 2-16 | `avx` | All amd64 |
55-
| AVX2 (xN) | 4-32 | `avx2` | Intel Haswell+, AMD Excavator+ |
56-
| AVX-512 (xN) | 8-64 | `avx512f` | Intel Skylake-X+, some Xeons |
57-
5845
> **Note**: Choose the variant matching your CPU's capabilities. Higher lane counts provide better performance but require newer CPU support.
5946
6047
```go

docs/data/simd-contains.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,6 @@ signatures:
4242

4343
Checks if a target value is present in a collection using SIMD instructions. The suffix (x4, x8, x16, x32, x64) indicates the number of lanes processed simultaneously.
4444

45-
## Requirements
46-
47-
- **Go 1.26+** with `GOEXPERIMENT=simd`
48-
- **amd64** architecture only
49-
50-
### CPU compatibility
51-
52-
| SIMD variant | Lanes | Required flags | Typical CPUs |
53-
| ------------ | ----- | -------------- | ------------------------------ |
54-
| AVX (xN) | 2-16 | `avx` | All amd64 |
55-
| AVX2 (xN) | 4-32 | `avx2` | Intel Haswell+, AMD Excavator+ |
56-
| AVX-512 (xN) | 8-64 | `avx512f` | Intel Skylake-X+, some Xeons |
57-
5845
> **Note**: Choose the variant matching your CPU's capabilities. Higher lane counts provide better performance but require newer CPU support.
5946
6047
```go

docs/data/simd-max.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,6 @@ signatures:
4242

4343
Finds the maximum value in a collection using SIMD instructions. The suffix (x2, x4, x8, x16, x32, x64) indicates the number of lanes processed simultaneously.
4444

45-
## Requirements
46-
47-
- **Go 1.26+** with `GOEXPERIMENT=simd`
48-
- **amd64** architecture only
49-
50-
### CPU compatibility
51-
52-
| SIMD variant | Lanes | Required flags | Typical CPUs |
53-
| ------------ | ----- | -------------- | ------------------------------ |
54-
| AVX (xN) | 2-16 | `avx` | All amd64 |
55-
| AVX2 (xN) | 4-32 | `avx2` | Intel Haswell+, AMD Excavator+ |
56-
| AVX-512 (xN) | 8-64 | `avx512f` | Intel Skylake-X+, some Xeons |
57-
5845
> **Note**: Choose the variant matching your CPU's capabilities. Higher lane counts provide better performance but require newer CPU support.
5946
6047
```go

docs/data/simd-mean.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,6 @@ signatures:
4343

4444
Calculates the arithmetic mean of a collection using SIMD instructions. The suffix (x2, x4, x8, x16, x32, x64) indicates the number of lanes processed simultaneously.
4545

46-
## Requirements
47-
48-
- **Go 1.26+** with `GOEXPERIMENT=simd`
49-
- **amd64** architecture only
50-
51-
### CPU compatibility
52-
53-
| SIMD variant | Lanes | Required flags | Typical CPUs |
54-
| ------------ | ----- | -------------- | ------------------------------ |
55-
| AVX (xN) | 2-16 | `avx` | All amd64 |
56-
| AVX2 (xN) | 4-32 | `avx2` | Intel Haswell+, AMD Excavator+ |
57-
| AVX-512 (xN) | 8-64 | `avx512f` | Intel Skylake-X+, some Xeons |
58-
5946
> **Note**: Choose the variant matching your CPU's capabilities. Higher lane counts provide better performance but require newer CPU support.
6047
6148
```go

docs/data/simd-meanby.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,6 @@ signatures:
5353

5454
MeanBy transforms a collection using an iteratee function and calculates the arithmetic mean of the result using SIMD instructions. The automatic dispatch functions (e.g., `MeanByInt8`) will select the best SIMD variant based on CPU capabilities. The specific variants (e.g., `MeanByInt8x32`) use a fixed SIMD instruction set regardless of CPU capabilities.
5555

56-
## Requirements
57-
58-
- **Go 1.26+** with `GOEXPERIMENT=simd`
59-
- **amd64** architecture only
60-
61-
### CPU compatibility
62-
63-
| SIMD variant | Lanes | Required flags | Typical CPUs |
64-
| ------------ | ----- | -------------- | ------------------------------ |
65-
| AVX (xN) | 2-16 | `avx` | All amd64 |
66-
| AVX2 (xN) | 4-32 | `avx2` | Intel Haswell+, AMD Excavator+ |
67-
| AVX-512 (xN) | 8-64 | `avx512f` | Intel Skylake-X+, some Xeons |
68-
6956
> **Note**: The automatic dispatch functions (e.g., `MeanByInt8`) will use the best available SIMD variant for the current CPU. Use specific variants (e.g., `MeanByInt8x32`) only if you know your target CPU supports that instruction set.
7057
7158
```go

docs/data/simd-min.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,6 @@ signatures:
4242

4343
Finds the minimum value in a collection using SIMD instructions. The suffix (x2, x4, x8, x16, x32, x64) indicates the number of lanes processed simultaneously.
4444

45-
## Requirements
46-
47-
- **Go 1.26+** with `GOEXPERIMENT=simd`
48-
- **amd64** architecture only
49-
50-
### CPU compatibility
51-
52-
| SIMD variant | Lanes | Required flags | Typical CPUs |
53-
| ------------ | ----- | -------------- | ------------------------------ |
54-
| AVX (xN) | 2-16 | `avx` | All amd64 |
55-
| AVX2 (xN) | 4-32 | `avx2` | Intel Haswell+, AMD Excavator+ |
56-
| AVX-512 (xN) | 8-64 | `avx512f` | Intel Skylake-X+, some Xeons |
57-
5845
> **Note**: Choose the variant matching your CPU's capabilities. Higher lane counts provide better performance but require newer CPU support.
5946
6047
```go

docs/data/simd-sum.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,6 @@ signatures:
4343

4444
Sums the values in a collection using SIMD instructions. The suffix (x2, x4, x8, x16, x32, x64) indicates the number of lanes processed simultaneously.
4545

46-
## Requirements
47-
48-
- **Go 1.26+** with `GOEXPERIMENT=simd`
49-
- **amd64** architecture only
50-
51-
### CPU compatibility
52-
53-
| SIMD variant | Lanes | Required flags | Typical CPUs |
54-
| ------------ | ----- | -------------- | ------------------------------ |
55-
| AVX (xN) | 2-16 | `avx` | All amd64 |
56-
| AVX2 (xN) | 4-32 | `avx2` | Intel Haswell+, AMD Excavator+ |
57-
| AVX-512 (xN) | 8-64 | `avx512f` | Intel Skylake-X+, some Xeons |
58-
5946
> **Note**: Choose the variant matching your CPU's capabilities. Higher lane counts provide better performance but require newer CPU support.
6047
6148
```go

docs/data/simd-sumby.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,6 @@ signatures:
5353

5454
SumBy transforms a collection using an iteratee function and sums the result using SIMD instructions. The automatic dispatch functions (e.g., `SumByInt8`) will select the best SIMD variant based on CPU capabilities. The specific variants (e.g., `SumByInt8x32`) use a fixed SIMD instruction set regardless of CPU capabilities.
5555

56-
## Requirements
57-
58-
- **Go 1.26+** with `GOEXPERIMENT=simd`
59-
- **amd64** architecture only
60-
61-
### CPU compatibility
62-
63-
| SIMD variant | Lanes | Required flags | Typical CPUs |
64-
| ------------ | ----- | -------------- | ------------------------------ |
65-
| AVX (xN) | 2-16 | `avx` | All amd64 |
66-
| AVX2 (xN) | 4-32 | `avx2` | Intel Haswell+, AMD Excavator+ |
67-
| AVX-512 (xN) | 8-64 | `avx512f` | Intel Skylake-X+, some Xeons |
68-
6956
> **Note**: The automatic dispatch functions (e.g., `SumByInt8`) will use the best available SIMD variant for the current CPU. Use specific variants (e.g., `SumByInt8x32`) only if you know your target CPU supports that instruction set.
7057
7158
```go

docs/docs/experimental/simd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: SIMD operations
2+
title: SIMD
33
description: High-performance slice operations using AVX, AVX2 and AVX512 SIMD when built with Go 1.26+ and GOEXPERIMENT=simd on amd64.
44
sidebar_position: 0
55
hide_table_of_contents: true

0 commit comments

Comments
 (0)