-
Notifications
You must be signed in to change notification settings - Fork 748
/
EnumerableEx.Buffering.cs
647 lines (555 loc) · 22.9 KB
/
EnumerableEx.Buffering.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.Diagnostics;
namespace System.Linq
{
public static partial class EnumerableEx
{
/// <summary>
/// Creates a buffer with a shared view over the source sequence, causing each enumerator to fetch the next element from the source sequence.
/// </summary>
/// <typeparam name="TSource">Source sequence element type.</typeparam>
/// <param name="source">Source sequence.</param>
/// <returns>Buffer enabling each enumerator to retrieve elements from the shared source sequence.</returns>
/// <example>
/// var rng = Enumerable.Range(0, 10).Share();
///
/// var e1 = rng.GetEnumerator(); // Both e1 and e2 will consume elements from
/// var e2 = rng.GetEnumerator(); // the source sequence.
///
/// Assert.IsTrue(e1.MoveNext());
/// Assert.AreEqual(0, e1.Current);
///
/// Assert.IsTrue(e1.MoveNext());
/// Assert.AreEqual(1, e1.Current);
///
/// Assert.IsTrue(e2.MoveNext()); // e2 "steals" element 2
/// Assert.AreEqual(2, e2.Current);
///
/// Assert.IsTrue(e1.MoveNext()); // e1 can't see element 2
/// Assert.AreEqual(3, e1.Current);
/// </example>
public static IBuffer<TSource> Share<TSource>(this IEnumerable<TSource> source)
{
if (source == null)
throw new ArgumentNullException("source");
return new SharedBuffer<TSource>(source.GetEnumerator());
}
/// <summary>
/// Shares the source sequence within a selector function where each enumerator can fetch the next element from the source sequence.
/// </summary>
/// <typeparam name="TSource">Source sequence element type.</typeparam>
/// <typeparam name="TResult">Result sequence element type.</typeparam>
/// <param name="source">Source sequence.</param>
/// <param name="selector">Selector function with shared access to the source sequence for each enumerator.</param>
/// <returns>Sequence resulting from applying the selector function to the shared view over the source sequence.</returns>
public static IEnumerable<TResult> Share<TSource, TResult>(this IEnumerable<TSource> source, Func<IEnumerable<TSource>, IEnumerable<TResult>> selector)
{
if (source == null)
throw new ArgumentNullException("source");
if (selector == null)
throw new ArgumentNullException("selector");
return Create<TResult>(() => selector(source.Share()).GetEnumerator());
}
class SharedBuffer<T> : IBuffer<T>
{
private IEnumerator<T> _source;
private bool _disposed;
public SharedBuffer(IEnumerator<T> source)
{
_source = source;
}
public IEnumerator<T> GetEnumerator()
{
if (_disposed)
throw new ObjectDisposedException("");
return GetEnumerator_();
}
private IEnumerator<T> GetEnumerator_()
{
while (true)
{
if (_disposed)
throw new ObjectDisposedException("");
var hasValue = default(bool);
var current = default(T);
lock (_source)
{
hasValue = _source.MoveNext();
if (hasValue)
current = _source.Current;
}
if (hasValue)
yield return current;
else
break;
}
}
System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
{
if (_disposed)
throw new ObjectDisposedException("");
return GetEnumerator();
}
public void Dispose()
{
lock (_source)
{
if (!_disposed)
{
_source.Dispose();
_source = null;
}
_disposed = true;
}
}
}
/// <summary>
/// Creates a buffer with a view over the source sequence, causing each enumerator to obtain access to the remainder of the sequence from the current index in the buffer.
/// </summary>
/// <typeparam name="TSource">Source sequence element type.</typeparam>
/// <param name="source">Source sequence.</param>
/// <returns>Buffer enabling each enumerator to retrieve elements from the shared source sequence, starting from the index at the point of obtaining the enumerator.</returns>
/// <example>
/// var rng = Enumerable.Range(0, 10).Publish();
///
/// var e1 = rng.GetEnumerator(); // e1 has a view on the source starting from element 0
///
/// Assert.IsTrue(e1.MoveNext());
/// Assert.AreEqual(0, e1.Current);
///
/// Assert.IsTrue(e1.MoveNext());
/// Assert.AreEqual(1, e1.Current);
///
/// var e2 = rng.GetEnumerator();
///
/// Assert.IsTrue(e2.MoveNext()); // e2 has a view on the source starting from element 2
/// Assert.AreEqual(2, e2.Current);
///
/// Assert.IsTrue(e1.MoveNext()); // e1 continues to enumerate over its view
/// Assert.AreEqual(2, e1.Current);
/// </example>
public static IBuffer<TSource> Publish<TSource>(this IEnumerable<TSource> source)
{
if (source == null)
throw new ArgumentNullException("source");
return new PublishedBuffer<TSource>(source.GetEnumerator());
}
/// <summary>
/// Publishes the source sequence within a selector function where each enumerator can obtain a view over a tail of the source sequence.
/// </summary>
/// <typeparam name="TSource">Source sequence element type.</typeparam>
/// <typeparam name="TResult">Result sequence element type.</typeparam>
/// <param name="source">Source sequence.</param>
/// <param name="selector">Selector function with published access to the source sequence for each enumerator.</param>
/// <returns>Sequence resulting from applying the selector function to the published view over the source sequence.</returns>
public static IEnumerable<TResult> Publish<TSource, TResult>(this IEnumerable<TSource> source, Func<IEnumerable<TSource>, IEnumerable<TResult>> selector)
{
if (source == null)
throw new ArgumentNullException("source");
if (selector == null)
throw new ArgumentNullException("selector");
return Create<TResult>(() => selector(source.Publish()).GetEnumerator());
}
class PublishedBuffer<T> : IBuffer<T>
{
private IEnumerator<T> _source;
private RefCountList<T> _buffer;
private bool _stopped;
private Exception _error;
private bool _disposed;
public PublishedBuffer(IEnumerator<T> source)
{
_buffer = new RefCountList<T>(0);
_source = source;
}
public IEnumerator<T> GetEnumerator()
{
if (_disposed)
throw new ObjectDisposedException("");
var i = default(int);
lock (_source)
{
i = _buffer.Count;
_buffer.ReaderCount++;
}
return GetEnumerator_(i);
}
private IEnumerator<T> GetEnumerator_(int i)
{
try
{
while (true)
{
if (_disposed)
throw new ObjectDisposedException("");
var hasValue = default(bool);
var current = default(T);
lock (_source)
{
if (i >= _buffer.Count)
{
if (!_stopped)
{
try
{
hasValue = _source.MoveNext();
if (hasValue)
current = _source.Current;
}
catch (Exception ex)
{
_stopped = true;
_error = ex;
_source.Dispose();
}
}
if (_stopped)
{
if (_error != null)
throw _error;
else
break;
}
if (hasValue)
{
_buffer.Add(current);
}
}
else
{
hasValue = true;
}
}
if (hasValue)
yield return _buffer[i];
else
break;
i++;
}
}
finally
{
if (_buffer != null)
_buffer.Done(i + 1);
}
}
System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
{
if (_disposed)
throw new ObjectDisposedException("");
return GetEnumerator();
}
public void Dispose()
{
lock (_source)
{
if (!_disposed)
{
_source.Dispose();
_source = null;
_buffer.Clear();
_buffer = null;
}
_disposed = true;
}
}
}
/// <summary>
/// Creates a buffer with a view over the source sequence, causing each enumerator to obtain access to all of the sequence's elements without causing multiple enumerations over the source.
/// </summary>
/// <typeparam name="TSource">Source sequence element type.</typeparam>
/// <param name="source">Source sequence.</param>
/// <returns>Buffer enabling each enumerator to retrieve all elements from the shared source sequence, without duplicating source enumeration side-effects.</returns>
/// <example>
/// var rng = Enumerable.Range(0, 10).Do(x => Console.WriteLine(x)).Memoize();
///
/// var e1 = rng.GetEnumerator();
///
/// Assert.IsTrue(e1.MoveNext()); // Prints 0
/// Assert.AreEqual(0, e1.Current);
///
/// Assert.IsTrue(e1.MoveNext()); // Prints 1
/// Assert.AreEqual(1, e1.Current);
///
/// var e2 = rng.GetEnumerator();
///
/// Assert.IsTrue(e2.MoveNext()); // Doesn't print anything; the side-effect of Do
/// Assert.AreEqual(0, e2.Current); // has already taken place during e1's iteration.
///
/// Assert.IsTrue(e1.MoveNext()); // Prints 2
/// Assert.AreEqual(2, e1.Current);
/// </example>
public static IBuffer<TSource> Memoize<TSource>(this IEnumerable<TSource> source)
{
if (source == null)
throw new ArgumentNullException("source");
return new MemoizedBuffer<TSource>(source.GetEnumerator());
}
/// <summary>
/// Memoizes the source sequence within a selector function where each enumerator can get access to all of the sequence's elements without causing multiple enumerations over the source.
/// </summary>
/// <typeparam name="TSource">Source sequence element type.</typeparam>
/// <typeparam name="TResult">Result sequence element type.</typeparam>
/// <param name="source">Source sequence.</param>
/// <param name="selector">Selector function with memoized access to the source sequence for each enumerator.</param>
/// <returns>Sequence resulting from applying the selector function to the memoized view over the source sequence.</returns>
public static IEnumerable<TResult> Memoize<TSource, TResult>(this IEnumerable<TSource> source, Func<IEnumerable<TSource>, IEnumerable<TResult>> selector)
{
if (source == null)
throw new ArgumentNullException("source");
if (selector == null)
throw new ArgumentNullException("selector");
return Create<TResult>(() => selector(source.Memoize()).GetEnumerator());
}
/// <summary>
/// Creates a buffer with a view over the source sequence, causing a specified number of enumerators to obtain access to all of the sequence's elements without causing multiple enumerations over the source.
/// </summary>
/// <typeparam name="TSource">Source sequence element type.</typeparam>
/// <param name="source">Source sequence.</param>
/// <param name="readerCount">Number of enumerators that can access the underlying buffer. Once every enumerator has obtained an element from the buffer, the element is removed from the buffer.</param>
/// <returns>Buffer enabling a specified number of enumerators to retrieve all elements from the shared source sequence, without duplicating source enumeration side-effects.</returns>
public static IBuffer<TSource> Memoize<TSource>(this IEnumerable<TSource> source, int readerCount)
{
if (source == null)
throw new ArgumentNullException("source");
if (readerCount <= 0)
throw new ArgumentOutOfRangeException("readerCount");
return new MemoizedBuffer<TSource>(source.GetEnumerator(), readerCount);
}
/// <summary>
/// Memoizes the source sequence within a selector function where a specified number of enumerators can get access to all of the sequence's elements without causing multiple enumerations over the source.
/// </summary>
/// <typeparam name="TSource">Source sequence element type.</typeparam>
/// <typeparam name="TResult">Result sequence element type.</typeparam>
/// <param name="source">Source sequence.</param>
/// <param name="readerCount">Number of enumerators that can access the underlying buffer. Once every enumerator has obtained an element from the buffer, the element is removed from the buffer.</param>
/// <param name="selector">Selector function with memoized access to the source sequence for a specified number of enumerators.</param>
/// <returns>Sequence resulting from applying the selector function to the memoized view over the source sequence.</returns>
public static IEnumerable<TResult> Memoize<TSource, TResult>(this IEnumerable<TSource> source, int readerCount, Func<IEnumerable<TSource>, IEnumerable<TResult>> selector)
{
if (source == null)
throw new ArgumentNullException("source");
if (readerCount <= 0)
throw new ArgumentOutOfRangeException("readerCount");
if (selector == null)
throw new ArgumentNullException("selector");
return Create<TResult>(() => selector(source.Memoize(readerCount)).GetEnumerator());
}
class MemoizedBuffer<T> : IBuffer<T>
{
private IEnumerator<T> _source;
private IRefCountList<T> _buffer;
private bool _stopped;
private Exception _error;
private bool _disposed;
public MemoizedBuffer(IEnumerator<T> source)
: this(source, new MaxRefCountList<T>())
{
}
public MemoizedBuffer(IEnumerator<T> source, int readerCount)
: this(source, new RefCountList<T>(readerCount))
{
}
private MemoizedBuffer(IEnumerator<T> source, IRefCountList<T> buffer)
{
_source = source;
_buffer = buffer;
}
public IEnumerator<T> GetEnumerator()
{
if (_disposed)
throw new ObjectDisposedException("");
return GetEnumerator_();
}
private IEnumerator<T> GetEnumerator_()
{
var i = 0;
try
{
while (true)
{
if (_disposed)
throw new ObjectDisposedException("");
var hasValue = default(bool);
var current = default(T);
lock (_source)
{
if (i >= _buffer.Count)
{
if (!_stopped)
{
try
{
hasValue = _source.MoveNext();
if (hasValue)
current = _source.Current;
}
catch (Exception ex)
{
_stopped = true;
_error = ex;
_source.Dispose();
}
}
if (_stopped)
{
if (_error != null)
throw _error;
else
break;
}
if (hasValue)
{
_buffer.Add(current);
}
}
else
{
hasValue = true;
}
}
if (hasValue)
yield return _buffer[i];
else
break;
i++;
}
}
finally
{
if (_buffer != null)
_buffer.Done(i + 1);
}
}
System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
{
if (_disposed)
throw new ObjectDisposedException("");
return GetEnumerator();
}
public void Dispose()
{
lock (_source)
{
if (!_disposed)
{
_source.Dispose();
_source = null;
_buffer.Clear();
_buffer = null;
}
_disposed = true;
}
}
}
}
/// <summary>
/// Represents a buffer exposing a shared view over an underlying enumerable sequence.
/// </summary>
/// <typeparam name="T">Element type.</typeparam>
public interface IBuffer<
#if !NO_VARIANCE && !SILVERLIGHT4 // SL4 has defined IEnumerable with invariant T
out
#endif
T> : IEnumerable<T>, IDisposable
{
}
interface IRefCountList<T>
{
void Clear();
int Count { get; }
T this[int i]
{
get;
}
void Add(T item);
void Done(int index);
}
class MaxRefCountList<T> : IRefCountList<T>
{
private IList<T> _list = new List<T>();
public void Clear()
{
_list.Clear();
}
public int Count
{
get { return _list.Count; }
}
public T this[int i]
{
get { return _list[i]; }
}
public void Add(T item)
{
_list.Add(item);
}
public void Done(int index)
{
}
}
class RefCountList<T> : IRefCountList<T>
{
private int _readerCount;
private readonly IDictionary<int, RefCount> _list;
private int _count;
public RefCountList(int readerCount)
{
_readerCount = readerCount;
_list = new Dictionary<int, RefCount>();
}
public int ReaderCount
{
get
{
return _readerCount;
}
set
{
_readerCount = value;
}
}
public void Clear()
{
_list.Clear();
}
public int Count
{
get { return _count; }
}
public T this[int i]
{
get
{
Debug.Assert(i < _count);
var res = default(RefCount);
if (!_list.TryGetValue(i, out res))
throw new InvalidOperationException("Element no longer available in the buffer.");
var val = res.Value;
if (--res.Count == 0)
_list.Remove(i);
return val;
}
}
public void Add(T item)
{
_list[_count] = new RefCount { Value = item, Count = _readerCount };
_count++;
}
public void Done(int index)
{
for (int i = index; i < _count; i++)
{
var ignore = this[i];
}
_readerCount--;
}
class RefCount
{
public int Count;
public T Value;
}
}
}