Skip to content

Revert "Improve ArgumentOutOfRange exception in Math.Clamp" #119276

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
jkotas merged 1 commit into from
Sep 2, 2025
Merged

Revert "Improve ArgumentOutOfRange exception in Math.Clamp" #119276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions src/libraries/System.Private.CoreLib/src/System/Double.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -940,14 +940,20 @@ bool IFloatingPoint<double>.TryWriteSignificandLittleEndian(Span<byte> destinati
/// <inheritdoc cref="INumber{TSelf}.Clamp(TSelf, TSelf, TSelf)" />
public static double Clamp(double value, double min, double max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
Math.ThrowMinMaxException(min, max);
}
return Min(Max(value, min), max);
}

/// <inheritdoc cref="INumber{TSelf}.ClampNative(TSelf, TSelf, TSelf)" />
public static double ClampNative(double value, double min, double max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
Math.ThrowMinMaxException(min, max);
}
return MinNative(MaxNative(value, min), max);
}

Expand Down
5 changes: 4 additions & 1 deletion src/libraries/System.Private.CoreLib/src/System/Half.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1644,7 +1644,10 @@ public static int ILogB(Half x)
/// <inheritdoc cref="INumber{TSelf}.ClampNative(TSelf, TSelf, TSelf)" />
public static Half ClampNative(Half value, Half min, Half max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
Math.ThrowMinMaxException(min, max);
}
return MinNative(MaxNative(value, min), max);
}

Expand Down
5 changes: 4 additions & 1 deletion src/libraries/System.Private.CoreLib/src/System/Int128.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1201,7 +1201,10 @@ public static Int128 BigMul(Int128 left, Int128 right, out Int128 lower)
/// <inheritdoc cref="INumber{TSelf}.Clamp(TSelf, TSelf, TSelf)" />
public static Int128 Clamp(Int128 value, Int128 min, Int128 max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
Math.ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand Down
67 changes: 53 additions & 14 deletions src/libraries/System.Private.CoreLib/src/System/Math.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,10 @@ public static decimal Ceiling(decimal d)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static byte Clamp(byte value, byte min, byte max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -542,7 +545,10 @@ public static byte Clamp(byte value, byte min, byte max)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static decimal Clamp(decimal value, decimal min, decimal max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -559,7 +565,10 @@ public static decimal Clamp(decimal value, decimal min, decimal max)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static double Clamp(double value, double min, double max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -576,7 +585,10 @@ public static double Clamp(double value, double min, double max)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static short Clamp(short value, short min, short max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -593,7 +605,10 @@ public static short Clamp(short value, short min, short max)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static int Clamp(int value, int min, int max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -610,7 +625,10 @@ public static int Clamp(int value, int min, int max)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static long Clamp(long value, long min, long max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand Down Expand Up @@ -642,7 +660,10 @@ public static long Clamp(long value, long min, long max)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static nint Clamp(nint value, nint min, nint max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -660,7 +681,10 @@ public static nint Clamp(nint value, nint min, nint max)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static sbyte Clamp(sbyte value, sbyte min, sbyte max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -677,7 +701,10 @@ public static sbyte Clamp(sbyte value, sbyte min, sbyte max)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static float Clamp(float value, float min, float max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -695,7 +722,10 @@ public static float Clamp(float value, float min, float max)
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static ushort Clamp(ushort value, ushort min, ushort max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -713,7 +743,10 @@ public static ushort Clamp(ushort value, ushort min, ushort max)
[CLSCompliant(false)]
public static uint Clamp(uint value, uint min, uint max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -731,7 +764,10 @@ public static uint Clamp(uint value, uint min, uint max)
[CLSCompliant(false)]
public static ulong Clamp(ulong value, ulong min, ulong max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand Down Expand Up @@ -764,7 +800,10 @@ public static ulong Clamp(ulong value, ulong min, ulong max)
[CLSCompliant(false)]
public static nuint Clamp(nuint value, nuint min, nuint max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand Down Expand Up @@ -1457,7 +1496,7 @@ public static unsafe double Truncate(double d)
[DoesNotReturn]
internal static void ThrowMinMaxException<T>(T min, T max)
{
throw new ArgumentOutOfRangeException(nameof(max), max, SR.Format(SR.ArgumentOutOfRange_Generic_MustBeGreaterOrEqual, nameof(max), max, min));
throw new ArgumentException(SR.Format(SR.Argument_MinMaxValue, min, max));
}

public static double ScaleB(double x, int n)
Expand Down
10 changes: 8 additions & 2 deletions src/libraries/System.Private.CoreLib/src/System/Single.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -937,14 +937,20 @@ bool IFloatingPoint<float>.TryWriteSignificandLittleEndian(Span<byte> destinatio
/// <inheritdoc cref="INumber{TSelf}.Clamp(TSelf, TSelf, TSelf)" />
public static float Clamp(float value, float min, float max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
Math.ThrowMinMaxException(min, max);
}
return Min(Max(value, min), max);
}

/// <inheritdoc cref="INumber{TSelf}.ClampNative(TSelf, TSelf, TSelf)" />
public static float ClampNative(float value, float min, float max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
Math.ThrowMinMaxException(min, max);
}
return MinNative(MaxNative(value, min), max);
}

Expand Down
5 changes: 4 additions & 1 deletion src/libraries/System.Private.CoreLib/src/System/UInt128.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1399,7 +1399,10 @@ public static UInt128 BigMul(UInt128 left, UInt128 right, out UInt128 lower)
/// <inheritdoc cref="INumber{TSelf}.Clamp(TSelf, TSelf, TSelf)" />
public static UInt128 Clamp(UInt128 value, UInt128 min, UInt128 max)
{
ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
Math.ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand Down
3 changes: 3 additions & 0 deletions src/libraries/System.Runtime.Numerics/src/Resources/Strings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@
<data name="Argument_InvalidHexStyle" xml:space="preserve">
<value>With the AllowHexSpecifier bit set in the enum bit field, the only other valid bits that can be combined into the enum value must be a subset of those in HexNumber.</value>
</data>
<data name="Argument_MinMaxValue" xml:space="preserve">
<value>'{0}' cannot be greater than {1}.</value>
</data>
<data name="Argument_MustBeBigInt" xml:space="preserve">
<value>The parameter must be a BigInteger.</value>
</data>
Expand Down
11 changes: 10 additions & 1 deletion src/libraries/System.Runtime.Numerics/src/System/Numerics/BigInteger.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3947,7 +3947,10 @@ public static BigInteger Clamp(BigInteger value, BigInteger min, BigInteger max)
min.AssertValid();
max.AssertValid();

ArgumentOutOfRangeException.ThrowIfLessThan(max, min);
if (min > max)
{
ThrowMinMaxException(min, max);
}

if (value < min)
{
Expand All @@ -3959,6 +3962,12 @@ public static BigInteger Clamp(BigInteger value, BigInteger min, BigInteger max)
}

return value;

[DoesNotReturn]
static void ThrowMinMaxException<T>(T min, T max)
{
throw new ArgumentException(SR.Format(SR.Argument_MinMaxValue, min, max));
}
}

/// <inheritdoc cref="INumber{TSelf}.CopySign(TSelf, TSelf)" />
Expand Down
28 changes: 14 additions & 14 deletions src/libraries/System.Runtime/tests/System.Runtime.Extensions.Tests/System/Math.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2212,20 +2212,20 @@ public static void Clamp_Decimal(decimal value, decimal min, decimal max, decima
}

[Fact]
public static void Clamp_MinGreaterThanMax_ThrowsArgumentOutOfRangeException()
{
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((sbyte)1, (sbyte)2, (sbyte)1));
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((byte)1, (byte)2, (byte)1));
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((short)1, (short)2, (short)1));
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((ushort)1, (ushort)2, (ushort)1));
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((int)1, (int)2, (int)1));
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((uint)1, (uint)2, (uint)1));
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((long)1, (long)2, (long)1));
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((ulong)1, (ulong)2, (ulong)1));

AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((float)1, (float)2, (float)1));
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((double)1, (double)2, (double)1));
AssertExtensions.Throws<ArgumentOutOfRangeException>("max", () => Math.Clamp((decimal)1, (decimal)2, (decimal)1));
public static void Clamp_MinGreaterThanMax_ThrowsArgumentException()
{
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((sbyte)1, (sbyte)2, (sbyte)1));
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((byte)1, (byte)2, (byte)1));
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((short)1, (short)2, (short)1));
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((ushort)1, (ushort)2, (ushort)1));
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((int)1, (int)2, (int)1));
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((uint)1, (uint)2, (uint)1));
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((long)1, (long)2, (long)1));
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((ulong)1, (ulong)2, (ulong)1));

AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((float)1, (float)2, (float)1));
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((double)1, (double)2, (double)1));
AssertExtensions.Throws<ArgumentException>(null, () => Math.Clamp((decimal)1, (decimal)2, (decimal)1));
}

[Theory]
Expand Down