RGB.NET/RGB.NET.Core/Extensions/MathExtensions.cs

using System;
using System.Runtime.CompilerServices;

namespace RGB.NET.Core
{
    /// <summary>
    /// Offers some extensions and helper-methods for the work with doubles
    /// </summary>
    public static class DoubleExtensions
    {
        #region Constants

        /// <summary>
        /// Defines the precision RGB.NET processes floating point comparisons in.
        /// </summary>
        public const double TOLERANCE = 1E-10;

        #endregion

        #region Methods

        /// <summary>
        /// Checks if two values are equal respecting the <see cref="TOLERANCE"/>.
        /// </summary>
        /// <param name="value1">The first value to compare.</param>
        /// <param name="value2">The first value to compare.</param>
        /// <returns><c>true</c> if the difference is smaller than the <see cref="TOLERANCE"/>; otherwise, <c>false</c>.</returns>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static bool EqualsInTolerance(this double value1, double value2) => Math.Abs(value1 - value2) < TOLERANCE;

        /// <summary>
        /// Clamps the provided value to be bigger or equal min and smaller or equal max.
        /// </summary>
        /// <param name="value">The value to clamp.</param>
        /// <param name="min">The lower value of the range the value is clamped to.</param>
        /// <param name="max">The higher value of the range the value is clamped to.</param>
        /// <returns>The clamped value.</returns>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static double Clamp(this double value, double min, double max) => Math.Max(min, Math.Min(max, value));

        /// <summary>
        /// Clamps the provided value to be bigger or equal min and smaller or equal max.
        /// </summary>
        /// <param name="value">The value to clamp.</param>
        /// <param name="min">The lower value of the range the value is clamped to.</param>
        /// <param name="max">The higher value of the range the value is clamped to.</param>
        /// <returns>The clamped value.</returns>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static int Clamp(this int value, int min, int max) => Math.Max(min, Math.Min(max, value));

        /// <summary>
        /// Enforces the provided value to be in the specified range by wrapping it around the edges if it exceeds them.
        /// </summary>
        /// <param name="value">The value to wrap.</param>
        /// <param name="min">The lower value of the range the value is wrapped into.</param>
        /// <param name="max">The higher value of the range the value is wrapped into.</param>
        /// <returns>The wrapped value.</returns>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static double Wrap(this double value, double min, double max)
        {
            double range = max - min;

            while (value >= max)
                value -= range;

            while (value < min)
                value += range;

            return value;
        }
        
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static byte GetByteValueFromPercentage(this double percentage)
        {
            if (double.IsNaN(percentage)) return 0;

            percentage = percentage.Clamp(0, 1.0);
            return (byte)(percentage.Equals(1.0) ? 255 : percentage * 256.0);
        }
        
        #endregion
    }
}