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