peak_icv_array_2d.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_icv/exceptions/detail/peak_icv_exception_helpers.hpp>
#include <peak_icv/utils/peak_icv_printable.hpp>
#include <array>
 
namespace peak
{
namespace icv
{
 
template <typename Type, std::size_t rows, std::size_t columns>
class Array2D : public detail::IPrintable<Array2D<Type, rows, columns>>
{
public:
    constexpr Array2D()
        : m_data{}
    {}
 
    constexpr Array2D(const Type (&initList)[rows][columns]) // NOLINT
    {
        for (std::size_t row = 0; row < rows; ++row)
        {
            for (std::size_t col = 0; col < columns; ++col)
            {
                m_data[row * columns + col] = initList[row][col];
            }
        }
    }
 
    explicit constexpr Array2D(std::array<Type, rows * columns> data)
        : m_data(std::move(data))
    {}
 
    PEAK_COMMON_NO_DISCARD constexpr const Type* GetData() const
    {
        return m_data.data();
    }
 
    constexpr Type& At(std::size_t row, std::size_t col)
    {
        if (row >= rows || col >= columns)
        {
            throw OutOfRangeException("The given row or column index is out of range. Please check the array dimensions.");
        }
        return m_data[row * columns + col];
    }
 
    PEAK_COMMON_NO_DISCARD constexpr const Type& At(std::size_t row, std::size_t col) const
    {
        if (row >= rows || col >= columns)
        {
            throw OutOfRangeException("The given row or column index is out of range. Please check the array dimensions.");
        }
        return m_data[row * columns + col];
    }
 
    PEAK_COMMON_NO_DISCARD constexpr std::size_t GetNumberOfRows() const
    {
        return rows;
    }
 
    PEAK_COMMON_NO_DISCARD constexpr std::size_t GetNumberOfColumns() const
    {
        return columns;
    }
 
    PEAK_COMMON_NO_DISCARD auto begin();
 
    PEAK_COMMON_NO_DISCARD auto cbegin() const;
 
    PEAK_COMMON_NO_DISCARD auto end();
 
    PEAK_COMMON_NO_DISCARD auto cend() const;
 
protected:
    void Print(detail::CommaSeperatedStream& stream) const override
    {
        for (std::size_t row = 0; row < rows; ++row)
        {
            for (std::size_t col = 0; col < columns; ++col)
            {
                stream << this->At(row, col);
            }
            if (row < rows - 1)
            {
                stream << std::endl;
            }
        }
    }
 
private:
    std::array<Type, rows * columns> m_data;
};
 
template <typename Type, std::size_t rows, std::size_t columns>
auto Array2D<Type, rows, columns>::begin()
{
    return m_data.begin();
}
 
template <typename T, std::size_t rows, std::size_t columns>
auto Array2D<T, rows, columns>::cbegin() const
{
    return m_data.cbegin();
}
 
template <typename Type, std::size_t rows, std::size_t columns>
auto Array2D<Type, rows, columns>::end()
{
    return m_data.end();
}
 
template <typename T, std::size_t rows, std::size_t columns>
auto Array2D<T, rows, columns>::cend() const
{
    return m_data.cend();
}
 
} /* namespace icv */
} /* namespace peak */