Class MultiDictionary<TKey, TValue>

Namespace

NanoByte.Common.Collections

Assembly

NanoByte.Common.dll

A dictionary that allows a key to reference multiple values.

[Serializable]
public class MultiDictionary<TKey, TValue> : Dictionary<TKey, HashSet<TValue>> where TKey : notnull

Type Parameters

TKey

The type to use as a key to identify entries in the dictionary.

TValue

The type to use as elements to store in the dictionary.

Inheritance

object

Dictionary<TKey, HashSet<TValue>>

MultiDictionary<TKey, TValue>

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, string, string?)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

CollectionExtensions.AddIfNew<T>(ICollection<T>, T)

CollectionExtensions.Add<TCollection, TElements>(ICollection<TCollection>, IEnumerable<TElements>)

CollectionExtensions.RemoveAll<T>(ICollection<T>, Func<T, bool>)

CollectionExtensions.Remove<TCollection, TElements>(ICollection<TCollection>, IEnumerable<TElements>)

DictionaryExtensions.AddRange<TSourceKey, TSourceValue, TTargetKey, TTargetValue>(IDictionary<TTargetKey, TTargetValue>, IEnumerable<KeyValuePair<TSourceKey, TSourceValue>>)

DictionaryExtensions.GetOrAddAsync<TKey, TValue>(IDictionary<TKey, TValue>, TKey, Func<Task<TValue>>)

DictionaryExtensions.GetOrAdd<TKey, TValue>(IDictionary<TKey, TValue>, TKey)

DictionaryExtensions.GetOrAdd<TKey, TValue>(IDictionary<TKey, TValue>, TKey, Func<TValue>)

DictionaryExtensions.GetOrDefault<TKey, TValue>(IDictionary<TKey, TValue>, TKey)

DictionaryExtensions.GetUnsequencedHashCode<TKey, TValue>(IDictionary<TKey, TValue>, IEqualityComparer<TValue>?)

DictionaryExtensions.TryAdd<TKey, TValue>(IDictionary<TKey, TValue>, TKey, TValue)

DictionaryExtensions.UnsequencedEquals<TKey, TValue>(IDictionary<TKey, TValue>, IDictionary<TKey, TValue>, IEqualityComparer<TValue>?)

DictionaryExtensions.ToMultiDictionary<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TValue>)

EnumerableExtensions.ContainsAny<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.ContainsOrEmpty<T>(IEnumerable<T>, T)

EnumerableExtensions.DistinctBy<T, TKey>(IEnumerable<T>, Func<T, TKey>)

EnumerableExtensions.Except<T>(IEnumerable<T>, T)

EnumerableExtensions.Except<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.GetSequencedHashCode<T>(IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.GetUnsequencedHashCode<T>(IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.MaxBy<T, TValue>(IEnumerable<T>, Func<T, TValue>, IComparer<TValue>?)

EnumerableExtensions.MinBy<T, TValue>(IEnumerable<T>, Func<T, TValue>, IComparer<TValue>?)

EnumerableExtensions.Permutate<T>(IEnumerable<T>)

EnumerableExtensions.SequencedEquals<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.TopologicalSort<T>(IEnumerable<T>, Func<T, IEnumerable<T>>)

EnumerableExtensions.TrySelect<TSource, TResult, TException>(IEnumerable<TSource>, Func<TSource, TResult>, Action<TException>)

EnumerableExtensions.UnsequencedEquals<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

Bucketizer.Bucketize<T>(IEnumerable<T>)

Bucketizer.Bucketize<TElement, TValue>(IEnumerable<TElement>, Func<TElement, TValue>)

ExceptionUtils.TryAnyAsync<T>(IEnumerable<T>, Func<T, Task>)

ExceptionUtils.TryAny<T>(IEnumerable<T>, Action<T>)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

XmlStorage.SaveXml(object, Stream, string?)

XmlStorage.ToXmlString(object, string?)

Remarks

This structure internally uses hash maps, so most operations run in O(1).

Properties

this[TKey]

Gets a collection containing the values with the specified key.

[CollectionAccess(CollectionAccessType.Read)]
public IEnumerable<TValue> this[TKey key] { get; }

Parameters

key TKey

The key of the element to get.

Property Value

IEnumerable<TValue>

A list of elements with the specified key. Empty list if the key was not found.

Values

A collection containing the values in the dictionary.

[CollectionAccess(CollectionAccessType.Read)]
public IEnumerable<TValue> Values { get; }

Property Value

IEnumerable<TValue>

Methods

Add(TKey, TValue)

Adds an element with the provided key and value to the dictionary.

[CollectionAccess(CollectionAccessType.UpdatedContent)]
public void Add(TKey key, TValue value)

Parameters

key TKey

The key of the element to add.

value TValue

The value of the element to add.

Remove(TKey, TValue)

Removes an element with the provided key and value from the dictionary.

[CollectionAccess(CollectionAccessType.ModifyExistingContent)]
public bool Remove(TKey key, TValue value)

Parameters

key TKey

The key of the element to remove.

value TValue

The value of the element to remove.

Returns

bool

true if any elements were successfully removed; otherwise, false.