osrm-backend/Include/osrm/Coordinate.h

/*

Copyright (c) 2013, Project OSRM, Dennis Luxen, others
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#ifndef FIXED_POINT_COORDINATE_H_
#define FIXED_POINT_COORDINATE_H_

#include <iosfwd> //for std::ostream
#include <string>
#include <type_traits>

constexpr float COORDINATE_PRECISION = 1000000.f;

struct FixedPointCoordinate
{
    int lat;
    int lon;

    FixedPointCoordinate();
    FixedPointCoordinate(int lat, int lon);

    template<class T>
    FixedPointCoordinate(const T &coordinate) : lat(coordinate.lat), lon(coordinate.lon)
    {
        static_assert(std::is_same<decltype(lat), decltype(coordinate.lat)>::value, "coordinate types incompatible");
        static_assert(std::is_same<decltype(lon), decltype(coordinate.lon)>::value, "coordinate types incompatible");
    }

    void Reset();
    bool isSet() const;
    bool isValid() const;
    bool operator==(const FixedPointCoordinate &other) const;

    static double
    ApproximateDistance(const int lat1, const int lon1, const int lat2, const int lon2);

    static double ApproximateDistance(const FixedPointCoordinate &first_coordinate,
                                      const FixedPointCoordinate &second_coordinate);

    static float ApproximateEuclideanDistance(const FixedPointCoordinate &first_coordinate,
                                              const FixedPointCoordinate &second_coordinate);

    static float
    ApproximateEuclideanDistance(const int lat1, const int lon1, const int lat2, const int lon2);

    static float ApproximateSquaredEuclideanDistance(const FixedPointCoordinate &first_coordinate,
                                                     const FixedPointCoordinate &second_coordinate);

    static void convertInternalLatLonToString(const int value, std::string &output);

    static void convertInternalCoordinateToString(const FixedPointCoordinate &coordinate,
                                                  std::string &output);

    static void convertInternalReversedCoordinateToString(const FixedPointCoordinate &coordinate,
                                                          std::string &output);

    static float ComputePerpendicularDistance(const FixedPointCoordinate &segment_source,
                                              const FixedPointCoordinate &segment_target,
                                              const FixedPointCoordinate &query_location);

    static float ComputePerpendicularDistance(const FixedPointCoordinate &segment_source,
                                              const FixedPointCoordinate &segment_target,
                                              const FixedPointCoordinate &query_location,
                                              FixedPointCoordinate &nearest_location,
                                              float &ratio);

    static int
    OrderedPerpendicularDistanceApproximation(const FixedPointCoordinate &segment_source,
                                              const FixedPointCoordinate &segment_target,
                                              const FixedPointCoordinate &query_location);

    static float GetBearing(const FixedPointCoordinate &A, const FixedPointCoordinate &B);

    float GetBearing(const FixedPointCoordinate &other) const;

    void Output(std::ostream &out) const;

    static float DegreeToRadian(const float degree);
    static float RadianToDegree(const float radian);
};

inline std::ostream &operator<<(std::ostream &out_stream, FixedPointCoordinate const &coordinate)
{
    coordinate.Output(out_stream);
    return out_stream;
}

#endif /* FIXED_POINT_COORDINATE_H_ */