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