RhinoList<T>

References
[Serializable] [DebuggerTypeProxy(ListDebuggerDisplayProxy<>)] [DebuggerDisplay("Count = {Count}")] public class RhinoList<T> : IList<T>, IList, ICloneable
Represents a list of generic data. This class is similar to System.Collections.Generic.List(T) but exposes a few more methods.
T

Constructors

RhinoList

#
Initializes a new, empty list.
public RhinoList()

RhinoList

#
Initializes this list as a shallow duplicate of another list, array or any other enumerable set of T.
public RhinoList(
collection
Collection of items to duplicate.
)

RhinoList

#
Initializes a new list with a specified amount of values.
public RhinoList(
amount,
Number of values to add to this list. Must be equal to or larger than zero.
T
defaultValue
Value to add, for reference types, the same item will be added over and over again.
)

RhinoList

#
Initializes an empty list with a certain capacity.
public RhinoList(
initialCapacity
Number of items this list can store without resizing.
)

RhinoList

#
Initializes an new list by shallow duplicating another list.
public RhinoList(
RhinoList<T>
list
List to mimic.
)

Properties

Capacity

#
Gets or sets the total number of elements the internal data structure can hold without resizing.
public int Capacity { get; set; }

Count

#
Gets the number of elements actually contained in the List.
public int Count { get; }

First

#
Gets or sets the first item in the list. This is synonymous to calling List[0].
public T First { get; set; }

Last

#
Gets or sets the last item in the list. This is synonymous to calling List[Count-1].
public T Last { get; set; }

NullCount

#
Gets the number of null references (Nothing in Visual Basic) in this list. If T is a ValueType, this property always return zero.
public int NullCount { get; }
Explicit

ICollection<T>.IsReadOnly

#
When implemented by a class, gets a value indicating whether the IList is read-only. RhinoList is never ReadOnly.
Explicit

ICollection.IsSynchronized

#
When implemented by a class, gets a value indicating whether access to the ICollection is synchronized (thread-safe). ON_List is never Synchronized.
Explicit

ICollection.SyncRoot

#
Gets an object that can be used to synchronize access to the ICollection.
Explicit

IList.IsFixedSize

#
When implemented by a class, gets a value indicating whether the IList has a fixed size. RhinoList is never fixed.
Explicit

IList.IsReadOnly

#
When implemented by a class, gets a value indicating whether the IList is read-only. RhinoList is never ReadOnly.

Indexers

Explicit

IList.this[]

#
Gets or sets the element at the specified index.
object IList.this[
index
The zero-based index of the element to get or set.
]
The element at the specified index.

this[]

#
Gets or sets the element at the specified index.
public T this[
index
The zero-based index of the element to get or set.
] { get; set; }
The element at the specified index.

Methods

Add

#
Adds an object to the end of the List.
public void Add(
T
item
Item to append.
)

AddRange

#
Adds the elements of the specified collection to the end of the List.
public void AddRange(
collection
The collection whose elements should be added to the end of the List. The collection itself cannot be a null reference (Nothing in Visual Basic), but it can contain elements that are a null reference (Nothing in Visual Basic). Objects in collection which cannot be represented as T will throw exceptions.
)

AddRange

#
Adds the elements of the specified collection to the end of the List.
public void AddRange(
collection
The collection whose elements should be added to the end of the List. The collection itself cannot be a null reference (Nothing in Visual Basic), but it can contain elements that are a null reference (Nothing in Visual Basic), if type T is a reference type.
)

AsReadOnly

#
Constructs a read-only wrapper of this class.
public ReadOnlyCollection<T> AsReadOnly()
A wrapper.

BinarySearch

#
Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element.
public int BinarySearch(
index,
The zero-based starting index of the range to search.
count,
The length of the range to search.
T
item,
The object to locate. The value can be a null reference (Nothing in Visual Basic) for reference types.
comparer
The IComparer(T) implementation to use when comparing elements. Or a null reference (Nothing in Visual Basic) to use the default comparer Comparer(T)::Default.
)
The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count.

BinarySearch

#
Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element.
public int BinarySearch(
T
item,
The object to locate. The value can be a null reference (Nothing in Visual Basic) for reference types.
comparer
The IComparer(T) implementation to use when comparing elements. Or a null reference (Nothing in Visual Basic) to use the default comparer Comparer(T)::Default.
)
The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count.

BinarySearch

#
Searches the entire sorted List for an element using the default comparer and returns the zero-based index of the element.
public int BinarySearch(
T
item
The object to locate. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count.

Clear

#
Removes all elements from the List.
public void Clear()

Contains

#
Determines whether an element is in the List.
public bool Contains(
T
item
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
true if item is found in the List; otherwise, false.

ConvertAll<TOutput>

#
Aggregates all results of a conversion function over this table into a new list.
public RhinoList<TOutput> ConvertAll<TOutput>(
Converter<T, TOutput>
converter
A conversion function that can transform from T to TOutput.
)
The new list.

CopyTo

#
Copies a range of elements from the List to a compatible one-dimensional array, starting at the specified index of the target array.
public void CopyTo(
index,
The zero-based index in the source List at which copying begins.
T[]
array,
The one-dimensional Array that is the destination of the elements copied from List. The Array must have zero-based indexing.
arrayIndex,
The zero-based index in array at which copying begins.
count
The number of elements to copy.
)

CopyTo

#
Copies the entire List to a compatible one-dimensional array, starting at the specified index of the target array.
public void CopyTo(
T[]
array,
The one-dimensional Array that is the destination of the elements copied from List. The Array must have zero-based indexing.
arrayIndex
The zero-based index in array at which copying begins.
)

CopyTo

#
Copies the entire List to a compatible one-dimensional array, starting at the beginning of the target array.
public void CopyTo(
T[]
array
The one-dimensional Array that is the destination of the elements copied from List. The Array must have zero-based indexing.
)

Duplicate

#
Returns a shallow copy of this instance. If the generic type is comprised of only value types (struct, enum, ptr), then the result will be a deep copy.
public RhinoList<T> Duplicate()
The duplicated list.

Exists

#
Determines whether the List contains elements that match the conditions defined by the specified predicate.
public bool Exists(
match
The Predicate(T) delegate that defines the conditions of the elements to search for.
)
true if the List contains one or more elements that match the conditions defined by the specified predicate; otherwise, false.

Find

#
Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List.
public T Find(
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.

FindAll

#
Retrieves all the elements that match the conditions defined by the specified predicate.
public RhinoList<T> FindAll(
match
The Predicate(T) delegate that defines the conditions of the elements to search for.
)
A ON_List(T) containing all the elements that match the conditions defined by the specified predicate, if found; otherwise, an empty ON_List(T).

FindIndex

#
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element.
public int FindIndex(
startIndex,
The zero-based starting index of the search.
count,
The number of elements in the section to search.
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindIndex

#
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List.
public int FindIndex(
startIndex,
The zero-based starting index of the search.
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindIndex

#
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List.
public int FindIndex(
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindLast

#
Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List.
public T FindLast(
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T.

FindLastIndex

#
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.
public int FindLastIndex(
startIndex,
The zero-based starting index of the backward search.
count,
The number of elements in the section to search.
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindLastIndex

#
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.
public int FindLastIndex(
startIndex,
The zero-based starting index of the backward search.
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

FindLastIndex

#
Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.
public int FindLastIndex(
match
The Predicate(T) delegate that defines the conditions of the element to search for.
)
The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1.

ForEach

#
Performs the specified action on each element of the List.
public void ForEach(
Action<T>
action
The Action(T) delegate to perform on each element of the List.
)

GetEnumerator

#
Constructs an enumerator that is capable of iterating over all items in this list.
public IEnumerator<T> GetEnumerator()
The new enumerator.

GetRange

#
Constructs a shallow copy of a range of elements in the source List.
public RhinoList<T> GetRange(
index,
The zero-based List index at which the range starts.
count
The number of elements in the range.
)
A shallow copy of a range of elements in the source List.

IndexOf

#
Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that starts at the specified index and contains the specified number of elements.
public int IndexOf(
T
item,
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
index,
The zero-based starting index of the search.
count
The number of elements in the section to search.
)
The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1.

IndexOf

#
Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element.
public int IndexOf(
T
item,
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
index
The zero-based starting index of the search.
)
The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1.

IndexOf

#
Searches for the specified object and returns the zero-based index of the first occurrence within the entire List.
public int IndexOf(
T
item
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1.

Insert

#
Inserts an element into the List at the specified index.
public void Insert(
index,
The zero-based index at which item should be inserted.
T
item
The object to insert. The value can be a null reference (Nothing in Visual Basic) for reference types.
)

InsertRange

#
Inserts the elements of a collection into the List at the specified index.
public void InsertRange(
index,
The zero-based index at which the new elements should be inserted.
collection
The collection whose elements should be inserted into the List. The collection itself cannot be a null reference (Nothing in Visual Basic), but it can contain elements that are a null reference (Nothing in Visual Basic), if type T is a reference type.
)

LastIndexOf

#
Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that contains the specified number of elements and ends at the specified index.
public int LastIndexOf(
T
item,
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
index,
The zero-based starting index of the backward search.
count
The number of elements in the section to search.
)
The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1.

LastIndexOf

#
Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that extends from the first element to the specified index.
public int LastIndexOf(
T
item,
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
index
The zero-based starting index of the backward search.
)
The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1.

LastIndexOf

#
Searches for the specified object and returns the zero-based index of the last occurrence within the entire List.
public int LastIndexOf(
T
item
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1.

RemapIndex

#
Remap an index in the infinite range onto the List index range.
public int RemapIndex(
index
Index to remap.
)
Remapped index.

Remove

#
Removes the first occurrence of a specific object from the List.
public bool Remove(
T
item
The object to remove from the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the List.

RemoveAll

#
Removes the all the elements that match the conditions defined by the specified predicate.
public int RemoveAll(
match
The Predicate(T) delegate that defines the conditions of the elements to remove.
)
The number of elements removed from the List.

RemoveAt

#
Removes the element at the specified index of the List.
public void RemoveAt(
index
The zero-based index of the element to remove.
)

RemoveNulls

#
Removes all elements from the List that are null references (Nothing in Visual Basic). This function will not do anything if T is not a Reference type.
public int RemoveNulls()
The number of nulls removed from the List.

RemoveRange

#
Removes a range of elements from the List.
public void RemoveRange(
index,
The zero-based starting index of the range of elements to remove.
count
The number of elements to remove.
)

Reverse

#
Reverses the order of the elements in the entire List.
public void Reverse()

Reverse

#
Reverses the order of the elements in the specified range.
public void Reverse(
index,
The zero-based starting index of the range to reverse.
count
The number of elements in the range to reverse.
)

Sort

#
Sorts the elements in the entire List using the default comparer.
public void Sort()

Sort

#
Sorts the elements in the entire list using the specified comparer.
public void Sort(
comparison
The System.Comparison(T) to use when comparing elements.
)

Sort

#
Sort this list based on a list of numeric keys of equal length. The keys array will not be altered.
public void Sort(
keys
Numeric keys to sort with.
)
Remarks: This function does not exist on the DotNET List class. David thought it was a good idea.

Sort

#
Sorts the elements in the entire list using the specified System.Comparison(T)
public void Sort(
comparer
The IComparer(T) implementation to use when comparing elements, or a null reference (Nothing in Visual Basic) to use the default comparer Comparer(T).Default.
)

Sort

#
Sorts the elements in a range of elements in list using the specified comparer.
public void Sort(
index,
The zero-based starting index of the range to sort.
count,
The length of the range to sort.
comparer
The IComparer(T) implementation to use when comparing elements, or a null reference (Nothing in Visual Basic) to use the default comparer Comparer(T).Default.
)

Sort

#
Sort this list based on a list of numeric keys of equal length. The keys array will not be altered.
public void Sort(
int[]
keys
Numeric keys to sort with.
)
Remarks: This function does not exist on the DotNET List class. David thought it was a good idea.
Explicit

ICollection.CopyTo

#
Copies the elements of the ICollection to an Array, starting at a particular Array index.
void ICollection.CopyTo(
array,
The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.
arrayIndex
The zero-based index in array at which copying begins.
)
Explicit

IEnumerable.GetEnumerator

#
IEnumerator IEnumerable.GetEnumerator()
Explicit

IList.Add

#
Adds an item to the IList.
int IList.Add(
item
The Object to add to the IList.
)
The position into which the new element was inserted.
Explicit

IList.Contains

#
Determines whether an element is in the List.
bool IList.Contains(
item
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
true if item is found in the List; otherwise, false.
Explicit

IList.IndexOf

#
Searches for the specified object and returns the zero-based index of the first occurrence within the entire List.
int IList.IndexOf(
item
The object to locate in the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1.
Explicit

IList.Insert

#
Inserts an element into the List at the specified index.
void IList.Insert(
index,
The zero-based index at which item should be inserted.
item
The object to insert. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
Explicit

IList.Remove

#
Removes the first occurrence of a specific object from the List.
void IList.Remove(
item
The object to remove from the List. The value can be a null reference (Nothing in Visual Basic) for reference types.
)
Explicit

ICloneable.Clone

#

ToArray

#
Constructs an array that contains all items in this list.
public T[] ToArray()
An array containing all items in this list.

TrimExcess

#
Sets the capacity to the actual number of elements in the List, if that number is less than a threshold value.
public void TrimExcess()
Remarks: This function differs from the DotNET implementation of List<T> since that one only trims the excess if the excess exceeds 10% of the list length.

TrueForAll

#
Determines whether every element in the List matches the conditions defined by the specified predicate.
public bool TrueForAll(
match
The Predicate(T) delegate that defines the conditions to check against the elements.
)
true if every element in the List matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true.