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