/usr/include/geos/geom/CoordinateSequence.h is in libgeos-dev 3.2.2-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | /**********************************************************************
* $Id: CoordinateSequence.h 2678 2009-10-17 12:28:41Z strk $
*
* GEOS - Geometry Engine Open Source
* http://geos.refractions.net
*
* Copyright (C) 2006 Refractions Research Inc.
*
* This is free software; you can redistribute and/or modify it under
* the terms of the GNU Lesser General Public Licence as published
* by the Free Software Foundation.
* See the COPYING file for more information.
*
**********************************************************************/
#ifndef GEOS_GEOM_COORDINATESEQUENCE_H
#define GEOS_GEOM_COORDINATESEQUENCE_H
#include <geos/export.h>
#include <geos/platform.h>
#include <geos/inline.h>
#include <geos/geom/Coordinate.h> // for applyCoordinateFilter
#include <vector>
#include <iosfwd> // ostream
#include <memory> // for auto_ptr typedef
// Forward declarations
namespace geos {
namespace geom {
class Envelope;
class CoordinateFilter;
class Coordinate;
}
}
namespace geos {
namespace geom { // geos::geom
/**
* \class CoordinateSequence geom.h geos.h
*
* \brief
* The internal representation of a list of coordinates inside a Geometry.
*
* There are some cases in which you might want Geometries to store their
* points using something other than the GEOS Coordinate class. For example, you
* may want to experiment with another implementation, such as an array of Xs
* and an array of Ys. or you might want to use your own coordinate class, one
* that supports extra attributes like M-values.
*
* You can do this by implementing the CoordinateSequence and
* CoordinateSequenceFactory interfaces. You would then create a
* GeometryFactory parameterized by your CoordinateSequenceFactory, and use
* this GeometryFactory to create new Geometries. All of these new Geometries
* will use your CoordinateSequence implementation.
*
*/
class GEOS_DLL CoordinateSequence {
protected:
CoordinateSequence() {}
CoordinateSequence(const CoordinateSequence&) {}
public:
typedef std::auto_ptr<CoordinateSequence> AutoPtr;
friend std::ostream& operator<< (std::ostream& os,
const CoordinateSequence& cs);
friend bool operator== (
const CoordinateSequence& seq1,
const CoordinateSequence& seq2);
friend bool operator!= (
const CoordinateSequence& seq1,
const CoordinateSequence& seq2);
virtual ~CoordinateSequence() {}
/** \brief
* Returns a deep copy of this collection.
*/
virtual CoordinateSequence *clone() const=0;
/** \brief
* Returns a read-only reference to Coordinate at position i.
*
* Whether or not the Coordinate returned is the actual underlying
* Coordinate or merely a copy depends on the implementation.
*/
//virtual const Coordinate& getCoordinate(int i) const=0;
virtual const Coordinate& getAt(size_t i) const=0;
/// Return last Coordinate in the sequence
const Coordinate& back() const {
return getAt(size()-1);
}
/// Return first Coordinate in the sequence
const Coordinate& front() const {
return getAt(0);
}
const Coordinate& operator[] (size_t i) const {
return getAt(i);
}
/** \brief
* Write Coordinate at position i to given Coordinate.
*/
virtual void getAt(size_t i, Coordinate& c) const=0;
/** \brief
* Returns the number of Coordinates (actual or otherwise, as
* this implementation may not store its data in Coordinate objects).
*/
//virtual int size() const=0;
virtual size_t getSize() const=0;
size_t size() const { return getSize(); }
/** \brief
* Returns a read-only vector with the Coordinates in this collection.
*
* Whether or not the Coordinates returned are the actual underlying
* Coordinates or merely copies depends on the implementation.
* Note that if this implementation does not store its data as an
* array of Coordinates, this method will incur a performance penalty
* because the array needs to be built from scratch.
*
* This method is a port of the toCoordinateArray() method of JTS.
* It is not much used as memory management requires us to
* know wheter we should or not delete the returned object
* in a consistent way. Our options are: use shared_ptr<Coordinate>
* or always keep ownerhips of an eventual newly created vector.
* We opted for the second, so the returned object is a const, to
* also ensure that returning an internal pointer doesn't make
* the object mutable.
*
* @deprecated use toVector(std::vector<Coordinate>&) instead
*/
virtual const std::vector<Coordinate>* toVector() const=0;
/// Pushes all Coordinates of this sequence onto the provided vector.
//
/// This method is a port of the toCoordinateArray() method of JTS.
///
virtual void toVector(std::vector<Coordinate>& coords) const=0;
/**
* \brief Add an array of coordinates
* @param vc The coordinates
* @param allowRepeated if set to false, repeated coordinates
* are collapsed
* @return true (as by general collection contract)
*/
void add(const std::vector<Coordinate>* vc, bool allowRepeated);
/* This is here for backward compatibility.. */
//void add(CoordinateSequence *cl,bool allowRepeated,bool direction);
/** \brief
* Add an array of coordinates
*
* @param cl The coordinates
*
* @param allowRepeated
* if set to false, repeated coordinates are collapsed
*
* @param direction if false, the array is added in reverse order
*
* @return true (as by general collection contract)
*/
void add(const CoordinateSequence *cl, bool allowRepeated,
bool direction);
/**
* \brief Add a coordinate
* @param c The coordinate to add
* @param allowRepeated if set to false, repeated coordinates
* are collapsed
* @return true (as by general collection contract)
*/
virtual void add(const Coordinate& c, bool allowRepeated);
/** \brief
* Inserts the specified coordinate at the specified position in
* this list.
*
* @param i the position at which to insert
* @param coord the coordinate to insert
* @param allowRepeated if set to false, repeated coordinates are
* collapsed
*
* NOTE: this is a CoordinateList interface in JTS
*/
virtual void add(size_t i, const Coordinate& coord, bool allowRepeated)=0;
/// Returns <code>true</code> it list contains no coordinates.
virtual bool isEmpty() const=0;
/// Add a Coordinate to the list
virtual void add(const Coordinate& c)=0;
// Get number of coordinates
//virtual int getSize() const=0;
/// Get a reference to Coordinate at position pos
//virtual const Coordinate& getAt(size_t pos) const=0;
/// Copy Coordinate c to position pos
virtual void setAt(const Coordinate& c, size_t pos)=0;
/// Delete Coordinate at position pos (list will shrink).
virtual void deleteAt(size_t pos)=0;
/// Get a string rapresentation of CoordinateSequence
virtual std::string toString() const=0;
/// Substitute Coordinate list with a copy of the given vector
virtual void setPoints(const std::vector<Coordinate> &v)=0;
/// Returns true if contains any two consecutive points
bool hasRepeatedPoints() const;
/// Returns lower-left Coordinate in list
const Coordinate* minCoordinate() const;
/// \brief
/// Returns a new CoordinateSequence being a copy of the input
/// with any consecutive equal Coordinate removed.
///
/// Equality test is 2D based
///
/// Ownership of returned object goes to the caller.
///
static CoordinateSequence* removeRepeatedPoints(
const CoordinateSequence *cl);
/// Remove consecutive equal Coordinates from the sequence
//
/// Equality test is 2D based. Returns a reference to self.
///
virtual CoordinateSequence& removeRepeatedPoints()=0;
/** \brief
* Returns true if given CoordinateSequence contains
* any two consecutive Coordinate
*/
static bool hasRepeatedPoints(const CoordinateSequence *cl);
/** \brief
* Returns either the given CoordinateSequence if its length
* is greater than the given amount, or an empty CoordinateSequence.
*/
static CoordinateSequence* atLeastNCoordinatesOrNothing(size_t n,
CoordinateSequence *c);
/** \brief
* Returns lower-left Coordinate in given CoordinateSequence.
* This is actually the Coordinate with lower X (and Y if needed)
* ordinate.
*/
static const Coordinate* minCoordinate(CoordinateSequence *cl);
/// Return position of a Coordinate, or -1 if not found
//
/// FIXME: return size_t, using numeric_limits<size_t>::max
/// as 'not found' value.
///
static int indexOf(const Coordinate *coordinate,
const CoordinateSequence *cl);
/**
* \brief
* Returns true if the two arrays are identical, both null,
* or pointwise equal
*/
static bool equals(const CoordinateSequence *cl1,
const CoordinateSequence *cl2);
/// Scroll given CoordinateSequence so to start with given Coordinate.
static void scroll(CoordinateSequence *cl, const Coordinate *firstCoordinate);
/** \brief
* Determines which orientation of the {@link Coordinate} array
* is (overall) increasing.
*
* In other words, determines which end of the array is "smaller"
* (using the standard ordering on {@link Coordinate}).
* Returns an integer indicating the increasing direction.
* If the sequence is a palindrome, it is defined to be
* oriented in a positive direction.
*
* @param pts the array of Coordinates to test
* @return <code>1</code> if the array is smaller at the start
* or is a palindrome,
* <code>-1</code> if smaller at the end
*
* NOTE: this method is found in CoordinateArrays class for JTS
*/
static int increasingDirection(const CoordinateSequence& pts);
/// Reverse Coordinate order in given CoordinateSequence
static void reverse(CoordinateSequence *cl);
/// Standard ordinate index values
enum { X,Y,Z,M };
/**
* Returns the dimension (number of ordinates in each coordinate)
* for this sequence.
*
* @return the dimension of the sequence.
*/
virtual size_t getDimension() const=0;
/**
* Returns the ordinate of a coordinate in this sequence.
* Ordinate indices 0 and 1 are assumed to be X and Y.
* Ordinates indices greater than 1 have user-defined semantics
* (for instance, they may contain other dimensions or measure values).
*
* @param index the coordinate index in the sequence
* @param ordinateIndex the ordinate index in the coordinate
* (in range [0, dimension-1])
*/
virtual double getOrdinate(size_t index, size_t ordinateIndex) const=0;
/**
* Returns ordinate X (0) of the specified coordinate.
*
* @param index
* @return the value of the X ordinate in the index'th coordinate
*/
virtual double getX(size_t index) const { return getOrdinate(index, X); }
/**
* Returns ordinate Y (1) of the specified coordinate.
*
* @param index
* @return the value of the Y ordinate in the index'th coordinate
*/
virtual double getY(size_t index) const { return getOrdinate(index, Y); }
/**
* Sets the value for a given ordinate of a coordinate in this sequence.
*
* @param index the coordinate index in the sequence
* @param ordinateIndex the ordinate index in the coordinate
* (in range [0, dimension-1])
* @param value the new ordinate value
*/
virtual void setOrdinate(size_t index, size_t ordinateIndex, double value)=0;
/**
* Expands the given Envelope to include the coordinates in the
* sequence.
* Allows implementing classes to optimize access to coordinate values.
*
* @param env the envelope to expand
*/
virtual void expandEnvelope(Envelope &env) const;
virtual void apply_rw(const CoordinateFilter *filter)=0; //Abstract
virtual void apply_ro(CoordinateFilter *filter) const=0; //Abstract
/** \brief
* Apply a fiter to each Coordinate of this sequence.
* The filter is expected to provide a .filter(Coordinate&)
* method.
*
* TODO: accept a Functor instead, will be more flexible.
* actually, define iterators on Geometry
*/
template <class T>
void applyCoordinateFilter(T& f)
{
Coordinate c;
for(size_t i=0, n=size(); i<n; ++i)
{
getAt(i, c);
f.filter(c);
setAt(c, i);
}
}
};
std::ostream& operator<< (std::ostream& os, const CoordinateSequence& cs);
bool operator== (const CoordinateSequence& s1, const CoordinateSequence& s2);
bool operator!= (const CoordinateSequence& s1, const CoordinateSequence& s2);
} // namespace geos::geom
} // namespace geos
//#ifdef GEOS_INLINE
//# include "geos/geom/CoordinateSequence.inl"
//#endif
#endif // ndef GEOS_GEOM_COORDINATESEQUENCE_H
/**********************************************************************
* $Log$
* Revision 1.12 2006/06/12 16:51:23 strk
* Added equality and inequality operators and tests
*
* Revision 1.11 2006/06/12 16:36:22 strk
* indentation, notes about things to be fixed.
*
* Revision 1.10 2006/06/12 15:06:30 strk
* Added default ctor and copy ctor (protected)
*
* Revision 1.9 2006/06/12 10:10:39 strk
* Fixed getGeometryN() to take size_t rather then int, changed unsigned int parameters to size_t.
*
* Revision 1.8 2006/05/04 08:42:12 strk
* Added note about the CoordinateSequence::toVector() method.
*
* Revision 1.7 2006/05/03 19:47:27 strk
* added operator<< for CoordinateSequence
*
* Revision 1.6 2006/05/03 08:58:34 strk
* added new non-static CoordinateSequence::removeRepeatedPoints() mutator.
*
* Revision 1.5 2006/04/11 11:55:22 strk
* Added CoordinateSequence::AutoPtr typedef
*
* Revision 1.4 2006/04/04 09:53:45 strk
* Fixed applyCoordinateFilter() templated function body
*
* Revision 1.3 2006/03/24 09:52:41 strk
* USE_INLINE => GEOS_INLINE
*
* Revision 1.2 2006/03/20 17:27:03 strk
* Bug #72 - Missing <vector> header
*
* Revision 1.1 2006/03/09 16:46:49 strk
* geos::geom namespace definition, first pass at headers split
*
**********************************************************************/
|