QueueDateTimes Class

Class implementing the IListDateTimes storing data in a queue/circular array.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.Generic.CollectionsFifoQueueDateTime
DHI.Mike1D.GenericQueueDateTimes

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

Syntax

C++

Copy

public class QueueDateTimes : FifoQueue<DateTime>, 
	IListDateTimes, IEnumerable<DateTime>, IEnumerable, IList<DateTime>, 
	ICollection<DateTime>, IReadOnlyList<DateTime>, IReadOnlyCollection<DateTime>

Public Class QueueDateTimes
	Inherits FifoQueue(Of DateTime)
	Implements IListDateTimes, IEnumerable(Of DateTime), 
	IEnumerable, IList(Of DateTime), ICollection(Of DateTime), 
	IReadOnlyList(Of DateTime), IReadOnlyCollection(Of DateTime)

public ref class QueueDateTimes : public FifoQueue<DateTime>, 
	IListDateTimes, IEnumerable<DateTime>, IEnumerable, IList<DateTime>, 
	ICollection<DateTime>, IReadOnlyList<DateTime>, IReadOnlyCollection<DateTime>

The QueueDateTimes type exposes the following members.

Constructors

	Name	Description
	QueueDateTimes	Initializes a new instance of the QueueDateTimes class

Top

Properties

	Name	Description
	Array	An array representation of the current content of the queue. Note that this will make a copy of the internal array (Inherited from FifoQueueT.)
	Capacity	Gets or sets the total number of elements the internal data structure can hold without resizing. (Inherited from FifoQueueT.)
	Count	Gets the number of elements contained in the FifoQueue{T}. (Inherited from FifoQueueT.)
	Item	Gets/sets the element at the specified position in the FifoQueue{T}. (Inherited from FifoQueueT.)
	Tail	Index in internal _q array of last element in the queue (Inherited from FifoQueueT.)

Top

Methods

	Name	Description
	Add	Adds an object to the end of the FifoQueue{T}, same as Enqueue(T) (Inherited from FifoQueueT.)
	AddRange	Adds an object to the end of the FifoQueue{T}, same as Enqueue(T) (Inherited from FifoQueueT.)
	AddRotate	Adds an object to the end of the FifoQueue{T}, dequeuing the first item if queue is full (capacity is met). (Inherited from FifoQueueT.)
	Clear	Removes all objects from the FifoQueue{T}. (Inherited from FifoQueueT.)
	Contains	Determines whether the ICollectionT contains a specific value. (Inherited from FifoQueueT.)
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index. (Inherited from FifoQueueT.)
	Dequeue	Removes and returns the object at the beginning of the FifoQueue{T}. (Inherited from FifoQueueT.)
	Enqueue	Adds an object to the end of the FifoQueue{T}. (Inherited from FifoQueueT.)
	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
	GetEnumerator	Returns an enumerator that iterates through the FifoQueue{T}. (Inherited from FifoQueueT.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Index	Index in internal _q array _q of the element with index in queue, handling circular array wrapping. (Inherited from FifoQueueT.)
	IndexOf	Determines the index of a specific item in the IListT. (Inherited from FifoQueueT.)
	Insert	Inserts an item to the IListT at the specified index. (Inherited from FifoQueueT.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Peek	Returns the object at the beginning of the FifoQueue{T} without removing it. (Inherited from FifoQueueT.)
	PushBack	Put the first element to the end of the queue (Inherited from FifoQueueT.)
	Remove	Removes the first occurrence of a specific object from the ICollectionT. (Inherited from FifoQueueT.)
	RemoveAt	Removes the IListT item at the specified index. (Inherited from FifoQueueT.)
	ToArray
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	_count	Number of elements currently in the queue/circular array (Inherited from FifoQueueT.)
	_head	Index of first element in circular array _q (Inherited from FifoQueueT.)
	_q	Internal array of queue values, used as circular array. (Inherited from FifoQueueT.)

Top

Extension Methods

	Name	Description
	BinarySearchDateTime(DateTime)	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.)
	BinarySearchDateTime(FuncDateTime, 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.)
	BinarySearchDateTime(DateTime, IComparerDateTime)	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.)
	BinarySearchDateTime, TKey(FuncDateTime, 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.)
	BinarySearchDateTime, TKey(FuncDateTime, 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.)
	FindIndexDateTime(PredicateDateTime)	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.)
	FindIndexDateTime(Int32, PredicateDateTime)	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.)
	SortDateTime	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.)
	SortDateTime(IComparerDateTime)	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.)
	SortStableDateTime	Overloaded. (Defined by GenericExtensions.)
	SortStableDateTime(IComparerDateTime)	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.)
	SortStableDateTime(ComparisonDateTime)	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.Generic Namespace