Browse Source

Document genetics namespace and revise math namespace

master
C. J. Howard 3 years ago
parent
commit
f4f180d5f1
6 changed files with 4 additions and 21 deletions
  1. +3
    -0
      src/game/genetics/genetics.hpp
  2. +0
    -5
      src/math/angles.hpp
  3. +0
    -5
      src/math/constants.hpp
  4. +0
    -5
      src/math/interpolation.hpp
  5. +1
    -1
      src/math/math.hpp
  6. +0
    -5
      src/math/random.hpp

+ 3
- 0
src/game/genetics/genetics.hpp View File

@ -20,6 +20,9 @@
#ifndef ANTKEEPER_GENETICS_HPP #ifndef ANTKEEPER_GENETICS_HPP
#define ANTKEEPER_GENETICS_HPP #define ANTKEEPER_GENETICS_HPP
/// Genetic algorithms and data types.
namespace genetic {}
#include "amino-acid.hpp" #include "amino-acid.hpp"
#include "base.hpp" #include "base.hpp"
#include "codon.hpp" #include "codon.hpp"

+ 0
- 5
src/math/angles.hpp View File

@ -25,9 +25,6 @@
namespace math { namespace math {
/// @addtogroup utility
/// @{
/** /**
* Converts an angle given in radians to degrees. * Converts an angle given in radians to degrees.
* *
@ -88,8 +85,6 @@ inline T wrap_radians(T radians)
return std::remainder(radians, two_pi<T>); return std::remainder(radians, two_pi<T>);
} }
/// @}
} // namespace math } // namespace math
#endif // ANTKEEPER_MATH_ANGLES_HPP #endif // ANTKEEPER_MATH_ANGLES_HPP

+ 0
- 5
src/math/constants.hpp View File

@ -26,9 +26,6 @@
namespace math { namespace math {
/// @addtogroup utility
/// @{
/** /**
* Pi. * Pi.
*/ */
@ -97,8 +94,6 @@ constexpr transform identity_transform =
{T(1), T(1), T(1)} {T(1), T(1), T(1)}
}; };
/// @}
} // namespace math } // namespace math
#endif // ANTKEEPER_MATH_CONSTANTS_HPP #endif // ANTKEEPER_MATH_CONSTANTS_HPP

+ 0
- 5
src/math/interpolation.hpp View File

@ -29,9 +29,6 @@
namespace math { namespace math {
/// @addtogroup utility
/// @{
/** /**
* Linearly interpolates between @p x and @p y. * Linearly interpolates between @p x and @p y.
* *
@ -90,8 +87,6 @@ inline T log_lerp(const T& x, const T& y, S a)
return x * std::pow(y / x, a); return x * std::pow(y / x, a);
} }
/// @}
} // namespace math } // namespace math
#endif // ANTKEEPER_MATH_INTERPOLATION_HPP #endif // ANTKEEPER_MATH_INTERPOLATION_HPP

+ 1
- 1
src/math/math.hpp View File

@ -20,7 +20,7 @@
#ifndef ANTKEEPER_MATH_HPP #ifndef ANTKEEPER_MATH_HPP
#define ANTKEEPER_MATH_HPP #define ANTKEEPER_MATH_HPP
/// Contains mathematical functions and data types.
/// Mathematical functions and data types.
namespace math {} namespace math {}
/** /**

+ 0
- 5
src/math/random.hpp View File

@ -25,9 +25,6 @@
namespace math { namespace math {
/// @addtogroup utility
/// @{
/** /**
* Generates a pseudo-random floating point number on `[start, end)` using std::rand(). * Generates a pseudo-random floating point number on `[start, end)` using std::rand().
* *
@ -48,8 +45,6 @@ inline T random(T start, T end)
return static_cast<T>(std::rand()) * rand_max_inverse * (end - start) + start; return static_cast<T>(std::rand()) * rand_max_inverse * (end - start) + start;
} }
/// @}
} // namespace math } // namespace math
#endif // ANTKEEPER_MATH_RANDOM_HPP #endif // ANTKEEPER_MATH_RANDOM_HPP

Loading…
Cancel
Save