Artemis/src/Artemis.Core/Models/Profile/LayerProperties/IntRange.cs

using System;

namespace Artemis.Core
{
    /// <summary>
    ///     Represents a range between two signed integers
    /// </summary>
    public class IntRange
    {
        private readonly Random _rand;

        /// <summary>
        ///     Creates a new instance of the <see cref="IntRange" /> class
        /// </summary>
        /// <param name="start">The start value of the range</param>
        /// <param name="end">The end value of the range</param>
        public IntRange(int start, int end)
        {
            Start = start;
            End = end;

            _rand = new Random();
        }

        /// <summary>
        ///     Gets or sets the start value of the range
        /// </summary>
        public int Start { get; set; }

        /// <summary>
        ///     Gets or sets the end value of the range
        /// </summary>
        public int End { get; set; }

        /// <summary>
        ///     Determines whether the given value is in this range
        /// </summary>
        /// <param name="value">The value to check</param>
        /// <param name="inclusive">
        ///     Whether the value may be equal to <see cref="Start" /> or <see cref="End" />
        ///     <para>Defaults to <see langword="true" /></para>
        /// </param>
        /// <returns></returns>
        public bool IsInRange(int value, bool inclusive = true)
        {
            if (inclusive)
                return value >= Start && value <= End;
            return value > Start && value < End;
        }

        /// <summary>
        ///     Returns a pseudo-random value between <see cref="Start" /> and <see cref="End" />
        /// </summary>
        /// <param name="inclusive">Whether the value may be equal to <see cref="Start" /></param>
        /// <returns>The pseudo-random value</returns>
        public int GetRandomValue(bool inclusive = true)
        {
            if (inclusive)
                return _rand.Next(Start, End + 1);
            return _rand.Next(Start + 1, End);
        }
    }
}