Coordinate.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * 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.
 *
 **********************************************************************/
 
#pragma once
 
#include <geos/export.h>
#include <geos/constants.h> // for DoubleNotANumber
#include <set>
#include <stack>
#include <vector> // for typedefs
#include <string>
#include <limits>
 
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4251) // warning C4251: needs to have dll-interface to be used by clients of class
#endif
 
namespace geos {
namespace geom { // geos.geom
 
struct CoordinateLessThen;
 
// Define the following to make assignments and copy constructions
// NON-(will let profilers report usages)
//#define PROFILE_COORDINATE_COPIES 1
class GEOS_DLL Coordinate {
 
private:
 
    static Coordinate _nullCoord;
 
public:
    typedef std::set<const Coordinate*, CoordinateLessThen> ConstSet;
 
    typedef std::vector<const Coordinate*> ConstVect;
 
    typedef std::stack<const Coordinate*> ConstStack;
 
    typedef std::vector<Coordinate> Vect;
 
    double x;
 
    double y;
 
    double z;
 
    GEOS_DLL friend std::ostream& operator<< (std::ostream& os, const Coordinate& c);
 
    GEOS_DLL friend bool operator==(const Coordinate& a, const Coordinate& b)
    {
        return a.equals2D(b);
    };
 
    GEOS_DLL friend bool operator!=(const Coordinate& a, const Coordinate& b)
    {
        return ! a.equals2D(b);
    };
 
    Coordinate()
        : x(0.0)
        , y(0.0)
        , z(DoubleNotANumber)
        {};
 
    Coordinate(double xNew, double yNew, double zNew = DoubleNotANumber)
        : x(xNew)
        , y(yNew)
        , z(zNew)
        {};
 
    void setNull()
    {
        x = DoubleNotANumber;
        y = DoubleNotANumber;
        z = DoubleNotANumber;
    };
 
    static Coordinate& getNull();
 
    bool isNull() const
    {
        return (std::isnan(x) && std::isnan(y) && std::isnan(z));
    };
 
    bool isValid() const
    {
        return std::isfinite(x) && std::isfinite(y);
    };
 
    bool equals2D(const Coordinate& other) const
    {
        if(x != other.x) {
            return false;
        }
        if(y != other.y) {
            return false;
        }
        return true;
    };
 
    bool equals2D(const Coordinate& other, double tolerance) const
    {
        if (std::abs(x - other.x) > tolerance) {
            return false;
        }
        if (std::abs(y - other.y) > tolerance) {
            return false;
        }
        return true;
    };
 
    bool equals(const Coordinate& other) const
    {
        return equals2D(other);
    };
 
    int compareTo(const Coordinate& other) const
    {
        if(x < other.x) {
            return -1;
        }
        if(x > other.x) {
            return 1;
        }
        if(y < other.y) {
            return -1;
        }
        if(y > other.y) {
            return 1;
        }
        return 0;
    };
 
    bool equals3D(const Coordinate& other) const
    {
        return (x == other.x) && (y == other.y) &&
               ((z == other.z) || (std::isnan(z) && std::isnan(other.z)));
    };
 
    std::string toString() const;
 
    //void makePrecise(const PrecisionModel *pm);
    double distance(const Coordinate& p) const
    {
        double dx = x - p.x;
        double dy = y - p.y;
        return std::sqrt(dx * dx + dy * dy);
    };
 
    double distanceSquared(const Coordinate& p) const
    {
        double dx = x - p.x;
        double dy = y - p.y;
        return dx * dx + dy * dy;
    };
 
    struct GEOS_DLL HashCode
    {
        std::size_t operator()(const Coordinate & c) const
        {
            size_t h = std::hash<double>{}(c.x);
            h ^= std::hash<double>{}(c.y) << 1;
            // z ordinate ignored for consistency with operator==
            return h;
        };
    };
 
};
 
 
struct GEOS_DLL CoordinateLessThen {
 
    bool operator()(const Coordinate* a, const Coordinate* b) const
    {
        if(a->compareTo(*b) < 0) {
            return true;
        }
        else {
            return false;
        }
    };
 
    bool operator()(const Coordinate& a, const Coordinate& b) const
    {
        if(a.compareTo(b) < 0) {
            return true;
        }
        else {
            return false;
        }
    };
 
};
 
inline bool operator<(const Coordinate& a, const Coordinate& b)
{
    return CoordinateLessThen()(a, b);
}
 
} // namespace geos.geom
} // namespace geos
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif