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

Template parameters
T the type of element to store
I the size of the array as a constant expression

Contents

Static array

Public types

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

Constructors, destructors, conversion operators

Array()
Array(const std::initializer_list<T>& lst)
Array(const Array<T, I>& arr)
Array(Array<T, I>&& arr) noexcept

Public functions

auto operator=(const Array<T, I>& arr) -> Array<T, I>&
auto operator=(Array<T, I>&& arr) -> Array<T, I>& noexcept
void Swap(const Iterator& a, const Iterator& b)
auto Size() const -> fsize constexpr
auto First() -> T&
auto Last() -> T&
auto First() const -> const T&
auto Last() const -> const T&
auto operator*() const -> const T*
auto operator*() -> T*
auto operator[](const fsize id) -> T&
auto operator[](const fsize id) const -> const T&
auto operator==(const Array<T, I>& other) -> bool
auto operator!=(const Array<T, I>& 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 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
template<template<typename> class Comparator>
auto FindByValue(const T& val) -> Array<T>::Iterator

Function documentation

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

Constructs an empty array

template<typename T, fsize I>
bpf::collection::Array<T, I>::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, fsize I>
bpf::collection::Array<T, I>::Array(const Array<T, I>& arr)

Copy constructor

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

Move constructor

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

Copy assignment operator

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

Move assignment operator

template<typename T, fsize I>
void bpf::collection::Array<T, I>::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, fsize I>
fsize bpf::collection::Array<T, I>::Size() const constexpr

Returns size of collection as an unsigned number

Returns the length of the array

template<typename T, fsize I>
T& bpf::collection::Array<T, I>::First()

Returns mutable item

Returns the first element in this Array

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

Returns mutable item

Returns the last element in this Array

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

Returns immutable item

Returns the first element in this array

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

Returns immutable item

Returns the last element in this array

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

Returns low-level c-like arrray pointer

Returns an immutable low-level c-like arrray

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

Returns low-level c-like arrray pointer

Returns a mutable low-level c-like arrray

template<typename T, fsize I>
T& bpf::collection::Array<T, I>::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, fsize I>
const T& bpf::collection::Array<T, I>::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, fsize I>
bool bpf::collection::Array<T, I>::operator==(const Array<T, I>& 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, fsize I>
bool bpf::collection::Array<T, I>::operator!=(const Array<T, I>& 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, fsize I>
Iterator bpf::collection::Array<T, I>::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, fsize I> template<template<typename> class Comparator = ops::Equal>
Iterator bpf::collection::Array<T, I>::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, fsize I>
Iterator bpf::collection::Array<T, I>::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, fsize I>
Iterator bpf::collection::Array<T, I>::begin()

Returns new iterator

Returns an iterator to the begining of the array

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

Returns new iterator

Returns an iterator to the end of the array

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

Returns new iterator

Returns an iterator to the begining of the array

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

Returns new iterator

Returns an iterator to the end of the array

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

Returns new iterator

Returns a reverse iterator to the begining of the array

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

Returns new iterator

Returns a reverse iterator to the end of the array

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

Returns new iterator

Returns a reverse iterator to the begining of the array

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

Returns new iterator

Returns a reverse iterator to the end of the array

#include <Base/include/Framework/Collection/Array.impl.hpp>
template<typename T, fsize I> template<template<typename> class Comparator>
Array<T>::Iterator bpf::collection::Array<T, I>::FindByValue(const T& val)