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