Revision 334
added more docs
| fast_math.h | ||
|---|---|---|
| 1 | 1 |
#ifndef FAST_MATH_H_INCLUDED |
| 2 | 2 |
#define FAST_MATH_H_INCLUDED |
| 3 | 3 |
|
| 4 |
/** |
|
| 5 |
* @defgroup fast_math fast_math |
|
| 6 |
* @ingroup utils |
|
| 7 |
* @brief Fast math module. |
|
| 8 |
* |
|
| 9 |
* Essentially, this module provides almost-constant time for mathematical operations |
|
| 10 |
* that do not require extreme precision. |
|
| 11 |
* |
|
| 12 |
* @{
|
|
| 13 |
*/ |
|
| 14 |
|
|
| 15 |
/** |
|
| 16 |
* @brief Fast sine function. |
|
| 17 |
* @param x Argument |
|
| 18 |
* @return Sine of x |
|
| 19 |
*/ |
|
| 4 | 20 |
double fm_sin(double x); |
| 21 |
/** |
|
| 22 |
* @brief Fast cosine function. |
|
| 23 |
* @param x Argument |
|
| 24 |
* @return Cosine of x |
|
| 25 |
*/ |
|
| 5 | 26 |
double fm_cos(double x); |
| 6 | 27 |
|
| 28 |
/** |
|
| 29 |
* @} |
|
| 30 |
*/ |
|
| 31 |
|
|
| 7 | 32 |
#endif //FAST_MATH_H_INCLUDED |
Also available in: Unified diff