using System;

namespace Chernobyl.Utility
{
    /// <summary>
    /// Extension methods for <see cref="IComparable{T}"/> types.
    /// </summary>
    public static class ComparableExtensions
    {
        /// <summary>
        /// A method that limits the value of <paramref name="val"/> to the range
        /// [<paramref name="min"/>, <paramref name="max"/>], both inclusive. This method was taken
        /// from http://stackoverflow.com/a/2683487 (some minor changes were made).
        /// </summary>
        /// <typeparam name="T">The type of the value to clamp, this type must implement
        /// <see cref="IComparable{T}"/>.</typeparam>
        /// <param name="val">The value that is to be clamped.</param>
        /// <param name="min">The inclusive minimum value of <paramref name="val"/>.</param>
        /// <param name="max">The inclusive maximum value of <paramref name="val"/>.</param>
        /// <returns><paramref name="val"/> limited to the range
        /// [<paramref name="min"/>, <paramref name="max"/>].</returns>
        public static T Clamp<T>(this T val, T min, T max) where T : IComparable<T>
        {
            T value = val;

            if (val.CompareTo(min) < 0)
                value = min;
            else if (val.CompareTo(max) > 0)
                value = max;

            return value;
        }
    }
}