Class StackSet<T>

Namespace

Garyon.DataStructures

Assembly

Garyon.dll

Represents a set whose elements are stored in a stack. This data structure encapsulates a Stack<T> and a HashSet<T>. Through the usage of the set, the data structure ensures that no elements are contained more than once.

public sealed class StackSet<T> : BaseSetLinearCollection<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable

Type Parameters

T

The type of the stored elements.

Inheritance

object

BaseSetLinearCollection<T>

StackSet<T>

Implements

IReadOnlyCollection<T>

IEnumerable<T>

IEnumerable

Inherited Members

BaseSetLinearCollection<T>.Count

BaseSetLinearCollection<T>.IsEmpty

BaseSetLinearCollection<T>.Contains(T)

BaseSetLinearCollection<T>.Add(T)

BaseSetLinearCollection<T>.Remove()

BaseSetLinearCollection<T>.AddRange(IEnumerable<T>)

BaseSetLinearCollection<T>.RemoveRange(int)

BaseSetLinearCollection<T>.Clear()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

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)

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[])

UpcastingCollectionExtensions.UpcastReadOnlyCollection<TBase, TUp>(IReadOnlyCollection<TBase>)

IEnumerableExtensions.EqualsUnordered(IEnumerable, IEnumerable)

Constructors

StackSet()

Initializes a new empty instance of the StackSet<T> class.

public StackSet()

StackSet(IEqualityComparer<T>)

Initializes a new empty instance of the StackSet<T> class with a given comparer for the HashSet<T>.

public StackSet(IEqualityComparer<T> comparer)

Parameters

comparer IEqualityComparer<T>

The comparer that HashSet<T> will use for the elements.

StackSet(int)

Initializes a new empty instance of the StackSet<T> class with a given initial capacity.

public StackSet(int capacity)

Parameters

capacity int

The capacity of both the contained Stack<T> and the HashSet<T>.

StackSet(int, IEqualityComparer<T>)

Initializes a new empty instance of the StackSet<T> class with a given initial capacity and a given comparer for the HashSet<T>.

public StackSet(int capacity, IEqualityComparer<T> comparer)

Parameters

capacity int

The capacity of both the contained Stack<T> and the HashSet<T>.

comparer IEqualityComparer<T>

The comparer that HashSet<T> will use for the elements.

Methods

AddToLinearCollection(T)

Adds an item to the linear collection.

protected override void AddToLinearCollection(T item)

Parameters

item T

The item to add to the linear collection.

Remarks

It should only perform the necessary operations to the linear collection.

ClearLinearCollection()

Clears the linear collection. It should call the respective Clear method for the linear collection instance that backs the data structure.

protected override void ClearLinearCollection()

CopyTo(T[], int)

Copies the elements of the linear collection in the provided T[] starting from the given array index.

public override void CopyTo(T[] array, int arrayIndex)

Parameters

array T[]

The array in which to copy the elements of the linear collection in the order they would be removed.

arrayIndex int

The index of the first element that will be copied from the linear collection into.

GetEnumerator()

Gets the enumerator for this stack set, which is the enumerator for the stack.

public override IEnumerator<T> GetEnumerator()

Returns

IEnumerator<T>

The stack's enumerator.

Peek()

Peeks the linear collection. This does not remove any items from the setted linear collection.

public override T Peek()

Returns

T

The item that was peeked from the linear collection. It is the item that will be removed next.

Pop()

Pops the item at the top of the stack, and also removes it from the set.

public T Pop()

Returns

T

The popped item.

PopRange(int)

Pops a number of items from the stack set, and returns them in the order they were popped.

public IEnumerable<T> PopRange(int count)

Parameters

count int

The number of items to pop from the stack set. If the stack set contains less items than the provided count, it will be capped to the current item count.

Returns

IEnumerable<T>

The collection of items that were popped from the stack set.

Push(T)

Pushes an item in the stack set, if it is not already stored.

public bool Push(T item)

Parameters

item T

The item to push.

Returns

bool

true if the item was not contained anywhere in the stack set and was successfully pushed, otherwise false.

PushRange(IEnumerable<T>)

Pushes a collection of items to the stack set. The order at which each item is pushed is determined by the enumeration order of the provided collection.

public void PushRange(IEnumerable<T> items)

Parameters

items IEnumerable<T>

The collection of items to push to the stack set.

RemoveFromLinearCollection()

Removes the next item to be removed from the linear collection.

protected override T RemoveFromLinearCollection()

Returns

T

The item that was removed from the linear collection.

Remarks

It should only perform the necessary operations to the linear collection.