Interface ITreeNode<TValue>

Namespace

Garyon.DataStructures.Trees

Assembly

Garyon.dll

Represents a tree node, which is a component that is contained within a tree.

public interface ITreeNode<TValue> : IEnumerable<TValue>, IEnumerable

Type Parameters

TValue

The type of the value that is stored in the node.

Inherited Members

IEnumerable<TValue>.GetEnumerator()

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)

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.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.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)

Properties

BaseTreeHeight

Gets the height of this tree node's base tree height. It is equal to the sum of this tree node's height and depth. Prefer calling this instead of the Height property on Root.

int BaseTreeHeight { get; }

Property Value

int

Breadth

Gets the breadth of this tree node.

int Breadth { get; }

Property Value

int

ChildrenCount

Gets the count of children of this node; prefer calling this property instead of getting the count directly from the respective property to retrieve the children.

int ChildrenCount { get; }

Property Value

int

Depth

Gets the depth of this tree node.

int Depth { get; }

Property Value

int

Descendants

Gets the descendants of this tree node.

int Descendants { get; }

Property Value

int

Height

Gets the height of this tree node's subtree.

int Height { get; }

Property Value

int

IsLeaf

Determines whether this node is a leaf; that is, it has no children.

bool IsLeaf { get; }

Property Value

bool

IsRoot

Determines whether this node is the root; that is, its parent is null.

bool IsRoot { get; }

Property Value

bool

Value

The value of the node.

TValue Value { get; set; }

Property Value

TValue

Methods

GetTreeView(int)

Gets the tree view of this tree node as a subtree.

string GetTreeView(int childIndent = 4)

Parameters

childIndent int

The length of the indentation for each subsequent child.

Returns

string

The tree view.

RemoveChild(TValue)

Removes a child from this node's children list.

bool RemoveChild(TValue childToRemove)

Parameters

childToRemove TValue

The child to remove from this node's children list.

Returns

bool

RemoveNode(TValue)

Removes a node that has the specified value. This includes any node that is within the subtree with this tree node as the root.

bool RemoveNode(TValue value)

Parameters

value TValue

The value of the node to remove from this node's children list.

Returns

bool

true if the child was successfully removed from this node's children list, otherwise false.

RemoveNodes(IEnumerable<TValue>)

Removes nodes that have the specified values. This includes any node that is within the subtree with this tree node as the root.

void RemoveNodes(IEnumerable<TValue> values)

Parameters

values IEnumerable<TValue>

The values of the child nodes to remove from this node's children list.

RemoveNodes(params TValue[])

Removes nodes that have the specified values. This includes any node that is within the subtree with this tree node as the root.

void RemoveNodes(params TValue[] values)

Parameters

values TValue[]

The values of the child nodes to remove from this node's children list.

TraverseLevelOrder()

Traverses the subtree with this node as a root using level-order.

IEnumerable<TValue> TraverseLevelOrder()

Returns

IEnumerable<TValue>

An IEnumerable<T> containing the yielded values.

TraversePostOrder()

Traverses the subtree with this node as a root using post-order.

IEnumerable<TValue> TraversePostOrder()

Returns

IEnumerable<TValue>

An IEnumerable<T> containing the yielded values.

TraversePreOrder()

Traverses the subtree with this node as a root using pre-order.

IEnumerable<TValue> TraversePreOrder()

Returns

IEnumerable<TValue>

An IEnumerable<T> containing the yielded values.