Loading...
Searching...
No Matches
node_ref_list.hpp
Go to the documentation of this file.
#ifndef OSMIUM_OSM_NODE_REF_LIST_HPP
#define OSMIUM_OSM_NODE_REF_LIST_HPP
/*
This file is part of Osmium (https://osmcode.org/libosmium).
Copyright 2013-2026 Jochen Topf <jochen@topf.org> and others (see README).
Boost Software License - Version 1.0 - August 17th, 2003
Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:
The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
#include <osmium/memory/item.hpp>
#include <osmium/osm/box.hpp>
#include <osmium/osm/item_type.hpp>
#include <osmium/osm/location.hpp>
#include <osmium/osm/node_ref.hpp>
#include <cassert>
#include <cstddef>
#include <iterator>
namespace osmium {
class NodeRefList : public osmium::memory::Item {
public:
using value_type = NodeRef;
using reference = NodeRef&;
using const_reference = const NodeRef&;
using iterator = NodeRef*;
using const_iterator = const NodeRef*;
using const_reverse_iterator = std::reverse_iterator<const NodeRef*>;
using difference_type = std::ptrdiff_t;
using size_type = std::size_t;
explicit NodeRefList(osmium::item_type itemtype) noexcept :
osmium::memory::Item(sizeof(NodeRefList), itemtype) {
}
bool empty() const noexcept {
return sizeof(NodeRefList) == byte_size();
}
size_type size() const noexcept {
const auto size_node_refs = byte_size() - sizeof(NodeRefList);
assert(size_node_refs % sizeof(NodeRef) == 0);
return size_node_refs / sizeof(NodeRef);
}
const NodeRef& operator[](size_type n) const noexcept {
assert(n < size());
const NodeRef* node_ref = &*(cbegin());
return node_ref[n];
}
NodeRef& operator[](size_type n) noexcept {
assert(n < size());
NodeRef* node_ref = &*(begin());
return node_ref[n];
}
const NodeRef& front() const noexcept {
assert(!empty());
return operator[](0);
}
const NodeRef& back() const noexcept {
assert(!empty());
return operator[](size() - 1);
}
bool is_closed() const noexcept {
assert(!empty());
return ends_have_same_id();
}
bool ends_have_same_id() const noexcept {
assert(!empty());
return front().ref() == back().ref();
}
bool ends_have_same_location() const {
assert(!empty());
assert(front().location() && back().location());
return front().location() == back().location();
}
osmium::Box envelope() const noexcept {
osmium::Box box;
for (const auto& node_ref : *this) {
box.extend(node_ref.location());
}
return box;
}
iterator begin() noexcept {
return reinterpret_cast< iterator >(data() + sizeof(NodeRefList));
}
iterator end() noexcept {
return reinterpret_cast< iterator >(data() + byte_size());
}
const_iterator cbegin() const noexcept {
return reinterpret_cast< const_iterator >(data() + sizeof(NodeRefList));
}
const_iterator cend() const noexcept {
return reinterpret_cast< const_iterator >(data() + byte_size());
}
const_iterator begin() const noexcept {
return cbegin();
}
const_iterator end() const noexcept {
return cend();
}
const_reverse_iterator crbegin() const noexcept {
return const_reverse_iterator(cend());
}
const_reverse_iterator crend() const noexcept {
return const_reverse_iterator(cbegin());
}
}; // class NodeRefList
} // namespace osmium
#endif // OSMIUM_OSM_NODE_REF_LIST_HPP
box.hpp
osmium::NodeRefList::cbegin
const_iterator cbegin() const noexcept
Returns an iterator to the beginning.
Definition node_ref_list.hpp:209
osmium::NodeRefList::iterator
NodeRef * iterator
Definition node_ref_list.hpp:59
osmium::NodeRefList::envelope
osmium::Box envelope() const noexcept
Definition node_ref_list.hpp:190
osmium::NodeRefList::begin
iterator begin() noexcept
Returns an iterator to the beginning.
Definition node_ref_list.hpp:199
osmium::NodeRefList::size_type
std::size_t size_type
Definition node_ref_list.hpp:63
osmium::NodeRefList::const_reference
const NodeRef & const_reference
Definition node_ref_list.hpp:58
osmium::NodeRefList::operator[]
const NodeRef & operator[](size_type n) const noexcept
Definition node_ref_list.hpp:98
osmium::NodeRefList::front
const NodeRef & front() const noexcept
Definition node_ref_list.hpp:126
osmium::NodeRefList::is_closed
bool is_closed() const noexcept
Definition node_ref_list.hpp:151
osmium::NodeRefList::cend
const_iterator cend() const noexcept
Returns an iterator to the end.
Definition node_ref_list.hpp:214
osmium::NodeRefList::reference
NodeRef & reference
Definition node_ref_list.hpp:57
osmium::NodeRefList::NodeRefList
NodeRefList(osmium::item_type itemtype) noexcept
Definition node_ref_list.hpp:65
osmium::NodeRefList::difference_type
std::ptrdiff_t difference_type
Definition node_ref_list.hpp:62
osmium::NodeRefList::end
iterator end() noexcept
Returns an iterator to the end.
Definition node_ref_list.hpp:204
osmium::NodeRefList::size
size_type size() const noexcept
Definition node_ref_list.hpp:83
osmium::NodeRefList::ends_have_same_location
bool ends_have_same_location() const
Definition node_ref_list.hpp:178
osmium::NodeRefList::crend
const_reverse_iterator crend() const noexcept
Returns a reverse_iterator to the end.
Definition node_ref_list.hpp:234
osmium::NodeRefList::const_reverse_iterator
std::reverse_iterator< const NodeRef * > const_reverse_iterator
Definition node_ref_list.hpp:61
osmium::NodeRefList::ends_have_same_id
bool ends_have_same_id() const noexcept
Definition node_ref_list.hpp:164
osmium::NodeRefList::begin
const_iterator begin() const noexcept
Returns an iterator to the beginning.
Definition node_ref_list.hpp:219
osmium::NodeRefList::crbegin
const_reverse_iterator crbegin() const noexcept
Returns a reverse_iterator to the beginning.
Definition node_ref_list.hpp:229
osmium::NodeRefList::value_type
NodeRef value_type
Definition node_ref_list.hpp:56
osmium::NodeRefList::empty
bool empty() const noexcept
Definition node_ref_list.hpp:74
osmium::NodeRefList::back
const NodeRef & back() const noexcept
Definition node_ref_list.hpp:138
osmium::NodeRefList::const_iterator
const NodeRef * const_iterator
Definition node_ref_list.hpp:60
osmium::NodeRefList::end
const_iterator end() const noexcept
Returns an iterator to the end.
Definition node_ref_list.hpp:224
osmium::NodeRefList::operator[]
NodeRef & operator[](size_type n) noexcept
Definition node_ref_list.hpp:113
osmium::NodeRef
Definition node_ref.hpp:50
osmium::NodeRef::ref
constexpr osmium::object_id_type ref() const noexcept
Definition node_ref.hpp:71
osmium::NodeRef::location
osmium::Location & location() noexcept
Definition node_ref.hpp:85
osmium::memory::Item
Definition item.hpp:105
osmium::memory::Item::byte_size
item_size_type byte_size() const noexcept
Definition item.hpp:163
item.hpp
item_type.hpp
location.hpp
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
osmium::item_type
item_type
Definition item_type.hpp:45
node_ref.hpp