GEOS 3.9.1
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
32namespace geos {
33namespace geom { // geos.geom
34
35struct 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
60class GEOS_DLL Coordinate {
61
62private:
63
64 static Coordinate _nullCoord;
65
66public:
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 double distanceSquared(const Coordinate& p) const;
117
118 struct GEOS_DLL HashCode {
119 size_t operator()(const Coordinate & c) const;
120 };
121
122};
123
125struct GEOS_DLL CoordinateLessThen {
126
127 bool operator()(const Coordinate* a, const Coordinate* b) const;
128 bool operator()(const Coordinate& a, const Coordinate& b) const;
129
130};
131
133inline bool
134operator<(const Coordinate& a, const Coordinate& b)
135{
136 return CoordinateLessThen()(a, b);
137}
138
140GEOS_DLL std::ostream& operator<< (std::ostream& os, const Coordinate& c);
141
143GEOS_DLL bool operator==(const Coordinate& a, const Coordinate& b);
144
146GEOS_DLL bool operator!=(const Coordinate& a, const Coordinate& b);
147
148
149
150} // namespace geos.geom
151} // namespace geos
152
153#ifdef _MSC_VER
154#pragma warning(pop)
155#endif
156
157#ifdef GEOS_INLINE
158# include "geos/geom/Coordinate.inl"
159#endif
160
161#endif // ndef GEOS_GEOM_COORDINATE_H
162
Coordinate is the lightweight class used to store coordinates.
Definition: Coordinate.h:60
bool equals(const Coordinate &other) const
2D only
std::string toString() const
Returns a string of the form (x,y,z) .
std::vector< Coordinate > Vect
A vector of Coordinate objects (real object, not pointers)
Definition: Coordinate.h:77
std::vector< const Coordinate * > ConstVect
A vector of const Coordinate pointers.
Definition: Coordinate.h:71
std::set< const Coordinate *, CoordinateLessThen > ConstSet
A set of const Coordinate pointers.
Definition: Coordinate.h:68
std::stack< const Coordinate * > ConstStack
A stack of const Coordinate pointers.
Definition: Coordinate.h:74
double distance(const Coordinate &p) const
double y
y-coordinate
Definition: Coordinate.h:83
double x
x-coordinate
Definition: Coordinate.h:80
int compareTo(const Coordinate &other) const
TODO: deprecate this, move logic to CoordinateLessThen instead.
bool equals3D(const Coordinate &other) const
3D comparison
double z
z-coordinate
Definition: Coordinate.h:86
bool operator<(const Coordinate &a, const Coordinate &b)
Strict weak ordering operator for Coordinate.
Definition: Coordinate.h:134
bool operator!=(const Coordinate &a, const Coordinate &b)
Inequality operator for Coordinate. 2D only.
bool operator==(const Coordinate &a, const Coordinate &b)
Equality operator for Coordinate. 2D only.
std::ostream & operator<<(std::ostream &os, const Coordinate &c)
Output function.
Basic namespace for all GEOS functionalities.
Definition: IndexedNestedRingTester.h:26
Strict weak ordering Functor for Coordinate.
Definition: Coordinate.h:125