Class FlexDictionary<TKey, TValue>

Namespace

Garyon.DataStructures

Assembly

Garyon.dll

A dictionary that allows indexing or setting values on non-existing keys without throwing exceptions.

public class FlexDictionary<TKey, TValue> : BaseFlexDictionary<TKey, TValue>, IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable where TKey : notnull

Type Parameters

TKey

The type of the keys that are being added to the dictionary.

TValue

The type of the values that are being paired with the keys in the dictionary.

Inheritance

object

BaseFlexDictionary<TKey, TValue>

FlexDictionary<TKey, TValue>

Implements

IDictionary<TKey, TValue>

ICollection<KeyValuePair<TKey, TValue>>

IEnumerable<KeyValuePair<TKey, TValue>>

IEnumerable

Derived

ValueCounterDictionary<TKey>

Inherited Members

BaseFlexDictionary<TKey, TValue>.Dictionary

BaseFlexDictionary<TKey, TValue>.Count

BaseFlexDictionary<TKey, TValue>.Keys

BaseFlexDictionary<TKey, TValue>.Values

BaseFlexDictionary<TKey, TValue>.Add(TKey, TValue)

BaseFlexDictionary<TKey, TValue>.Add(KeyValuePair<TKey, TValue>)

BaseFlexDictionary<TKey, TValue>.Remove(TKey)

BaseFlexDictionary<TKey, TValue>.RemoveKeys(params TKey[])

BaseFlexDictionary<TKey, TValue>.RemoveKeys(IEnumerable<TKey>)

BaseFlexDictionary<TKey, TValue>.Clear()

BaseFlexDictionary<TKey, TValue>.Clone()

BaseFlexDictionary<TKey, TValue>.ContainsKey(TKey)

BaseFlexDictionary<TKey, TValue>.TryGetValue(TKey, out TValue)

BaseFlexDictionary<TKey, TValue>.GetEnumerator()

BaseFlexDictionary<TKey, TValue>.GetNewEntryInitializationValue()

BaseFlexDictionary<TKey, TValue>.AddWithInitializationValue(TKey)

BaseFlexDictionary<TKey, TValue>.this[TKey]

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparisonExtensions.BeginCompare<T>(T, T)

IEnumeratorExtensions.GetEnumerator<TEnumerator, TValue>(TEnumerator)

MoreLinqExtensions.Apply<TSource>(TSource, Action<TSource>)

MoreLinqExtensions.Apply<TSource, TResult>(TSource, Func<TSource, TResult>)

SingleValueEnumeratorExtensions.EnumerateSingle<T>(T)

UpcastingCollectionExtensions.UpcastCollection<TBase, TUp>(ICollection<TBase>)

IDictionaryExtensions.AddOrSetRange<TKey, TValue>(IDictionary<TKey, TValue>, IDictionary<TKey, TValue>)

IDictionaryExtensions.AddOrSet<TKey, TValue>(IDictionary<TKey, TValue>, TKey, TValue)

IDictionaryExtensions.AddRange<TKey, TValue>(IDictionary<TKey, TValue>, IDictionary<TKey, TValue>)

IDictionaryExtensions.Add<TKey, TValue>(IDictionary<TKey, TValue>, KeyValuePair<TKey, TValue>)

IDictionaryExtensions.GetKeyValuePair<TKey, TValue>(IDictionary<TKey, TValue>, TKey)

IDictionaryExtensions.TryAddPreserveRange<TKey, TValue>(IDictionary<TKey, TValue>, IDictionary<TKey, TValue>)

IDictionaryExtensions.TryAddPreserve<TKey, TValue>(IDictionary<TKey, TValue>, KeyValuePair<TKey, TValue>)

IDictionaryExtensions.TryAddPreserve<TKey, TValue>(IDictionary<TKey, TValue>, KeyValuePair<TKey, TValue>, out TValue?)

IDictionaryExtensions.TryAddPreserve<TKey, TValue>(IDictionary<TKey, TValue>, TKey, TValue)

IDictionaryExtensions.TryAddPreserve<TKey, TValue>(IDictionary<TKey, TValue>, TKey, TValue, out TValue?)

IDictionaryExtensions.TryAdd<TKey, TValue>(IDictionary<TKey, TValue>, KeyValuePair<TKey, TValue>)

IDictionaryExtensions.ValueOrDefault<TKey, TValue>(IDictionary<TKey, TValue>, TKey?)

IDictionaryExtensions.ValueOrDefault<TKey, TValue>(IDictionary<TKey, TValue>, TKey?, TValue?)

ToCollectionExtensions.ToSortedDictionaryOrEmpty<TKey, TValue>(IDictionary<TKey, TValue>?)

ToCollectionExtensions.ToSortedDictionary<TKey, TValue>(IDictionary<TKey, TValue>)

ToCollectionExtensions.ToSortedListOrEmpty<TKey, TValue>(IDictionary<TKey, TValue>?)

ToCollectionExtensions.ToSortedList<TKey, TValue>(IDictionary<TKey, TValue>)

UpcastingCollectionExtensions.UpcastDictionary<TKey, TBase, TUp>(IDictionary<TKey, TBase>)

EarlyTerminatingLinqExtensions.CutAt<T>(IEnumerable<T>, Predicate<T>, bool)

EnumerableCartesianProducts.CartesianProduct<T>(IEnumerable<T>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, decimal>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, double>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, int>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, long>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, decimal?>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, double?>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, int?>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, long?>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, float?>)

EnumerableExtremumExtensions.Extremum<T>(IEnumerable<T>, Extremum, Func<T, float>)

EnumerableExtremumExtensions.Extremum<TSource, TResult>(IEnumerable<TSource>, Extremum, Func<TSource, TResult?>)

IEnumerableExtensions.ConcatMultiple<T>(IEnumerable<T>, params IEnumerable<IEnumerable<T>>)

IEnumerableExtensions.ConcatMultiple<T>(IEnumerable<T>, params IEnumerable<T>[])

IEnumerableExtensions.ConcatMultiple<T>(IEnumerable<T>, params ReadOnlySpan<IEnumerable<T>>)

IEnumerableExtensions.EqualsUnordered<T>(IEnumerable<T>, IEnumerable<T>)

MoreLinqExtensions.CountAtLeast<T>(IEnumerable<T>, Func<T, bool>, int)

MoreLinqExtensions.CountAtLeast<T>(IEnumerable<T>, int)

MoreLinqExtensions.CountAtMost<T>(IEnumerable<T>, Func<T, bool>, int)

MoreLinqExtensions.CountAtMost<T>(IEnumerable<T>, int)

MoreLinqExtensions.CountBetween<T>(IEnumerable<T>, Func<T, bool>, int, int)

MoreLinqExtensions.CountBetween<T>(IEnumerable<T>, int, int)

MoreLinqExtensions.CountExactly<T>(IEnumerable<T>, Func<T, bool>, int)

MoreLinqExtensions.CountExactly<T>(IEnumerable<T>, int)

MoreLinqExtensions.EnumeratePerformAction<T>(IEnumerable<T>, Action<T>?, Action<T>?, Action<T>)

MoreLinqExtensions.NotNullCount<T>(IEnumerable<T>)

MoreLinqExtensions.NullCount<T>(IEnumerable<T>)

MoreLinqExtensions.OnlyOrDefault<T>(IEnumerable<T>?)

MoreLinqExtensions.SelectOrDefault<TSource, TResult>(IEnumerable<TSource>, Func<TSource, TResult>?)

MoreLinqExtensions.WhereNotNull<T>(IEnumerable<T?>)

MoreLinqExtensions.WhereNot<T>(IEnumerable<T>, Func<T, bool>)

MoreLinqExtensions.WhereOrSource<T>(IEnumerable<T>, Func<T, bool>?)

MoreLinqExtensions.WherePredicate<T>(IEnumerable<T>, Predicate<T>)

MoreLinqExtensions.Zip<TA, TB>(IEnumerable<TA>, IEnumerable<TB>)

PendingLinqExtensions.Sum<TSource>(IEnumerable<TSource>, Func<TSource, uint?>)

PendingLinqExtensions.Sum<TSource>(IEnumerable<TSource>, Func<TSource, ulong?>)

PendingLinqExtensions.Sum<TSource>(IEnumerable<TSource>, Func<TSource, uint>)

PendingLinqExtensions.Sum<TSource>(IEnumerable<TSource>, Func<TSource, ulong>)

ToCollectionExtensions.ToArrayOrEmpty<T>(IEnumerable<T>?)

ToCollectionExtensions.ToArrayOrExisting<T>(IEnumerable<T>)

ToCollectionExtensions.ToCollectionOrExisting<T>(IEnumerable<T>)

ToCollectionExtensions.ToDictionaryOrExisting<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>)

ToCollectionExtensions.ToDictionary<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>)

ToCollectionExtensions.ToHashSetOrEmpty<T>(IEnumerable<T>?)

ToCollectionExtensions.ToHashSetOrExisting<T>(IEnumerable<T>)

ToCollectionExtensions.ToListOrEmpty<T>(IEnumerable<T>?)

ToCollectionExtensions.ToListOrExisting<T>(IEnumerable<T>)

ToCollectionExtensions.ToReadOnlyCollectionOrExisting<T>(IEnumerable<T>)

ToCollectionExtensions.ToReadOnlyDictionaryOrExisting<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>)

ToCollectionExtensions.ToReadOnlyListOrExisting<T>(IEnumerable<T>)

ToCollectionExtensions.ToReadOnlySetOrExisting<T>(IEnumerable<T>)

ToCollectionExtensions.ToSetOrExisting<T>(IEnumerable<T>)

ToCollectionExtensions.ToSortedSetOrEmpty<T>(IEnumerable<T>?)

ToCollectionExtensions.ToSortedSet<T>(IEnumerable<T>)

AffixedEnumerableExtensions.WithPrefix<T>(IEnumerable<T>, IEnumerable<T>)

AffixedEnumerableExtensions.WithPrefix<T>(IEnumerable<T>, T)

AffixedEnumerableExtensions.WithPrefix<T>(IEnumerable<T>, params T[])

AffixedEnumerableExtensions.WithSuffix<T>(IEnumerable<T>, IEnumerable<T>)

AffixedEnumerableExtensions.WithSuffix<T>(IEnumerable<T>, T)

AffixedEnumerableExtensions.WithSuffix<T>(IEnumerable<T>, params T[])

IEnumerableExtensions.EqualsUnordered(IEnumerable, IEnumerable)

Constructors

FlexDictionary(FlexDictionary<TKey, TValue>)

Initializes a new instance of the FlexDictionary<TKey, TValue> class out of another FlexDictionary<TKey, TValue> instance.

public FlexDictionary(FlexDictionary<TKey, TValue> other)

Parameters

other FlexDictionary<TKey, TValue>

The other FlexDictionary<TKey, TValue> whose key-value pairs to copy.

FlexDictionary(IEnumerable<KeyValuePair<TKey, TValue>>, TValue)

Initializes a new instance of the FlexDictionary<TKey, TValue> class.

public FlexDictionary(IEnumerable<KeyValuePair<TKey, TValue>> kvps, TValue defaultValue)

Parameters

kvps IEnumerable<KeyValuePair<TKey, TValue>>

The collection of KeyValuePair<TKey, TValue> objects to initialize the dictionary from.

defaultValue TValue

FlexDictionary(IEnumerable<TKey>, TValue)

Initializes a new instance of the FlexDictionary<TKey, TValue> class. Each item in the provided collection is added as a key and is mapped to the specified value of the TValue type.

public FlexDictionary(IEnumerable<TKey> collection, TValue initialValue)

Parameters

collection IEnumerable<TKey>

The collection to initialize the dictionary from.

initialValue TValue

The initial value to map each key to.

FlexDictionary(int, TValue)

Initializes a new instance of the FlexDictionary<TKey, TValue> class.

public FlexDictionary(int capacity, TValue defaultValue)

Parameters

capacity int

The capacity of the dictionary.

defaultValue TValue

FlexDictionary(TValue)

Initializes a new instance of the FlexDictionary<TKey, TValue> class with the default initial capacity (16).

public FlexDictionary(TValue defaultValue)

Parameters

defaultValue TValue

Methods

Clone()

Clones this FlexDictionary<TKey, TValue> and adds all its keys to the resulting instance.

public override FlexDictionary<TKey, TValue> Clone()

Returns

FlexDictionary<TKey, TValue>

The cloned instance containing the same key-value pairs.

GetNewEntryInitializationValue()

Gets the value that will be stored by default upon creating a new entry through the this accessor. This does not affect the Add(TKey, TValue) function.

protected override TValue GetNewEntryInitializationValue()

Returns

TValue

The new value that will be stored in the new entry.