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