slice.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
/* Copyright 2018-2020, Intel Corporation */
 
#ifndef LIBPMEMOBJ_CPP_SLICE_HPP
#define LIBPMEMOBJ_CPP_SLICE_HPP
 
#include <iterator>
#include <stdexcept>
#include <type_traits>
 
namespace pmem
{
 
namespace obj
{
 
template <typename Iterator>
class slice {
public:
    using size_type = std::size_t;
    using iterator = Iterator;
    using reverse_iterator = std::reverse_iterator<iterator>;
    using reference = typename std::iterator_traits<iterator>::reference;
 
    slice(Iterator begin, Iterator end) : it_begin(begin), it_end(end)
    {
        static_assert(
            std::is_same<typename std::iterator_traits<
                         iterator>::iterator_category,
                     std::random_access_iterator_tag>::value,
            "Iterator should have RandomAccessIterator tag");
 
        if (it_end < it_begin)
            throw std::out_of_range("pmem::obj::slice");
    }
 
    slice(const slice &other) noexcept = default;
 
    slice &operator=(const slice &other) noexcept = default;
 
    iterator
    begin() const noexcept
    {
        return it_begin;
    }
 
    iterator
    end() const noexcept
    {
        return it_end;
    }
 
    reverse_iterator
    rend() const noexcept
    {
        return reverse_iterator(it_begin);
    }
 
    reverse_iterator
    rbegin() const noexcept
    {
        return reverse_iterator(it_end);
    }
 
    reference
    at(size_type idx)
    {
        if (idx >= size())
            throw std::out_of_range("pmem::obj::slice");
 
        return it_begin[static_cast<typename std::iterator_traits<
            Iterator>::difference_type>(idx)];
    }
 
    reference operator[](size_type idx)
    {
        return it_begin[static_cast<typename std::iterator_traits<
            Iterator>::difference_type>(idx)];
    }
 
    size_type
    size() const
    {
        return static_cast<size_type>(it_end - it_begin);
    }
 
private:
    iterator it_begin, it_end;
};
 
} /* namespace obj */
 
} /* namespace pmem */
 
#endif /* LIBPMEMOBJ_CPP_SLICE_HPP */