Click here to Skip to main content
14,634,310 members
Articles » Platforms, Frameworks & Libraries » LINQ » General

A 'Between' Extension Method for LINQ in C#

Rate this:
0.00 (No votes)
Please Sign up or sign in to vote.
0.00 (No votes)
5 Jan 2012CPOL
Here's an example of a simple LINQ extension method for getting values that fall within a certain range from an IEnumerable collection.

Here's an example of a simple LINQ extension method for getting values that fall within a certain range from an IEnumerable collection. First, we order the TSource items using the given selector. Then, we use Invoke on each item in the collection to determine if the selector's result is above the lowest value we want. If it isn't, we skip it with the SkipWhile method. Once we're at a point where we know the selector's result is at least as large as the lowest value we want, we start taking items with the TakeWhile method until the same Invoke returns a value larger than the largest item we want. Then, we just stop and return. It's a one-liner.

Picture: Linq Between Extension Method

/// <summary>
/// Returns the values in a sequence whose resulting value of the specified 
/// selector is between the lowest and highest values given in the parameters.
/// </summary>
/// <typeparam name="TSource">
/// The type of elements in the sequence.
/// </typeparam>
/// <param name="source">
/// The IEnumerable object on which this method works.
/// </param>
/// <param name="selector">
/// The selector predicate used to attain the value.
/// </param>
/// <param name="lowest">
/// The lowest value of the selector that will appear in the new list.
/// </param>
/// <param name="highest">
/// The highest value of the selector that will appear in the new list.
/// </param>
/// <returns>
/// An IEnumerable sequence of TSource whose selector values fall within the range 
/// of <paramref name="lowest"/> and <paramref name="highest"/>.
/// </returns>
public static IEnumerable<TSource> Between<TSource, TResult>
(
    this IEnumerable<TSource> source, Func<TSource, TResult> selector,
    TResult lowest, TResult highest
)
    where TResult : IComparable<TResult>
{
    return source.OrderBy(selector).
        SkipWhile(s => selector.Invoke(s).CompareTo(lowest) < 0).
        TakeWhile(s => selector.Invoke(s).CompareTo(highest) <= 0 );
}
 
/// <summary>
/// This is a simple test for the Between Linq extension method. We'll add a few
/// values to a list and select only those that are between a certain range.
/// When we're done, we should know the lowest and highest values contained
/// in the resulting values set.
/// </summary>
[TestMethod]
public void BetweenTest()
{
    var list = new List<double>();
    for (var i = 1; i <= 20; i++)
        list.Add(i);
    var fiveTo15 = list.Between(s => s, 5, 15);
    Assert.IsTrue(fiveTo15.Min() == 5);
    Assert.IsTrue(fiveTo15.Max() == 15);
}

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

qenn
Engineer
United States United States
No Biography provided

Comments and Discussions

 
Question[My vote of 2] Binary Search Pin
frblondin6-Jan-12 23:03
Memberfrblondin6-Jan-12 23:03 
QuestionNo need to require OrderBy... Pin
Matt T Heffron6-Jan-12 13:53
professionalMatt T Heffron6-Jan-12 13:53 
SuggestionOff Topic - UserID Pin
thatraja6-Jan-12 1:46
professionalthatraja6-Jan-12 1:46 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Technical Blog
Posted 5 Jan 2012

Tagged as

Stats

19.3K views
9 bookmarked