Libosmium  2.5.4
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-2015 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/node_ref.hpp>
43 
44 namespace osmium {
45 
51 
52  public:
53 
54  explicit NodeRefList(osmium::item_type itemtype) noexcept :
55  osmium::memory::Item(sizeof(NodeRefList), itemtype) {
56  }
57 
61  bool empty() const noexcept {
62  return sizeof(NodeRefList) == byte_size();
63  }
64 
68  size_t size() const noexcept {
69  auto size_node_refs = byte_size() - sizeof(NodeRefList);
70  assert(size_node_refs % sizeof(NodeRef) == 0);
71  return size_node_refs / sizeof(NodeRef);
72  }
73 
81  const NodeRef& operator[](size_t n) const noexcept {
82  assert(n < size());
83  const NodeRef* node_ref = &*(cbegin());
84  return node_ref[n];
85  }
86 
92  const NodeRef& front() const noexcept {
93  assert(!empty());
94  return operator[](0);
95  }
96 
102  const NodeRef& back() const noexcept {
103  assert(!empty());
104  return operator[](size()-1);
105  }
106 
113  bool is_closed() const noexcept {
114  return ends_have_same_id();
115  }
116 
123  bool ends_have_same_id() const noexcept {
124  return front().ref() == back().ref();
125  }
126 
134  bool ends_have_same_location() const {
135  assert(front().location() && back().location());
136  return front().location() == back().location();
137  }
138 
139  using iterator = NodeRef*;
140  using const_iterator = const NodeRef*;
141  using const_reverse_iterator = std::reverse_iterator<const NodeRef*>;
142 
144  iterator begin() noexcept {
145  return iterator(data() + sizeof(NodeRefList));
146  }
147 
149  iterator end() noexcept {
150  return iterator(data() + byte_size());
151  }
152 
154  const_iterator cbegin() const noexcept {
155  return const_iterator(data() + sizeof(NodeRefList));
156  }
157 
159  const_iterator cend() const noexcept {
160  return const_iterator(data() + byte_size());
161  }
162 
164  const_iterator begin() const noexcept {
165  return cbegin();
166  }
167 
169  const_iterator end() const noexcept {
170  return cend();
171  }
172 
174  const_reverse_iterator crbegin() const noexcept {
175  return const_reverse_iterator(cend());
176  }
177 
179  const_reverse_iterator crend() const noexcept {
180  return const_reverse_iterator(cbegin());
181  }
182 
183  }; // class NodeRefList
184 
185 } // namespace osmium
186 
187 #endif // OSMIUM_OSM_NODE_REF_LIST_HPP
std::reverse_iterator< const NodeRef * > const_reverse_iterator
Definition: node_ref_list.hpp:141
item_type
Definition: item_type.hpp:43
const NodeRef * const_iterator
Definition: node_ref_list.hpp:140
bool ends_have_same_location() const
Definition: node_ref_list.hpp:134
item_size_type byte_size() const noexcept
Definition: item.hpp:147
const_reverse_iterator crend() const noexcept
Returns a reverse_iterator to the end.
Definition: node_ref_list.hpp:179
Definition: item.hpp:97
Namespace for everything in the Osmium library.
Definition: assembler.hpp:59
const NodeRef & operator[](size_t n) const noexcept
Definition: node_ref_list.hpp:81
constexpr osmium::object_id_type ref() const noexcept
Definition: node_ref.hpp:65
const NodeRef & front() const noexcept
Definition: node_ref_list.hpp:92
bool ends_have_same_id() const noexcept
Definition: node_ref_list.hpp:123
osmium::Location & location() noexcept
Definition: node_ref.hpp:79
iterator begin() noexcept
Returns an iterator to the beginning.
Definition: node_ref_list.hpp:144
NodeRefList(osmium::item_type itemtype) noexcept
Definition: node_ref_list.hpp:54
const_iterator begin() const noexcept
Returns an iterator to the beginning.
Definition: node_ref_list.hpp:164
iterator end() noexcept
Returns an iterator to the end.
Definition: node_ref_list.hpp:149
Definition: node_ref_list.hpp:50
const_iterator cend() const noexcept
Returns an iterator to the end.
Definition: node_ref_list.hpp:159
const_reverse_iterator crbegin() const noexcept
Returns a reverse_iterator to the beginning.
Definition: node_ref_list.hpp:174
size_t size() const noexcept
Definition: node_ref_list.hpp:68
const_iterator end() const noexcept
Returns an iterator to the end.
Definition: node_ref_list.hpp:169
NodeRef * iterator
Definition: node_ref_list.hpp:139
const_iterator cbegin() const noexcept
Returns an iterator to the beginning.
Definition: node_ref_list.hpp:154
Definition: node_ref.hpp:50
bool empty() const noexcept
Definition: node_ref_list.hpp:61
const NodeRef & back() const noexcept
Definition: node_ref_list.hpp:102
bool is_closed() const noexcept
Definition: node_ref_list.hpp:113