Skip to content

Correct some comments in Avx*.cs #115056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tannergooding merged 2 commits into from
Jun 11, 2025
Merged

Correct some comments in Avx*.cs #115056

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93caab9
Update Avx*.cs
tfenise Apr 25, 2025
7dfe0ed
Add some remarks to Avx*.cs
tfenise Jun 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions .../System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Avx10v1.PlatformNotSupported.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1678,13 +1678,13 @@ internal Avx10v1() { }
public static Vector256<sbyte> MultiShift(Vector256<sbyte> control, Vector256<long> value) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m256i _mm256_permutevar16x16_epi16 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi16 (__m256i idx, __m256i a)</para>
/// <para> VPERMW ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<short> PermuteVar16x16(Vector256<short> left, Vector256<short> control) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m256i _mm256_permutevar16x16_epi16 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi16 (__m256i idx, __m256i a)</para>
/// <para> VPERMW ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<ushort> PermuteVar16x16(Vector256<ushort> left, Vector256<ushort> control) { throw new PlatformNotSupportedException(); }
Expand All @@ -1704,13 +1704,13 @@ internal Avx10v1() { }
public static Vector256<ushort> PermuteVar16x16x2(Vector256<ushort> lower, Vector256<ushort> indices, Vector256<ushort> upper) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m128i _mm_permutevar64x8_epi8 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi8 (__m128i idx, __m128i a)</para>
/// <para> VPERMB xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<byte> PermuteVar16x8(Vector128<byte> left, Vector128<byte> control) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m128i _mm_permutevar64x8_epi8 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi8 (__m128i idx, __m128i a)</para>
/// <para> VPERMB xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<sbyte> PermuteVar16x8(Vector128<sbyte> left, Vector128<sbyte> control) { throw new PlatformNotSupportedException(); }
Expand Down Expand Up @@ -1751,13 +1751,13 @@ internal Avx10v1() { }
public static Vector128<ulong> PermuteVar2x64x2(Vector128<ulong> lower, Vector128<ulong> indices, Vector128<ulong> upper) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m256i _mm256_permutevar64x8_epi8 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi8 (__m256i idx, __m256i a)</para>
/// <para> VPERMB ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<byte> PermuteVar32x8(Vector256<byte> left, Vector256<byte> control) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m256i _mm256_permutevar64x8_epi8 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi8 (__m256i idx, __m256i a)</para>
/// <para> VPERMB ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<sbyte> PermuteVar32x8(Vector256<sbyte> left, Vector256<sbyte> control) { throw new PlatformNotSupportedException(); }
Expand Down Expand Up @@ -1804,13 +1804,13 @@ internal Avx10v1() { }
public static Vector256<double> PermuteVar4x64(Vector256<double> value, Vector256<long> control) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m256i _mm256_permute4x64_epi64 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi64 (__m256i idx, __m256i a)</para>
/// <para> VPERMQ ymm1 {k1}{z}, ymm2, ymm3/m256/m64bcst</para>
/// </summary>
public static Vector256<long> PermuteVar4x64(Vector256<long> value, Vector256<long> control) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m256i _mm256_permute4x64_pd (__m256d a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi64 (__m256i idx, __m256i a)</para>
/// <para> VPERMQ ymm1 {k1}{z}, ymm2, ymm3/m256/m64bcst</para>
/// </summary>
public static Vector256<ulong> PermuteVar4x64(Vector256<ulong> value, Vector256<ulong> control) { throw new PlatformNotSupportedException(); }
Expand All @@ -1837,13 +1837,13 @@ internal Avx10v1() { }
public static Vector256<ulong> PermuteVar4x64x2(Vector256<ulong> lower, Vector256<ulong> indices, Vector256<ulong> upper) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m128i _mm_permutevar8x16_epi16 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi16 (__m128i idx, __m128i a)</para>
/// <para> VPERMW xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<short> PermuteVar8x16(Vector128<short> left, Vector128<short> control) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m128i _mm_permutevar8x16_epi16 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi16 (__m128i idx, __m128i a)</para>
/// <para> VPERMW xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<ushort> PermuteVar8x16(Vector128<ushort> left, Vector128<ushort> control) { throw new PlatformNotSupportedException(); }
Expand Down Expand Up @@ -3168,13 +3168,13 @@ internal V512() { }
public static Vector512<double> Xor(Vector512<double> left, Vector512<double> right) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m512i _mm512_permutevar64x8_epi8 (__m512i a, __m512i b)</para>
/// <para>__m512i _mm512_permutexvar_epi8 (__m512i idx, __m512i a)</para>
/// <para> VPERMB zmm1 {k1}{z}, zmm2, zmm3/m512</para>
/// </summary>
public static Vector512<sbyte> PermuteVar64x8(Vector512<sbyte> left, Vector512<sbyte> control) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m512i _mm512_permutevar64x8_epi8 (__m512i a, __m512i b)</para>
/// <para>__m512i _mm512_permutexvar_epi8 (__m512i idx, __m512i a)</para>
/// <para> VPERMB zmm1 {k1}{z}, zmm2, zmm3/m512</para>
/// </summary>
public static Vector512<byte> PermuteVar64x8(Vector512<byte> left, Vector512<byte> control) { throw new PlatformNotSupportedException(); }
Expand Down
24 changes: 12 additions & 12 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Avx10v1.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1677,13 +1677,13 @@ internal Avx10v1() { }
public static Vector256<sbyte> MultiShift(Vector256<sbyte> control, Vector256<long> value) => MultiShift(control, value);

/// <summary>
/// <para>__m256i _mm256_permutevar16x16_epi16 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi16 (__m256i idx, __m256i a)</para>
/// <para> VPERMW ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<short> PermuteVar16x16(Vector256<short> left, Vector256<short> control) => PermuteVar16x16(left, control);

/// <summary>
/// <para>__m256i _mm256_permutevar16x16_epi16 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi16 (__m256i idx, __m256i a)</para>
/// <para> VPERMW ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<ushort> PermuteVar16x16(Vector256<ushort> left, Vector256<ushort> control) => PermuteVar16x16(left, control);
Expand All @@ -1703,13 +1703,13 @@ internal Avx10v1() { }
public static Vector256<ushort> PermuteVar16x16x2(Vector256<ushort> lower, Vector256<ushort> indices, Vector256<ushort> upper) => PermuteVar16x16x2(lower, indices, upper);

/// <summary>
/// <para>__m128i _mm_permutevar64x8_epi8 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi8 (__m128i idx, __m128i a)</para>
/// <para> VPERMB xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<byte> PermuteVar16x8(Vector128<byte> left, Vector128<byte> control) => PermuteVar16x8(left, control);

/// <summary>
/// <para>__m128i _mm_permutevar64x8_epi8 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi8 (__m128i idx, __m128i a)</para>
/// <para> VPERMB xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<sbyte> PermuteVar16x8(Vector128<sbyte> left, Vector128<sbyte> control) => PermuteVar16x8(left, control);
Expand Down Expand Up @@ -1750,13 +1750,13 @@ internal Avx10v1() { }
public static Vector128<ulong> PermuteVar2x64x2(Vector128<ulong> lower, Vector128<ulong> indices, Vector128<ulong> upper) => PermuteVar2x64x2(lower, indices, upper);

/// <summary>
/// <para>__m256i _mm256_permutevar64x8_epi8 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi8 (__m256i idx, __m256i a)</para>
/// <para> VPERMB ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<byte> PermuteVar32x8(Vector256<byte> left, Vector256<byte> control) => PermuteVar32x8(left, control);

/// <summary>
/// <para>__m256i _mm256_permutevar64x8_epi8 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi8 (__m256i idx, __m256i a)</para>
/// <para> VPERMB ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<sbyte> PermuteVar32x8(Vector256<sbyte> left, Vector256<sbyte> control) => PermuteVar32x8(left, control);
Expand Down Expand Up @@ -1803,13 +1803,13 @@ internal Avx10v1() { }
public static Vector256<double> PermuteVar4x64(Vector256<double> value, Vector256<long> control) => PermuteVar4x64(value, control);

/// <summary>
/// <para>__m256i _mm256_permute4x64_epi64 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi64 (__m256i idx, __m256i a)</para>
/// <para> VPERMQ ymm1 {k1}{z}, ymm2, ymm3/m256/m64bcst</para>
/// </summary>
public static Vector256<long> PermuteVar4x64(Vector256<long> value, Vector256<long> control) => PermuteVar4x64(value, control);

/// <summary>
/// <para>__m256i _mm256_permute4x64_pd (__m256d a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi64 (__m256i idx, __m256i a)</para>
/// <para> VPERMQ ymm1 {k1}{z}, ymm2, ymm3/m256/m64bcst</para>
/// </summary>
public static Vector256<ulong> PermuteVar4x64(Vector256<ulong> value, Vector256<ulong> control) => PermuteVar4x64(value, control);
Expand All @@ -1836,13 +1836,13 @@ internal Avx10v1() { }
public static Vector256<ulong> PermuteVar4x64x2(Vector256<ulong> lower, Vector256<ulong> indices, Vector256<ulong> upper) => PermuteVar4x64x2(lower, indices, upper);

/// <summary>
/// <para>__m128i _mm_permutevar8x16_epi16 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi16 (__m128i idx, __m128i a)</para>
/// <para> VPERMW xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<short> PermuteVar8x16(Vector128<short> left, Vector128<short> control) => PermuteVar8x16(left, control);

/// <summary>
/// <para>__m128i _mm_permutevar8x16_epi16 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi16 (__m128i idx, __m128i a)</para>
/// <para> VPERMW xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<ushort> PermuteVar8x16(Vector128<ushort> left, Vector128<ushort> control) => PermuteVar8x16(left, control);
Expand Down Expand Up @@ -3158,13 +3158,13 @@ internal V512() { }
public static Vector512<double> Xor(Vector512<double> left, Vector512<double> right) => Xor(left, right);

/// <summary>
/// <para>__m512i _mm512_permutevar64x8_epi8 (__m512i a, __m512i b)</para>
/// <para>__m512i _mm512_permutexvar_epi8 (__m512i idx, __m512i a)</para>
/// <para> VPERMB zmm1 {k1}{z}, zmm2, zmm3/m512</para>
/// </summary>
public static Vector512<sbyte> PermuteVar64x8(Vector512<sbyte> left, Vector512<sbyte> control) => PermuteVar64x8(left, control);

/// <summary>
/// <para>__m512i _mm512_permutevar64x8_epi8 (__m512i a, __m512i b)</para>
/// <para>__m512i _mm512_permutexvar_epi8 (__m512i idx, __m512i a)</para>
/// <para> VPERMB zmm1 {k1}{z}, zmm2, zmm3/m512</para>
/// </summary>
public static Vector512<byte> PermuteVar64x8(Vector512<byte> left, Vector512<byte> control) => PermuteVar64x8(left, control);
Expand Down
12 changes: 6 additions & 6 deletions ...ies/System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Avx2.PlatformNotSupported.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1710,20 +1710,20 @@ internal X64() { }

/// <summary>
/// <para>__m256i _mm256_permutevar8x32_epi32 (__m256i a, __m256i idx)</para>
/// <para> VPERMD ymm1, ymm2/m256, imm8</para>
/// <para> VPERMD ymm1 {k1}{z}, ymm2/m256/m32bcst, imm8</para>
/// <para> VPERMD ymm1, ymm2, ymm3/m256, </para>
/// <para> VPERMD ymm1 {k1}{z}, ymm2, ymm3/m256/m32bcst</para>
/// </summary>
public static Vector256<int> PermuteVar8x32(Vector256<int> left, Vector256<int> control) { throw new PlatformNotSupportedException(); }
/// <summary>
/// <para>__m256i _mm256_permutevar8x32_epi32 (__m256i a, __m256i idx)</para>
/// <para> VPERMD ymm1, ymm2/m256, imm8</para>
/// <para> VPERMD ymm1 {k1}{z}, ymm2/m256/m32bcst, imm8</para>
/// <para> VPERMD ymm1, ymm2, ymm3/m256, </para>
/// <para> VPERMD ymm1 {k1}{z}, ymm2, ymm3/m256/m32bcst</para>
/// </summary>
public static Vector256<uint> PermuteVar8x32(Vector256<uint> left, Vector256<uint> control) { throw new PlatformNotSupportedException(); }
/// <summary>
/// <para>__m256 _mm256_permutevar8x32_ps (__m256 a, __m256i idx)</para>
/// <para> VPERMPS ymm1, ymm2/m256, imm8</para>
/// <para> VPERMPS ymm1 {k1}{z}, ymm2/m256/m32bcst, imm8</para>
/// <para> VPERMPS ymm1, ymm2, ymm3/m256, </para>
/// <para> VPERMPS ymm1 {k1}{z}, ymm2, ymm3/m256/m32bcst</para>
/// </summary>
public static Vector256<float> PermuteVar8x32(Vector256<float> left, Vector256<int> control) { throw new PlatformNotSupportedException(); }

Expand Down
12 changes: 6 additions & 6 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Avx2.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2190,20 +2190,20 @@ public static unsafe Vector256<double> GatherMaskVector256(Vector256<double> sou

/// <summary>
/// <para>__m256i _mm256_permutevar8x32_epi32 (__m256i a, __m256i idx)</para>
/// <para> VPERMD ymm1, ymm2/m256, imm8</para>
/// <para> VPERMD ymm1 {k1}{z}, ymm2/m256/m32bcst, imm8</para>
/// <para> VPERMD ymm1, ymm2, ymm3/m256, </para>
/// <para> VPERMD ymm1 {k1}{z}, ymm2, ymm3/m256/m32bcst</para>
/// </summary>
public static Vector256<int> PermuteVar8x32(Vector256<int> left, Vector256<int> control) => PermuteVar8x32(left, control);
/// <summary>
/// <para>__m256i _mm256_permutevar8x32_epi32 (__m256i a, __m256i idx)</para>
/// <para> VPERMD ymm1, ymm2/m256, imm8</para>
/// <para> VPERMD ymm1 {k1}{z}, ymm2/m256/m32bcst, imm8</para>
/// <para> VPERMD ymm1, ymm2, ymm3/m256, </para>
/// <para> VPERMD ymm1 {k1}{z}, ymm2, ymm3/m256/m32bcst</para>
/// </summary>
public static Vector256<uint> PermuteVar8x32(Vector256<uint> left, Vector256<uint> control) => PermuteVar8x32(left, control);
/// <summary>
/// <para>__m256 _mm256_permutevar8x32_ps (__m256 a, __m256i idx)</para>
/// <para> VPERMPS ymm1, ymm2/m256, imm8</para>
/// <para> VPERMPS ymm1 {k1}{z}, ymm2/m256/m32bcst, imm8</para>
/// <para> VPERMPS ymm1, ymm2, ymm3/m256, </para>
/// <para> VPERMPS ymm1 {k1}{z}, ymm2, ymm3/m256/m32bcst</para>
/// </summary>
public static Vector256<float> PermuteVar8x32(Vector256<float> left, Vector256<int> control) => PermuteVar8x32(left, control);

Expand Down
12 changes: 6 additions & 6 deletions ...System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Avx512BW.PlatformNotSupported.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,12 +281,12 @@ internal VL() { }
public static Vector128<sbyte> ConvertToVector128SByteWithSaturation(Vector256<short> value) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m128i _mm_permutevar8x16_epi16 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi16 (__m128i idx, __m128i a)</para>
/// <para> VPERMW xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<short> PermuteVar8x16(Vector128<short> left, Vector128<short> control) { throw new PlatformNotSupportedException(); }
/// <summary>
/// <para>__m128i _mm_permutevar8x16_epi16 (__m128i a, __m128i b)</para>
/// <para>__m128i _mm_permutexvar_epi16 (__m128i idx, __m128i a)</para>
/// <para> VPERMW xmm1 {k1}{z}, xmm2, xmm3/m128</para>
/// </summary>
public static Vector128<ushort> PermuteVar8x16(Vector128<ushort> left, Vector128<ushort> control) { throw new PlatformNotSupportedException(); }
Expand All @@ -305,12 +305,12 @@ internal VL() { }
public static Vector128<ushort> PermuteVar8x16x2(Vector128<ushort> lower, Vector128<ushort> indices, Vector128<ushort> upper) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m256i _mm256_permutevar16x16_epi16 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi16 (__m256i idx, __m256i a)</para>
/// <para> VPERMW ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<short> PermuteVar16x16(Vector256<short> left, Vector256<short> control) { throw new PlatformNotSupportedException(); }
/// <summary>
/// <para>__m256i _mm256_permutevar16x16_epi16 (__m256i a, __m256i b)</para>
/// <para>__m256i _mm256_permutexvar_epi16 (__m256i idx, __m256i a)</para>
/// <para> VPERMW ymm1 {k1}{z}, ymm2, ymm3/m256</para>
/// </summary>
public static Vector256<ushort> PermuteVar16x16(Vector256<ushort> left, Vector256<ushort> control) { throw new PlatformNotSupportedException(); }
Expand Down Expand Up @@ -823,12 +823,12 @@ internal X64() { }
public static Vector512<ushort> PackUnsignedSaturate(Vector512<int> left, Vector512<int> right) { throw new PlatformNotSupportedException(); }

/// <summary>
/// <para>__m512i _mm512_permutevar32x16_epi16 (__m512i a, __m512i b)</para>
/// <para>__m512i _mm512_permutexvar_epi16 (__m512i idx, __m512i a)</para>
/// <para> VPERMW zmm1 {k1}{z}, zmm2, zmm3/m512</para>
/// </summary>
public static Vector512<short> PermuteVar32x16(Vector512<short> left, Vector512<short> control) { throw new PlatformNotSupportedException(); }
/// <summary>
/// <para>__m512i _mm512_permutevar32x16_epi16 (__m512i a, __m512i b)</para>
/// <para>__m512i _mm512_permutexvar_epi16 (__m512i idx, __m512i a)</para>
/// <para> VPERMW zmm1 {k1}{z}, zmm2, zmm3/m512</para>
/// </summary>
public static Vector512<ushort> PermuteVar32x16(Vector512<ushort> left, Vector512<ushort> control) { throw new PlatformNotSupportedException(); }
Expand Down
Loading
Loading