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

Template parameters
T the type of element to store

Contents

Dynamic array (array which size is defined dynamically at run-time)

Public types

using Iterator = ArrayIterator<T>
using CIterator = ArrayConstIterator<T>
using ReverseIterator = ArrayReverseIterator<T>
using CReverseIterator = ArrayConstReverseIterator<T>

Constructors, destructors, conversion operators

Array()
Array(fsize size) explicit
Array(const std::initializer_list<T>& lst)
Array(Array<T>&& arr) noexcept
Array(const Array<T>& arr)
~Array()

Public functions

auto operator=(Array<T>&& arr) -> Array<T>& noexcept
auto operator=(const Array<T>& arr) -> Array<T>&
void Swap(const Iterator& a, const Iterator& b)
auto operator[](fsize id) const -> const T&
auto operator[](fsize id) -> T&
void Resize(fsize newSize)
auto operator==(const Array<T>& other) -> bool
auto operator!=(const Array<T>& other) -> bool
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
auto First() -> T&
auto Last() -> T&
auto First() const -> const T&
auto Last() const -> const T&
auto Size() const -> fsize
auto operator*() const -> const T*
auto operator*() -> T*
auto Release() -> T*
auto begin() -> Iterator
auto end() -> Iterator
auto begin() const -> CIterator
auto end() const -> CIterator
auto rbegin() -> ReverseIterator
auto rend() -> ReverseIterator
auto rbegin() const -> CReverseIterator
auto rend() const -> CReverseIterator

Function documentation

template<typename T>
bpf::collection::Array<T, 0><T>::Array()

Constructs an empty array

template<typename T>
bpf::collection::Array<T, 0><T>::Array(fsize size) explicit

Parameters
size the size of the new array

Constructs an array of given size

template<typename T>
bpf::collection::Array<T, 0><T>::Array(const std::initializer_list<T>& lst)

Parameters
lst the list of values to copy the values from

Constructs an array from a list of values

template<typename T>
bpf::collection::Array<T, 0><T>::Array(Array<T>&& arr) noexcept

Move constructor

template<typename T>
bpf::collection::Array<T, 0><T>::Array(const Array<T>& arr)

Copy constructor

template<typename T>
Array<T>& bpf::collection::Array<T, 0><T>::operator=(Array<T>&& arr) noexcept

Move assignment operator

template<typename T>
Array<T>& bpf::collection::Array<T, 0><T>::operator=(const Array<T>& arr)

Copy assignment operator

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

Parameters
a first element
b second element

Swap two elements by iterator in the Array

template<typename T>
const T& bpf::collection::Array<T, 0><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::Array<T, 0><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>
void bpf::collection::Array<T, 0><T>::Resize(fsize newSize)

Parameters
newSize the new array size

Resizes the array to a different size

template<typename T>
bool bpf::collection::Array<T, 0><T>::operator==(const Array<T>& other)

Parameters
other Array to compare with
Returns true if the two arrays are equal, false otherwise

Compare Array by performing a per-element check

template<typename T>
bool bpf::collection::Array<T, 0><T>::operator!=(const Array<T>& other)

Parameters
other Array to compare with
Returns false if the two arrays are equal, true otherwise

Compare Array by performing a per-element check

template<typename T>
Iterator bpf::collection::Array<T, 0><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 array

template<typename T> template<template<typename> class Comparator = ops::Equal>
Iterator bpf::collection::Array<T, 0><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::Array<T, 0><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>
T& bpf::collection::Array<T, 0><T>::First()

Returns mutable item
Exceptions
IndexException if Array is not initialized

Returns the first element in this Array

template<typename T>
T& bpf::collection::Array<T, 0><T>::Last()

Returns mutable item
Exceptions
IndexException if Array is not initialized

Returns the last element in this Array

template<typename T>
const T& bpf::collection::Array<T, 0><T>::First() const

Returns immutable item
Exceptions
IndexException if array is not initialized

Returns the first element in this array

template<typename T>
const T& bpf::collection::Array<T, 0><T>::Last() const

Returns immutable item
Exceptions
IndexException if array is not initialized

Returns the last element in this array

template<typename T>
fsize bpf::collection::Array<T, 0><T>::Size() const

Returns size of collection as an unsigned number

Returns the length of the array

template<typename T>
const T* bpf::collection::Array<T, 0><T>::operator*() const

Returns low-level c-like arrray pointer

Returns an immutable low-level c-like arrray

template<typename T>
T* bpf::collection::Array<T, 0><T>::operator*()

Returns low-level c-like arrray pointer

Returns a mutable low-level c-like arrray

template<typename T>
T* bpf::collection::Array<T, 0><T>::Release()

Returns low-level c-like arrray pointer

Terminates management of the raw pointer and returns it WARNING: You are responsible for calling MemUtils::DeleteArray on the raw pointer after calling this function. Do not call this function unless you know what you're doing

template<typename T>
Iterator bpf::collection::Array<T, 0><T>::begin()

Returns new iterator

Returns an iterator to the begining of the array

template<typename T>
Iterator bpf::collection::Array<T, 0><T>::end()

Returns new iterator

Returns an iterator to the end of the array

template<typename T>
CIterator bpf::collection::Array<T, 0><T>::begin() const

Returns new iterator

Returns an iterator to the begining of the array

template<typename T>
CIterator bpf::collection::Array<T, 0><T>::end() const

Returns new iterator

Returns an iterator to the end of the array

template<typename T>
ReverseIterator bpf::collection::Array<T, 0><T>::rbegin()

Returns new iterator

Returns a reverse iterator to the begining of the array

template<typename T>
ReverseIterator bpf::collection::Array<T, 0><T>::rend()

Returns new iterator

Returns a reverse iterator to the end of the array

template<typename T>
CReverseIterator bpf::collection::Array<T, 0><T>::rbegin() const

Returns new iterator

Returns a reverse iterator to the begining of the array

template<typename T>
CReverseIterator bpf::collection::Array<T, 0><T>::rend() const

Returns new iterator

Returns a reverse iterator to the end of the array