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
|
/************************************************************************
*
* Copyright (C) 2021-2024 IRCAD France
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
// cspell:ignore NOLINT
#pragma once
#include <data/iterator/types.hpp>
#include <iterator>
namespace sight::data
{
#ifdef SIGHT_DEBUG_ITERATOR
#define SIGHT_IF_DEBUG(x) , x
#else
#define SIGHT_IF_DEBUG(x)
#endif
/**
* @brief Iterator on an array buffer
*
* By default, this does not check out of bounds conditions. However it is possible to enable them temporarily
* by defining the definition SIGHT_DEBUG_ITERATOR before including this file. Also, you should consider to disable
* the PCH in the current target to avoid skipping this definition.
*
* @tparam T format used to iterate through the buffer, should be one of the formats defined in IterationBase
*
* Example:
* @code{.cpp}
data::image::sptr img = std::make_shared<data::image>();
img->resize(1920, 1080, 0, core::type::UINT8, data::image::pixel_format::rgba);
auto iter = img->begin<RGBA>();
const auto iterEnd = img->end<RGBA>();
for (; iter != iterEnd; ++iter)
{
iter->r = val1;
iter->g = val2;
iter->b = val2;
iter->a = val4;
}
@endcode
*/
template<class T>
class array_iterator
{
public:
/**
* @name Typedefs required by std::iterator_traits
* @{
*/
using pointer_t = T*;
using value_type = T;
using reference = T&;
/// Define difference type
using difference_type = std::ptrdiff_t;
/// define the category of the iterator.
using iterator_category = std::random_access_iterator_tag;
/// @}
array_iterator() = default;
constexpr array_iterator(pointer_t _begin);
array_iterator(const array_iterator<T>& _other) = default;
array_iterator(array_iterator<T>&& _other) noexcept = default;
~array_iterator() = default;
template<bool isConst = std::is_const_v<T>, typename = typename std::enable_if_t<isConst> >
constexpr array_iterator(const array_iterator<std::remove_const_t<T> >& _other);
array_iterator& operator=(const array_iterator& _other) = default;
array_iterator& operator=(array_iterator&& _other) noexcept = default;
/// Comparison operators
constexpr bool operator==(const array_iterator& _other) const noexcept;
constexpr bool operator!=(const array_iterator& _other) const noexcept;
/// Increment/Decrement operators
array_iterator& operator++();
const array_iterator operator++(int); // NOLINT(readability-const-return-type)
constexpr array_iterator operator+(difference_type _index) const;
array_iterator& operator+=(difference_type _index);
array_iterator& operator--();
const array_iterator operator--(int); // NOLINT(readability-const-return-type)
constexpr array_iterator operator-(difference_type _index) const;
array_iterator& operator-=(difference_type _index);
constexpr difference_type operator-(const array_iterator& _other) const noexcept;
/// Subscript operator
constexpr auto& operator[](const std::size_t _index) const noexcept;
/// Value access operators
reference operator*() const;
/// Value access operators
constexpr pointer_t operator->() const noexcept;
protected:
/// allow to create a ConstIterator from an Iterator
friend class array_iterator<const T>;
pointer_t m_current {nullptr};
#ifdef SIGHT_DEBUG_ITERATOR
pointer_t m_begin {nullptr};
pointer_t m_end {nullptr};
#endif
};
template<typename T>
/// Image const iterator
using const_array_iterator = array_iterator<const T>;
} // namespace sight::data
#include "data/iterator.hxx"
|
