array.h File Reference

This file contains implementation of Array class. More...

#include <cstddef>
#include <iostream>
#include <iterator>
#include <type_traits>
#include <utility>

Go to the source code of this file.

Classes
struct	dsa::Array< T, N >
	Implements Array class template for fixed size container. More...

Functions
template<std::size_t I, typename T, std::size_t N>
constexpr auto	dsa::get (Array< T, N > &array) noexcept -> T &
	Provide access to Ith element of an array.
template<std::size_t I, typename T, std::size_t N>
constexpr auto	dsa::get (const Array< T, N > &array) noexcept -> const T &
	Provide access to Ith element of an array.
template<std::size_t I, typename T, std::size_t N>
constexpr auto	dsa::get (Array< T, N > &&array) noexcept -> T &&
	Provide access to Ith element of an array.
template<std::size_t I, typename T, std::size_t N>
constexpr auto	dsa::get (const Array< T, N > &&array) noexcept -> const T &&
	Provide access to Ith element of an array.
template<typename T, std::size_t N>
void	dsa::swap (Array< T, N > &lhs, Array< T, N > &rhs) noexcept(noexcept(lhs.swap(rhs)))
	Exchanges content of two Array containers.
template<typename T, std::size_t N> requires (!std::is_array_v<T>)
constexpr auto	dsa::to_array (T(&array)[N]) -> Array< std::remove_cv_t< T >, N >
	Creates Array from one dimensional C-style array using copy semantics.
template<typename T, std::size_t N> requires (!std::is_array_v<T> && !std::is_const_v<T>)
constexpr auto	dsa::to_array (T(&&array)[N]) -> Array< std::remove_cv_t< T >, N >
	Creates Array from one dimensional C-style array using move semantics.
template<typename T, std::size_t N>
auto	dsa::operator<< (std::ostream &out, const Array< T, N > &array) -> std::ostream &
	Overloads operator to print all elements of Array.
template<typename T, std::size_t N>
constexpr auto	dsa::operator== (const Array< T, N > &lhs, const Array< T, N > &rhs) noexcept(noexcept(*lhs.begin()== *rhs.begin())) -> bool
	The relational operator compares two Array objects.
template<typename T, std::size_t N>
constexpr auto	dsa::operator<=> (const Array< T, N > &lhs, const Array< T, N > &rhs) noexcept(noexcept(*lhs.begin()== *rhs.begin())) -> std::compare_three_way_result_t< T >
	The relational operator compares two Array objects.

Detailed Description

This file contains implementation of Array class.

Author

Michal Zygmunt

Copyright

Copyright (c) 2025 Michal Zygmunt This project is distributed under the MIT License. See accompanying LICENSE.txt file or obtain copy at https://opensource.org/license/mit

Definition in file array.h.

Function Documentation

get() [1/4]

template<std::size_t I, typename T, std::size_t N>

auto dsa::get ( Array< T, N > && array ) -> T&&

nodiscardconstexprnoexcept

Provide access to Ith element of an array.

Intentionally not moving entire parameter array. This overload of get<I>(dsa::Array&&) returns an rvalue reference to an element, matching the behaviour of std::get<I>(std::array&&) in C++ standard library. Only the selected element is moved from std::move(array[I]), not the whole array.

Template Parameters

I	index of element in container
T	data type stored in container
N	number of elements in container

Parameters

[in]

array

container to extract element from

Returns

T&& reference to Ith element of array container

Definition at line 485 of file array.h.

    {
        static_assert(I < N, "Index out of range in dsa::Array::get");
        return std::move(array[I]);
    }

get() [2/4]

template<std::size_t I, typename T, std::size_t N>

auto dsa::get ( Array< T, N > & array ) -> T&

nodiscardconstexprnoexcept

Provide access to Ith element of an array.

Template Parameters

I	index of element in container
T	data type stored in container
N	number of elements in container

Parameters

[in]

array

container to extract element from

Returns

T& reference to Ith element of array container

Definition at line 447 of file array.h.

    {
        static_assert(I < N, "Index out of range in dsa::Array::get");
        return array[I];
    }

get() [3/4]

template<std::size_t I, typename T, std::size_t N>

auto dsa::get ( const Array< T, N > && array ) -> const T&&

nodiscardconstexprnoexcept

Provide access to Ith element of an array.

Template Parameters

I	index of element in container
T	data type stored in container
N	number of elements in container

Parameters

[in]

array

container to extract element from

Returns

const T&& reference to Ith element of array container

Definition at line 501 of file array.h.

    {
        static_assert(I < N, "Index out of range in dsa::Array::get");
        return std::move(array[I]);
    }

get() [4/4]

template<std::size_t I, typename T, std::size_t N>

auto dsa::get ( const Array< T, N > & array ) -> const T&

nodiscardconstexprnoexcept

Provide access to Ith element of an array.

Template Parameters

I	index of element in container
T	data type stored in container
N	number of elements in container

Parameters

[in]

array

container to extract element from

Returns

const T& reference to Ith element of array container

Definition at line 463 of file array.h.

    {
        static_assert(I < N, "Index out of range in dsa::Array::get");
        return array[I];
    }

operator<<()

template<typename T, std::size_t N>

auto dsa::operator<<	(	std::ostream &	out,
		const Array< T, N > &	array ) -> std::ostream&

Overloads operator to print all elements of Array.

Template Parameters

T	data type stored in container

Parameters

[in,out]	out	reference to output stream
[in]	array	Array to print

Returns

std::ostream&

Definition at line 572 of file array.h.

    {
        for (size_t i = 0; i < N; i++)
        {
            out << array[i] << ' ';
        }
 
        return out;
    }

operator<=>()

template<typename T, std::size_t N>

auto dsa::operator<=> ( const Array< T, N > & lhs, const Array< T, N > & rhs ) -> std::compare_three_way_result_t<T>

nodiscardconstexprnoexcept

The relational operator compares two Array objects.

Depending on type T, function returns one of following objects: std::strong_ordering::less / equal / greater std::weak_ordering::less / equivalent / greater std::partial_ordering::less / equivalent / greater / unordered It is best to compare results with 0 to determine if lhs is <, >, or == to rhs

Parameters

[in]	lhs	input container
[in]	rhs	input container

Returns

three way comparison result type

Definition at line 625 of file array.h.

    {
        auto lhs_iter = lhs.cbegin();
        auto rhs_iter = rhs.cbegin();
 
        for (size_t i = 0; i < N; i++)
        {
            auto cmp = *lhs_iter <=> *rhs_iter;
            if (cmp != 0)
            {
                return cmp;
            }
 
            lhs_iter++;
            rhs_iter++;
        }
 
        return std::compare_three_way_result_t<T>::equivalent;
    }

operator==()

template<typename T, std::size_t N>

auto dsa::operator== ( const Array< T, N > & lhs, const Array< T, N > & rhs ) -> bool

nodiscardconstexprnoexcept

The relational operator compares two Array objects.

Parameters

[in]	lhs	input container
[in]	rhs	input container

Return values

true	if input containers are equal
false	if input containers are not equal

Definition at line 591 of file array.h.

    {
        auto lhs_iter = lhs.cbegin();
        auto rhs_iter = rhs.cbegin();
 
        for (size_t i = 0; i < N; i++)
        {
            if (*lhs_iter != *rhs_iter)
            {
                return false;
            }
 
            lhs_iter++;
            rhs_iter++;
        }
 
        return true;
    }

swap()

template<typename T, std::size_t N>

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

noexcept

Exchanges content of two Array containers.

Template Parameters

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

Parameters

[in]	lhs	container to swap content
[in]	rhs	container to swap content

Definition at line 516 of file array.h.

    {
        lhs.swap(rhs);
    }

to_array() [1/2]

template<typename T, std::size_t N>
requires (!std::is_array_v<T> && !std::is_const_v<T>)

auto dsa::to_array ( T(&&) array[N] ) -> Array<std::remove_cv_t<T>, N>

nodiscardconstexpr

Creates Array from one dimensional C-style array using move semantics.

Template Parameters

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

Parameters

[in]

array

C-style array

Returns

Array container

Definition at line 554 of file array.h.

    {
        return[&]<std::size_t... I>(std::index_sequence<I...>)
        {
            // NOLINTNEXTLINE(cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays)
            return dsa::Array<std::remove_cv_t<T>, N>{std::move(array[I])...};
        }(std::make_index_sequence<N>{});
    }

to_array() [2/2]

template<typename T, std::size_t N>
requires (!std::is_array_v<T>)

auto dsa::to_array ( T(&) array[N] ) -> Array<std::remove_cv_t<T>, N>

nodiscardconstexpr

Creates Array from one dimensional C-style array using copy semantics.

Template Parameters

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

Parameters

[in]

array

C-style array

Returns

Array container

Definition at line 533 of file array.h.

    {
        return[&]<std::size_t... I>(std::index_sequence<I...>)
        {
            // NOLINTNEXTLINE(cppcoreguidelines-avoid-c-arrays,modernize-avoid-c-arrays)
            return dsa::Array<std::remove_cv_t<T>, N>{array[I]...};
        }(std::make_index_sequence<N>{});
    }