ICatchments Methods |
The ICatchments type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Add | Adds an item to the ICollection<T>. (Inherited from ICollection<ICatchment>.) |
| Clear | Removes all items from the ICollection<T>. (Inherited from ICollection<ICatchment>.) |
| Contains | Determines whether the ICollection<T> contains a specific value. (Inherited from ICollection<ICatchment>.) |
| CopyTo | (Inherited from ICollection<ICatchment>.) |
| Find |
Find a catchment by catchment model id (unique)
|
| FindAll |
Find a catchment by catchment name
|
| GetEnumerator | Returns an enumerator that iterates through the collection. (Inherited from IEnumerable<ICatchment>.) |
| IndexOf | Determines the index of a specific item in the IList<T>. (Inherited from IList<ICatchment>.) |
| Initialize |
Initialize Rainfall Runoff models. Sets up static data.
|
| Insert | Inserts an item to the IList<T> at the specified index. (Inherited from IList<ICatchment>.) |
| Prepare |
Prepare Rainfall Runoff models. Sets up dynamic data so that the model is ready for first time step.
|
| Remove | Removes the first occurrence of a specific object from the ICollection<T>. (Inherited from ICollection<ICatchment>.) |
| RemoveAt | Removes the IList<T> item at the specified index. (Inherited from IList<ICatchment>.) |
Extension Methods| Name | Description | |
|---|---|---|
 | BinarySearch<ICatchment>(ICatchment) | Overloaded.
Searches the entire sorted IList<T> for an element
and returns the zero-based index of the element.
(Defined by GenericExtensions.)If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e. list[interval-1] < key < list[interval] |
 | BinarySearch<ICatchment>(Func<ICatchment, Int32>) | Overloaded.
Searches the entire sorted IList<T> for an element using the provided
comparer and returns the zero-based index of the element.
(Defined by GenericExtensions.)This differs from the "ordinary" binary search in allowing a comparer delegate that defines whether an item is found (returning 0), whether the item in the list is before (<0) or after (>0) that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class. Examples
If having a list of doubles, to find 4.5 in the list, use:
int index = list.BinarySearch(d => d.CompareTo(4.5)) |
| BinarySearch<ICatchment>(ICatchment, IComparer<ICatchment>) | Overloaded.
Searches the entire sorted IList<T> for an element using the provided
comparer and returns the zero-based index of the element.
(Defined by GenericExtensions.)If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e. list[interval-1] < key < list[interval] |
| BinarySearch<ICatchment, TKey>(Func<ICatchment, TKey>, TKey) | Overloaded.
Searches the entire sorted IList<T> for an element
and returns the zero-based index of the element.
(Defined by GenericExtensions.)If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e. list[interval-1] < key < list[interval]This differs from the "ordinary" binary search in allowing a keySelectorcomparer that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class. |
| BinarySearch<ICatchment, TKey>(Func<ICatchment, TKey>, TKey, IComparer<TKey>) | Overloaded.
Searches the entire sorted IList<T> for an element using the provided
comparer and returns the zero-based index of the element.
(Defined by GenericExtensions.)If the key is not found, a negative number is returned, which can be intepreted as the bitwise complement of the interval of indices that the key is in between, i.e. list[interval-1] < key < list[interval]This differs from the "ordinary" binary search in allowing a keySelectorcomparer that knows how to compare a class with its key. Example, if the list contains classes of type T having an id number and the class is sorted on that id, then the keySelector returns the id number for that class. |
| FindAll |
Find all catchments with the specified name, and providing the specified quantity
(Defined by RRExtensions.) |
| FindIndex<ICatchment>(Predicate<ICatchment>) | Overloaded. 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. (Defined by GenericExtensions.) |
| FindIndex<ICatchment>(Int32, Predicate<ICatchment>) | Overloaded. 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<T> that extends from the specified index to the last element. (Defined by GenericExtensions.) |
| Sort<ICatchment>() | Overloaded.
Sorts the elements in the entire List{T} using the default comparer.
(Defined by GenericExtensions.)A quick sort algorithm is used. Quick sort is a un-stable sort algorithm i.e. if two elements are equal their order may not be preserved. If the provided IList is either an array or a list, the build in sorting method is used (also quick sort). |
| Sort<ICatchment>(IComparer<ICatchment>) | Overloaded.
Sorts the elements in the entire List{T} using the provided comparer.
(Defined by GenericExtensions.)A quick sort algorithm is used. Quick sort is a un-stable sort algorithm i.e. if two elements are equal their order may not be preserved. If the provided IList is either an array or a list, the build in sorting method is used (also quick sort). |
| SortStable<ICatchment>() | Overloaded. (Defined by GenericExtensions.) |
| SortStable<ICatchment>(IComparer<ICatchment>) | Overloaded.
Sorts the elements in the entire List{T} using the provided comparer.
(Defined by GenericExtensions.)A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. |
| SortStable<ICatchment>(Comparison<ICatchment>) | Overloaded.
Sorts the elements in the entire List{T} using the provided comparer.
(Defined by GenericExtensions.)A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. |
See Also