celestia/src/celutil/array_view.h

// array_view.h
//
// Copyright (C) 2021-present, Celestia Development Team.
//
// Read-only view of array-like containers.
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.

#pragma once

#include <type_traits> // std::remove_cv
#include <cstddef>     // std::size_t

namespace celestia
{
namespace util
{

/**
 * Read-only view of array-like containers similar to C++20's std::span.
 */
template<typename T>
class array_view
{
 public:
    using element_type = typename std::remove_cv<T>::type;

    /**
     * Create an empty array view.
     */
    constexpr array_view() noexcept :
        m_ptr(nullptr),
        m_size(0)
    {};

    ~array_view() noexcept = default;

    /**
     * Wrap a compile-time C-style array.
     */
    template<size_t N> constexpr array_view(const T (&ary)[N]) noexcept :
        m_ptr(ary),
        m_size(N)
    {};


    /**
     * Wrap a run-time C-style array.
     */
    constexpr array_view(const T ary[], size_t n) noexcept :
        m_ptr(ary),
        m_size(n)
    {};

    /**
     * Wrap a std::array or std::vector or other classes which have the same
     * memory layout and interface.
     */
    template<typename C> constexpr array_view(const C &ary) noexcept :
        m_ptr(ary.data()),
        m_size(ary.size())
    {};

    /** @copydoc array_view::array_view(const C &ary) */
    template<typename C> constexpr array_view(C &&ary) noexcept :
        m_ptr(ary.data()),
        m_size(ary.size())
    {}

    /**
     * Assign another view or an object convertable to a view.
     */
    array_view<T>& operator=(const array_view<T> &ary) noexcept
    {
        m_ptr = ary.data();
        m_size = ary.size();
        return *this;
    }

    /** @copydoc array_view::operator=(const array_view<T> &ary) */
    array_view<T>& operator=(array_view<T> &&ary) noexcept
    {
        m_ptr = ary.data();
        m_size = ary.size();
        return *this;
    }

    /**
     * Direct access to the underlying array.
     */
    constexpr const element_type* data() const noexcept
    {
        return m_ptr;
    };

    /**
     * Return the number of elements.
     */
    constexpr size_t size() const noexcept
    {
        return m_size;
    };

    /**
     * Check whether the view is empty.
     */
    constexpr bool empty() const noexcept
    {
        return m_size == 0;
    }

    /**
     * Return the first element.
     *
     * Calling front on an empty container is undefined.
     */
    constexpr T front() const noexcept
    {
        return *m_ptr;
    }

    /**
     * Return the last element.
     *
     * Calling back on an empty container is undefined.
     */
    constexpr T back() const noexcept
    {
        return m_ptr[m_size - 1];
    }

    /**
     * Return array element at specified position. No bounds checking
     * performed.
     *
     * Accessing a nonexistent element through this operator is
     * undefined behavior.
     *
     * @param pos - position of the element to return
     * @return the requested element
     */
    constexpr element_type operator[](std::size_t pos) const noexcept
    {
        return m_ptr[pos];
    }

    /**
     * Return an iterator to the beginning.
     */
    constexpr const element_type* begin() const noexcept
    {
        return m_ptr;
    }

    /**
     * Return an iterator to the beginning.
     */
    constexpr const element_type* cbegin() const noexcept
    {
        return m_ptr;
    }

    /**
     * Return an iterator to the end.
     */
    constexpr const element_type* end() const noexcept
    {
        return m_ptr + m_size;
    }

    /**
     * Return an iterator to the end.
     */
    constexpr const element_type* cend() const noexcept
    {
        return m_ptr + m_size;
    }

 private:
    const element_type* m_ptr;
    size_t m_size;
};
}
}