Skip to content

Fix documentation for LoadAndPack* methods in TeddyHelper #118178

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
merged 2 commits into from
Aug 11, 2025
Merged

Fix documentation for LoadAndPack* methods in TeddyHelper #118178

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15bde26
Fix documentation for `LoadAndPack*` methods in `TeddyHelper`
xtqqczze Jul 29, 2025
1b5cf3b
Fix error CS1584
xtqqczze Jul 29, 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: 18 additions & 6 deletions src/libraries/System.Private.CoreLib/src/System/SearchValues/Strings/Helpers/TeddyHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,12 @@ public static (Vector512<byte> Result, Vector512<byte> Prev0, Vector512<byte> Pr
return (result, match0, match1);
}

// Read two Vector512<ushort> and concatenate their lower bytes together into a single Vector512<byte>.
// On X86, characters above 32767 are turned into 0, but we account for that by not using Teddy if any of the string values contain a 0.
/// <summary>
/// Read two <see cref="Vector128&lt;UInt16&gt;" /> and concatenate their lower bytes together into a single <see cref="Vector128&lt;Byte&gt;" />.
/// </summary>
/// <remarks>
/// On X86, characters above 32767 are turned into 0, but we account for that by not using Teddy if any of the string values contain a 0.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[CompExactlyDependsOn(typeof(Sse2))]
[CompExactlyDependsOn(typeof(AdvSimd))]
Expand All @@ -233,8 +237,12 @@ public static Vector128<byte> LoadAndPack16AsciiChars(ref char source)
}
}

// Read two Vector512<ushort> and concatenate their lower bytes together into a single Vector512<byte>.
// Characters above 32767 are turned into 0, but we account for that by not using Teddy if any of the string values contain a 0.
/// <summary>
/// Read two <see cref="Vector256&lt;UInt16&gt;" /> and concatenate their lower bytes together into a single <see cref="Vector256&lt;Byte&gt;" />.
/// </summary>
/// <remarks>
/// On X86, characters above 32767 are turned into 0, but we account for that by not using Teddy if any of the string values contain a 0.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[CompExactlyDependsOn(typeof(Avx2))]
public static Vector256<byte> LoadAndPack32AsciiChars(ref char source)
Expand All @@ -247,8 +255,12 @@ public static Vector256<byte> LoadAndPack32AsciiChars(ref char source)
return PackedSpanHelpers.FixUpPackedVector256Result(packed);
}

// Read two Vector512<ushort> and concatenate their lower bytes together into a single Vector512<byte>.
// Characters above 32767 are turned into 0, but we account for that by not using Teddy if any of the string values contain a 0.
/// <summary>
/// Read two <see cref="Vector512&lt;UInt16&gt;" /> and concatenate their lower bytes together into a single <see cref="Vector512&lt;Byte&gt;" />.
/// </summary>
/// <remarks>
/// On X86, characters above 32767 are turned into 0, but we account for that by not using Teddy if any of the string values contain a 0.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[CompExactlyDependsOn(typeof(Avx512BW))]
public static Vector512<byte> LoadAndPack64AsciiChars(ref char source)
Expand Down
Loading