/// <summary>
/// Extension method that allows for <see cref="NonIntegralRangeBase{TIntegralType}.Constrain"/>
/// to be called on a <see cref="Double"/> subject with the range and exclusivity passed as a
/// parameter, rather than on the <see cref="NonIntegralRangeBase{TIntegralType}"/> object
/// with a <see cref="Double"/> parameter.
/// </summary>
/// <param name="this">
/// The subject <see cref="Double"/> value in which to check against the <paramref name="range"/>
/// parameter to constrain a value within a range with an implicit inclusive comparison mode.
/// </param>
/// <param name="range">
/// An instance of the type <see cref="DoubleRange"/>, describing a range of numeric values in
/// which the <paramref name="this"/> subject is to be compared against.
/// </param>
/// <exception cref="ArgumentNullException">
/// Thrown when the specified <paramref name="range"/> is <see langword="null"/>.
/// </exception>
/// <returns>
/// A <see cref="Double"/> value that is the <paramref name="this"/> subject value adjusted to
/// force the range of possible values to be within the provided <paramref cref="range"/>
/// parameter, using <see cref="EndpointExclusivity.Inclusive"/> as the comparison mode.
/// </returns>
public static Double Constrain(
this Double @this,
[NotNull] DoubleRange range)
{
range.IsNotNull(nameof(range));
return(range
.Constrain(
@this));
}
/// <summary>
/// Extension method that allows for <see cref="NonIntegralRangeBase{TIntegralType}.IsNotWithin"/>
/// to be called on a <see cref="Double"/> subject with the range and exclusivity passed as a
/// parameter, rather than on the <see cref="NonIntegralRangeBase{TIntegralType}"/> object
/// with a <see cref="Double"/> parameter.
/// </summary>
/// <param name="this">
/// The subject <see cref="Double"/> value in which to check against the <paramref name="range"/>
/// parameter to determine whether it is within the range, taking into account the exclusivity.
/// </param>
/// <param name="range">
/// An instance of the type <see cref="DoubleRange"/>, describing a range of numeric values in
/// which the <paramref name="this"/> subject is to be compared against.
/// </param>
/// <param name="exclusivity">
/// A value indicating whether to perform the upper and lower bounds comparisons including
/// the range's Minimum and Maximum bounds, or to exclude them. This parameter is optional,
/// and the default value is <see cref="EndpointExclusivity.Inclusive"/>.
/// </param>
/// <exception cref="ArgumentNullException">
/// Thrown when the specified <paramref name="range"/> is <see langword="null"/>.
/// </exception>
/// <returns>
/// A <see cref="Double"/> value indicating whether or not the <paramref name="this"/> subject
/// is within the provided <paramref cref="range"/> parameter, taking into account the
/// <see cref="EndpointExclusivity"/> mode via the <paramref name="exclusivity"/> parameter.
/// This comparison is the logical inverse of the <see cref="IsNotWithin"/> extension method.
/// </returns>
public static bool IsNotWithin(
this Double @this,
[NotNull] DoubleRange range,
EndpointExclusivity exclusivity = EndpointExclusivity.Inclusive)
{
range.IsNotNull(nameof(range));
return(range
.IsNotWithin(
@this,
exclusivity));
}
/// <summary>
/// Extension method that performs a transformation on the <see cref="Double"/> subject using
/// linear mapping to re-map from the provided initial range <paramref name="startRange"/>
/// to the target range <paramref name="endRange"/>.
/// </summary>
/// <param name="this">
/// The subject <see cref="Double"/> to perform the linear map range re-mapping upon.
/// </param>
/// <param name="startRange">
/// An instance of the type <see cref="DoubleRange"/>, describing a range of numeric values in
/// which the linear re-mapping uses as the inital range of the subject.
/// </param>
/// <param name="endRange">
/// An instance of the type <see cref="DoubleRange"/>, describing a range of numeric values in
/// which the linear re-mapping uses as the target range of the return value.
/// </param>
/// <exception cref="ArgumentNullException">
/// Thrown when either the <paramref name="startRange"/> or the <paramref name="endRange"/>
/// parameters are equal to <see langword="null"/>.
/// </exception>
/// <returns>
/// A <see cref="Double"/> value that has been linearly mapped to the <paramref name="startRange"/>
/// parameter and re-mapped to the <paramref name="endRange"/> parameter.
/// </returns>
public static Double LinearMap(
this Double @this,
[NotNull] DoubleRange startRange,
[NotNull] DoubleRange endRange)
{
startRange.IsNotNull(nameof(startRange));
endRange.IsNotNull(nameof(endRange));
return((
(@this - startRange.Minimum) *
(endRange.Maximum - endRange.Minimum) /
(startRange.Maximum - startRange.Minimum) +
endRange.Minimum)
.To <Double>());
}
public static void ThrowIfNotWithin(
[AssertionCondition(IS_NOT_NULL)] this Double @this,
[NotNull] DoubleRange range,
[InvokerParameterName] string elementName,
EndpointExclusivity exclusivity = Inclusive,
[CallerMemberName] string callerMemberName = "")
{
range.IsNotNull(nameof(range));
if (range
.IsNotWithin(
@this,
exclusivity))
throw new ArgumentOutOfRangeException(
elementName,
$"Parameter {elementName.SQuote()} passed to the method {callerMemberName.SQuote()} " +
$"must be within [{range.Minimum} and {range.Maximum}], {exclusivity}ly.");
}