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