Class EnumDictionary<TEnum, TValue>

Namespace: Gamelogic.Extensions

Assembly: Gamelogic.Extensions.dll

Represents a dictionary with keys of an enumerated type.

[Version(4, 5, 0)]
[Serializable]
public class EnumDictionary<TEnum, TValue> : IReadOnlyDictionary<TEnum, TValue>, IReadOnlyCollection<KeyValuePair<TEnum, TValue>>, IEnumerable<KeyValuePair<TEnum, TValue>>, IEnumerable

Type Parameters

TEnum: A type of enum. An error will be thrown if this type is not an enum type.
TValue: The value type. For the dictionary to be serializable, this type must also be serializable.

Inheritance: object

EnumDictionary<TEnum, TValue>

Implements: IReadOnlyDictionary<TEnum, TValue>

IReadOnlyCollection<KeyValuePair<TEnum, TValue>>

IEnumerable<KeyValuePair<TEnum, TValue>>

IEnumerable

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: CollectionExtensions.Aggregate<T>(IEnumerable<T>, Func<T, T, T>, Func<T, T, T>)

CollectionExtensions.AsCountable<T>(IEnumerable<T>)

CollectionExtensions.AsList<T>(IEnumerable<T>)

CollectionExtensions.ButFirst<T>(IEnumerable<T>)

CollectionExtensions.ButLast<T>(IEnumerable<T>)

CollectionExtensions.HasSameElementsAs<T>(IEnumerable<T>, IEnumerable<T>)

CollectionExtensions.HasSingle<T>(IEnumerable<T>)

CollectionExtensions.ListToString<T>(IEnumerable<T>)

CollectionExtensions.MaxBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>)

CollectionExtensions.MaxBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>, IComparer<TKey>)

CollectionExtensions.MaxItemsBy<T, TComparable>(IEnumerable<T>, Func<T, TComparable>)

CollectionExtensions.MaxItemsBy<T, TComparable>(IEnumerable<T>, Func<T, TComparable>, Comparer<TComparable>)

CollectionExtensions.MinBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>)

CollectionExtensions.MinBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>, IComparer<TKey>)

CollectionExtensions.MinItemsBy<T, TComparable>(IEnumerable<T>, Func<T, TComparable>)

CollectionExtensions.MinItemsBy<T, TComparable>(IEnumerable<T>, Func<T, TComparable>, Comparer<TComparable>)

CollectionExtensions.RandomItem<T>(IEnumerable<T>)

CollectionExtensions.RandomItem<T>(IEnumerable<T>, IRandom)

CollectionExtensions.RotateLeft<T>(IEnumerable<T>)

CollectionExtensions.RotateRight<T>(IEnumerable<T>)

CollectionExtensions.SampleRandom<T>(IEnumerable<T>, int)

CollectionExtensions.SampleRandom<T>(IEnumerable<T>, int, IRandom)

CollectionExtensions.SlidingWindow<T>(IEnumerable<T>, int)

CollectionExtensions.TakeHalf<T>(IEnumerable<T>)

CollectionExtensions.TakeLast<T>(IEnumerable<T>, int)

CollectionExtensions.TryFirst<T>(IEnumerable<T>, out T)

CollectionExtensions.TryFirst<T>(IEnumerable<T>, Func<T, bool>, out T)

CollectionExtensions.TryLast<T>(IEnumerable<T>, out T)

CollectionExtensions.TryLast<T>(IEnumerable<T>, Func<T, bool>, out T)

CollectionExtensions.TrySingle<T>(IEnumerable<T>, out T)

CollectionExtensions.WithIndices<T>(IEnumerable<T>)

Combinatorial.Combinations<T>(IEnumerable<T>, int)

Combinatorial.Partitions<T>(IEnumerable<T>)

Combinatorial.Permutations<T>(IEnumerable<T>)

Combinatorial.PowerSet<T>(IEnumerable<T>)

Combinatorial.Tuples<T>(IEnumerable<T>)

ThrowHelper.ThrowIfNull(object, string)

Remarks

This class differs from an ordinary dictionary

it is serializable
does not provide constant time access to elements
it always has all values of the enum as keys

It is meant to be used with enums with a smallish number of elements. Because of the last property above, it can cause problems if the enum type used for keys changes. This can corrupt the dictionary. Keep the enum type stable, or inspect all serialized instances after changes have been made.

Constructors

EnumDictionary(): Initializes a new instance of the EnumDictionary<TEnum, TValue> class.

Properties

Count

this[TEnum]

Keys

Values

Methods

ContainsKey(TEnum)

GetEnumerator()