Implements Array class template for fixed size container. More...

#include <array.h>

Public Types
using	value_type = T
	Alias for data type used in class.
using	size_type = std::size_t
	Alias for size type used in class.
using	difference_type = std::ptrdiff_t
	Alias for pointer difference type.
using	pointer = value_type*
	Alias for pointer to data type used in class.
using	const_pointer = const value_type*
	Alias for const pointer to data type used in class.
using	reference = value_type&
	Alias for reference to data type used in class.
using	const_reference = const value_type&
	Alias for const reference to data type used in class.
using	iterator = value_type*
	Alias for iterator to data type used in class.
using	const_iterator = const value_type*
	Alias for const iterator to data type used in class.
using	reverse_iterator = std::reverse_iterator<iterator>
	Alias for reverse_iterator to data type used in class.
using	const_reverse_iterator = std::reverse_iterator<const_iterator>
	Alias for const reverse_iterator to data type used in class.

Public Member Functions
constexpr auto	at (size_type pos) -> reference
	Returns a reference to Array element at `pos` index. If `pos` is outside of container range, an exception std::out_of_range is thrown.
constexpr auto	at (size_type pos) const -> const_reference
	Returns a const_reference to Array element at `pos` index. If `pos` is outside of container range, an exception std::out_of_range is thrown.
constexpr auto	operator[] (size_type pos) -> reference
	Returns a reference to Array element at `pos` index. If `pos` is outside of container range, undefined behaviour occurs.
constexpr auto	operator[] (size_type pos) const -> const_reference
	Returns a const_reference to Array element at `pos` index. If `pos` is outside of container range, undefined behaviour occurs.
constexpr auto	front () -> reference
	Returns reference to first Arary element.
constexpr auto	front () const -> const_reference
	Returns const_reference to first Arary element.
constexpr auto	back () -> reference
	Returns reference to last Arary element.
constexpr auto	back () const -> const_reference
	Returns const_reference to last Arary element.
constexpr auto	data () noexcept -> pointer
	Returns pointer to underlying array container.
constexpr auto	data () const noexcept -> const_pointer
	Returns const_pointer to underlying array container.
constexpr auto	begin () noexcept -> iterator
	Returns iterator to first element.
constexpr auto	begin () const noexcept -> const_iterator
	Returns const_iterator to first element.
constexpr auto	cbegin () const noexcept -> const_iterator
	Returns const_iterator to first element.
constexpr auto	end () noexcept -> iterator
	Returns iterator past last element of underlaying array structure.
constexpr auto	end () const noexcept -> const_iterator
	Returns const_iterator past last element of underlaying array structure.
constexpr auto	cend () const noexcept -> const_iterator
	Returns const_iterator past last element of underlaying array structure.
constexpr auto	rbegin () noexcept -> reverse_iterator
	Returns reverse_iterator to the first element of reversed underlaying array structure.
constexpr auto	rbegin () const noexcept -> const_reverse_iterator
	Returns const_reverse_iterator to the first element of reversed underlaying array structure.
constexpr auto	crbegin () const noexcept -> const_reverse_iterator
	Returns const_reverse_iterator to the first element of reversed underlaying array structure.
constexpr auto	rend () noexcept -> reverse_iterator
	Returns reverse_iterator past the last element of reversed underlaying array structure.
constexpr auto	rend () const noexcept -> const_reverse_iterator
	Returns const_reverse_iterator past the last element of reversed underlaying array structure.
constexpr auto	crend () const noexcept -> const_reverse_iterator
	Returns const_reverse_iterator past the last element of reversed underlaying array structure.
constexpr auto	empty () const noexcept -> bool
	Checks if container has elements.
constexpr auto	size () const noexcept -> size_type
	Returns number of elements in container.
constexpr auto	max_size () const noexcept -> size_type
	Returns maximum number of elements container can hold.
void	fill (const value_type &value)
	Assigns `value` to all elements of the container.
constexpr void	swap (Array< T, N > &other) noexcept(std::is_nothrow_swappable_v< T >)
	Exchanges content of current container with `other` container.

Public Attributes
value_type	m_data [N==0 ? 1 :N] {}
	Underlaying fixed size array containing all elements Conditional size is used to handle zero sized array without template specialization.

Detailed Description

template<typename T, std::size_t N>
struct dsa::Array< T, N >

Implements Array class template for fixed size container.

Template Parameters

T	type of data stored in container
N	number of elements in container

Definition at line 31 of file array.h.

Member Typedef Documentation

◆ const_iterator

template<typename T, std::size_t N>

using dsa::Array< T, N >::const_iterator = const value_type*

Alias for const iterator to data type used in class.

Definition at line 90 of file array.h.

◆ const_pointer

template<typename T, std::size_t N>

using dsa::Array< T, N >::const_pointer = const value_type*

Alias for const pointer to data type used in class.

Template Parameters

T*	pointer to data type

Definition at line 66 of file array.h.

◆ const_reference

template<typename T, std::size_t N>

using dsa::Array< T, N >::const_reference = const value_type&

Alias for const reference to data type used in class.

Template Parameters

T&	const reference to data type

Definition at line 80 of file array.h.

◆ const_reverse_iterator

template<typename T, std::size_t N>

using dsa::Array< T, N >::const_reverse_iterator = std::reverse_iterator<const_iterator>

Alias for const reverse_iterator to data type used in class.

Definition at line 100 of file array.h.

◆ difference_type

template<typename T, std::size_t N>

using dsa::Array< T, N >::difference_type = std::ptrdiff_t

Alias for pointer difference type.

Used by STL to define distance between two pointers

Definition at line 52 of file array.h.

◆ iterator

template<typename T, std::size_t N>

using dsa::Array< T, N >::iterator = value_type*

Alias for iterator to data type used in class.

Definition at line 85 of file array.h.

◆ pointer

template<typename T, std::size_t N>

using dsa::Array< T, N >::pointer = value_type*

Alias for pointer to data type used in class.

Template Parameters

T*	pointer to data type

Definition at line 59 of file array.h.

◆ reference

template<typename T, std::size_t N>

using dsa::Array< T, N >::reference = value_type&

Alias for reference to data type used in class.

Template Parameters

T&	reference to data type

Definition at line 73 of file array.h.

◆ reverse_iterator

template<typename T, std::size_t N>

using dsa::Array< T, N >::reverse_iterator = std::reverse_iterator<iterator>

Alias for reverse_iterator to data type used in class.

Definition at line 95 of file array.h.

◆ size_type

template<typename T, std::size_t N>

using dsa::Array< T, N >::size_type = std::size_t

Alias for size type used in class.

Template Parameters

T size type

Definition at line 45 of file array.h.

◆ value_type

template<typename T, std::size_t N>

using dsa::Array< T, N >::value_type = T

Alias for data type used in class.

Template Parameters

T data type

Definition at line 38 of file array.h.

Member Function Documentation

◆ at() [1/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::at ( size_type pos ) -> reference

inlinenodiscardconstexpr

Returns a reference to Array element at pos index. If pos is outside of container range, an exception std::out_of_range is thrown.

Parameters

[in] pos index of element to return

Returns: reference to Array element at pos index

Definition at line 109 of file array.h.

        {
            if (pos >= N)
            {
                throw std::out_of_range("Pos argument outside of container range");
            }
 
            // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-constant-array-index)
            return m_data[pos];
        }

◆ at() [2/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::at ( size_type pos ) const -> const_reference

inlinenodiscardconstexpr

Returns a const_reference to Array element at pos index. If pos is outside of container range, an exception std::out_of_range is thrown.

Parameters

[in] pos index of element to return

Returns: const_reference to Array element at pos index

Definition at line 127 of file array.h.

        {
            if (pos >= N)
            {
                throw std::out_of_range("Pos argument outside of container range");
            }
 
            // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-constant-array-index)
            return m_data[pos];
        }

◆ back() [1/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::back ( ) -> reference

inlinenodiscardconstexpr

Returns reference to last Arary element.

Returns: reference to last element

Definition at line 191 of file array.h.

        {
            return m_data[N - 1];
        }

◆ back() [2/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::back ( ) const -> const_reference

inlinenodiscardconstexpr

Returns const_reference to last Arary element.

Returns: const_reference to last element

Definition at line 201 of file array.h.

        {
            return m_data[N - 1];
        }

◆ begin() [1/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::begin ( ) const -> const_iterator

inlinenodiscardconstexprnoexcept

Returns const_iterator to first element.

Note: If container is empty, returned iterator will be equal to end()

Returns: const_iterator to first element

Definition at line 245 of file array.h.

        {
            return &m_data[0];
        }

◆ begin() [2/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::begin ( ) -> iterator

inlinenodiscardconstexprnoexcept

Returns iterator to first element.

Note: If container is empty, returned iterator will be equal to end()

Returns: iterator to first element

Definition at line 233 of file array.h.

        {
            return &m_data[0];
        }

◆ cbegin()

template<typename T, std::size_t N>

auto dsa::Array< T, N >::cbegin ( ) const -> const_iterator

inlinenodiscardconstexprnoexcept

Returns const_iterator to first element.

Note: If container is empty, returned iterator will be equal to end()

Returns: const_iterator to first element

Definition at line 257 of file array.h.

        {
            return &m_data[0];
        }

◆ cend()

template<typename T, std::size_t N>

auto dsa::Array< T, N >::cend ( ) const -> const_iterator

inlinenodiscardconstexprnoexcept

Returns const_iterator past last element of underlaying array structure.

Note: Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns: const_iterator past last element

Definition at line 293 of file array.h.

        {
            return &(m_data[N]);
        }

◆ crbegin()

template<typename T, std::size_t N>

auto dsa::Array< T, N >::crbegin ( ) const -> const_reverse_iterator

inlinenodiscardconstexprnoexcept

Returns const_reverse_iterator to the first element of reversed underlaying array structure.

Note: If container is empty, returned iterator will be equal to end()

Returns: const_reverse_iterator to the first element

Definition at line 329 of file array.h.

        {
            return const_reverse_iterator(end());
        }

◆ crend()

template<typename T, std::size_t N>

auto dsa::Array< T, N >::crend ( ) const -> const_reverse_iterator

inlinenodiscardconstexprnoexcept

Returns const_reverse_iterator past the last element of reversed underlaying array structure.

Note: Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns: const_reverse_iterator to the element after the last element

Definition at line 365 of file array.h.

        {
            return const_reverse_iterator(begin());
        }

◆ data() [1/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::data ( ) const -> const_pointer

inlinenodiscardconstexprnoexcept

Returns const_pointer to underlying array container.

Returns: const_pointer to underlaying array container

Definition at line 221 of file array.h.

        {
            return &m_data[0];
        }

◆ data() [2/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::data ( ) -> pointer

inlinenodiscardconstexprnoexcept

Returns pointer to underlying array container.

Returns: pointer to underlaying array container

Definition at line 211 of file array.h.

        {
            return &m_data[0];
        }

◆ empty()

template<typename T, std::size_t N>

auto dsa::Array< T, N >::empty ( ) const -> bool

inlinenodiscardconstexprnoexcept

Checks if container has elements.

Returns: true if container is empty; false if container is not empty

Definition at line 376 of file array.h.

        {
            return N == 0;
        }

◆ end() [1/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::end ( ) const -> const_iterator

inlinenodiscardconstexprnoexcept

Returns const_iterator past last element of underlaying array structure.

Note: Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns: const_iterator past last element

Definition at line 281 of file array.h.

        {
            return &(m_data[N]);
        }

◆ end() [2/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::end ( ) -> iterator

inlinenodiscardconstexprnoexcept

Returns iterator past last element of underlaying array structure.

Note: Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns: iterator past last element

Definition at line 269 of file array.h.

        {
            return &m_data[N];
        }

◆ fill()

template<typename T, std::size_t N>

void dsa::Array< T, N >::fill ( const value_type & value )

inline

Assigns value to all elements of the container.

Parameters

[in] value to assign to all elements of container

Definition at line 406 of file array.h.

        {
            for (size_type i = 0; i < size(); i++)
            {
                // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-constant-array-index)
                m_data[i] = value;
            }
        }

◆ front() [1/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::front ( ) -> reference

inlinenodiscardconstexpr

Returns reference to first Arary element.

Returns: reference to first element

Definition at line 171 of file array.h.

        {
            return m_data[0];
        }

◆ front() [2/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::front ( ) const -> const_reference

inlinenodiscardconstexpr

Returns const_reference to first Arary element.

Returns: const_reference to first element

Definition at line 181 of file array.h.

        {
            return m_data[0];
        }

◆ max_size()

template<typename T, std::size_t N>

auto dsa::Array< T, N >::max_size ( ) const -> size_type

inlinenodiscardconstexprnoexcept

Returns maximum number of elements container can hold.

Returns: size_type maximum number of elements

Definition at line 396 of file array.h.

        {
            return N;
        }

◆ operator[]() [1/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::operator[] ( size_type pos ) -> reference

inlinenodiscardconstexpr

Returns a reference to Array element at pos index. If pos is outside of container range, undefined behaviour occurs.

Parameters

[in] pos index of element to return

Returns: reference to Array element

Definition at line 145 of file array.h.

        {
            // Same semantics as std::array::operator[], no bounds checking
            // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-constant-array-index)
            return m_data[pos];
        }

◆ operator[]() [2/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::operator[] ( size_type pos ) const -> const_reference

inlinenodiscardconstexpr

Returns a const_reference to Array element at pos index. If pos is outside of container range, undefined behaviour occurs.

Parameters

[in] pos index of element to return

Returns: const_reference to Array element

Definition at line 159 of file array.h.

        {
            // Same semantics as std::array::operator[], no bounds checking
            // NOLINTNEXTLINE(cppcoreguidelines-pro-bounds-constant-array-index)
            return m_data[pos];
        }

◆ rbegin() [1/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::rbegin ( ) const -> const_reverse_iterator

inlinenodiscardconstexprnoexcept

Returns const_reverse_iterator to the first element of reversed underlaying array structure.

Note: If container is empty, returned iterator will be equal to end()

Returns: const_reverse_iterator to the first element

Definition at line 317 of file array.h.

        {
            return const_reverse_iterator(end());
        }

◆ rbegin() [2/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::rbegin ( ) -> reverse_iterator

inlinenodiscardconstexprnoexcept

Returns reverse_iterator to the first element of reversed underlaying array structure.

Note: If container is empty, returned iterator will be equal to end()

Returns: reverse_iterator to the first element

Definition at line 305 of file array.h.

        {
            return reverse_iterator(end());
        }

◆ rend() [1/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::rend ( ) const -> const_reverse_iterator

inlinenodiscardconstexprnoexcept

Returns const_reverse_iterator past the last element of reversed underlaying array structure.

Note: Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns: const_reverse_iterator to the element after the last element

Definition at line 353 of file array.h.

        {
            return const_reverse_iterator(begin());
        }

◆ rend() [2/2]

template<typename T, std::size_t N>

auto dsa::Array< T, N >::rend ( ) -> reverse_iterator

inlinenodiscardconstexprnoexcept

Returns reverse_iterator past the last element of reversed underlaying array structure.

Note: Iterator act as a sentinel, it is not guaranteed to be dereferencable

Returns: reverse_iterator to the element after the last element

Definition at line 341 of file array.h.

        {
            return reverse_iterator(begin());
        }

◆ size()

template<typename T, std::size_t N>

auto dsa::Array< T, N >::size ( ) const -> size_type

inlinenodiscardconstexprnoexcept

Returns number of elements in container.

Returns: size_type number of elements in container

Definition at line 386 of file array.h.

        {
            return N;
        }

◆ swap()

template<typename T, std::size_t N>

void dsa::Array< T, N >::swap ( Array< T, N > & other )

inlineconstexprnoexcept

Exchanges content of current container with other container.

Parameters

[in] other container to exchange content with

Definition at line 420 of file array.h.

        {
            if (*this != other)
            {
                std::swap(m_data, other.m_data);
            }
        }

Member Data Documentation

◆ m_data

template<typename T, std::size_t N>

value_type dsa::Array< T, N >::m_data[N==0 ? 1 :N] {}

Underlaying fixed size array containing all elements Conditional size is used to handle zero sized array without template specialization.

Definition at line 434 of file array.h.

434: N]{};

The documentation for this struct was generated from the following file:

include/dsa/array.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

Member Function Documentation

◆ at() [1/2]

◆ at() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ crbegin()

◆ crend()

◆ data() [1/2]

◆ data() [2/2]

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ fill()

◆ front() [1/2]

◆ front() [2/2]

◆ max_size()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ size()

◆ swap()

Member Data Documentation

◆ m_data