Vector

A very simple container class using pre-allocated memory.

Template Parameters:

• T The type of objects this container works on.
• capacity The maximum number of objects this container can store.

Public Functions

void	add(T e)
	Adds an element to the Vector if the Vector is not full.
void	clear()
	Clears the contents of the container.
bool	contains(T elem)
	Checks if the Vector contains an element.
bool	isEmpty() const
	Query if this object is empty.
uint16_t	maxCapacity() const
	Query the maximum capacity of the vector.
T &	operator[](uint16_t idx)
	Index operator.
const T &	operator[](uint16_t idx) const
	Const version of the index operator.
void	quickRemoveAt(uint16_t index)
	Removes an element at the specified index of the Vector.
void	remove(T e)
	Removes an element from the Vector if found in the Vector.
T	removeAt(uint16_t index)
	Removes an element at the specified index of the Vector.
void	reverse()
	Reverses the ordering of the elements in the Vector.
uint16_t	size() const
	Gets the current size of the Vector which is the number of elements contained in the Vector.
	Vector()
	Default constructor.

Public Functions Documentation

add

void add	(	T	e	)

Adds an element to the Vector if the Vector is not full.

Adds an element to the Vector if the Vector is not full. Does nothing if the Vector is full.

Parameters:

e	The element to add to the Vector.

clear

void clear	(			)

Clears the contents of the container.

It does not destruct any of the elements in the Vector.

contains

bool contains	(	T	elem	)

Checks if the Vector contains an element.

The == operator of the element is used when comparing it with the elements in the Vector.

Parameters:

elem	The element.

Returns:

true if the Vector contains the element, false otherwise.

isEmpty

bool isEmpty	(			)	const

Query if this object is empty.

Returns:

true if the Vector contains no elements.

maxCapacity

uint16_t maxCapacity	(			)	const

Query the maximum capacity of the vector.

Returns:

The capacity the Vector was initialized with.

operator[]

T & operator[]	(	uint16_t	idx	)

Index operator.

Parameters:

idx	The index of the element to obtain.

Returns:

A reference to the element placed at index idx.

operator[]

const T & operator[]	(	uint16_t	idx	)

Const version of the index operator.

Parameters:

idx	The index of the element to obtain.

Returns:

A const reference to the element placed at index idx.

quickRemoveAt

void quickRemoveAt	(	uint16_t	index	)

Removes an element at the specified index of the Vector.

The last element in the list is moved to the position where the element is removed.

Parameters:

index	The index to remove.

remove

void remove	(	T	e	)

Removes an element from the Vector if found in the Vector.

Does nothing if the element is not found in the Vector. The == operator of the element is used when comparing it with the elements in the Vector.

Parameters:

e	The element to remove from the Vector.

removeAt

T removeAt	(	uint16_t	index	)

Removes an element at the specified index of the Vector.

Will "bubble-down" any remaining elements after the specified index.

Parameters:

index	The index to remove.

Returns:

The value of the removed element.

reverse

void reverse	(			)

Reverses the ordering of the elements in the Vector.

size

uint16_t size	(			)	const

Gets the current size of the Vector which is the number of elements contained in the Vector.

Gets the current size of the Vector which is the number of elements contained in the Vector.

Returns:

The size of the Vector.

Vector

Vector	(			)

Default constructor.

Constructs an empty vector.