Code/Engine/Foundation/Math/Constants.h - dev - redgpu/ezEngine

Code/Engine/Foundation/Math/Constants.h
70 строк2 KB
Jan Krassnigg
MSFT: Various improvements (#450)
10 авг 2021, 11:29
10 авг 2021, 11:29372a365
#pragma once

#include <Foundation/Math/Declarations.h>

namespace ezMath
{
  /// \brief Returns the natural constant Pi.
  template <typename TYPE>
  constexpr TYPE Pi();

  /// \brief Returns the natural constant e.
  template <typename TYPE>
  constexpr TYPE e();

  /// \brief Returns whether the template type supports specialized values to represent NaN.
  template <typename TYPE>
  constexpr bool SupportsNaN();

  /// \brief Returns the value for NaN as the template type. Returns zero, if the type does not support NaN.
  ///
  /// Do not use this for comparisons, it will fail. Use it to initialize data (e.g. in debug builds), to detect uninitialized variables.
  /// Use the function IsNaN() to check whether a value is not a number.
  template <typename TYPE>
  constexpr TYPE NaN();

  /// \brief Returns whether the template type supports specialized values to represent Infinity.
  template <typename TYPE>
  constexpr bool SupportsInfinity();

  /// \brief Returns the value for Infinity as the template type. Returns zero, if the type does not support Infinity.
  template <typename TYPE>
  constexpr TYPE Infinity();

  /// \brief Returns the largest possible positive value (that is not infinity).
  template <typename TYPE>
  constexpr TYPE MaxValue();

  /// \brief Returns the smallest possible value (that is not -infinity). Usually zero or -MaxValue(). For signed integers this will be -MaxValue() - 1
  template <typename TYPE>
  constexpr TYPE MinValue();

  /// \brief A very large value, that is slightly smaller than sqrt(MaxValue()).
  ///
  /// Useful to default initialize values, that may get squared in subsequent operations.
  template <typename TYPE>
  constexpr TYPE HighValue();

  /// \brief The difference between 1.0 and the next representable value for the given type.
  template <typename TYPE>
  constexpr TYPE FloatEpsilon();

  template <typename TYPE>
  constexpr TYPE SmallEpsilon();

  template <typename TYPE>
  constexpr TYPE DefaultEpsilon();

  template <typename TYPE>
  constexpr TYPE LargeEpsilon();

  template <typename TYPE>
  constexpr TYPE HugeEpsilon();

  /// \brief Returns the number of bits in the given type. Mostly useful for unsigned integer types.
  template <typename TYPE>
  constexpr ezUInt32 NumBits();
} // namespace ezMath


#include <Foundation/Math/Implementation/Constants_inl.h>