oliverbooth/X10D
oliverbooth/X10D
1
0
Fork 0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-10 04:55:42 +00:00
Code Issues

(#15) Rewrite summary for IComparable.Between

Browse Source
This commit is contained in:
Oliver Booth 2021-04-06 11:06:43 +01:00
parent c6f550d5a7
commit 9d3f2b263f
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
X10D/src/ComparableExtensions/ComparableExtensions.cs
View File

@ -8,16 +8,16 @@ namespace X10D.ComparableExtensions
public static class ComparableExtensions public static class ComparableExtensions
{ {
/// <summary> /// <summary>
/// Determines if <paramref name="actual" /> is between <paramref name="lower" /> and <paramref name="upper" />. /// Determines if a specified value falls exclusively between a specified lower bound and upper bound.
/// </summary> /// </summary>
/// <typeparam name="T1">An <see cref="IComparable{T2}" /> type.</typeparam> /// <typeparam name="T1">An <see cref="IComparable{T2}" /> type.</typeparam>
/// <typeparam name="T2">The first comparison operand type.</typeparam> /// <typeparam name="T2">The first comparison operand type.</typeparam>
/// <typeparam name="T3">The second comparison operand type.</typeparam> /// <typeparam name="T3">The second comparison operand type.</typeparam>
/// <param name="actual">The value to compare.</param> /// <param name="value">The value to compare.</param>
/// <param name="lower">The exclusive lower bound.</param> /// <param name="lower">The exclusive lower bound.</param>
/// <param name="upper">The exclusive upper bound.</param> /// <param name="upper">The exclusive upper bound.</param>
/// <returns> /// <returns>
/// <see langword="true" /> if <paramref name="actual" /> is between the <paramref name="lower"/> and /// <see langword="true" /> if <paramref name="value" /> is between the <paramref name="lower"/> and
/// <paramref name="upper"/> /// <paramref name="upper"/>
/// -or- /// -or-
/// <see langword="false" /> otherwise. /// <see langword="false" /> otherwise.
@ -43,10 +43,10 @@ namespace X10D.ComparableExtensions
/// // True /// // True
/// </code> /// </code>
/// </example> /// </example>
public static bool Between<T1, T2, T3>(this T1 actual, T2 lower, T3 upper) public static bool Between<T1, T2, T3>(this T1 value, T2 lower, T3 upper)
where T1 : IComparable<T2>, IComparable<T3> where T1 : IComparable<T2>, IComparable<T3>
{ {
return actual.CompareTo(lower) > 0 && actual.CompareTo(upper) < 0; return value.CompareTo(lower) > 0 && value.CompareTo(upper) < 0;
} }
/// <summary> /// <summary>