[API Proposal]: Add missing Min/MaxNumber generic math APIs on TensorPrimitives

[stephentoub]

Background and motivation

These slipped through when aiming for parity.

API Proposal

namespace System.Numerics.Tensors;

public static class TensorPrimitives
{
    // Same surface area as Min/Max{Magnitude}, but for Min/Max{Magnitude}Number
+   public static int IndexOfMaxNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
+   public static int IndexOfMinNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
+   public static int IndexOfMaxMagnitudeNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
+   public static int IndexOfMinMagnitudeNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;

+   public static T MaxMagnitudeNumber<T>(ReadOnlySpan<T> x) where T : INumberBase<T>;
+   public static void MaxMagnitudeNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, System.Span<T> destination) where T : INumberBase<T>;
+   public static void MaxMagnitudeNumber<T>(ReadOnlySpan<T> x, T y, Span<T> destination) where T : INumberBase<T>;

+   public static T MaxNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
+   public static void MaxNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination) where T : INumber<T>;
+   public static void MaxNumber<T>(ReadOnlySpan<T> x, T y, Span<T> destination) where T : INumber<T>;

+   public static T MinMagnitudeNumber<T>(ReadOnlySpan<T> x) where T : INumberBase<T>;
+   public static void MinMagnitudeNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination) where T : INumberBase<T>;
+   public static void MinMagnitudeNumber<T>(ReadOnlySpan<T> x, T y, Span<T> destination) where T : INumberBase<T>;

+   public static T MinNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
+   public static void MinNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination) where T : INumber<T>;
+   public static void MinNumber<T>(ReadOnlySpan<T> x, T y, Span<T> destination) where T : INumber<T>;
}

API Usage

TensorPrimitives.MaxMagnitude(x, y, dest);

Alternative Designs

No response

Risks

No response

[ghost]

Tagging subscribers to this area: @dotnet/area-system-numerics-tensors
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Background and motivation

These slipped through when aiming for parity.

API Proposal

namespace System.Numerics.Tensors;

public static class TensorPrimitives
{
    // Same surface area as Min/Max{Magnitude}, but for Min/Max{Magnitude}Number
+   public static int IndexOfMaxNumber<T>(System.ReadOnlySpan<T> x) where T : INumber<T>;
+   public static int IndexOfMinNumber<T>(System.ReadOnlySpan<T> x) where T : INumber<T>;
+   public static int IndexOfMaxMagnitudeNumber<T>(System.ReadOnlySpan<T> x) where T : INumber<T>;
+   public static int IndexOfMinMagnitudeNumber<T>(System.ReadOnlySpan<T> x) where T : INumber<T>;

+   public static T MaxMagnitudeNumber<T>(System.ReadOnlySpan<T> x) where T : INumberBase<T>;
+   public static void MaxMagnitudeNumber<T>(System.ReadOnlySpan<T> x, System.ReadOnlySpan<T> y, System.Span<T> destination) where T : INumberBase<T>;
+   public static void MaxMagnitudeNumber<T>(System.ReadOnlySpan<T> x, T y, System.Span<T> destination) where T : INumberBase<T>;

+   public static T MaxNumber<T>(System.ReadOnlySpan<T> x) where T : INumber<T>;
+   public static void MaxNumber<T>(System.ReadOnlySpan<T> x, System.ReadOnlySpan<T> y, System.Span<T> destination) where T : INumber<T>;
+   public static void MaxNumber<T>(System.ReadOnlySpan<T> x, T y, System.Span<T> destination) where T : INumber<T>;

+   public static T MinMagnitudeNumber<T>(System.ReadOnlySpan<T> x) where T : INumberBase<T>;
+   public static void MinMagnitudeNumber<T>(System.ReadOnlySpan<T> x, System.ReadOnlySpan<T> y, System.Span<T> destination) where T : INumberBase<T>;
+   public static void MinMagnitudeNumber<T>(System.ReadOnlySpan<T> x, T y, System.Span<T> destination) where T : INumberBase<T>;

+   public static T MinNumber<T>(System.ReadOnlySpan<T> x) where T : INumber<T>;
+   public static void MinNumber<T>(System.ReadOnlySpan<T> x, System.ReadOnlySpan<T> y, System.Span<T> destination) where T : INumber<T>;
+   public static void MinNumber<T>(System.ReadOnlySpan<T> x, T y, System.Span<T> destination) where T : INumber<T>;
}

API Usage

TensorPrimitives.MaxMagnitude(x, y, dest);

Alternative Designs

No response

Risks

No response

Author:	stephentoub
Assignees:	-
Labels:	area-System.Numerics.Tensors, api-ready-for-review
Milestone:	-

[eiriktsarpalis]

The Number suffix feels redundant, is it intended to disambiguate from existing method groups?

[bartonjs]

Video

• Looks good as proposed

namespace System.Numerics.Tensors;

public static class TensorPrimitives
{
    // Same surface area as Min/Max{Magnitude}, but for Min/Max{Magnitude}Number
    public static int IndexOfMaxNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
    public static int IndexOfMinNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
    public static int IndexOfMaxMagnitudeNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
    public static int IndexOfMinMagnitudeNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;

    public static T MaxMagnitudeNumber<T>(ReadOnlySpan<T> x) where T : INumberBase<T>;
    public static void MaxMagnitudeNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, System.Span<T> destination) where T : INumberBase<T>;
    public static void MaxMagnitudeNumber<T>(ReadOnlySpan<T> x, T y, Span<T> destination) where T : INumberBase<T>;

    public static T MaxNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
    public static void MaxNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination) where T : INumber<T>;
    public static void MaxNumber<T>(ReadOnlySpan<T> x, T y, Span<T> destination) where T : INumber<T>;

    public static T MinMagnitudeNumber<T>(ReadOnlySpan<T> x) where T : INumberBase<T>;
    public static void MinMagnitudeNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination) where T : INumberBase<T>;
    public static void MinMagnitudeNumber<T>(ReadOnlySpan<T> x, T y, Span<T> destination) where T : INumberBase<T>;

    public static T MinNumber<T>(ReadOnlySpan<T> x) where T : INumber<T>;
    public static void MinNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination) where T : INumber<T>;
    public static void MinNumber<T>(ReadOnlySpan<T> x, T y, Span<T> destination) where T : INumber<T>;
}