IterableContainer.hpp

Go to the documentation of this file.

 
#ifndef LLU_CONTAINERS_ITERATORS_ITERABLECONTAINER_HPP
#define LLU_CONTAINERS_ITERATORS_ITERABLECONTAINER_HPP
 
#include <iterator>
#include <vector>
 
#include "LLU/LibraryData.h"
 
namespace LLU {
    template<typename T>
    class IterableContainer {
    public:
        using value_type = T;
 
        using iterator = value_type*;
 
        using const_iterator = const value_type*;
 
        using reverse_iterator = std::reverse_iterator<iterator>;
 
        using const_reverse_iterator = std::reverse_iterator<const_iterator>;
 
        using reference = value_type&;
 
        using const_reference = const value_type&;
 
    public:
        // Provide special member functions
        virtual ~IterableContainer() = default;
 
        value_type* data() noexcept {
            return getData();
        }
 
        const value_type* data() const noexcept {
            return getData();
        }
 
        mint size() const noexcept {
            return getSize();
        }
 
        iterator begin() noexcept {
            return getData();
        }
 
        const_iterator begin() const noexcept {
            return getData();
        }
 
        const_iterator cbegin() const noexcept {
            return getData();
        }
 
        iterator end() noexcept {
            return std::next(begin(), getSize());
        }
 
        const_iterator end() const noexcept {
            return std::next(begin(), getSize());
        }
 
        const_iterator cend() const noexcept {
            return std::next(cbegin(), getSize());
        }
 
        reverse_iterator rbegin() noexcept {
            return std::make_reverse_iterator(end());
        }
 
        const_reverse_iterator rbegin() const noexcept {
            return std::make_reverse_iterator(end());
        }
 
        const_reverse_iterator crbegin() const noexcept {
            return std::make_reverse_iterator(cend());
        }
 
        reverse_iterator rend() noexcept {
            return std::make_reverse_iterator(begin());
        }
 
        const_reverse_iterator rend() const noexcept {
            return std::make_reverse_iterator(begin());
        }
 
        const_reverse_iterator crend() const noexcept {
            return std::make_reverse_iterator(cbegin());
        }
 
        reference operator[](mint index) {
            return *(begin() + index);
        }
 
        const_reference operator[](mint index) const {
            return *(cbegin() + index);
        }
 
        reference front() {
            return *begin();
        }
 
        const_reference front() const {
            return *cbegin();
        }
 
        reference back() {
            return *(end() - 1);
        }
 
        const_reference back() const {
            return *(cend() - 1);
        }
 
        [[nodiscard]] std::vector<value_type> asVector() const {
            return std::vector<value_type> {cbegin(), cend()};
        }
 
    private:
        virtual T* getData() const noexcept = 0;
 
        virtual mint getSize() const noexcept = 0;
    };
 
}    // namespace LLU
 
#endif    // LLU_CONTAINERS_ITERATORS_ITERABLECONTAINER_HPP