Stack¶

1

import "std/data/stack";

Stack<T> struct¶

A stack in Spice is a commonly used data structure, which uses the FiLo (first in, last out) principle.

Time complexity:
Insert: O(1)
Delete: O(1)
Search: O(n)

Stacks pre-allocate space using an initial size and a resize factor to not have to re-allocate with every item pushed.

Constructors¶

ctor¶

1

public p Stack.ctor(unsigned long initAllocItems, const T &defaultValue)

Construct a stack pre-filled with a number of copies of a default value

Parameters

ctor¶

1

public p Stack.ctor(unsigned int initAllocItems)

Construct a stack, pre-allocating space for the given number of items

Parameters

ctor¶

1

public p Stack.ctor(unsigned long initAllocItems = INITIAL_CAPACITY)

Construct a stack, pre-allocating space for the given number of items

Parameters

ctor¶

1

public p Stack.ctor(const Stack<T>& original)

Construct a stack as a deep copy of another stack

Parameters

Methods¶

push¶

1

public p Stack.push(const T& item)

Add an item to the stack

Parameters

pop¶

1

public f<T&> Stack.pop()

Retrieve item and remove it from the stack

Returns: T&

top¶

1

public f<T&> Stack.top()

Retrieve topmost without removing it from the stack

Returns: T&

getSize¶

1

public f<long> Stack.getSize()

Retrieve the current size of the stack

Returns: long — Current size of the stack

getCapacity¶

1

public f<long> Stack.getCapacity()

Retrieve the current capacity of the stack

Returns: long — Current capacity of the stack

isEmpty¶

1

public f<bool> Stack.isEmpty()

Checks if the queue contains any items at the moment

Returns: bool — Empty or not empty

isFull¶

1

public f<bool> Stack.isFull()

Checks if the queue exhausts its capacity and needs to resize at the next call of push

Returns: bool — Full or not full

pack¶

1

public p Stack.pack()

Frees allocated memory that is not used by the queue

Operators¶

operator=¶

1

public p operator=<T>(Stack<T>& this, const Stack<T>& newValue)

Copy-assign the contents of another stack into this one

Parameters

operator==¶

1

public f<bool> operator==<T>(const Stack<T>& lhs, const Stack<T>& rhs)

Check if two stacks are equal, i.e. they have the same size and equal contents

Parameters

Returns: bool — Equal or not equal

operator!=¶

1

public f<bool> operator!=<T>(const Stack<T>& lhs, const Stack<T>& rhs)

Check if two stacks are not equal

Parameters

Returns: bool — Not equal or equal