Interface IReadOnlyTreeDictionary<TKey, TValue>

Namespace

LfrlAnvil.Collections

Assembly

LfrlAnvil.Collections.dll

Represents a generic read-only tree data structure with the ability to identify nodes by keys.

public interface IReadOnlyTreeDictionary<TKey, TValue> : IReadOnlyDictionary<TKey, TValue>, IReadOnlyCollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable where TKey : notnull

Type Parameters

TKey

Key type.

TValue

Value type.

Inherited Members

IReadOnlyDictionary<TKey, TValue>.ContainsKey(TKey)

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

IReadOnlyDictionary<TKey, TValue>.this[TKey]

IReadOnlyDictionary<TKey, TValue>.Keys

IReadOnlyDictionary<TKey, TValue>.Values

IReadOnlyCollection<KeyValuePair<TKey, TValue>>.Count

IEnumerable<KeyValuePair<TKey, TValue>>.GetEnumerator()

IEnumerable.GetEnumerator()

Extension Methods

EnumerableExtensions.ToMultiDictionary<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>)

EnumerableExtensions.ToMultiDictionary<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>, IEqualityComparer<TKey>)

EnumerableExtensions.ToMultiDictionary<TKey, TValue>(IEnumerable<TValue>, Func<TValue, TKey>)

EnumerableExtensions.ToMultiDictionary<TKey, TValue>(IEnumerable<TValue>, Func<TValue, TKey>, IEqualityComparer<TKey>)

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

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

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

EnumerableExtensions.ToMultiHashSet<T>(IEnumerable<T>, IEqualityComparer<T>)

EnumerableExtensions.ToSequentialDictionary<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>)

EnumerableExtensions.ToSequentialDictionary<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>, IEqualityComparer<TKey>)

EnumerableExtensions.ToSequentialDictionary<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TValue>)

EnumerableExtensions.ToSequentialDictionary<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TValue>, IEqualityComparer<TKey>)

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

EnumerableExtensions.ToSequentialHashSet<T>(IEnumerable<T>, IEqualityComparer<T>)

Properties

Comparer

Key equality comparer.

IEqualityComparer<TKey> Comparer { get; }

Property Value

IEqualityComparer<TKey>

Nodes

Returns a new IEnumerable<T> instance that contains all nodes of this tree.

IEnumerable<ITreeDictionaryNode<TKey, TValue>> Nodes { get; }

Property Value

IEnumerable<ITreeDictionaryNode<TKey, TValue>>

Root

Represents this tree's root node. Equal to null when the tree is empty.

ITreeDictionaryNode<TKey, TValue>? Root { get; }

Property Value

ITreeDictionaryNode<TKey, TValue>

Methods

CreateSubtree(TKey)

Creates a new TreeDictionary<TKey, TValue> instance equivalent to the sub-tree with a node associated with the provided key as its root node.

[Pure]
ITreeDictionary<TKey, TValue> CreateSubtree(TKey key)

Parameters

key TKey

Root node's key.

Returns

ITreeDictionary<TKey, TValue>

New TreeDictionary<TKey, TValue> instance. Result will be empty if the provided key does not exist.

GetNode(TKey)

Attempts to return an ITreeDictionaryNode<TKey, TValue> associated with the provided key.

[Pure]
ITreeDictionaryNode<TKey, TValue>? GetNode(TKey key)

Parameters

key TKey

Key to check.

Returns

ITreeDictionaryNode<TKey, TValue>

An ITreeDictionaryNode<TKey, TValue> instance associated with the provided key or null if key does not exist.