EngineNodes Class

List of EngineNode's, providing functionality for fast searching on node id.

The list does not allow nodes with the same id.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.EngineEngineNodes

Namespace: DHI.Mike1D.Engine
Assembly: DHI.Mike1D.Engine (in DHI.Mike1D.Engine.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class EngineNodes : IList<EngineNode>, 
	ICollection<EngineNode>, IEnumerable<EngineNode>, IEnumerable, 
	IReadOnlyList<EngineNode>, IReadOnlyCollection<EngineNode>

Public Class EngineNodes
	Implements IList(Of EngineNode), ICollection(Of EngineNode), 
	IEnumerable(Of EngineNode), IEnumerable, IReadOnlyList(Of EngineNode), 
	IReadOnlyCollection(Of EngineNode)

public ref class EngineNodes : IList<EngineNode^>, 
	ICollection<EngineNode^>, IEnumerable<EngineNode^>, IEnumerable, 
	IReadOnlyList<EngineNode^>, IReadOnlyCollection<EngineNode^>

The EngineNodes type exposes the following members.

Constructors

	Name	Description
	EngineNodes	Default constructor.
	EngineNodes(IEnumerableEngineNode)	Constructor initializing the list with another collection.

Top

Properties

	Name	Description
	Count	Gets the number of elements contained in the ICollectionT.
	IsReadOnly	Gets a value indicating whether the ICollectionT is read-only.
	Item	Gets or sets the element at the specified index.

Top

Methods

	Name	Description
	Add	Adds an item to the ICollectionT.
	Clear	Removes all items from the ICollectionT.
	Contains	Determines whether the ICollectionT contains a specific value.
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Find(String)	Find EngineNode based on Node ID.
	Find(PredicateEngineNode)	Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire list. Linear searching, o(n), so use with care.
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Determines the index of a specific item in the IListT.
	Insert	Inserts an item to the IListT at the specified index.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes the first occurrence of a specific object from the ICollectionT.
	RemoveAt	Removes the IListT item at the specified index.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TrimExcess	Sets the capacity to the actual number of elements in the collection, if that number is less than a threshold value.

Top

Extension Methods

	Name	Description
	BinarySearchEngineNode(EngineNode)	Overloaded. Searches the entire sorted IListT for an element and returns the zero-based index of the element. 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. Copy list[interval-1] < key < list[interval] (Defined by GenericExtensions.)
	BinarySearchEngineNode(FuncEngineNode, Int32)	Overloaded. Searches the entire sorted IListT for an element using the provided comparer and returns the zero-based index of the element. 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: Copy int index = list.BinarySearch(d => d.CompareTo(4.5)) (Defined by GenericExtensions.)
	BinarySearchEngineNode(EngineNode, IComparerEngineNode)	Overloaded. Searches the entire sorted IListT for an element using the provided comparer and returns the zero-based index of the element. 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. Copy list[interval-1] < key < list[interval] (Defined by GenericExtensions.)
	BinarySearchEngineNode, TKey(FuncEngineNode, TKey, TKey)	Overloaded. Searches the entire sorted IListT for an element and returns the zero-based index of the element. 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. Copy 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. (Defined by GenericExtensions.)
	BinarySearchEngineNode, TKey(FuncEngineNode, TKey, TKey, IComparerTKey)	Overloaded. Searches the entire sorted IListT for an element using the provided comparer and returns the zero-based index of the element. 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. Copy 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. (Defined by GenericExtensions.)
	FindIndexEngineNode(PredicateEngineNode)	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.)
	FindIndexEngineNode(Int32, PredicateEngineNode)	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 ListT that extends from the specified index to the last element. (Defined by GenericExtensions.)
	SortEngineNode	Overloaded. Sorts the elements in the entire List{T} using the default comparer. 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). (Defined by GenericExtensions.)
	SortEngineNode(IComparerEngineNode)	Overloaded. Sorts the elements in the entire List{T} using the provided comparer. 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). (Defined by GenericExtensions.)
	SortStableEngineNode	Overloaded. (Defined by GenericExtensions.)
	SortStableEngineNode(IComparerEngineNode)	Overloaded. Sorts the elements in the entire List{T} using the provided comparer. A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. (Defined by GenericExtensions.)
	SortStableEngineNode(ComparisonEngineNode)	Overloaded. Sorts the elements in the entire List{T} using the provided comparer. A merge sort algorithm is used. merge sort is a stable sort algorithm i.e. if two elements are equal their order are preserved. (Defined by GenericExtensions.)

Top

Reference

DHI.Mike1D.Engine Namespace