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