Add MemoryExtensions.Min/Max#128306
Conversation
|
Tagging subscribers to this area: @dotnet/area-system-memory |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds Min and Max extension methods on ReadOnlySpan<T> (with optional IComparer<T>), mirroring LINQ's Enumerable.Min/Max semantics for spans. Includes ref assembly updates and tests.
Changes:
- New
Min/MaxReadOnlySpan extension methods with empty-span and null-element handling. - Reference assembly exposes the four new API overloads.
- New test file covering empty, all-null, mixed-null, default comparer, and custom comparer scenarios.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| src/libraries/System.Private.CoreLib/src/System/MemoryExtensions.cs | Implements Min/Max with a generic comparer fast path and null-skipping inner core. |
| src/libraries/System.Memory/ref/System.Memory.cs | Adds public surface for the four new overloads. |
| src/libraries/System.Memory/tests/System.Memory.Tests.csproj | Includes the new test file. |
| src/libraries/System.Memory/tests/ReadOnlySpan/MinMax.cs | Tests for empty/null/normal/custom-comparer behaviors. |
|
Enumerable's Min/Max already have vectorized logic implementing this. We should move that logic into these new methods, then switch LINQ to call them instead |
| /// </remarks> | ||
| [MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
| public static T? Min<T>(this ReadOnlySpan<T> span) => | ||
| Min(span, Comparer<T>.Default); |
There was a problem hiding this comment.
Much like with LINQ, this should be passing comparer: null and then we should be treating a null comparer as selecting the default, not throwing.
There was a problem hiding this comment.
@tannergooding Should we then update the approved API to explicitly accept a null comparer?
public T? Min<T>(this ReadOnlySpan<T> span, IComparer<T>? comparer);
public T? Max<T>(this ReadOnlySpan<T> span, IComparer<T>? comparer);There was a problem hiding this comment.
Nullability annotations are often overlooked in the API review. IComparer<T> parameters is a case that we almost universally allow to be nullable (much like IFormattable, IEqualityComparer, and a couple others) and where we often explicitly want it to be so we can do specific optimizations.
I've left an explicit comment indicating the oversight, so please adjust the PR accordingly.
| /// <para>If <typeparamref name="T" /> is a reference type and the span sequence is empty, this method returns <see langword="null" />.</para> | ||
| /// <para>Null values are ignored when determining the minimum value. If the span contains at least one non-null value, the minimum of those values is returned. If the span does not contain any non-null values, <see langword="null" /> is returned.</para> | ||
| /// </remarks> | ||
| public static T? Min<T>(this ReadOnlySpan<T> span, IComparer<T> comparer) |
There was a problem hiding this comment.
It's unclear why this deviates from the enumerable logic in implementation.
I'd generally expect the two entry points to be nearly identical. Covering the acceleration and other checks like: https://github.com/dotnet/runtime/blob/main/src/libraries/System.Linq/src/System/Linq/Min.cs#L292-L373
The biggest difference should be that if (!enumerator.MoveNext()) becomes if (i >= span.Length). The JIT should already know that span.Length can't be negative and should know the same of i since we initialize it to 0 and only ever do ++
There was a problem hiding this comment.
I have aligned the implementation on the enumerable logic.
| /// <typeparam name="T">The type of the elements in the span.</typeparam> | ||
| /// <param name="span">The span of values to determine the minimum value of.</param> | ||
| /// <param name="comparer">The <see cref="IComparer{T}"/> to compare values.</param> | ||
| /// <returns>The minimum value in the span.</returns> | ||
| /// <exception cref="InvalidOperationException"><paramref name="span"/> is empty and <typeparamref name="T"/> is a non-nullable value type.</exception> | ||
| /// <remarks> | ||
| /// <para>If <typeparamref name="T" /> is a reference type and the span sequence is empty, this method returns <see langword="null" />.</para> | ||
| /// <para>Null values are ignored when determining the minimum value. If the span contains at least one non-null value, the minimum of those values is returned. If the span does not contain any non-null values, <see langword="null" /> is returned.</para> | ||
| /// </remarks> | ||
| public static T? Min<T>(this ReadOnlySpan<T> span, IComparer<T>? comparer) | ||
| { | ||
| comparer ??= Comparer<T>.Default; |
MihaZupan
left a comment
There was a problem hiding this comment.
Please remove the duplicate logic in Linq and call these new helpers instead.
| /// <para>If <typeparamref name="T" /> is a reference type and the span sequence is empty, this method returns <see langword="null" />.</para> | ||
| /// <para>Null values are ignored when determining the minimum value. If the span contains at least one non-null value, the minimum of those values is returned. If the span does not contain any non-null values, <see langword="null" /> is returned.</para> | ||
| /// </remarks> | ||
| public static T? Min<T>(this ReadOnlySpan<T> span, IComparer<T>? comparer) |
There was a problem hiding this comment.
Please move all of these methods into a new MemoryExtensions.MinMax.cs file (see Trim as an example).
| ref Unsafe.As<TFrom, TTo>(ref MemoryMarshal.GetReference(span)), | ||
| span.Length); | ||
|
|
||
| private interface IMinMaxDirection |
There was a problem hiding this comment.
Can we reuse the other interface we're adding instead of having two sets?
| } | ||
|
|
||
| [MethodImpl(MethodImplOptions.AggressiveInlining)] | ||
| private static ReadOnlySpan<TTo> Cast<TFrom, TTo>(ReadOnlySpan<TFrom> span) |
There was a problem hiding this comment.
You can delete this helper and call Unsafe.BitCast<T, ...>(span) instead
| } | ||
| else | ||
| { | ||
| if (i >= span.Length) |
There was a problem hiding this comment.
| if (i >= span.Length) | |
| if (span.IsEmpty) |
This pull request adds new
MinandMaxextension methods forReadOnlySpan<T>to theSystem.Memorylibrary, allowing users to efficiently find the minimum and maximum values in a span, optionally using a custom comparer. Comprehensive unit tests are included to verify correct behavior for various data types and edge cases.New
MinandMaxmethods forReadOnlySpan<T>:Min<T>andMax<T>extension methods toMemoryExtensionsforReadOnlySpan<T>, supporting both default and custom comparers, and handling nullable and reference types gracefully. These methods throw an exception on empty spans of non-nullable value types and returnnullfor empty spans of reference or nullable types. [1] [2]Unit tests:
ReadOnlySpan/MinMax.csto cover empty spans, all-null values, custom comparers, and typical scenarios for both value and reference types.System.Memory.Tests.csprojto ensure the tests are run as part of the test suite.Fixes #127083