-
Notifications
You must be signed in to change notification settings - Fork 48
/
PooledList.cs
1665 lines (1431 loc) · 56.5 KB
/
PooledList.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
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.Buffers;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Runtime.CompilerServices;
using System.Runtime.Serialization;
using System.Threading;
namespace Collections.Pooled
{
/// <summary>
/// Implements a variable-size list that uses a pooled array to store the
/// elements. A PooledList has a capacity, which is the allocated length
/// of the internal array. As elements are added to a PooledList, the capacity
/// of the PooledList is automatically increased as required by reallocating the
/// internal array.
/// </summary>
/// <remarks>
/// This class is based on the code for <see cref="List{T}"/> but it supports <see cref="Span{T}"/>
/// and uses <see cref="ArrayPool{T}"/> when allocating internal arrays.
/// </remarks>
[DebuggerDisplay("Count = {Count}")]
[DebuggerTypeProxy(typeof(ICollectionDebugView<>))]
[Serializable]
public class PooledList<T> : IList<T>, IReadOnlyPooledList<T>, IList, IDisposable, IDeserializationCallback
{
// internal constant copied from Array.MaxArrayLength
private const int MaxArrayLength = 0x7FEFFFFF;
private const int DefaultCapacity = 4;
private static readonly T[] s_emptyArray = Array.Empty<T>();
[NonSerialized] private ArrayPool<T> _pool;
[NonSerialized] private object _syncRoot;
private T[] _items; // Do not rename (binary serialization)
private int _size; // Do not rename (binary serialization)
private int _version; // Do not rename (binary serialization)
private readonly bool _clearOnFree;
#region Constructors
/// <summary>
/// Constructs a PooledList. The list is initially empty and has a capacity
/// of zero. Upon adding the first element to the list the capacity is
/// increased to DefaultCapacity, and then increased in multiples of two
/// as required.
/// </summary>
public PooledList() : this(ClearMode.Auto, ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a PooledList. The list is initially empty and has a capacity
/// of zero. Upon adding the first element to the list the capacity is
/// increased to DefaultCapacity, and then increased in multiples of two
/// as required.
/// </summary>
public PooledList(ClearMode clearMode) : this(clearMode, ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a PooledList. The list is initially empty and has a capacity
/// of zero. Upon adding the first element to the list the capacity is
/// increased to DefaultCapacity, and then increased in multiples of two
/// as required.
/// </summary>
public PooledList(ArrayPool<T> customPool) : this(ClearMode.Auto, customPool)
{
}
/// <summary>
/// Constructs a PooledList. The list is initially empty and has a capacity
/// of zero. Upon adding the first element to the list the capacity is
/// increased to DefaultCapacity, and then increased in multiples of two
/// as required.
/// </summary>
public PooledList(ClearMode clearMode, ArrayPool<T> customPool)
{
_items = s_emptyArray;
_pool = customPool ?? ArrayPool<T>.Shared;
_clearOnFree = ShouldClear(clearMode);
}
/// <summary>
/// Constructs a List with a given initial capacity. The list is
/// initially empty, but will have room for the given number of elements
/// before any reallocations are required.
/// </summary>
public PooledList(int capacity) : this(capacity, ClearMode.Auto, ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a List with a given initial capacity. The list is
/// initially empty, but will have room for the given number of elements
/// before any reallocations are required.
/// </summary>
public PooledList(int capacity, bool sizeToCapacity) : this(capacity, ClearMode.Auto, ArrayPool<T>.Shared,
sizeToCapacity)
{
}
/// <summary>
/// Constructs a List with a given initial capacity. The list is
/// initially empty, but will have room for the given number of elements
/// before any reallocations are required.
/// </summary>
public PooledList(int capacity, ClearMode clearMode) : this(capacity, clearMode, ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a List with a given initial capacity. The list is
/// initially empty, but will have room for the given number of elements
/// before any reallocations are required.
/// </summary>
public PooledList(int capacity, ClearMode clearMode, bool sizeToCapacity) : this(capacity, clearMode,
ArrayPool<T>.Shared, sizeToCapacity)
{
}
/// <summary>
/// Constructs a List with a given initial capacity. The list is
/// initially empty, but will have room for the given number of elements
/// before any reallocations are required.
/// </summary>
public PooledList(int capacity, ArrayPool<T> customPool) : this(capacity, ClearMode.Auto, customPool)
{
}
/// <summary>
/// Constructs a List with a given initial capacity. The list is
/// initially empty, but will have room for the given number of elements
/// before any reallocations are required.
/// </summary>
public PooledList(int capacity, ArrayPool<T> customPool, bool sizeToCapacity) : this(capacity, ClearMode.Auto,
customPool, sizeToCapacity)
{
}
/// <summary>
/// Constructs a List with a given initial capacity. The list is
/// initially empty, but will have room for the given number of elements
/// before any reallocations are required.
/// </summary>
public PooledList(int capacity, ClearMode clearMode, ArrayPool<T> customPool) : this(capacity, clearMode,
customPool, false)
{
}
/// <summary>
/// Constructs a List with a given initial capacity. The list is
/// initially empty, but will have room for the given number of elements
/// before any reallocations are required.
/// </summary>
/// <param name="sizeToCapacity">If true, Count of list equals capacity. Depending on ClearMode, rented items may or may not hold dirty values.</param>
public PooledList(int capacity, ClearMode clearMode, ArrayPool<T> customPool, bool sizeToCapacity)
{
if (capacity < 0)
ThrowHelper.ThrowArgumentOutOfRangeException(ExceptionArgument.capacity,
ExceptionResource.ArgumentOutOfRange_NeedNonNegNum);
_pool = customPool ?? ArrayPool<T>.Shared;
_clearOnFree = ShouldClear(clearMode);
if (capacity == 0)
{
_items = s_emptyArray;
}
else
{
_items = _pool.Rent(capacity);
}
if (sizeToCapacity)
{
_size = capacity;
if (clearMode != ClearMode.Never)
{
Array.Clear(_items, 0, _size);
}
}
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(T[] array) : this(array.AsSpan(), ClearMode.Auto, ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(T[] array, ClearMode clearMode) : this(array.AsSpan(), clearMode, ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(T[] array, ArrayPool<T> customPool) : this(array.AsSpan(), ClearMode.Auto, customPool)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(T[] array, ClearMode clearMode, ArrayPool<T> customPool) : this(array.AsSpan(), clearMode,
customPool)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(ReadOnlySpan<T> span) : this(span, ClearMode.Auto, ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(ReadOnlySpan<T> span, ClearMode clearMode) : this(span, clearMode, ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(ReadOnlySpan<T> span, ArrayPool<T> customPool) : this(span, ClearMode.Auto, customPool)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(ReadOnlySpan<T> span, ClearMode clearMode, ArrayPool<T> customPool)
{
_pool = customPool ?? ArrayPool<T>.Shared;
_clearOnFree = ShouldClear(clearMode);
int count = span.Length;
if (count == 0)
{
_items = s_emptyArray;
}
else
{
_items = _pool.Rent(count);
span.CopyTo(_items);
_size = count;
}
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(IEnumerable<T> collection) : this(collection, ClearMode.Auto, ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size of the new list will be equal to the size of the given collection
/// and the capacity will be equal to suggestCapacity
/// </summary>
public PooledList(IEnumerable<T> collection, int suggestCapacity) : this(collection, ClearMode.Auto,
ArrayPool<T>.Shared, suggestCapacity)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(IEnumerable<T> collection, ClearMode clearMode) : this(collection, clearMode,
ArrayPool<T>.Shared)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(IEnumerable<T> collection, ArrayPool<T> customPool) : this(collection, ClearMode.Auto,
customPool)
{
}
/// <summary>
/// Constructs a PooledList, copying the contents of the given collection. The
/// size and capacity of the new list will both be equal to the size of the
/// given collection.
/// </summary>
public PooledList(IEnumerable<T> collection, ClearMode clearMode, ArrayPool<T> customPool,
int suggestCapacity = 0)
{
_pool = customPool ?? ArrayPool<T>.Shared;
_clearOnFree = ShouldClear(clearMode);
switch (collection)
{
case null:
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.collection);
break;
case ICollection<T> c:
{
int count = c.Count;
if (count == 0)
{
_items = s_emptyArray;
}
else
{
_items = _pool.Rent(count);
c.CopyTo(_items, 0);
_size = count;
}
break;
}
case ICollection c:
{
int count = c.Count;
if (count == 0)
{
_items = s_emptyArray;
}
else
{
_items = _pool.Rent(count);
c.CopyTo(_items, 0);
_size = count;
}
break;
}
case IReadOnlyCollection<T> c:
{
int count = c.Count;
if (count == 0)
{
_items = s_emptyArray;
}
else
{
_items = _pool.Rent(count);
_size = 0;
using (var en = c.GetEnumerator())
{
while (en.MoveNext())
Add(en.Current);
}
}
break;
}
default:
if (suggestCapacity < 0)
ThrowHelper.ThrowArgumentOutOfRangeException(ExceptionArgument.capacity,
ExceptionResource.ArgumentOutOfRange_NeedNonNegNum);
if (suggestCapacity == 0)
{
_items = s_emptyArray;
}
else
{
_items = _pool.Rent(suggestCapacity);
}
using (var en = collection.GetEnumerator())
{
while (en.MoveNext())
Add(en.Current);
}
break;
}
}
#endregion
/// <summary>
/// Gets a <see cref="System.Span{T}"/> for the items currently in the collection.
/// </summary>
public Span<T> Span => _items.AsSpan(0, _size);
/// <inheritdoc/>
ReadOnlySpan<T> IReadOnlyPooledList<T>.Span => Span;
/// <summary>
/// Gets and sets the capacity of this list. The capacity is the size of
/// the internal array used to hold items. When set, the internal
/// Memory of the list is reallocated to the given capacity.
/// Note that the return value for this property may be larger than the property was set to.
/// </summary>
public int Capacity
{
get => _items.Length;
set
{
if (value < _size)
{
ThrowHelper.ThrowArgumentOutOfRangeException(ExceptionArgument.value,
ExceptionResource.ArgumentOutOfRange_SmallCapacity);
}
if (value != _items.Length)
{
if (value > 0)
{
var newItems = _pool.Rent(value);
if (_size > 0)
{
Array.Copy(_items, newItems, _size);
}
ReturnArray();
_items = newItems;
}
else
{
ReturnArray();
_size = 0;
}
}
}
}
/// <summary>
/// Read-only property describing how many elements are in the List.
/// </summary>
public int Count => _size;
/// <summary>
/// Returns the ClearMode behavior for the collection, denoting whether values are
/// cleared from internal arrays before returning them to the pool.
/// </summary>
public ClearMode ClearMode => _clearOnFree ? ClearMode.Always : ClearMode.Never;
bool IList.IsFixedSize => false;
bool ICollection<T>.IsReadOnly => false;
bool IList.IsReadOnly => false;
int ICollection.Count => _size;
bool ICollection.IsSynchronized => false;
// Synchronization root for this object.
object ICollection.SyncRoot
{
get
{
if (_syncRoot == null)
{
Interlocked.CompareExchange<object>(ref _syncRoot, new object(), null);
}
return _syncRoot;
}
}
/// <summary>
/// Gets or sets the element at the given index.
/// </summary>
public T this[int index]
{
get
{
// Following trick can reduce the range check by one
if ((uint)index >= (uint)_size)
{
ThrowHelper.ThrowArgumentOutOfRange_IndexException();
}
return _items[index];
}
set
{
if ((uint)index >= (uint)_size)
{
ThrowHelper.ThrowArgumentOutOfRange_IndexException();
}
_items[index] = value;
_version++;
}
}
private static bool IsCompatibleObject(object value)
{
// Non-null values are fine. Only accept nulls if T is a class or Nullable<U>.
// Note that default(T) is not equal to null for value types except when T is Nullable<U>.
return ((value is T) || (value == null && default(T) == null));
}
object IList.this[int index]
{
get { return this[index]; }
set
{
ThrowHelper.IfNullAndNullsAreIllegalThenThrow<T>(value, ExceptionArgument.value);
try
{
this[index] = (T)value;
}
catch (InvalidCastException)
{
ThrowHelper.ThrowWrongValueTypeArgumentException(value, typeof(T));
}
}
}
/// <summary>
/// Adds the given object to the end of this list. The size of the list is
/// increased by one. If required, the capacity of the list is doubled
/// before adding the new element.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public void Add(T item)
{
_version++;
int size = _size;
if ((uint)size < (uint)_items.Length)
{
_size = size + 1;
_items[size] = item;
}
else
{
AddWithResize(item);
}
}
// Non-inline from List.Add to improve its code quality as uncommon path
[MethodImpl(MethodImplOptions.NoInlining)]
private void AddWithResize(T item)
{
int size = _size;
EnsureCapacity(size + 1);
_size = size + 1;
_items[size] = item;
}
int IList.Add(object item)
{
ThrowHelper.IfNullAndNullsAreIllegalThenThrow<T>(item, ExceptionArgument.item);
try
{
Add((T)item);
}
catch (InvalidCastException)
{
ThrowHelper.ThrowWrongValueTypeArgumentException(item, typeof(T));
}
return Count - 1;
}
/// <summary>
/// Adds the elements of the given collection to the end of this list. If
/// required, the capacity of the list is increased to twice the previous
/// capacity or the new size, whichever is larger.
/// </summary>
public void AddRange(IEnumerable<T> collection)
=> InsertRange(_size, collection);
/// <summary>
/// Adds the elements of the given array to the end of this list. If
/// required, the capacity of the list is increased to twice the previous
/// capacity or the new size, whichever is larger.
/// </summary>
public void AddRange(T[] array)
=> AddRange(array.AsSpan());
/// <summary>
/// Adds the elements of the given <see cref="ReadOnlySpan{T}"/> to the end of this list. If
/// required, the capacity of the list is increased to twice the previous
/// capacity or the new size, whichever is larger.
/// </summary>
public void AddRange(ReadOnlySpan<T> span)
{
var newSpan = InsertSpan(_size, span.Length, false);
span.CopyTo(newSpan);
}
/// <summary>
/// Advances the <see cref="Count"/> by the number of items specified,
/// increasing the capacity if required, then returns a Span representing
/// the set of items to be added, allowing direct writes to that section
/// of the collection.
/// </summary>
/// <param name="count">The number of items to add.</param>
public Span<T> AddSpan(int count)
=> InsertSpan(_size, count);
public ReadOnlyCollection<T> AsReadOnly()
=> new ReadOnlyCollection<T>(this);
/// <summary>
/// Searches a section of the list for a given element using a binary search
/// algorithm.
/// </summary>
///
/// <remarks><para>Elements of the list are compared to the search value using
/// the given IComparer interface. If comparer is null, elements of
/// the list are compared to the search value using the IComparable
/// interface, which in that case must be implemented by all elements of the
/// list and the given search value. This method assumes that the given
/// section of the list is already sorted; if this is not the case, the
/// result will be incorrect.</para>
///
/// <para>The method returns the index of the given value in the list. If the
/// list does not contain the given value, the method returns a negative
/// integer. The bitwise complement operator (~) can be applied to a
/// negative result to produce the index of the first element (if any) that
/// is larger than the given search value. This is also the index at which
/// the search value should be inserted into the list in order for the list
/// to remain sorted.
/// </para></remarks>
public int BinarySearch(int index, int count, T item, IComparer<T> comparer)
{
if (index < 0)
ThrowHelper.ThrowIndexArgumentOutOfRange_NeedNonNegNumException();
if (count < 0)
ThrowHelper.ThrowArgumentOutOfRangeException(ExceptionArgument.count,
ExceptionResource.ArgumentOutOfRange_NeedNonNegNum);
if (_size - index < count)
ThrowHelper.ThrowArgumentException(ExceptionResource.Argument_InvalidOffLen);
return Array.BinarySearch(_items, index, count, item, comparer);
}
/// <summary>
/// Searches the list for a given element using a binary search
/// algorithm. If the item implements <see cref="IComparable{T}"/>
/// then that is used for comparison, otherwise <see cref="Comparer{T}.Default"/> is used.
/// </summary>
public int BinarySearch(T item)
=> BinarySearch(0, Count, item, null);
/// <summary>
/// Searches the list for a given element using a binary search
/// algorithm. If the item implements <see cref="IComparable{T}"/>
/// then that is used for comparison, otherwise <see cref="Comparer{T}.Default"/> is used.
/// </summary>
public int BinarySearch(T item, IComparer<T> comparer)
=> BinarySearch(0, Count, item, comparer);
/// <summary>
/// Clears the contents of the PooledList.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public void Clear()
{
_version++;
int size = _size;
_size = 0;
if (size > 0 && _clearOnFree)
{
// Clear the elements so that the gc can reclaim the references.
Array.Clear(_items, 0, size);
}
}
/// <summary>
/// Contains returns true if the specified element is in the List.
/// It does a linear, O(n) search. Equality is determined by calling
/// EqualityComparer{T}.Default.Equals.
/// </summary>
public bool Contains(T item)
{
// PERF: IndexOf calls Array.IndexOf, which internally
// calls EqualityComparer<T>.Default.IndexOf, which
// is specialized for different types. This
// boosts performance since instead of making a
// virtual method call each iteration of the loop,
// via EqualityComparer<T>.Default.Equals, we
// only make one virtual call to EqualityComparer.IndexOf.
return _size != 0 && IndexOf(item) != -1;
}
bool IList.Contains(object item)
{
if (IsCompatibleObject(item))
{
return Contains((T)item);
}
return false;
}
public PooledList<TOutput> ConvertAll<TOutput>(Func<T, TOutput> converter)
{
if (converter == null)
{
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.converter);
}
var list = new PooledList<TOutput>(_size);
for (int i = 0; i < _size; i++)
{
list._items[i] = converter(_items[i]);
}
list._size = _size;
return list;
}
/// <summary>
/// Copies this list to the given span.
/// </summary>
public void CopyTo(Span<T> span)
{
if (span.Length < Count)
throw new ArgumentException("Destination span is shorter than the list to be copied.");
Span.CopyTo(span);
}
void ICollection<T>.CopyTo(T[] array, int arrayIndex)
{
Array.Copy(_items, 0, array, arrayIndex, _size);
}
// Copies this List into array, which must be of a
// compatible array type.
void ICollection.CopyTo(Array array, int arrayIndex)
{
if ((array != null) && (array.Rank != 1))
{
ThrowHelper.ThrowArgumentException(ExceptionResource.Arg_RankMultiDimNotSupported);
}
try
{
// Array.Copy will check for NULL.
Array.Copy(_items, 0, array, arrayIndex, _size);
}
catch (ArrayTypeMismatchException)
{
ThrowHelper.ThrowArgumentException_Argument_InvalidArrayType();
}
}
/// <summary>
/// Ensures that the capacity of this list is at least the given minimum
/// value. If the current capacity of the list is less than min, the
/// capacity is increased to twice the current capacity or to min,
/// whichever is larger.
/// </summary>
private void EnsureCapacity(int min)
{
if (_items.Length < min)
{
int newCapacity = _items.Length == 0 ? DefaultCapacity : _items.Length * 2;
// Allow the list to grow to maximum possible capacity (~2G elements) before encountering overflow.
// Note that this check works even when _items.Length overflowed thanks to the (uint) cast
if ((uint)newCapacity > MaxArrayLength) newCapacity = MaxArrayLength;
if (newCapacity < min) newCapacity = min;
Capacity = newCapacity;
}
}
public bool Exists(Func<T, bool> match)
=> FindIndex(match) != -1;
public bool TryFind(Func<T, bool> match, out T result)
{
if (match == null)
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.match);
for (int i = 0; i < _size; i++)
{
if (match(_items[i]))
{
result = _items[i];
return true;
}
}
result = default;
return false;
}
public PooledList<T> FindAll(Func<T, bool> match)
{
if (match == null)
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.match);
var list = new PooledList<T>();
for (int i = 0; i < _size; i++)
{
if (match(_items[i]))
{
list.Add(_items[i]);
}
}
return list;
}
public int FindIndex(Func<T, bool> match)
=> FindIndex(0, _size, match);
public int FindIndex(int startIndex, Func<T, bool> match)
=> FindIndex(startIndex, _size - startIndex, match);
public int FindIndex(int startIndex, int count, Func<T, bool> match)
{
if ((uint)startIndex > (uint)_size)
ThrowHelper.ThrowStartIndexArgumentOutOfRange_ArgumentOutOfRange_Index();
if (count < 0 || startIndex > _size - count)
ThrowHelper.ThrowCountArgumentOutOfRange_ArgumentOutOfRange_Count();
if (match is null)
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.match);
int endIndex = startIndex + count;
for (int i = startIndex; i < endIndex; i++)
{
if (match(_items[i])) return i;
}
return -1;
}
public bool TryFindLast(Func<T, bool> match, out T result)
{
if (match is null)
{
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.match);
}
for (int i = _size - 1; i >= 0; i--)
{
if (match(_items[i]))
{
result = _items[i];
return true;
}
}
result = default;
return false;
}
public int FindLastIndex(Func<T, bool> match)
=> FindLastIndex(_size - 1, _size, match);
public int FindLastIndex(int startIndex, Func<T, bool> match)
=> FindLastIndex(startIndex, startIndex + 1, match);
public int FindLastIndex(int startIndex, int count, Func<T, bool> match)
{
if (match == null)
{
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.match);
}
if (_size == 0)
{
// Special case for 0 length List
if (startIndex != -1)
{
ThrowHelper.ThrowStartIndexArgumentOutOfRange_ArgumentOutOfRange_Index();
}
}
else
{
// Make sure we're not out of range
if ((uint)startIndex >= (uint)_size)
{
ThrowHelper.ThrowStartIndexArgumentOutOfRange_ArgumentOutOfRange_Index();
}
}
// 2nd half of this also catches when startIndex == MAXINT, so MAXINT - 0 + 1 == -1, which is < 0.
if (count < 0 || startIndex - count + 1 < 0)
{
ThrowHelper.ThrowCountArgumentOutOfRange_ArgumentOutOfRange_Count();
}
int endIndex = startIndex - count;
for (int i = startIndex; i > endIndex; i--)
{
if (match(_items[i]))
{
return i;
}
}
return -1;
}
public void ForEach(Action<T> action)
{
if (action == null)
{
ThrowHelper.ThrowArgumentNullException(ExceptionArgument.action);
}
int version = _version;
for (int i = 0; i < _size; i++)
{
if (version != _version)
{
break;
}
action(_items[i]);
}
if (version != _version)
ThrowHelper.ThrowInvalidOperationException_InvalidOperation_EnumFailedVersion();
}
/// <summary>
/// Returns an enumerator for this list with the given
/// permission for removal of elements. If modifications made to the list
/// while an enumeration is in progress, the MoveNext and
/// GetObject methods of the enumerator will throw an exception.
/// </summary>
public Enumerator GetEnumerator()
=> new Enumerator(this);
IEnumerator<T> IEnumerable<T>.GetEnumerator()
=> new Enumerator(this);
IEnumerator IEnumerable.GetEnumerator()
=> new Enumerator(this);
/// <summary>
/// Equivalent to PooledList.Span.Slice(index, count).
/// </summary>
public Span<T> GetRange(int index, int count)
{
if (index < 0)
{
ThrowHelper.ThrowIndexArgumentOutOfRange_NeedNonNegNumException();
}
if (count < 0)
{
ThrowHelper.ThrowArgumentOutOfRangeException(ExceptionArgument.count,
ExceptionResource.ArgumentOutOfRange_NeedNonNegNum);
}
if (_size - index < count)
{
ThrowHelper.ThrowArgumentException(ExceptionResource.Argument_InvalidOffLen);
}
return Span.Slice(index, count);
}
/// <summary>
/// Returns the index of the first occurrence of a given value in