using System;
namespace DataStructures.Stack;
/// <summary>
/// Implementation of an array-based stack. LIFO style.
/// </summary>
/// <typeparam name="T">Generic Type.</typeparam>
public class ArrayBasedStack<T>
{
private const int DefaultCapacity = 10;
private const string StackEmptyErrorMessage = "Stack is empty";
/// <summary>
/// <see cref="Array" /> based stack.
/// </summary>
private T[] stack;
/// <summary>
/// How many items are in the stack right now.
/// </summary>
private int top;
/// <summary>
/// Initializes a new instance of the <see cref="ArrayBasedStack{T}" /> class.
/// </summary>
public ArrayBasedStack()
{
stack = new T[DefaultCapacity];
top = -1;
}
/// <summary>
/// Initializes a new instance of the <see cref="ArrayBasedStack{T}" /> class.
/// </summary>
/// <param name="item">Item to push onto the <see cref="ArrayBasedStack{T}" />.</param>
public ArrayBasedStack(T item)
: this() => Push(item);
/// <summary>
/// Initializes a new instance of the <see cref="ArrayBasedStack{T}" /> class.
/// </summary>
/// <param name="items">Items to push onto the <see cref="ArrayBasedStack{T}" />.</param>
public ArrayBasedStack(T[] items)
{
stack = items;
top = items.Length - 1;
}
/// <summary>
/// Gets the number of elements on the <see cref="ArrayBasedStack{T}" />.
/// </summary>
public int Top => top;
/// <summary>
/// Gets or sets the Capacity of the <see cref="ArrayBasedStack{T}" />.
/// </summary>
public int Capacity
{
get => stack.Length;
set => Array.Resize(ref stack, value);
}
/// <summary>
/// Removes all items from the <see cref="ArrayBasedStack{T}" />.
/// </summary>
public void Clear()
{
top = -1;
Capacity = DefaultCapacity;
}
/// <summary>
/// Determines whether an element is in the <see cref="ArrayBasedStack{T}" />.
/// </summary>
/// <param name="item">The item to locate in the <see cref="ArrayBasedStack{T}" />.</param>
/// <returns>True, if the item is in the stack.</returns>
public bool Contains(T item) => Array.IndexOf(stack, item, 0, top + 1) > -1;
/// <summary>
/// Returns the item at the top of the <see cref="ArrayBasedStack{T}" /> without removing it.
/// </summary>
/// <returns>The item at the top of the <see cref="ArrayBasedStack{T}" />.</returns>
public T Peek()
{
if (top == -1)
{
throw new InvalidOperationException(StackEmptyErrorMessage);
}
return stack[top];
}
/// <summary>
/// Removes and returns the item at the top of the <see cref="ArrayBasedStack{T}" />.
/// </summary>
/// <returns>The item removed from the top of the <see cref="ArrayBasedStack{T}" />.</returns>
public T Pop()
{
if (top == -1)
{
throw new InvalidOperationException(StackEmptyErrorMessage);
}
return stack[top--];
}
/// <summary>
/// Inserts an item at the top of the <see cref="ArrayBasedStack{T}" />.
/// </summary>
/// <param name="item">The item to push onto the <see cref="ArrayBasedStack{T}" />.</param>
public void Push(T item)
{
if (top == Capacity - 1)
{
Capacity *= 2;
}
stack[++top] = item;
}
}