Libosmium  2.15.1
Fast and flexible C++ library for working with OpenStreetMap data
location.hpp
Go to the documentation of this file.
1 #ifndef OSMIUM_OSM_LOCATION_HPP
2 #define OSMIUM_OSM_LOCATION_HPP
3 
4 /*
5 
6 This file is part of Osmium (https://osmcode.org/libosmium).
7 
8 Copyright 2013-2019 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 <algorithm>
37 #include <cmath>
38 #include <cstdint>
39 #include <cstring>
40 #include <functional>
41 #include <iosfwd>
42 #include <iterator>
43 #include <limits>
44 #include <stdexcept>
45 #include <string>
46 
47 namespace osmium {
48 
53  struct invalid_location : public std::range_error {
54 
55  explicit invalid_location(const std::string& what) :
56  std::range_error(what) {
57  }
58 
59  explicit invalid_location(const char* what) :
60  std::range_error(what) {
61  }
62 
63  }; // struct invalid_location
64 
65  namespace detail {
66 
67  enum {
68  coordinate_precision = 10000000
69  };
70 
71  // Convert string with a floating point number into integer suitable
72  // for use as coordinate in a Location.
73  inline int32_t string_to_location_coordinate(const char** data) {
74  const char* str = *data;
75  const char* full = str;
76 
77  int64_t result = 0;
78  int sign = 1;
79 
80  // one more than significant digits to allow rounding
81  int64_t scale = 8;
82 
83  // paranoia check for maximum number of digits
84  int max_digits = 10;
85 
86  // optional minus sign
87  if (*str == '-') {
88  sign = -1;
89  ++str;
90  }
91 
92  if (*str != '.') {
93  // there has to be at least one digit
94  if (*str >= '0' && *str <= '9') {
95  result = *str - '0';
96  ++str;
97  } else {
98  throw invalid_location{std::string{"wrong format for coordinate: '"} + full + "'"};
99  }
100 
101  // optional additional digits before decimal point
102  while (*str >= '0' && *str <= '9' && max_digits > 0) {
103  result = result * 10 + (*str - '0');
104  ++str;
105  --max_digits;
106  }
107 
108  if (max_digits == 0) {
109  throw invalid_location{std::string{"wrong format for coordinate: '"} + full + "'"};
110  }
111  } else {
112  // need at least one digit after decimal dot if there was no
113  // digit before decimal dot
114  if (*(str + 1) < '0' || *(str + 1) > '9') {
115  throw invalid_location{std::string{"wrong format for coordinate: '"} + full + "'"};
116  }
117  }
118 
119  // optional decimal point
120  if (*str == '.') {
121  ++str;
122 
123  // read significant digits
124  for (; scale > 0 && *str >= '0' && *str <= '9'; --scale, ++str) {
125  result = result * 10 + (*str - '0');
126  }
127 
128  // ignore non-significant digits
129  max_digits = 20;
130  while (*str >= '0' && *str <= '9' && max_digits > 0) {
131  ++str;
132  --max_digits;
133  }
134 
135  if (max_digits == 0) {
136  throw invalid_location{std::string{"wrong format for coordinate: '"} + full + "'"};
137  }
138  }
139 
140  // optional exponent in scientific notation
141  if (*str == 'e' || *str == 'E') {
142  ++str;
143 
144  int esign = 1;
145  // optional minus sign
146  if (*str == '-') {
147  esign = -1;
148  ++str;
149  }
150 
151  int64_t eresult = 0;
152 
153  // there has to be at least one digit in exponent
154  if (*str >= '0' && *str <= '9') {
155  eresult = *str - '0';
156  ++str;
157  } else {
158  throw invalid_location{std::string{"wrong format for coordinate: '"} + full + "'"};
159  }
160 
161  // optional additional digits in exponent
162  max_digits = 5;
163  while (*str >= '0' && *str <= '9' && max_digits > 0) {
164  eresult = eresult * 10 + (*str - '0');
165  ++str;
166  --max_digits;
167  }
168 
169  if (max_digits == 0) {
170  throw invalid_location{std::string{"wrong format for coordinate: '"} + full + "'"};
171  }
172 
173  scale += eresult * esign;
174  }
175 
176  if (scale < 0) {
177  for (; scale < 0 && result > 0; ++scale) {
178  result /= 10;
179  }
180  } else {
181  for (; scale > 0; --scale) {
182  result *= 10;
183  }
184  }
185 
186  result = (result + 5) / 10 * sign;
187 
188  if (result > std::numeric_limits<int32_t>::max() ||
189  result < std::numeric_limits<int32_t>::min()) {
190  throw invalid_location{std::string{"wrong format for coordinate: '"} + full + "'"};
191  }
192 
193  *data = str;
194  return static_cast<int32_t>(result);
195  }
196 
197  // Convert integer as used by location for coordinates into a string.
198  template <typename T>
199  inline T append_location_coordinate_to_string(T iterator, int32_t value) {
200  // need to special-case this, because later `value = -value` would overflow.
201  if (value == std::numeric_limits<int32_t>::min()) {
202  static const char minresult[] = "-214.7483648";
203  return std::copy_n(minresult, sizeof(minresult) - 1, iterator);
204  }
205 
206  // handle negative values
207  if (value < 0) {
208  *iterator++ = '-';
209  value = -value;
210  }
211 
212  // write digits into temporary buffer
213  int32_t v = value;
214  char temp[10];
215  char* t = temp;
216  do {
217  *t++ = char(v % 10) + '0';
218  v /= 10;
219  } while (v != 0);
220 
221  while (t - temp < 7) {
222  *t++ = '0';
223  }
224 
225  // write out digits before decimal point
226  if (value >= coordinate_precision) {
227  if (value >= 10 * coordinate_precision) {
228  if (value >= 100 * coordinate_precision) {
229  *iterator++ = *--t;
230  }
231  *iterator++ = *--t;
232  }
233  *iterator++ = *--t;
234  } else {
235  *iterator++ = '0';
236  }
237 
238  // remove trailing zeros
239  const char* tn = temp;
240  while (tn < t && *tn == '0') {
241  ++tn;
242  }
243 
244  // decimal point
245  if (t != tn) {
246  *iterator++ = '.';
247  while (t != tn) {
248  *iterator++ = *--t;
249  }
250  }
251 
252  return iterator;
253  }
254 
255  } // namespace detail
256 
271  class Location {
272 
273  int32_t m_x; // NOLINT(modernize-use-default-member-init)
274  int32_t m_y; // NOLINT(modernize-use-default-member-init)
275 
276  public:
277 
278  // this value is used for a coordinate to mark it as undefined
279  // MSVC doesn't declare std::numeric_limits<int32_t>::max() as
280  // constexpr, so we hard code this for the time being.
281  // undefined_coordinate = std::numeric_limits<int32_t>::max();
282  enum {
283  undefined_coordinate = 2147483647
284  };
285 
286  static int32_t double_to_fix(const double c) noexcept {
287  return static_cast<int32_t>(std::round(c * detail::coordinate_precision));
288  }
289 
290  static constexpr double fix_to_double(const int32_t c) noexcept {
291  return static_cast<double>(c) / detail::coordinate_precision;
292  }
293 
297  explicit constexpr Location() noexcept :
300  }
301 
307  constexpr Location(const int32_t x, const int32_t y) noexcept :
308  m_x(x),
309  m_y(y) {
310  }
311 
317  constexpr Location(const int64_t x, const int64_t y) noexcept :
318  m_x(static_cast<int32_t>(x)),
319  m_y(static_cast<int32_t>(y)) {
320  }
321 
325  Location(const double lon, const double lat) :
327  m_y(double_to_fix(lat)) {
328  }
329 
337  explicit constexpr operator bool() const noexcept {
339  }
340 
347  constexpr bool valid() const noexcept {
348  return m_x >= -180 * detail::coordinate_precision
349  && m_x <= 180 * detail::coordinate_precision
350  && m_y >= -90 * detail::coordinate_precision
351  && m_y <= 90 * detail::coordinate_precision;
352  }
353 
359  constexpr bool is_defined() const noexcept {
361  }
362 
368  constexpr bool is_undefined() const noexcept {
370  }
371 
372  constexpr int32_t x() const noexcept {
373  return m_x;
374  }
375 
376  constexpr int32_t y() const noexcept {
377  return m_y;
378  }
379 
380  Location& set_x(const int32_t x) noexcept {
381  m_x = x;
382  return *this;
383  }
384 
385  Location& set_y(const int32_t y) noexcept {
386  m_y = y;
387  return *this;
388  }
389 
395  double lon() const {
396  if (!valid()) {
397  throw osmium::invalid_location{"invalid location"};
398  }
399  return fix_to_double(m_x);
400  }
401 
405  double lon_without_check() const {
406  return fix_to_double(m_x);
407  }
408 
414  double lat() const {
415  if (!valid()) {
416  throw osmium::invalid_location{"invalid location"};
417  }
418  return fix_to_double(m_y);
419  }
420 
424  double lat_without_check() const {
425  return fix_to_double(m_y);
426  }
427 
428  Location& set_lon(double lon) noexcept {
429  m_x = double_to_fix(lon);
430  return *this;
431  }
432 
433  Location& set_lat(double lat) noexcept {
434  m_y = double_to_fix(lat);
435  return *this;
436  }
437 
438  Location& set_lon(const char* str) {
439  const char** data = &str;
440  const auto value = detail::string_to_location_coordinate(data);
441  if (**data != '\0') {
442  throw invalid_location{std::string{"characters after coordinate: '"} + *data + "'"};
443  }
444  m_x = value;
445  return *this;
446  }
447 
448  Location& set_lat(const char* str) {
449  const char** data = &str;
450  const auto value = detail::string_to_location_coordinate(data);
451  if (**data != '\0') {
452  throw invalid_location{std::string{"characters after coordinate: '"} + *data + "'"};
453  }
454  m_y = value;
455  return *this;
456  }
457 
458  Location& set_lon_partial(const char** str) {
459  m_x = detail::string_to_location_coordinate(str);
460  return *this;
461  }
462 
463  Location& set_lat_partial(const char** str) {
464  m_y = detail::string_to_location_coordinate(str);
465  return *this;
466  }
467 
468  template <typename T>
469  T as_string_without_check(T iterator, const char separator = ',') const {
470  iterator = detail::append_location_coordinate_to_string(iterator, x());
471  *iterator++ = separator;
472  return detail::append_location_coordinate_to_string(iterator, y());
473  }
474 
475  template <typename T>
476  T as_string(T iterator, const char separator = ',') const {
477  if (!valid()) {
478  throw osmium::invalid_location{"invalid location"};
479  }
480  return as_string_without_check(iterator, separator);
481  }
482 
483  }; // class Location
484 
488  inline constexpr bool operator==(const Location& lhs, const Location& rhs) noexcept {
489  return lhs.x() == rhs.x() && lhs.y() == rhs.y();
490  }
491 
492  inline constexpr bool operator!=(const Location& lhs, const Location& rhs) noexcept {
493  return !(lhs == rhs);
494  }
495 
501  inline constexpr bool operator<(const Location& lhs, const Location& rhs) noexcept {
502  return (lhs.x() == rhs.x() && lhs.y() < rhs.y()) || lhs.x() < rhs.x();
503  }
504 
505  inline constexpr bool operator>(const Location& lhs, const Location& rhs) noexcept {
506  return rhs < lhs;
507  }
508 
509  inline constexpr bool operator<=(const Location& lhs, const Location& rhs) noexcept {
510  return !(rhs < lhs);
511  }
512 
513  inline constexpr bool operator>=(const Location& lhs, const Location& rhs) noexcept {
514  return !(lhs < rhs);
515  }
516 
520  template <typename TChar, typename TTraits>
521  inline std::basic_ostream<TChar, TTraits>& operator<<(std::basic_ostream<TChar, TTraits>& out, const osmium::Location& location) {
522  if (location) {
523  out << '(';
524  location.as_string(std::ostream_iterator<char>(out), ',');
525  out << ')';
526  } else {
527  out << "(undefined,undefined)";
528  }
529  return out;
530  }
531 
532  namespace detail {
533 
534  template <int N>
535  inline size_t hash(const osmium::Location& location) noexcept {
536  return static_cast<uint32_t>(location.x()) ^ static_cast<uint32_t>(location.y());
537  }
538 
539  template <>
540  inline size_t hash<8>(const osmium::Location& location) noexcept {
541  uint64_t h = location.x();
542  h <<= 32u;
543  return static_cast<size_t>(h ^ static_cast<uint64_t>(location.y()));
544  }
545 
546  } // namespace detail
547 
548 } // namespace osmium
549 
550 namespace std {
551 
552 // This pragma is a workaround for a bug in an old libc implementation
553 #ifdef __clang__
554 #pragma clang diagnostic push
555 #pragma clang diagnostic ignored "-Wmismatched-tags"
556 #endif
557  template <>
558  struct hash<osmium::Location> {
560  using result_type = size_t;
561  size_t operator()(const osmium::Location& location) const noexcept {
562  return osmium::detail::hash<sizeof(size_t)>(location);
563  }
564  };
565 #ifdef __clang__
566 #pragma clang diagnostic pop
567 #endif
568 
569 } // namespace std
570 
571 #endif // OSMIUM_OSM_LOCATION_HPP
Location & set_lon(const char *str)
Definition: location.hpp:438
static int32_t double_to_fix(const double c) noexcept
Definition: location.hpp:286
std::basic_ostream< TChar, TTraits > & operator<<(std::basic_ostream< TChar, TTraits > &out, const osmium::Box &box)
Definition: box.hpp:224
double lon() const
Definition: location.hpp:395
bool operator<=(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:461
Location & set_lat_partial(const char **str)
Definition: location.hpp:463
double lat_without_check() const
Definition: location.hpp:424
constexpr bool operator==(const Box &lhs, const Box &rhs) noexcept
Definition: box.hpp:212
Location & set_lon(double lon) noexcept
Definition: location.hpp:428
double lat() const
Definition: location.hpp:414
Definition: location.hpp:550
constexpr Location(const int64_t x, const int64_t y) noexcept
Definition: location.hpp:317
constexpr Location(const int32_t x, const int32_t y) noexcept
Definition: location.hpp:307
constexpr bool valid() const noexcept
Definition: location.hpp:347
Location & set_lat(const char *str)
Definition: location.hpp:448
size_t operator()(const osmium::Location &location) const noexcept
Definition: location.hpp:561
bool operator<(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:453
Namespace for everything in the Osmium library.
Definition: assembler.hpp:53
Definition: attr.hpp:333
Definition: location.hpp:53
int32_t m_y
Definition: location.hpp:274
constexpr int32_t y() const noexcept
Definition: location.hpp:376
invalid_location(const std::string &what)
Definition: location.hpp:55
Location & set_lat(double lat) noexcept
Definition: location.hpp:433
Definition: location.hpp:283
Location & set_y(const int32_t y) noexcept
Definition: location.hpp:385
Definition: location.hpp:271
int32_t m_x
Definition: location.hpp:273
Location & set_x(const int32_t x) noexcept
Definition: location.hpp:380
bool operator>=(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:465
T as_string(T iterator, const char separator=',') const
Definition: location.hpp:476
bool operator>(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:457
T as_string_without_check(T iterator, const char separator=',') const
Definition: location.hpp:469
invalid_location(const char *what)
Definition: location.hpp:59
constexpr int32_t x() const noexcept
Definition: location.hpp:372
double lon_without_check() const
Definition: location.hpp:405
static constexpr double fix_to_double(const int32_t c) noexcept
Definition: location.hpp:290
constexpr bool is_defined() const noexcept
Definition: location.hpp:359
Location & set_lon_partial(const char **str)
Definition: location.hpp:458
Location(const double lon, const double lat)
Definition: location.hpp:325
bool operator!=(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:446
constexpr bool is_undefined() const noexcept
Definition: location.hpp:368
size_t result_type
Definition: location.hpp:560
constexpr Location() noexcept
Definition: location.hpp:297