Altitude.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_ALTITUDE_THROWS_EXCEPTION 1
 
#if SAFE_DATATYPES_EXPLICIT_CONVERSION
 
#define _AD_MAP_POINT_ALTITUDE_EXPLICIT_CONVERSION_ explicit
#else
 
#define _AD_MAP_POINT_ALTITUDE_EXPLICIT_CONVERSION_
#endif
 
class Altitude
{
public:
  static const double cMinValue;
 
  static const double cMaxValue;
 
  static const double cPrecisionValue;
 
  Altitude()
    : mAltitude(std::numeric_limits<double>::quiet_NaN())
  {
  }
 
  _AD_MAP_POINT_ALTITUDE_EXPLICIT_CONVERSION_ Altitude(double const iAltitude)
    : mAltitude(iAltitude)
  {
  }
 
  Altitude(const Altitude &other) = default;
 
  Altitude(Altitude &&other) = default;
 
  Altitude &operator=(const Altitude &other) = default;
 
  Altitude &operator=(Altitude &&other) = default;
 
  bool operator==(const Altitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return std::fabs(mAltitude - other.mAltitude) < cPrecisionValue;
  }
 
  bool operator!=(const Altitude &other) const
  {
    return !operator==(other);
  }
 
  bool operator>(const Altitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return (mAltitude > other.mAltitude) && operator!=(other);
  }
 
  bool operator<(const Altitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return (mAltitude < other.mAltitude) && operator!=(other);
  }
 
  bool operator>=(const Altitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return ((mAltitude > other.mAltitude) || operator==(other));
  }
 
  bool operator<=(const Altitude &other) const
  {
    ensureValid();
    other.ensureValid();
    return ((mAltitude < other.mAltitude) || operator==(other));
  }
 
  Altitude operator+(const Altitude &other) const
  {
    ensureValid();
    other.ensureValid();
    Altitude const result(mAltitude + other.mAltitude);
    result.ensureValid();
    return result;
  }
 
  Altitude &operator+=(const Altitude &other)
  {
    ensureValid();
    other.ensureValid();
    mAltitude += other.mAltitude;
    ensureValid();
    return *this;
  }
 
  Altitude operator-(const Altitude &other) const
  {
    ensureValid();
    other.ensureValid();
    Altitude const result(mAltitude - other.mAltitude);
    result.ensureValid();
    return result;
  }
 
  Altitude operator-=(const Altitude &other)
  {
    ensureValid();
    other.ensureValid();
    mAltitude -= other.mAltitude;
    ensureValid();
    return *this;
  }
 
  Altitude operator*(const double &scalar) const
  {
    ensureValid();
    Altitude const result(mAltitude * scalar);
    result.ensureValid();
    return result;
  }
 
  Altitude operator/(const double &scalar) const
  {
    Altitude const scalarAltitude(scalar);
    Altitude const result(operator/(scalarAltitude));
    result.ensureValid();
    return result;
  }
 
  double operator/(const Altitude &other) const
  {
    ensureValid();
    other.ensureValidNonZero();
    double const result = mAltitude / other.mAltitude;
    return result;
  }
 
  Altitude operator-() const
  {
    ensureValid();
    Altitude const result(-mAltitude);
    result.ensureValid(); // LCOV_EXCL_BR_LINE Some types do not throw an exception
    return result;
  }
 
  _AD_MAP_POINT_ALTITUDE_EXPLICIT_CONVERSION_ operator double() const
  {
    return mAltitude;
  }
 
  bool isValid() const
  {
    auto const valueClass = std::fpclassify(mAltitude);
    return ((valueClass == FP_NORMAL) || (valueClass == FP_ZERO)) && (cMinValue <= mAltitude)
      && (mAltitude <= cMaxValue);
  }
 
  void ensureValid() const
  {
    if (!isValid())
    {
      spdlog::info("ensureValid(::ad::map::point::Altitude)>> {} value out of range", *this); // LCOV_EXCL_BR_LINE
#if (AD_MAP_POINT_ALTITUDE_THROWS_EXCEPTION == 1)
      throw std::out_of_range("Altitude value out of range"); // LCOV_EXCL_BR_LINE
#endif
    }
  }
 
  void ensureValidNonZero() const
  {
    ensureValid();
    if (operator==(Altitude(0.))) // LCOV_EXCL_BR_LINE
    {
      spdlog::info("ensureValid(::ad::map::point::Altitude)>> {} value is zero", *this); // LCOV_EXCL_BR_LINE
#if (AD_MAP_POINT_ALTITUDE_THROWS_EXCEPTION == 1)
      throw std::out_of_range("Altitude value is zero"); // LCOV_EXCL_BR_LINE
#endif
    }
  }
 
  static Altitude getMin()
  {
    return Altitude(cMinValue);
  }
 
  static Altitude getMax()
  {
    return Altitude(cMaxValue);
  }
 
  static Altitude getPrecision()
  {
    return Altitude(cPrecisionValue);
  }
 
private:
  double mAltitude;
};
 
} // namespace point
} // namespace map
} // namespace ad
inline ::ad::map::point::Altitude operator*(const double &other, ::ad::map::point::Altitude const &value)
{
  return value.operator*(other);
}
 
namespace std {
 
inline ::ad::map::point::Altitude fabs(const ::ad::map::point::Altitude other)
{
  ::ad::map::point::Altitude const result(std::fabs(static_cast<double>(other)));
  return result;
}
 
template <> class numeric_limits<::ad::map::point::Altitude> : public numeric_limits<double>
{
public:
  static inline ::ad::map::point::Altitude lowest()
  {
    return ::ad::map::point::Altitude::getMin();
  }
  static inline ::ad::map::point::Altitude max()
  {
    return ::ad::map::point::Altitude::getMax();
  }
 
  static inline ::ad::map::point::Altitude epsilon()
  {
    return ::ad::map::point::Altitude::getPrecision();
  }
};
 
} // namespace std
 
#ifndef GEN_GUARD_AD_MAP_POINT_ALTITUDE
#define GEN_GUARD_AD_MAP_POINT_ALTITUDE
 
namespace ad {
namespace map {
namespace point {
 
inline std::ostream &operator<<(std::ostream &os, Altitude const &_value)
{
  return os << double(_value);
}
 
} // namespace point
} // namespace map
} // namespace ad
 
namespace std {
inline std::string to_string(::ad::map::point::Altitude const &value)
{
  return to_string(static_cast<double>(value));
}
} // namespace std
#endif // GEN_GUARD_AD_MAP_POINT_ALTITUDE