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

Template parameters
T the type of element to store

Contents

A simple double linked list

Public types

using Iterator = ListIterator<T, Node>
using CIterator = ListConstIterator<T, Node>
using ReverseIterator = ListReverseIterator<T, Node>
using CReverseIterator = ListConstReverseIterator<T, Node>

Constructors, destructors, conversion operators

List()
List(const std::initializer_list<T>& lst)
List(const List<T>& other)
List(List<T>&& other) noexcept
~List()

Public functions

auto operator=(List<T>&& other) -> List<T>& noexcept
auto operator=(const List<T>& other) -> List<T>&
void Add(const T& elem)
void Add(T&& elem)
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)
auto operator[](fsize id) const -> const T&
auto operator[](fsize id) -> T&
auto operator+(const List<T>& other) const -> List<T>
void operator+=(const List<T>& other)
auto operator==(const List<T>& other) const -> bool noexcept
auto operator!=(const List<T>& other) const -> bool noexcept
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 Swap(const Iterator& a, const Iterator& b)
void RemoveLast()
template<template<typename> class Comparator = ops::Less>
void Sort(bool stable = false)
auto First() -> T&
auto Last() -> T&
auto First() const -> const T&
auto Last() const -> const T&
auto Size() const -> fsize noexcept
void Clear()
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::List<T>::List()

Constructs an empty List

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

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

Constructs a List from an existing initializer list

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

Copy constructor

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

Move constructor

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

Move assignment operator

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

Copy assignment operator

template<typename T>
void bpf::collection::List<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::List<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::List<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::List<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::List<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::List<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>
const T& bpf::collection::List<T>::operator[](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>
T& bpf::collection::List<T>::operator[](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>
List<T> bpf::collection::List<T>::operator+(const List<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::List<T>::operator+=(const List<T>& other)

Parameters
other list to append

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

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

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

Compare List by performing a per-element check

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

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

Compare List by performing a per-element check

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

Parameters
pos item position

Removes an item at an arbitary position in the list

template<typename T>
void bpf::collection::List<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::List<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::List<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::List<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::List<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::List<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::List<T>::Swap(const Iterator& a, const Iterator& b)

Parameters
a first element
b second element

Swap two elements by iterator in the List

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

Removes the last item in this list

template<typename T> template<template<typename> class Comparator = ops::Less>
void bpf::collection::List<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>
T& bpf::collection::List<T>::First()

Returns mutable item
Exceptions
IndexException if none

Returns the first element in this List

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

Returns mutable item
Exceptions
IndexException if none

Returns the last element in this List

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

Returns immutable item
Exceptions
IndexException if none

Returns the first element in this List

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

Returns immutable item
Exceptions
IndexException if none

Returns the last element in this List

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

Returns number of items as unsigned

Returns the number of items in this list

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

Clears the content of this List

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

Returns new iterator

Returns an iterator to the begining of the collection

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

Returns new iterator

Returns an iterator to the end of the collection

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

Returns new iterator

Returns an iterator to the begining of the collection

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

Returns new iterator

Returns an iterator to the end of the collection

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

Returns new iterator

Returns a reverse iterator to the begining of the collection

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

Returns new iterator

Returns a reverse iterator to the end of the collection

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

Returns new iterator

Returns a reverse iterator to the begining of the collection

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

Returns new iterator

Returns a reverse iterator to the end of the collection