From 7af3c96405b96b15751f8cd91f7dbccc360b81c2 Mon Sep 17 00:00:00 2001
From: Oliver Booth <git@olivr.me>
Date: Thu, 14 Nov 2024 16:42:20 +0000
Subject: [PATCH] refactor: replace T.Saturate for float types with generic
 math

---
 CHANGELOG.md                       |  1 +
 X10D/src/Math/DecimalExtensions.cs | 13 -------------
 X10D/src/Math/DoubleExtensions.cs  | 13 -------------
 X10D/src/Math/NumberExtensions.cs  | 16 ++++++++++++++++
 4 files changed, 17 insertions(+), 26 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 43469b0c1..ada6f5447 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - X10D: Removed `IEnumerable<T>.LowestCommonMultiple` for all integer types in favour of generic math.
 - X10D: Removed `IEnumerable<T>.Product` for all integer types in favour of generic math.
 - X10D: Removed `IEnumerable<T>.RangeTo` for all integer types in favour of generic math.
+- X10D: Removed `T.Saturate` for all floating-point types in favour of generic math.
 - X10D: Removed `T.Sign` for all numeric types in favour of generic math.
 - X10D: Removed `T.Wrap` for all numeric types in favour of generic math.
 
diff --git a/X10D/src/Math/DecimalExtensions.cs b/X10D/src/Math/DecimalExtensions.cs
index 07db13d93..af1a9ed39 100644
--- a/X10D/src/Math/DecimalExtensions.cs
+++ b/X10D/src/Math/DecimalExtensions.cs
@@ -77,19 +77,6 @@ public static decimal Round(this decimal value, decimal nearest)
         return System.Math.Round(value / nearest) * nearest;
     }
 
-    /// <summary>
-    ///     Saturates this decimal number.
-    /// </summary>
-    /// <param name="value">The value to saturate.</param>
-    /// <returns>The saturated value.</returns>
-    /// <remarks>This method clamps <paramref name="value" /> between 0 and 1.</remarks>
-    [Pure]
-    [MethodImpl(CompilerResources.MaxOptimization)]
-    public static decimal Saturate(this decimal value)
-    {
-        return System.Math.Clamp(value, 0.0m, 1.0m);
-    }
-
     /// <summary>
     ///     Returns the square root of this decimal number.
     /// </summary>
diff --git a/X10D/src/Math/DoubleExtensions.cs b/X10D/src/Math/DoubleExtensions.cs
index 0ca716c08..33ee4813c 100644
--- a/X10D/src/Math/DoubleExtensions.cs
+++ b/X10D/src/Math/DoubleExtensions.cs
@@ -255,19 +255,6 @@ public static double Round(this double value, double nearest)
         return System.Math.Round(value / nearest) * nearest;
     }
 
-    /// <summary>
-    ///     Saturates this double-precision floating-point number.
-    /// </summary>
-    /// <param name="value">The value to saturate.</param>
-    /// <returns>The saturated value.</returns>
-    /// <remarks>This method clamps <paramref name="value" /> between 0 and 1.</remarks>
-    [Pure]
-    [MethodImpl(CompilerResources.MaxOptimization)]
-    public static double Saturate(this double value)
-    {
-        return System.Math.Clamp(value, 0.0, 1.0);
-    }
-
     /// <summary>
     ///     Returns the sine of the specified angle.
     /// </summary>
diff --git a/X10D/src/Math/NumberExtensions.cs b/X10D/src/Math/NumberExtensions.cs
index 6f14fdc24..3fdcc7ca3 100644
--- a/X10D/src/Math/NumberExtensions.cs
+++ b/X10D/src/Math/NumberExtensions.cs
@@ -113,6 +113,22 @@ public static TNumber Mod<TNumber>(this TNumber dividend, TNumber divisor)
         return r < TNumber.Zero ? r + divisor : r;
     }
 
+    /// <summary>
+    ///     Saturates this number.
+    /// </summary>
+    /// <param name="value">The value to saturate.</param>
+    /// <returns>The saturated value.</returns>
+    /// <remarks>
+    ///     This method clamps <paramref name="value" /> between <see cref="TNumber.Zero" /> and <see cref="TNumber.One" />.
+    /// </remarks>
+    [Pure]
+    [MethodImpl(CompilerResources.MaxOptimization)]
+    public static TNumber Saturate<TNumber>(this TNumber value)
+        where TNumber : INumber<TNumber>
+    {
+        return TNumber.Clamp(value, TNumber.Zero, TNumber.One);
+    }
+
     /// <summary>
     ///     Returns an integer that indicates the sign of this number.
     /// </summary>