1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
|
/*
* Copyright 2018, Intel Corporation
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* Iterface to access sequence of objects.
*/
#ifndef LIBPMEMOBJ_CPP_SLICE_HPP
#define LIBPMEMOBJ_CPP_SLICE_HPP
#include <iterator>
#include <type_traits>
namespace pmem
{
namespace obj
{
namespace experimental
{
/**
* pmem::obj::experimental::slice - provides interface to access
* sequence of objects.
*/
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;
/**
* Constructor taking two RandomAccess iterators which define a range.
*
* @throw std::out_of_range if it_end < it_begin.
*/
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");
}
/**
* Defaulted copy constructor.
*/
slice(const slice &other) noexcept = default;
/**
* Defaulted assignment operator.
*/
slice &operator=(const slice &other) noexcept = default;
/**
* Returns iterator to the beginning of the range.
*/
iterator
begin() const noexcept
{
return it_begin;
}
/**
* Returns iterator to the end of the range.
*/
iterator
end() const noexcept
{
return it_end;
}
/**
* Returns reverse iterator to the end.
*/
reverse_iterator
rend() const noexcept
{
return reverse_iterator(it_begin);
}
/**
* Returns reverse iterator to the beginning.
*/
reverse_iterator
rbegin() const noexcept
{
return reverse_iterator(it_end);
}
/**
* Element access operator.
*
* @throw std::out_of_range if idx is greater or equal to size.
*/
reference
at(size_type idx)
{
if (idx >= size())
throw std::out_of_range("pmem::obj::slice");
return it_begin[idx];
}
/**
* Element access operator.
* No bounds checking is performed.
*/
reference operator[](size_type idx)
{
return it_begin[idx];
}
size_type
size() const
{
return static_cast<size_type>(it_end - it_begin);
}
private:
iterator it_begin, it_end;
};
} /* namespace experimental */
} /* namespace obj */
} /* namespace pmem */
#endif /* LIBPMEMOBJ_CPP_SLICE_HPP */
|