#include <Base/include/Framework/Collection/ArrayList.hpp>
template<typename T>
bpf::collection::ArrayList class

Template parameters
T the type of element to store

Contents

Simple array-list class, automatically doubles it's size

Public types

using Iterator = typename Array<T>::Iterator
using ReverseIterator = typename Array<T>::ReverseIterator
using CIterator = typename Array<T>::CIterator
using CReverseIterator = typename Array<T>::CReverseIterator

Constructors, destructors, conversion operators

ArrayList(const fsize preallocsize = 8)
ArrayList(const std::initializer_list<T>& lst)
ArrayList(const ArrayList<T>& other)
ArrayList(ArrayList<T>&& other) noexcept

Public functions

auto operator=(const ArrayList<T>& other) -> ArrayList<T>&
auto operator=(ArrayList<T>&& other) -> ArrayList<T>& noexcept
auto operator==(const ArrayList<T>& other) const -> bool noexcept
auto operator!=(const ArrayList<T>& other) const -> bool noexcept
auto operator+(const ArrayList<T>& other) const -> ArrayList<T>
void operator+=(const ArrayList<T>& other)
auto operator+(const Array<T>& other) const -> ArrayList<T>
void operator+=(const Array<T>& other)
auto First() -> T&
auto Last() -> T&
auto First() const -> const T&
auto Last() const -> const T&
auto operator[](const fsize id) -> T&
auto operator[](const fsize id) const -> const T&
void Add(const T& elem)
void Add(T&& elem)
void Swap(const Iterator& a, const Iterator& b)
void Insert(fsize pos, const T& elem)
void Insert(fsize pos, T&& elem)
void Insert(const Iterator& pos, const T& elem)
void Insert(const Iterator& pos, T&& elem)
void RemoveAt(fsize pos)
void RemoveAt(Iterator& pos)
void RemoveAt(Iterator&& pos)
template<template<typename> class Comparator = ops::Equal>
void Remove(const T& elem, bool all = true)
auto FindByKey(fsize pos) -> Iterator
template<template<typename> class Comparator = ops::Equal>
auto FindByValue(const T& val) -> Iterator
auto Find(const std::function<bool(const fsize pos, const T&val)>& comparator) -> Iterator
void Clear()
void RemoveLast()
auto Size() const -> fsize
auto ToArray() const -> Array<T>
template<template<typename> class Comparator = ops::Less>
void Sort(bool stable = false)
auto begin() const -> CIterator
auto end() const -> CIterator
auto begin() -> Iterator
auto end() -> Iterator
auto rbegin() const -> CReverseIterator
auto rend() const -> CReverseIterator
auto rbegin() -> ReverseIterator
auto rend() -> ReverseIterator

Function documentation

template<typename T>
bpf::collection::ArrayList<T>::ArrayList(const fsize preallocsize = 8)

Parameters
preallocsize initial number of items to pre-allocate

Constructs a new ArrayList

template<typename T>
bpf::collection::ArrayList<T>::ArrayList(const std::initializer_list<T>& lst)

Parameters
lst the initial list of items to add to this new ArrayList

Constructs an ArrayList from an existing initializer list

template<typename T>
bpf::collection::ArrayList<T>::ArrayList(const ArrayList<T>& other)

Copy constructor

template<typename T>
bpf::collection::ArrayList<T>::ArrayList(ArrayList<T>&& other) noexcept

Move constructor

template<typename T>
ArrayList<T>& bpf::collection::ArrayList<T>::operator=(const ArrayList<T>& other)

Copy assignment operator

template<typename T>
ArrayList<T>& bpf::collection::ArrayList<T>::operator=(ArrayList<T>&& other) noexcept

Move assignment operator

template<typename T>
bool bpf::collection::ArrayList<T>::operator==(const ArrayList<T>& other) const noexcept

Parameters
other ArrayList to compare with
Returns true if the two lists are equal, false otherwise

Compare ArrayList by performing a per-element check

template<typename T>
bool bpf::collection::ArrayList<T>::operator!=(const ArrayList<T>& other) const noexcept

Parameters
other ArrayList to compare with
Returns false if the two lists are equal, true otherwise

Compare ArrayList by performing a per-element check

template<typename T>
ArrayList<T> bpf::collection::ArrayList<T>::operator+(const ArrayList<T>& other) const

Parameters
other list to concatenate with
Returns new list

Create a new list from concatenation of two lists

template<typename T>
void bpf::collection::ArrayList<T>::operator+=(const ArrayList<T>& other)

Parameters
other list to append

Appends the content of a list at the end of this list

template<typename T>
ArrayList<T> bpf::collection::ArrayList<T>::operator+(const Array<T>& other) const

Parameters
other array to concatenate with
Returns new list

Create a new list from concatenation of a list and an array

template<typename T>
void bpf::collection::ArrayList<T>::operator+=(const Array<T>& other)

Parameters
other array to append

Appends the content of an array at the end of this list

template<typename T>
T& bpf::collection::ArrayList<T>::First()

Returns mutable item
Exceptions
IndexException if none

Returns the first element in this ArrayList

template<typename T>
T& bpf::collection::ArrayList<T>::Last()

Returns mutable item
Exceptions
IndexException if none

Returns the last element in this ArrayList

template<typename T>
const T& bpf::collection::ArrayList<T>::First() const

Returns immutable item
Exceptions
IndexException if none

Returns the first element in this ArrayList

template<typename T>
const T& bpf::collection::ArrayList<T>::Last() const

Returns immutable item
Exceptions
IndexException if none

Returns the last element in this ArrayList

template<typename T>
T& bpf::collection::ArrayList<T>::operator[](const fsize id)

Parameters
id the index of the element, in case of out of bounds, throws
Returns mutable item at index id
Exceptions
IndexException if id is out of bounds

Returns an element non-const mode

template<typename T>
const T& bpf::collection::ArrayList<T>::operator[](const fsize id) const

Parameters
id the index of the element, in case of out of bounds, throws
Returns immutable item at index id
Exceptions
IndexException if id is out of bounds

Returns an element const mode

template<typename T>
void bpf::collection::ArrayList<T>::Add(const T& elem)

Parameters
elem the element to add

Adds an item at the end of this list

template<typename T>
void bpf::collection::ArrayList<T>::Add(T&& elem)

Parameters
elem the element to add

Adds an item at the end of this list

template<typename T>
void bpf::collection::ArrayList<T>::Swap(const Iterator& a, const Iterator& b)

Parameters
a first element
b second element

Swap two elements by iterator in the ArrayList

template<typename T>
void bpf::collection::ArrayList<T>::Insert(fsize pos, const T& elem)

Parameters
pos insert position
elem element to insert

Inserts an item at an arbitary position in the list

template<typename T>
void bpf::collection::ArrayList<T>::Insert(fsize pos, T&& elem)

Parameters
pos insert position
elem element to insert

Inserts an item at an arbitary position in the list

template<typename T>
void bpf::collection::ArrayList<T>::Insert(const Iterator& pos, const T& elem)

Parameters
pos insert position
elem element to insert

Inserts an item at an arbitary position in the list

template<typename T>
void bpf::collection::ArrayList<T>::Insert(const Iterator& pos, T&& elem)

Parameters
pos insert position
elem element to insert

Inserts an item at an arbitary position in the list

template<typename T>
void bpf::collection::ArrayList<T>::RemoveAt(fsize pos)

Parameters
pos item position

Removes an item at an arbitary position in the list

template<typename T>
void bpf::collection::ArrayList<T>::RemoveAt(Iterator& pos)

Parameters
pos item position, it is undefined behavior to pass a derived Iterator type

Removes an item at an arbitary position in the list

template<typename T>
void bpf::collection::ArrayList<T>::RemoveAt(Iterator&& pos)

Parameters
pos item position, it is undefined behavior to pass a derived Iterator type

Removes an item at an arbitary position in the list

template<typename T> template<template<typename> class Comparator = ops::Equal>
void bpf::collection::ArrayList<T>::Remove(const T& elem, bool all = true)

Template parameters
Comparator the comparision operator to use for comparing values
Parameters
elem the element to search for
all wether or not to remove all occurences or just the first one

Removes occurences of an element fron the list

template<typename T>
Iterator bpf::collection::ArrayList<T>::FindByKey(fsize pos)

Parameters
pos the index of the item to search for
Returns iterator to the found item or end() if none

Locate an item by index inside this list

template<typename T> template<template<typename> class Comparator = ops::Equal>
Iterator bpf::collection::ArrayList<T>::FindByValue(const T& val)

Template parameters
Comparator comparision operator to use
Parameters
val the value to search for
Returns iterator to the found item or end() if none

Locate an item by performing per-element check

template<typename T>
Iterator bpf::collection::ArrayList<T>::Find(const std::function<bool(const fsize pos, const T&val)>& comparator)

Parameters
comparator the comparision function to use
Returns iterator to the found item or end() if none

Locate an item by performing per-element check

template<typename T>
void bpf::collection::ArrayList<T>::Clear()

Clears the content of this ArrayList WARNING: Does not automatically deallocate existing items in this list

template<typename T>
void bpf::collection::ArrayList<T>::RemoveLast()

Removes the last item in this list

template<typename T>
fsize bpf::collection::ArrayList<T>::Size() const

Returns number of items as unsigned

Returns the number of items in this list

template<typename T>
Array<T> bpf::collection::ArrayList<T>::ToArray() const

Returns new Array containing all the items in this collection at the time of this function call

Converts this ArrayList to a raw Array WARNING: This function rquires deep-copy of the collection

template<typename T> template<template<typename> class Comparator = ops::Less>
void bpf::collection::ArrayList<T>::Sort(bool stable = false)

Template parameters
Comparator comparision operator
Parameters
stable if true this function will apply a Merge-Sort algorithm, otherwise this function uses the Quick-Sort algorithm

Sorts this collection in place

template<typename T>
CIterator bpf::collection::ArrayList<T>::begin() const

Returns new iterator

Returns an iterator to the begining of the collection

template<typename T>
CIterator bpf::collection::ArrayList<T>::end() const

Returns new iterator

Returns an iterator to the end of the collection

template<typename T>
Iterator bpf::collection::ArrayList<T>::begin()

Returns new iterator

Returns an iterator to the begining of the collection

template<typename T>
Iterator bpf::collection::ArrayList<T>::end()

Returns new iterator

Returns an iterator to the end of the collection

template<typename T>
CReverseIterator bpf::collection::ArrayList<T>::rbegin() const

Returns new iterator

Returns a reverse iterator to the begining of the collection

template<typename T>
CReverseIterator bpf::collection::ArrayList<T>::rend() const

Returns new iterator

Returns a reverse iterator to the end of the collection

template<typename T>
ReverseIterator bpf::collection::ArrayList<T>::rbegin()

Returns new iterator

Returns a reverse iterator to the begining of the collection

template<typename T>
ReverseIterator bpf::collection::ArrayList<T>::rend()

Returns new iterator

Returns a reverse iterator to the end of the collection