Browse Source

matrix helper: add documentation for sign function

v1.13.0-BW
Matthias Grob 3 years ago
parent
commit
4a5a8d59fe
  1. 6
      src/lib/matrix/matrix/helper_functions.hpp

6
src/lib/matrix/matrix/helper_functions.hpp

@ -152,6 +152,12 @@ Type unwrap_pi(const Type last_angle, const Type new_angle)
return unwrap(last_angle, new_angle, Type(-M_PI), Type(M_PI)); return unwrap(last_angle, new_angle, Type(-M_PI), Type(M_PI));
} }
/**
* Type-safe sign/signum function
*
* @param[in] val Number to take the sign from
* @return -1 if val < 0, 0 if val == 0, 1 if val > 0
*/
template<typename T> template<typename T>
int sign(T val) int sign(T val)
{ {

Loading…
Cancel
Save