Re: How would you describe what an IEnumerable is to a bright student of C# - C# Discussion Boards

Re: How would you describe what an IEnumerable is to a bright student of C#

22-Jan-22 2:34

... I Introduction

Imagine you have bright young student sitting down with you, whom you've introduced to Linq, and generics ... and, they've had no problems mastering 'Select and 'Where, 'Aggregate, etc.

You have introduced them to the use of 'yield return' in a method to return an IEnumerable they can turn into an instance of a collection. They "get that," and get use of yield means they can skip direct assignment to a pre-defined, initialized collection, or, a collection instance reference passed in as an 'out parameter.

And you are trying to explain to them the "deferred iteration/evaluation" aspect of IEnumerable, and the way that enables some advanced practices (function chaining).

At that point, you can sense the student is hesitant; you ask her/him what's really on their minds, and, because they trust you, they tell you. They ask interesting questions like:

Is there any real reason to use an IEnumerable ?

What's so useful about deferred evaluation ?

Isn't deferred evaluation dangerous because you have no idea of what might have changed in the time between assembling the IEnumerable and iterating/evaluating it ?

Why can't I test an IEnumerable to see if it's empty, or null; why do I have to trigger iteration with 'Count() to see how many items it has, and, why can I only use 'Any to see if there are no items in it without triggering iteration..

... II Context

I speak of an IEnumerable<T> returned from a Function (C# Func) that is ready be iterated over (has items).

I've had some interesting exchanges with my esteemed colleagues @RichardDeeming and @HaroldAptroot on this subject in this recent thread, here: [^].

I won't recapitulate that thread here, both because I'd like to hear your initial responses, and, I don't want to, possibly, misrepresent Richard or Harold's views.

«The mind is not a vessel to be filled but a fire to be kindled» Plutarch

modified 22-Jan-22 15:52pm.

jschell23-Jan-22 7:25

jschell

23-Jan-22 7:25

So in terms of teaching...

BillWoodruff wrote:
What's so useful about deferred evaluation ?

The data returned is in memory.
Your computer has 32 gig of memory (or whatever it is.)
The IEnumerable returns 32 gig number of entries.
Where does it fit into memory if you did it all at once?

(Of course not saying that would be a good idea, but rather as a thought experiment.)

BillWoodruff wrote:
Why can't I test an IEnumerable to see if it's empty, or null; why do I have to trigger iteration with 'Count() to see how many items it has, and, why can I only use 'Any to see if there are no items in it without triggering iteration..

The interface can only do what the interface does. This specific interface is very old and was only designed, very likely, with in memory arrays/lists in mind. Enhancing it now would break everything.

Might want to mention there are other ways to do it that would allow one to do that even for large sets (so not bringing everything into memory.) But also mention that using linq to process large sets in memory is going to be a problem regardless.

BillWoodruff wrote:
Isn't deferred evaluation dangerous because you have no idea of what might have changed in the time between assembling the IEnumerable and iterating/evaluating it ?

What if you have the set in memory and the source changes between when you use it and then? How is that not the same problem? There is no such thing as absolute anything in the universe including time. So understand the problem and define the rules to deal with the differences that will occur. Example is ordering something online but while you are ordering something else the first item gets all used up by other people's orders. So when you finally go to pay it tells you it out of stock. When you started it was there but by the time it was needed it was gone.

Re: How would you describe what an IEnumerable is to a bright student of C#

Richard Deeming23-Jan-22 21:59

Richard Deeming

23-Jan-22 21:59

jschell wrote:
This specific interface is very old

The original non-generic version is based on COM's IEnumVARIANT[^], so it's practically prehistoric. Big Grin | :-D

"These people looked deep within my soul and assigned me a number based on the order in which I joined."
- Homer

Re: How would you describe what an IEnumerable is to a bright student of C#

BillWoodruff25-Jan-22 3:23

Re: How would you describe what an IEnumerable is to a bright student of C#

25-Jan-22 3:23

Upvoted for responding with some substance to a lonely thread.

Thanks, mixed in with your howling tautologies, is the implication you can trigger partial iteration to handle more memory than is available ... if there's a cheap way to use virtual memory with IEnumerable, I am all ears.

fyi: detailed history of generics in .NET: [^].

«The mind is not a vessel to be filled but a fire to be kindled» Plutarch

jschell30-Jan-22 6:37

jschell

30-Jan-22 6:37

BillWoodruff wrote:
if there's a cheap way to use virtual memory with IEnumerable

Large data sets still end up going to disk since "virtual memory" in the traditional sense uses the disk to get that memory.

That is why for example even though a binary sort might "seem" fast if you attempt it on a large data set that requires disk paging it not going to work. See heap sort instead.

Actions on large data sets which involve disk access always require careful design. They can't be fixed by implementation (where implementation precludes design.)

So for example that is why one must carefully consider what indexes database tables should use.
And if one is going to return a sorted list to a UI which originates from a database then from the very first design the API should have paging in it. I have seen silly designs for decades (now and then) where the UI falls over because the developer designed a UI report and tested it for 20 entries and now the major customer using it has 20 million entries. And the UI was set up to sort it in memory.

As for IEnumerable you can of course back it with anything. So for example the implementation can use a database paged query. The call to the exposed methods track the point where the last chunk was grabbed in the database and it returns the next chunk and then feeds from a chunk until that one is empty. That doesn't fix the count problem because there is no way to expose the count in the first place. So you would need to use another interface. You can of course use a double interface and then in the calling code it would need to cast to get the top level which has a count. The backing implementation would then provide the count in a better way than using the IEnumerable iterator.

But of course there are often other design problems with solutions like the above.
1. They assume that the count is a absolute. With large datasets the data very likely will be in transition. By the time you get to the end there could be more or less than the original count.
2. They right UIs with expectation that users are stupid and don't know how to do their job. So that example above with 20 entries and no other way to search becomes absolutely useless when there are 20 million entries even if it is paged. It should always have search criteria.

Re: How would you describe what an IEnumerable is to a bright student of C#

#realJSOP24-Jan-22 23:44

#realJSOP

24-Jan-22 23:44

Me: "You know how when you have two cans connected with a string and when you pull the string tight you can hear what someone says in the can at the other end of the string?"

Student: "Yeah"

Me: "Well it's not like that at all."

I think humor should be injected into every conversation...

".45 ACP - because shooting twice is just silly" - JSOP, 2010
-----
You can never have too much ammo - unless you're swimming, or on fire. - JSOP, 2010
-----
When you pry the gun from my cold dead hands, be careful - the barrel will be very hot. - JSOP, 2013

Re: How would you describe what an IEnumerable is to a bright student of C#

endo funk26-Jan-22 5:31

Re: How would you describe what an IEnumerable is to a bright student of C#

26-Jan-22 5:31

Is there any real reason to use an IEnumerable ?
Yes; first off IEnumerable was Microsoft implementation of functional programming algebras for a List. It is essentially a monadic data type that encapsulates List; monadic data types are typically designed to conform to a fairly standard set of functional algebras i.e. providing a common API for computations.

One major difference with Microsoft’s implementation; is that Microsoft decided to depart from the more familiar naming conventions used in functional programming circles, for example:
- Select is more common referred to as a Functor; and its method is more typically named Map.
- SelectMany is more commonly referred to as a Monad, and its method is more typically named FlatMap.
Microsoft's choice was to align their monadic implementation with SQL for obvious reasons; they had an existing group of programmers who would be already quite accustomed to SQL; so adopting that style of API would simplify adoption.

Category Theory
Function programming algebras are directly tied to Category Theory; hence there are specific tests (axioms) that can be performed to verify that these common computations conform to the axioms of a Functor; for example, it must preserve:
- Identity morphisms
- Commutativity re composition of morphisms
Similarly said there are rules governing the other algebras like SelectMany; which as I mentioned is a monad, etc…

The benefit of IEnumerable is the same as for any other functionally conforming type; it allows the use of a common set of algebras (common API) on the type that is encapsulated by IEnumerable. In Functional Programming; IEnumerable is not the only monadic data types that are used; there are also for example:
- Identity Monad; this is the most trivial of the monadic types; encapsulating a single value.
- Maybe Monad; a type that encapsulates an optional value; similar to the Option type in C#
- List Monad; a type that encapsulates a list of values; similar to IEnumerable type in C#
- Either Monad; a type that encapsulates a value with one of two possible outcomes.
- Validate Monad; a type like Either that is used to write data validators; because it has been designed to accumulate errors with e.g. an input form with multiple input validations that could be in error at the same time.
- etc.
This is by no means a comprehensive list of monadic data types… both for functional programming and on the large, but its also not comprehensive in terms of the C# types that have some level of implementation of functional programming algebras.

What's so useful about deferred evaluation ?
Deferred evaluation is more commonly referred to as lazy evaluation; why is it useful in Linq is simple. it allows a more expressive use of the api without incurring additional computation cost, for example:
- Multiple Where statements in a single Linq computation without the cost of performing each Where computation separately -- it's combined into a single computation.

Allow you to only incur a computational cost when its needed.
For example; some lazy evaluations may be built up during a computation block; and then never executed because of e.g. a branched operation like a cancellation; where this lazy evaluation becomes unnecessary; hence it would be preferable to not incur any computational cost until its actually needed, and most certainly not at each step (e.g. for each dot chained method call).

Infinite Lists
The other less obvious use of lazy evaluation is infinite lists; lists that are computationally far too expensive and/or impossible to compute on the whole… that is where method calls like Take, Skip come into play, for example:
- I can choose to Skip the 1st 3 entries in an infinite list of primes, and Take the next 4; without incurring the computation cost of trying to 1st populate an infinite list of primes.

Isn't deferred evaluation dangerous because you have no idea of what might have changed in the time between assembling the IEnumerable and iterating/evaluating it ?
No not at all; because the final computation would still work on essentially a snapshot of the encapsulated value at the time the lazy evaluation was computed.

Plus its considered bad design to build any system that incorporates data races — a data race occurs when two computations access the same value concurrently, and at least one of the accesses mutates the value. The problem is that it makes testing impossible, because you have no way of knowing the state of the encapsulated value; worse the mutation step may only be partially computed; leaving the value in a compromised state. It makes it impossible to test code with objects that are in an indeterminate state.

Why can't I test an IEnumerable to see if it's empty, or null; why do I have to trigger iteration with 'Count() to see how many items it has, and, why can I only use 'Any to see if there are no items in it without triggering iteration..
…because its a lazy evaluation — which is typically impossible (if not difficult) to predetermine in advance of actually computing the lazy evaluation. However Microsoft as of .Net 6 has made available a new Linq method called TryGetNonEnumeratedCount which attempts to determine the number of elements in a sequence without forcing an enumeration; failing which it reverts to forcing the compute.

Personally I would advise against this style of coding completely + in the functional programming context; we specifically avoid these types of method calls, because they are indeterminate; worse this method mutates an input parameter (out keyword) -- which makes testing that much more difficult. In functional programming; there is huge merit in trying to keep a majority of the codebase as pure as possible. In the C# context; it is quite possible to have the core of the codebase pure; with a very small cut out for mutation where its unavoidable, for example: UI. Leaving a codebase that is for greater part very easy to test, and hence less prone to errors.

Anyway that's a window into the rabbit hole that is functional programming and its basis in category theory; hopefully its helpful.

modified 26-Jan-22 12:01pm.

Gerry Schmitz26-Jan-22 6:13

Re: How would you describe what an IEnumerable is to a bright student of C#

26-Jan-22 6:13

It's an interface to a forward reading state machine who's final implementation is left up to the author. The whole "internal list" concept is an illusion.

I use IEnumerable to create custom tokenizers for certain text files. It's when you need it, and realize it, that its usefulness becomes clear.

"Before entering on an understanding, I have meditated for a long time, and have foreseen what might happen. It is not genius which reveals to me suddenly, secretly, what I have to say or to do in a circumstance unexpected by other people; it is reflection, it is meditation." - Napoleon I

endo funk26-Jan-22 9:40

Re: How would you describe what an IEnumerable is to a bright student of C#

26-Jan-22 9:40

Most certainly Yes... in the context of considering IEnumerable as just an interface for iteration over a collection of sorts.

What however muddles the water is the questioning of its usefulness in relation to the Linq Extension Methods for IEnumerable, as mentioned by OP:
- Select
- Where
- Aggregate

Similarly deferred evaluation aka lazy evaluation and Count()

Whilst most any data type can conform to some degree with IEnumerable, and by virtue its Linq extensions; it's predominant practicality is with in memory collection types like List, where a majority of the Linq algebras would equally be useful, performant, etc.

Gerry Schmitz27-Jan-22 16:58

Re: How would you describe what an IEnumerable is to a bright student of C#

27-Jan-22 16:58

There is no muddling; until I yield, I can pretty well do anything I like, including chaining.

Count() is not a method of IEnumerable. A state machine can learn; you could probably get a good estimate the 2nd time around; all other things being equal.

If the IEnumerable returns an object, you could even have it return a status report every so often; you're not limited to returning a particular type.

endo funk27-Jan-22 19:35

Re: How would you describe what an IEnumerable is to a bright student of C#

27-Jan-22 19:35

Count() is not a method of IEnumerable.
It is an extension on IEnumerable<TSource>, the state machine is sub typed to IEnumerable; see reference runtime code below:
runtime/Count.cs at dotnet/runtime · GitHub

A state machine can learn; you could probably get a good estimate the 2nd time around; all other things being equal.
I see no example of this in the code for Linq. In .Net 6 Microsoft has added TryGetNonEnumeratedCount to try to compute the compute the count without enumeration; failing which they fallback on enumerating the collection, reference runtime code below:
runtime/Count.cs at dotnet/runtime · GitHub

If the IEnumerable returns an object, you could even have it return a status report every so often; you're not limited to returning a particular type.
It's as mentioned before is a state machine that is sub typed to IEnumerable; so barring guesstimate extension methods like TryGetNonEnumeratedCount; it requires enumeration to return a result. Select allows mapping from 1 encapsulated type to another; however the collection object (IEnumerable) is resolute for Linq.
Modifying the outer collection object; usually involves a traverse map; Linq AFAIK doesn't have any traversal extension methods; but it's fairly easy to build your own; re the building blocks for it are already there... Aggregate, SelectMany, and Select.
Side note: Arguably ToList and ToArray are basic traversals.

modified 28-Jan-22 1:52am.

Gerry Schmitz28-Jan-22 5:50

Re: How would you describe what an IEnumerable is to a bright student of C#

28-Jan-22 5:50

My references are to IEnumerable; you keep wanting to make it about LINQ, extensions, and generic types.

"I see no example". And that means what? You only believe in "prior art"?

You keep ignoring it's an "interface"; there is no "code" (LINQ or otherwise) that you can make claims about.

endo funk28-Jan-22 6:40

Re: How would you describe what an IEnumerable is to a bright student of C#

28-Jan-22 6:40

IEnumerable in the small in defined as just an interface; for example (.Net sourcecode):

internal interface IEnumerable {
  System.Collections.IEnumerator GetEnumerator();
}

Which does nothing but define the need for a method called GetEnumerator that returns a IEnumerator.
If that's what you mean by "My references are to IEnumerable"; then following "your rules"; you should avoid saying:

Count() is not a method of IEnumerable. A state machine can learn; you could probably get a good estimate the 2nd time around; all other things being equal.

If the IEnumerable returns an object, you could even have it return a status report every so often; you're not limited to returning a particular type.

..because "your rules" are stipulating that we ignored all the extension methods that are linked to IEnumerable and by distinction all the sub types of IEnumerable. Meaning you can't imply its a "state machine" because that would require you to first acknowledge the many extension methods for IEnumerable; because (if you missed it), the extension methods are the bridging code between IEnumerable as an interface to IEnumerable as a state machine i.e. part of what's commonly known as Linq.

What value is there in ignoring reality; Linq (for IEnumerable) exists as a large set of extension methods and sub types, etc.

Whilst its possible to create your own custom interfaces and types to tie in with Linq; that fact alone doesn't discount the large part of extension methods, ... that are considered .Net System.Linq and which is directly typed to the IEnumerable interface.

modified 28-Jan-22 12:49pm.

Gerry Schmitz28-Jan-22 7:29

Re: How would you describe what an IEnumerable is to a bright student of C#

28-Jan-22 7:29

You're fixated on one type of implementation; the implementation is up to the author. The author decides how, when, and what to "yield"; which is the whole point.

There are no "rules" .

endo funk28-Jan-22 8:46

Re: How would you describe what an IEnumerable is to a bright student of C#

28-Jan-22 8:46

Nope... but I'm sure we can agree its become rather pedantic.

An interface on its own is not a state machine; whilst the outcome of this type of implementation:

public class Id : IEnumerable {
    private readonly int Value;
    public Id(int value) => (Value) = (value);
    public IEnumerator GetEnumerator() {
      yield return Value;
    }
}

..technically yields a state machine; it does not make either IEnumerable or IEnumerator themselves a state machine... they're an implementation requirement.. but then (pedantically) we're getting into the weeds.

Plus this line of discussion has no bearing on the scope of the OP's question wrt to either:

...they've had no problems mastering 'Select and 'Where, 'Aggregate, etc.
What's so useful about deferred evaluation ?
why do I have to trigger iteration with 'Count() to see how many items it has...

In that context IEnumerable should not be considered without Linq; re Select and 'Where, 'Aggregate, etc. are a reference to Linq; and in that context it is the extension methods of Linq that bridge IEnumerable to Linq's implementation of a state machine, and similarly Count().

I also said...

Whilst its possible to create your own custom interfaces and types to tie in with Linq

It is not a requirement for custom Linq types to implement IEnumerable to use both syntactic styles of Linq. Nor would it be possible for product and sum types to conform to IEnumerable; because its an implementation that is tied to IEnumerator; an API designed for iterating over a collection.

BillWoodruff26-Jan-22 23:52

Re: How would you describe what an IEnumerable is to a bright student of C#

26-Jan-22 23:52

Gerry Schmitz wrote:
It's an interface to a forward reading state machine who's final implementation is left up to the author. The whole "internal list" concept is an illusion.

I like the analogy of a finite state machine, even if that ... for my students ... is an advanced concept that would probably distract them. i'd rephrase that as: "forward reading finite iteration machine."

"list ... illusion:" trying to prevent the student from assuming there is an internal list is a priority when i teach.

"custom tokenizers:" interesting ... i assume you mean 'Select based IEnumerables.

«The mind is not a vessel to be filled but a fire to be kindled» Plutarch

BillWoodruff26-Jan-22 23:39

Re: How would you describe what an IEnumerable is to a bright student of C#

26-Jan-22 23:39

@endofunk I am stupefied by the idea anyone guiding a "bright young student" would smother them in such a pile of tangled, redundant, overblown, irrelevant, rhetoric.

«The mind is not a vessel to be filled but a fire to be kindled» Plutarch

endo funk27-Jan-22 6:44

Re: How would you describe what an IEnumerable is to a bright student of C#

27-Jan-22 6:44

Tsk tsk... that type reaction is IMO simply a reflection on an inability to grok the underlying complexity; not on the information and/or its relevance and/or its accuracy. It was after-all intended to provide an indication of the complexity underlying the architecting of Linq.

Ps. Plus my response was to you, not the student -- a good teacher would be able to gauge the level of their audience and adjust the presentation of a complex topic to match that.

BillWoodruff27-Jan-22 23:44

Re: How would you describe what an IEnumerable is to a bright student of C#

27-Jan-22 23:44

the sweat trying to show off produces often tastes like non-sequiturs Smile | :)

«The mind is not a vessel to be filled but a fire to be kindled» Plutarch

endo funk28-Jan-22 2:11

Re: How would you describe what an IEnumerable is to a bright student of C#

28-Jan-22 2:11

An accusation of "showboating"; concludes with an incongruous use of a Latin phrase... Derp Roll eyes | :rolleyes:

No knowledge is ever to be wasted or ever to be despised
-- Joseph Needham

jschell30-Jan-22 7:08

jschell

30-Jan-22 7:08

endo funk wrote:
Tsk tsk... that type reaction is IMO simply a reflection on an inability to grok

Tsk tsk...That reply suggests one or more of the following
1. You did not read the original post
2. You didn't care what the original post asked.
3. You don't understand the context of what student might mean in the original post.

Re: How would you describe what an IEnumerable is to a bright student of C#

endo funk30-Jan-22 14:22