Libosmium  2.10.0
Fast and flexible C++ library for working with OpenStreetMap data
node_ref_list.hpp
Go to the documentation of this file.
1 #ifndef OSMIUM_OSM_NODE_REF_LIST_HPP
2 #define OSMIUM_OSM_NODE_REF_LIST_HPP
3 
4 /*
5 
6 This file is part of Osmium (http://osmcode.org/libosmium).
7 
8 Copyright 2013-2016 Jochen Topf <jochen@topf.org> and others (see README).
9 
10 Boost Software License - Version 1.0 - August 17th, 2003
11 
12 Permission is hereby granted, free of charge, to any person or organization
13 obtaining a copy of the software and accompanying documentation covered by
14 this license (the "Software") to use, reproduce, display, distribute,
15 execute, and transmit the Software, and to prepare derivative works of the
16 Software, and to permit third-parties to whom the Software is furnished to
17 do so, all subject to the following:
18 
19 The copyright notices in the Software and this entire statement, including
20 the above license grant, this restriction and the following disclaimer,
21 must be included in all copies of the Software, in whole or in part, and
22 all derivative works of the Software, unless such copies or derivative
23 works are solely in the form of machine-executable object code generated by
24 a source language processor.
25 
26 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
29 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
30 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
31 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
32 DEALINGS IN THE SOFTWARE.
33 
34 */
35 
36 #include <cassert>
37 #include <cstddef>
38 #include <iterator>
39 
40 #include <osmium/memory/item.hpp>
41 #include <osmium/osm/item_type.hpp>
42 #include <osmium/osm/location.hpp>
43 #include <osmium/osm/node_ref.hpp>
44 
45 namespace osmium {
46 
52 
53  public:
54 
56  using reference = NodeRef&;
57  using const_reference = const NodeRef&;
58  using iterator = NodeRef*;
59  using const_iterator = const NodeRef*;
60  using const_reverse_iterator = std::reverse_iterator<const NodeRef*>;
61  using difference_type = std::ptrdiff_t;
62  using size_type = std::size_t;
63 
64  explicit NodeRefList(osmium::item_type itemtype) noexcept :
65  osmium::memory::Item(sizeof(NodeRefList), itemtype) {
66  }
67 
73  bool empty() const noexcept {
74  return sizeof(NodeRefList) == byte_size();
75  }
76 
82  size_type size() const noexcept {
83  const auto size_node_refs = byte_size() - sizeof(NodeRefList);
84  assert(size_node_refs % sizeof(NodeRef) == 0);
85  return size_node_refs / sizeof(NodeRef);
86  }
87 
97  const NodeRef& operator[](size_type n) const noexcept {
98  assert(n < size());
99  const NodeRef* node_ref = &*(cbegin());
100  return node_ref[n];
101  }
102 
110  const NodeRef& front() const noexcept {
111  assert(!empty());
112  return operator[](0);
113  }
114 
122  const NodeRef& back() const noexcept {
123  assert(!empty());
124  return operator[](size()-1);
125  }
126 
135  bool is_closed() const noexcept {
136  return ends_have_same_id();
137  }
138 
147  bool ends_have_same_id() const noexcept {
148  return front().ref() == back().ref();
149  }
150 
160  bool ends_have_same_location() const {
161  assert(front().location() && back().location());
162  return front().location() == back().location();
163  }
164 
166  iterator begin() noexcept {
167  return iterator(data() + sizeof(NodeRefList));
168  }
169 
171  iterator end() noexcept {
172  return iterator(data() + byte_size());
173  }
174 
176  const_iterator cbegin() const noexcept {
177  return const_iterator(data() + sizeof(NodeRefList));
178  }
179 
181  const_iterator cend() const noexcept {
182  return const_iterator(data() + byte_size());
183  }
184 
186  const_iterator begin() const noexcept {
187  return cbegin();
188  }
189 
191  const_iterator end() const noexcept {
192  return cend();
193  }
194 
196  const_reverse_iterator crbegin() const noexcept {
197  return const_reverse_iterator(cend());
198  }
199 
201  const_reverse_iterator crend() const noexcept {
202  return const_reverse_iterator(cbegin());
203  }
204 
205  }; // class NodeRefList
206 
207 } // namespace osmium
208 
209 #endif // OSMIUM_OSM_NODE_REF_LIST_HPP
const_iterator cbegin() const noexcept
Returns an iterator to the beginning.
Definition: node_ref_list.hpp:176
std::reverse_iterator< const NodeRef * > const_reverse_iterator
Definition: node_ref_list.hpp:60
bool is_closed() const noexcept
Definition: node_ref_list.hpp:135
const_reverse_iterator crbegin() const noexcept
Returns a reverse_iterator to the beginning.
Definition: node_ref_list.hpp:196
item_type
Definition: item_type.hpp:43
const NodeRef * const_iterator
Definition: node_ref_list.hpp:59
bool ends_have_same_id() const noexcept
Definition: node_ref_list.hpp:147
const_iterator cend() const noexcept
Returns an iterator to the end.
Definition: node_ref_list.hpp:181
std::ptrdiff_t difference_type
Definition: node_ref_list.hpp:61
constexpr osmium::object_id_type ref() const noexcept
Definition: node_ref.hpp:65
bool empty() const noexcept
Definition: node_ref_list.hpp:73
Definition: item.hpp:105
Namespace for everything in the Osmium library.
Definition: assembler.hpp:73
const_iterator begin() const noexcept
Returns an iterator to the beginning.
Definition: node_ref_list.hpp:186
osmium::Location & location() noexcept
Definition: node_ref.hpp:79
std::size_t size_type
Definition: node_ref_list.hpp:62
item_size_type byte_size() const noexcept
Definition: item.hpp:157
iterator begin() noexcept
Returns an iterator to the beginning.
Definition: node_ref_list.hpp:166
NodeRefList(osmium::item_type itemtype) noexcept
Definition: node_ref_list.hpp:64
iterator end() noexcept
Returns an iterator to the end.
Definition: node_ref_list.hpp:171
Definition: node_ref_list.hpp:51
const NodeRef & front() const noexcept
Definition: node_ref_list.hpp:110
const NodeRef & back() const noexcept
Definition: node_ref_list.hpp:122
NodeRef * iterator
Definition: node_ref_list.hpp:58
Definition: node_ref.hpp:50
bool ends_have_same_location() const
Definition: node_ref_list.hpp:160
const_reverse_iterator crend() const noexcept
Returns a reverse_iterator to the end.
Definition: node_ref_list.hpp:201
const NodeRef & operator[](size_type n) const noexcept
Definition: node_ref_list.hpp:97
size_type size() const noexcept
Definition: node_ref_list.hpp:82
const_iterator end() const noexcept
Returns an iterator to the end.
Definition: node_ref_list.hpp:191