Latitude.hpp

Go to the documentation of this file.

/*
 * ----------------- BEGIN LICENSE BLOCK ---------------------------------
 *
 * Copyright (C) 2018-2020 Intel Corporation
 *
 * SPDX-License-Identifier: MIT
 *
 * ----------------- END LICENSE BLOCK -----------------------------------
 */
 
#pragma once
 
#include <cmath>
#include <iostream>
#include <limits>
#include <sstream>
#include <stdexcept>
#include "spdlog/fmt/ostr.h"
#include "spdlog/spdlog.h"
namespace ad {
namespace map {
namespace point {
 
#define AD_MAP_POINT_LATITUDE_THROWS_EXCEPTION 1
 
#if SAFE_DATATYPES_EXPLICIT_CONVERSION
 
#define _AD_MAP_POINT_LATITUDE_EXPLICIT_CONVERSION_ explicit
#else
 
#define _AD_MAP_POINT_LATITUDE_EXPLICIT_CONVERSION_
#endif
 
class Latitude
{
public:
  static const double cMinValue;
 
  static const double cMaxValue;
 
  static const double cPrecisionValue;
 
  Latitude()
    : mLatitude(std::numeric_limits<double>::quiet_NaN())
  {
  }
 
  _AD_MAP_POINT_LATITUDE_EXPLICIT_CONVERSION_ Latitude(double const iLatitude)
    : mLatitude(iLatitude)
  {
  }
 
  Latitude(const Latitude &other) = default;
 
  Latitude(Latitude &&other) = default;
 
  Latitude &operator=(const Latitude &other) = default;
 
  Latitude &operator=(Latitude &&other) = default;
 
  bool operator==(const Latitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return std::fabs(mLatitude - other.mLatitude) < cPrecisionValue;
  }
 
  bool operator!=(const Latitude &other) const
  {
    return !operator==(other);
  }
 
  bool operator>(const Latitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return (mLatitude > other.mLatitude) && operator!=(other);
  }
 
  bool operator<(const Latitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return (mLatitude < other.mLatitude) && operator!=(other);
  }
 
  bool operator>=(const Latitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return ((mLatitude > other.mLatitude) || operator==(other));
  }
 
  bool operator<=(const Latitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return ((mLatitude < other.mLatitude) || operator==(other));
  }
 
  Latitude operator+(const Latitude &other) const
  {
    ensureValid();
    other.ensureValid();
    Latitude const result(mLatitude + other.mLatitude);
    result.ensureValid();
    return result;
  }
 
  Latitude &operator+=(const Latitude &other)
  {
    ensureValid();
    other.ensureValid();
    mLatitude += other.mLatitude;
    ensureValid();
    return *this;
  }
 
  Latitude operator-(const Latitude &other) const
  {
    ensureValid();
    other.ensureValid();
    Latitude const result(mLatitude - other.mLatitude);
    result.ensureValid();
    return result;
  }
 
  Latitude operator-=(const Latitude &other)
  {
    ensureValid();
    other.ensureValid();
    mLatitude -= other.mLatitude;
    ensureValid();
    return *this;
  }
 
  Latitude operator*(const double &scalar) const
  {
    ensureValid();
    Latitude const result(mLatitude * scalar);
    result.ensureValid();
    return result;
  }
 
  Latitude operator/(const double &scalar) const
  {
    Latitude const scalarLatitude(scalar);
    Latitude const result(operator/(scalarLatitude));
    result.ensureValid();
    return result;
  }
 
  double operator/(const Latitude &other) const
  {
    ensureValid();
    other.ensureValidNonZero();
    double const result = mLatitude / other.mLatitude;
    return result;
  }
 
  Latitude operator-() const
  {
    ensureValid();
    Latitude const result(-mLatitude);
    result.ensureValid(); // LCOV_EXCL_BR_LINE Some types do not throw an exception
    return result;
  }
 
  _AD_MAP_POINT_LATITUDE_EXPLICIT_CONVERSION_ operator double() const
  {
    return mLatitude;
  }
 
  bool isValid() const
  {
    auto const valueClass = std::fpclassify(mLatitude);
    return ((valueClass == FP_NORMAL) || (valueClass == FP_ZERO)) && (cMinValue <= mLatitude)
      && (mLatitude <= cMaxValue);
  }
 
  void ensureValid() const
  {
    if (!isValid())
    {
      spdlog::info("ensureValid(::ad::map::point::Latitude)>> {} value out of range", *this); // LCOV_EXCL_BR_LINE
#if (AD_MAP_POINT_LATITUDE_THROWS_EXCEPTION == 1)
      throw std::out_of_range("Latitude value out of range"); // LCOV_EXCL_BR_LINE
#endif
    }
  }
 
  void ensureValidNonZero() const
  {
    ensureValid();
    if (operator==(Latitude(0.))) // LCOV_EXCL_BR_LINE
    {
      spdlog::info("ensureValid(::ad::map::point::Latitude)>> {} value is zero", *this); // LCOV_EXCL_BR_LINE
#if (AD_MAP_POINT_LATITUDE_THROWS_EXCEPTION == 1)
      throw std::out_of_range("Latitude value is zero"); // LCOV_EXCL_BR_LINE
#endif
    }
  }
 
  static Latitude getMin()
  {
    return Latitude(cMinValue);
  }
 
  static Latitude getMax()
  {
    return Latitude(cMaxValue);
  }
 
  static Latitude getPrecision()
  {
    return Latitude(cPrecisionValue);
  }
 
private:
  double mLatitude;
};
 
} // namespace point
} // namespace map
} // namespace ad
inline ::ad::map::point::Latitude operator*(const double &other, ::ad::map::point::Latitude const &value)
{
  return value.operator*(other);
}
 
namespace std {
 
inline ::ad::map::point::Latitude fabs(const ::ad::map::point::Latitude other)
{
  ::ad::map::point::Latitude const result(std::fabs(static_cast<double>(other)));
  return result;
}
 
template <> class numeric_limits<::ad::map::point::Latitude> : public numeric_limits<double>
{
public:
  static inline ::ad::map::point::Latitude lowest()
  {
    return ::ad::map::point::Latitude::getMin();
  }
  static inline ::ad::map::point::Latitude max()
  {
    return ::ad::map::point::Latitude::getMax();
  }
 
  static inline ::ad::map::point::Latitude epsilon()
  {
    return ::ad::map::point::Latitude::getPrecision();
  }
};
 
} // namespace std
 
#ifndef GEN_GUARD_AD_MAP_POINT_LATITUDE
#define GEN_GUARD_AD_MAP_POINT_LATITUDE
 
namespace ad {
namespace map {
namespace point {
 
inline std::ostream &operator<<(std::ostream &os, Latitude const &_value)
{
  return os << double(_value);
}
 
} // namespace point
} // namespace map
} // namespace ad
 
namespace std {
inline std::string to_string(::ad::map::point::Latitude const &value)
{
  return to_string(static_cast<double>(value));
}
} // namespace std
#endif // GEN_GUARD_AD_MAP_POINT_LATITUDE