fp_log.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef FP_LOG_H
#define FP_LOG_H
#ifdef __cplusplus
extern "C" {
#endif
 
/*!***************************************************************************
 * @addtogroup  argus_fp
 * @{
 *****************************************************************************/
 
#include "fp_def.h"
 
/*!***************************************************************************
 * @brief   Calculates the natural logarithm (base e) of an fixed point number.
 *
 * @details Calculates y = ln(x) = log_e(x) in fixed point representation.
 *
 *          Note that the result might not be 100 % accurate and might contain
 *          a small error!
 *
 *          @see https://www.quinapalus.com/efunc.html
 *
 * @param   x The input parameter in unsigned fixed point format Q15.16.
 * @return  Result y = ln(x) in the UQ16.16 format.
 *****************************************************************************/
q15_16_t fp_log16(uq16_16_t x);
 
#ifdef __cplusplus
} // extern "C"
#endif
#endif /* FP_DIV_H */