Xjyuk

I often find in codebases something on the order of if (sprockets.Count() > 0) which is easily replaced with LINQ's if (sprockets.Any()). This keeps the entirety of sprockets from having to be iterated over completely (to get the count) then comparing to zero. Further, the business logic often reads something like "if there are any sprockets, inform the user of the subtotal". I also often see similar logic for exactly one of something: if (sprockets.Count() == 1) which doesn't have an easy, low-cost LINQ alternative. So I've created one here:

public static bool ExactlyOne<TSource>(this IEnumerable<TSource> source)

 if (source is null)
 
 throw new ArgumentNullException(nameof(source));
 

 using (IEnumerator<TSource> enumerator = source.GetEnumerator())
 
 return enumerator.MoveNext() && !enumerator.MoveNext();
 

Usage is if (sprockets.ExactlyOne()) Here are unit tests. There is one helper method called Infinite() which is a never-ending enumerable, which will baffle sprockets.Count(), but not sprockets.ExactlyOne():

[TestClass]
public sealed class ExactlyOneTests

 [TestMethod]
 [ExpectedException(typeof(ArgumentNullException))]
 public void TestNull()
 
 int[] nullArray = null;

 Assert.IsFalse(nullArray.ExactlyOne());
 

 [TestMethod]
 public void TestZero()
 
 int[] zero = Array.Empty<int>();

 Assert.IsFalse(zero.ExactlyOne());
 

 [TestMethod]
 public void TestOne()
 
 int[] one = 1 ;

 Assert.IsTrue(one.ExactlyOne());
 

 [TestMethod]
 public void TestTwo()
 
 int[] two = 1, 2 ;

 Assert.IsFalse(two.ExactlyOne());
 

 [TestMethod]
 public void TestInfinite()
 
 IEnumerable<int> infinite = Infinite();

 Assert.IsFalse(infinite.ExactlyOne());
 

 private static IEnumerable<int> Infinite()
 
 while (true)
 
 yield return 0;
 
 

Looking for overall review - is the code readable, maintainable, performant. Do the tests cover the expected cases or are there more to consider?

Q&A

Is the code readable?

• 
  ExactlyOne states very clearly what the method is supposed to do.


• 
  source is null seems odd to me (does that even compile?). I'd prefer source == null. (Edit from comments: a topic about is null vs == null)


• 
  IEnumerator<TSource> enumerator = source.GetEnumerator() can be written as var enumerator = source.GetEnumerator().

Is the code maintainable?

• Since you are looking for a sibling function of Any<T>(), I would also include a ExactlyOne<T>(Func<T, bool> predicate).

Is the code performant?

• It does seem so, right? But notice that LINQ is optimized for IEnumerable<T> that is also ICollection<T>, in which case Count is used. Implementations should have an eager implementation of this property. Your method should also use this optimization Count == 1.


• I actually noticed (in my eyes) unexpected behavior in LINQ: Count<T>() is optimized for ICollection<T> but Any<T() is not. This means you probably could make a slightly faster implementation than LINQ.

Do the tests cover the expected cases or are there more to consider?

You cover null, empty, 1, multiple, early exit on infinite.. but perhaps also test on ICollection<T> and custom IEnumerable<T> implementations with eager and/or lazy loading.

Reference Source: LINQ Any vs Count

// not optimized for ICollection<T> (why ??)
public static bool Any<TSource>(this IEnumerable<TSource> source) 
 if (source == null) throw Error.ArgumentNull("source");
 using (IEnumerator<TSource> e = source.GetEnumerator()) 
 if (e.MoveNext()) return true;
 
 return false;


public static bool Any<TSource>(this IEnumerable<TSource> source, Func<TSource, bool> predicate) 
 if (source == null) throw Error.ArgumentNull("source");
 if (predicate == null) throw Error.ArgumentNull("predicate");
 foreach (TSource element in source) 
 if (predicate(element)) return true;
 
 return false;


// optimized for ICollection<T>
public static int Count<TSource>(this IEnumerable<TSource> source) 
 if (source == null) throw Error.ArgumentNull("source");
 ICollection<TSource> collectionoft = source as ICollection<TSource>;
 if (collectionoft != null) return collectionoft.Count;
 ICollection collection = source as ICollection;
 if (collection != null) return collection.Count;
 int count = 0;
 using (IEnumerator<TSource> e = source.GetEnumerator()) 
 checked 
 while (e.MoveNext()) count++;
 
 
 return count;

This is for dfhwze as per comment:

public static bool ExactlyOne<TSource>(this IEnumerable<TSource> source, Func<TSource, bool> predicate)

 if (source is null)
 
 throw new ArgumentNullException(nameof(source));
 

 if (predicate is null)
 
 throw new ArgumentNullException(nameof(predicate));
 

 bool gotOne = false;

 foreach (TSource element in source)
 
 if (!predicate(element))
 
 continue;
 

 if (gotOne)
 
 return false;
 

 gotOne = true;
 

 return gotOne;