OrderedDictionaryTKey, TValue Class

Represents an ordered collection of keys and values with the same performance as DictionaryTKey, TValue with O(1) lookups and adds but with O(n) inserts and removes.

Inheritance Hierarchy

SystemObject
GSF.CollectionsOrderedDictionaryTKey, TValue

Namespace: GSF.Collections
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public class OrderedDictionary<TKey, TValue> : IDictionary<TKey, TValue>, 
	ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, 
	IEnumerable, IReadOnlyDictionary<TKey, TValue>, IReadOnlyCollection<KeyValuePair<TKey, TValue>>, 
	IList<KeyValuePair<TKey, TValue>>, IReadOnlyList<KeyValuePair<TKey, TValue>>

Public Class OrderedDictionary(Of TKey, TValue)
	Implements IDictionary(Of TKey, TValue), ICollection(Of KeyValuePair(Of TKey, TValue)), 
	IEnumerable(Of KeyValuePair(Of TKey, TValue)), IEnumerable, 
	IReadOnlyDictionary(Of TKey, TValue), IReadOnlyCollection(Of KeyValuePair(Of TKey, TValue)), 
	IList(Of KeyValuePair(Of TKey, TValue)), IReadOnlyList(Of KeyValuePair(Of TKey, TValue))

generic<typename TKey, typename TValue>
public ref class OrderedDictionary : IDictionary<TKey, TValue>, 
	ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, 
	IEnumerable, IReadOnlyDictionary<TKey, TValue>, IReadOnlyCollection<KeyValuePair<TKey, TValue>>, 
	IList<KeyValuePair<TKey, TValue>>, IReadOnlyList<KeyValuePair<TKey, TValue>>

type OrderedDictionary<'TKey, 'TValue> = 
    class
        interface IDictionary<'TKey, 'TValue>
        interface ICollection<KeyValuePair<'TKey, 'TValue>>
        interface IEnumerable<KeyValuePair<'TKey, 'TValue>>
        interface IEnumerable
        interface IReadOnlyDictionary<'TKey, 'TValue>
        interface IReadOnlyCollection<KeyValuePair<'TKey, 'TValue>>
        interface IList<KeyValuePair<'TKey, 'TValue>>
        interface IReadOnlyList<KeyValuePair<'TKey, 'TValue>>
    end

JavaScript does not support generic types or methods.

View Source

Type Parameters

TKey: The type of the keys in the dictionary.
TValue: The type of the values in the dictionary.

The OrderedDictionaryTKey, TValue type exposes the following members.

Constructors

	Name	Description
	OrderedDictionaryTKey, TValue	Initializes a new instance of the OrderedDictionaryTKey, TValue class that is empty, has the default initial capacity, and uses the default equality comparer for the key type.
	OrderedDictionaryTKey, TValue(IEnumerableKeyValuePairTKey, TValue)	Initializes a new instance of the OrderedDictionaryTKey, TValue class that contains elements copied from the specified [!:IEnumerable<KeyValuePair<TKey, TValue>>] and uses the default equality comparer for the key type.
	OrderedDictionaryTKey, TValue(IEqualityComparerTKey)	Initializes a new instance of the OrderedDictionaryTKey, TValue class that is empty, has the default initial capacity, and uses the specified IEqualityComparerT.
	OrderedDictionaryTKey, TValue(Int32)	Initializes a new instance of the OrderedDictionaryTKey, TValue class that is empty, has the specified initial capacity, and uses the default equality comparer for the key type.
	OrderedDictionaryTKey, TValue(IEnumerableKeyValuePairTKey, TValue, IEqualityComparerTKey)	Initializes a new instance of the OrderedDictionaryTKey, TValue class that contains elements copied from the specified [!:IEnumerable<KeyValuePair<TKey, TValue>>] and uses the specified IEqualityComparerT.
	OrderedDictionaryTKey, TValue(Int32, IEqualityComparerTKey)	Initializes a new instance of the OrderedDictionaryTKey, TValue class that is empty, has the specified initial capacity, and uses the specified IEqualityComparerT.

Top

Properties

	Name	Description
	Comparer	Gets the IEqualityComparerT that is used to determine equality of keys for the dictionary.
	Count	Gets the number of key/value pairs contained in the OrderedDictionaryTKey, TValue.
	ItemInt32	Gets or sets the value at the specified index as an O(1) operation.
	ItemTKey	Gets or sets the value associated with the specified key as an O(1) operation.
	Keys	Gets a collection containing the keys in the OrderedDictionaryTKey, TValue.
	Values	Gets a collection containing the values in the OrderedDictionaryTKey, TValue.

Top

Methods

	Name	Description
	Add	Adds the specified key and value to the dictionary as an O(1) operation.
	Clear	Removes all keys and values from the OrderedDictionaryTKey, TValue.
	ContainsKey	Determines whether the OrderedDictionaryTKey, TValue contains the specified key as an O(1) operation.
	EnsureCapacity	Resizes the internal data structure if necessary to ensure no additional resizing to support the specified capacity.
	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)
	GetEnumerator	Returns an enumerator that iterates through the OrderedDictionaryTKey, TValue.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetOrAdd(TKey, TValue)	Adds a key/value pair to the OrderedDictionaryTKey, TValue if the key does not already exist as an O(1) operation.
	GetOrAdd(TKey, FuncTValue)	Adds a key/value pair to the OrderedDictionaryTKey, TValue by using the specified function, if the key does not already exist as an O(1) operation.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IndexOf	Returns the zero-based index of the element with the specified key within the OrderedDictionaryTKey, TValue as an O(1) operation.
	Insert	Inserts the specified key/value pair into the OrderedDictionaryTKey, TValue at the specified index as an O(n) operation.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	Move	Moves the element at the specified fromIndex to the specified toIndex while re-arranging the elements in between.
	MoveRange	Moves the specified number of elements at the specified fromIndex to the specified toIndex while re-arranging the elements in between.
	Remove(TKey)	Removes the value with the specified key from the OrderedDictionaryTKey, TValue as an O(n) operation.
	Remove(TKey, TValue)	Removes the value with the specified key from the OrderedDictionaryTKey, TValue and returns the value as an O(n) operation.
	RemoveAt	Removes the value at the specified index from the OrderedDictionaryTKey, TValue as an O(n) operation.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TrimExcess	Sets the capacity of an OrderedDictionaryTKey, TValue object to the actual number of elements it contains, rounded up to a nearby, implementation-specific value.
	TrimExcess(Int32)	Sets the capacity of an OrderedDictionaryTKey, TValue object to the specified capacity, rounded up to a nearby, implementation-specific value.
	TryAdd	Tries to add the specified key and value to the dictionary as an O(1) operation.
	TryGetValue	Gets the value associated with the specified key as an O(1) operation.

Top

Extension Methods

	Name	Description
	AddRangeKeyValuePairTKey, TValue	Adds the specified items to the collection. (Defined by CollectionExtensions)
	AllParallelKeyValuePairTKey, TValue	Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel. (Defined by CollectionExtensions)
	DistinctByKeyValuePairTKey, TValue, TKey	Returns only the elements whose keys are distinct. (Defined by CollectionExtensions)
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetRangeKeyValuePairTKey, TValue	Returns elements in the specified range from the collection. (Defined by CollectionExtensions)
	IndexOfKeyValuePairTKey, TValue	Returns the index of the first element of the sequence that satisfies a condition or -1 if no such element is found. (Defined by CollectionExtensions)
	LoadDelimitedStringKeyValuePairTKey, TValue	Appends items parsed from delimited string, created with ToDelimitedString, using the default delimiter ("\|") into the given list. (Defined by CollectionExtensions)
	LoadDelimitedStringKeyValuePairTKey, TValue	Appends items parsed from delimited string, created with ToDelimitedString, into the given list. (Defined by CollectionExtensions)
	LoadDelimitedStringKeyValuePairTKey, TValue	Appends items parsed from delimited string, created with ToDelimitedString, into the given list. (Defined by CollectionExtensions)
	MajorityKeyValuePairTKey, TValue	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityKeyValuePairTKey, TValue	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByKeyValuePairTKey, TValue, TKey	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByKeyValuePairTKey, TValue, TKey	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MaxKeyValuePairTKey, TValue	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxKeyValuePairTKey, TValue	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxByKeyValuePairTKey, TValue, TKey	Selects the largest item from the enumeration. (Defined by CollectionExtensions)
	MedianKeyValuePairTKey, TValue	Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MinKeyValuePairTKey, TValue	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinKeyValuePairTKey, TValue	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinByKeyValuePairTKey, TValue, TKey	Selects the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinorityKeyValuePairTKey, TValue	Returns the minority value in the collection, or default type value if no item represents the minority. (Defined by CollectionExtensions)
	MinorityKeyValuePairTKey, TValue	Returns the minority value in the collection, or defaultValue if no item represents the minority. (Defined by CollectionExtensions)
	MinorityByKeyValuePairTKey, TValue, TKey	Returns the minority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MinorityByKeyValuePairTKey, TValue, TKey	Returns the minority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	ScrambleKeyValuePairTKey, TValue	Rearranges all the elements in the list into a highly-random order. (Defined by CollectionExtensions)
	ScrambleKeyValuePairTKey, TValue	Rearranges all the elements in the list into a repeatable pseudo-random order. (Defined by CollectionExtensions)
	StandardDeviationKeyValuePairTKey, TValue	Computes the standard deviation over a sequence of Double values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationKeyValuePairTKey, TValue	Computes the standard deviation over a sequence of Decimal values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationKeyValuePairTKey, TValue	Computes the standard deviation over a sequence of Single values. (Defined by NumericalAnalysisExtensions)
	ToDelimitedStringKeyValuePairTKey, TValue	Converts an enumeration to a string, using the default delimiter ("\|") that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringKeyValuePairTKey, TValue	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringKeyValuePairTKey, TValue	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToPagedListKeyValuePairTKey, TValue	Gets a PagedListT to paginate source enumeration for a given page and specified pageSize. (Defined by CollectionExtensions)
	UnscrambleKeyValuePairTKey, TValue	Rearranges all the elements in the list previously scrambled with ScrambleTSource(IListTSource, Int32) back into their original order. (Defined by CollectionExtensions)
	UpdateRangeKeyValuePairTKey, TValue	Updates collection starting at the index with the specified items. (Defined by CollectionExtensions)

Top

Reference

GSF.Collections Namespace