GEOS  3.8.0dev
Coordinate.h
1 /**********************************************************************
2  *
3  * GEOS - Geometry Engine Open Source
4  * http://geos.osgeo.org
5  *
6  * Copyright (C) 2006 Refractions Research Inc.
7  *
8  * This is free software; you can redistribute and/or modify it under
9  * the terms of the GNU Lesser General Public Licence as published
10  * by the Free Software Foundation.
11  * See the COPYING file for more information.
12  *
13  **********************************************************************/
14 
15 #ifndef GEOS_GEOM_COORDINATE_H
16 #define GEOS_GEOM_COORDINATE_H
17 
18 #include <geos/export.h>
19 #include <geos/constants.h> // for DoubleNotANumber
20 #include <geos/inline.h>
21 #include <set>
22 #include <stack>
23 #include <vector> // for typedefs
24 #include <string>
25 #include <limits>
26 
27 #ifdef _MSC_VER
28 #pragma warning(push)
29 #pragma warning(disable: 4251) // warning C4251: needs to have dll-interface to be used by clients of class
30 #endif
31 
32 namespace geos {
33 namespace geom { // geos.geom
34 
35 struct CoordinateLessThen;
36 
57 // Define the following to make assignments and copy constructions
58 // NON-inline (will let profilers report usages)
59 //#define PROFILE_COORDINATE_COPIES 1
60 class GEOS_DLL Coordinate {
61 
62 private:
63 
64  static Coordinate _nullCoord;
65 
66 public:
68  typedef std::set<const Coordinate*, CoordinateLessThen> ConstSet;
69 
71  typedef std::vector<const Coordinate*> ConstVect;
72 
74  typedef std::stack<const Coordinate*> ConstStack;
75 
77  typedef std::vector<Coordinate> Vect;
78 
80  double x;
81 
83  double y;
84 
86  double z;
87 
88  void setNull();
89 
90  static Coordinate& getNull();
91 
92  bool isNull() const;
93 
94  Coordinate(double xNew = 0.0, double yNew = 0.0, double zNew = DoubleNotANumber);
95 
96  bool equals2D(const Coordinate& other) const;
97 
99  bool equals(const Coordinate& other) const;
100 
102  int compareTo(const Coordinate& other) const;
103 
105  bool equals3D(const Coordinate& other) const;
106 
108  std::string toString() const;
109 
112  //void makePrecise(const PrecisionModel *pm);
113 
114  double distance(const Coordinate& p) const;
115 
116  int hashCode() const;
117 
122  static int hashCode(double d);
123 
124 };
125 
127 struct GEOS_DLL CoordinateLessThen {
128 
129  bool operator()(const Coordinate* a, const Coordinate* b) const;
130  bool operator()(const Coordinate& a, const Coordinate& b) const;
131 
132 };
133 
135 inline bool
136 operator<(const Coordinate& a, const Coordinate& b)
137 {
138  return CoordinateLessThen()(a, b);
139 }
140 
142 GEOS_DLL std::ostream& operator<< (std::ostream& os, const Coordinate& c);
143 
145 GEOS_DLL bool operator==(const Coordinate& a, const Coordinate& b);
146 
148 GEOS_DLL bool operator!=(const Coordinate& a, const Coordinate& b);
149 
150 
151 
152 } // namespace geos.geom
153 } // namespace geos
154 
155 #ifdef _MSC_VER
156 #pragma warning(pop)
157 #endif
158 
159 #ifdef GEOS_INLINE
160 # include "geos/geom/Coordinate.inl"
161 #endif
162 
163 #endif // ndef GEOS_GEOM_COORDINATE_H
164 
double y
y-coordinate
Definition: Coordinate.h:83
Coordinate is the lightweight class used to store coordinates.
Definition: Coordinate.h:60
Strict weak ordering Functor for Coordinate.
Definition: Coordinate.h:127
GEOS_DLL std::ostream & operator<<(std::ostream &os, const Coordinate &c)
Output function.
std::set< const Coordinate *, CoordinateLessThen > ConstSet
A set of const Coordinate pointers.
Definition: Coordinate.h:68
bool operator<(const Coordinate &a, const Coordinate &b)
Strict weak ordering operator for Coordinate.
Definition: Coordinate.h:136
std::vector< const Coordinate * > ConstVect
A vector of const Coordinate pointers.
Definition: Coordinate.h:71
Basic namespace for all GEOS functionalities.
Definition: IndexedNestedRingTester.h:25
std::vector< Coordinate > Vect
A vector of Coordinate objects (real object, not pointers)
Definition: Coordinate.h:77
GEOS_DLL bool operator==(const Coordinate &a, const Coordinate &b)
Equality operator for Coordinate. 2D only.
double x
x-coordinate
Definition: Coordinate.h:80
double z
z-coordinate
Definition: Coordinate.h:86
std::stack< const Coordinate * > ConstStack
A stack of const Coordinate pointers.
Definition: Coordinate.h:74
GEOS_DLL bool operator!=(const Coordinate &a, const Coordinate &b)
Inequality operator for Coordinate. 2D only.