Libosmium  2.14.0
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 (http://osmcode.org/libosmium).
7 
8 Copyright 2013-2018 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  constexpr const int coordinate_precision = 10000000;
68 
69  // Convert string with a floating point number into integer suitable
70  // for use as coordinate in a Location.
71  inline int32_t string_to_location_coordinate(const char** data) {
72  const char* str = *data;
73  const char* full = str;
74 
75  int64_t result = 0;
76  int sign = 1;
77 
78  // one more than significant digits to allow rounding
79  int64_t scale = 8;
80 
81  // paranoia check for maximum number of digits
82  int max_digits = 10;
83 
84  // optional minus sign
85  if (*str == '-') {
86  sign = -1;
87  ++str;
88  }
89 
90  if (*str != '.') {
91  // there has to be at least one digit
92  if (*str >= '0' && *str <= '9') {
93  result = *str - '0';
94  ++str;
95  } else {
96  goto error;
97  }
98 
99  // optional additional digits before decimal point
100  while (*str >= '0' && *str <= '9' && max_digits > 0) {
101  result = result * 10 + (*str - '0');
102  ++str;
103  --max_digits;
104  }
105 
106  if (max_digits == 0) {
107  goto error;
108  }
109  } else {
110  // need at least one digit after decimal dot if there was no
111  // digit before decimal dot
112  if (*(str + 1) < '0' || *(str + 1) > '9') {
113  goto error;
114  }
115  }
116 
117  // optional decimal point
118  if (*str == '.') {
119  ++str;
120 
121  // read significant digits
122  for (; scale > 0 && *str >= '0' && *str <= '9'; --scale, ++str) {
123  result = result * 10 + (*str - '0');
124  }
125 
126  // ignore non-significant digits
127  max_digits = 20;
128  while (*str >= '0' && *str <= '9' && max_digits > 0) {
129  ++str;
130  --max_digits;
131  }
132 
133  if (max_digits == 0) {
134  goto error;
135  }
136  }
137 
138  // optional exponent in scientific notation
139  if (*str == 'e' || *str == 'E') {
140  ++str;
141 
142  int esign = 1;
143  // optional minus sign
144  if (*str == '-') {
145  esign = -1;
146  ++str;
147  }
148 
149  int64_t eresult = 0;
150 
151  // there has to be at least one digit in exponent
152  if (*str >= '0' && *str <= '9') {
153  eresult = *str - '0';
154  ++str;
155  } else {
156  goto error;
157  }
158 
159  // optional additional digits in exponent
160  max_digits = 5;
161  while (*str >= '0' && *str <= '9' && max_digits > 0) {
162  eresult = eresult * 10 + (*str - '0');
163  ++str;
164  --max_digits;
165  }
166 
167  if (max_digits == 0) {
168  goto error;
169  }
170 
171  scale += eresult * esign;
172  }
173 
174  if (scale < 0) {
175  for (; scale < 0 && result > 0; ++scale) {
176  result /= 10;
177  }
178  } else {
179  for (; scale > 0; --scale) {
180  result *= 10;
181  }
182  }
183 
184  result = (result + 5) / 10 * sign;
185 
186  if (result > std::numeric_limits<int32_t>::max() ||
187  result < std::numeric_limits<int32_t>::min()) {
188  goto error;
189  }
190 
191  *data = str;
192  return static_cast<int32_t>(result);
193 
194  error:
195 
196  throw invalid_location{std::string{"wrong format for coordinate: '"} + full + "'"};
197  }
198 
199  // Convert integer as used by location for coordinates into a string.
200  template <typename T>
201  inline T append_location_coordinate_to_string(T iterator, int32_t value) {
202  // need to special-case this, because later `value = -value` would overflow.
203  if (value == std::numeric_limits<int32_t>::min()) {
204  static const char minresult[] = "-214.7483648";
205  return std::copy_n(minresult, sizeof(minresult) - 1, iterator);
206  }
207 
208  // handle negative values
209  if (value < 0) {
210  *iterator++ = '-';
211  value = -value;
212  }
213 
214  // write digits into temporary buffer
215  int32_t v = value;
216  char temp[10];
217  char* t = temp;
218  do {
219  *t++ = char(v % 10) + '0';
220  v /= 10;
221  } while (v != 0);
222 
223  while (t - temp < 7) {
224  *t++ = '0';
225  }
226 
227  // write out digits before decimal point
228  if (value >= coordinate_precision) {
229  if (value >= 10 * coordinate_precision) {
230  if (value >= 100 * coordinate_precision) {
231  *iterator++ = *--t;
232  }
233  *iterator++ = *--t;
234  }
235  *iterator++ = *--t;
236  } else {
237  *iterator++ = '0';
238  }
239 
240  // remove trailing zeros
241  const char* tn = temp;
242  while (tn < t && *tn == '0') {
243  ++tn;
244  }
245 
246  // decimal point
247  if (t != tn) {
248  *iterator++ = '.';
249  while (t != tn) {
250  *iterator++ = *--t;
251  }
252  }
253 
254  return iterator;
255  }
256 
257  } // namespace detail
258 
273  class Location {
274 
275  int32_t m_x;
276  int32_t m_y;
277 
278  public:
279 
280  // this value is used for a coordinate to mark it as undefined
281  // MSVC doesn't declare std::numeric_limits<int32_t>::max() as
282  // constexpr, so we hard code this for the time being.
283  // static constexpr int32_t undefined_coordinate = std::numeric_limits<int32_t>::max();
284  static constexpr int32_t undefined_coordinate = 2147483647;
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 :
298  m_x(undefined_coordinate),
299  m_y(undefined_coordinate) {
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) :
326  m_x(double_to_fix(lon)),
327  m_y(double_to_fix(lat)) {
328  }
329 
337  explicit constexpr operator bool() const noexcept {
338  return m_x != undefined_coordinate && m_y != undefined_coordinate;
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 {
360  return m_x != undefined_coordinate || m_y != undefined_coordinate;
361  }
362 
368  constexpr bool is_undefined() const noexcept {
369  return m_x == undefined_coordinate && m_y == undefined_coordinate;
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 <<= 32;
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
double lon() const
Definition: location.hpp:395
bool operator<=(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:456
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:448
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:276
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
Location & set_y(const int32_t y) noexcept
Definition: location.hpp:385
Definition: location.hpp:273
int32_t m_x
Definition: location.hpp:275
Location & set_x(const int32_t x) noexcept
Definition: location.hpp:380
bool operator>=(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:460
T as_string(T iterator, const char separator=',') const
Definition: location.hpp:476
bool operator>(const Changeset &lhs, const Changeset &rhs)
Definition: changeset.hpp:452
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:441
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