nuttx/libs/libc/math/lib_log.c
SPRESENSE 2e80d5e38e libs/libc/math: Fix calculation error of log function
Fix a problem where the log function would loop infinitely by
calculation error when a specific value was passed. For example,
in the following case, the log function loops infinitely and
never returns. So, this commit fixes to return the right value.

  double a = 7883961.5;
  double b = log(a);
2021-07-10 12:28:34 -07:00

118 lines
3.2 KiB
C

/****************************************************************************
* libs/libc/math/lib_log.c
*
* This file is a part of NuttX:
*
* Copyright (C) 2012, 2018 Gregory Nutt. All rights reserved.
* Ported by: Darcy Gong
*
* It derives from the Rhombus OS math library by Nick Johnson which has
* a compatibile, MIT-style license:
*
* Copyright (C) 2009, 2010 Nick Johnson <nickbjohnson4224 at gmail.com>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <nuttx/compiler.h>
#include <math.h>
#include <float.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* To avoid looping forever in particular corner cases, every LOGF_MAX_ITER
* the error criteria is relaxed by a factor LOGF_RELAX_MULTIPLIER.
* todo: might need to adjust the double floating point version too.
*/
#define LOGF_MAX_ITER 10
#define LOGF_RELAX_MULTIPLIER 2
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: log
****************************************************************************/
#ifdef CONFIG_HAVE_DOUBLE
double log(double x)
{
double y;
double y_old;
double ey;
double epsilon;
int relax_factor;
int iter;
y = 0.0;
y_old = 1.0;
epsilon = DBL_EPSILON;
iter = 0;
relax_factor = 1;
while (y > y_old + epsilon || y < y_old - epsilon)
{
y_old = y;
ey = exp(y);
y -= (ey - x) / ey;
if (y > 700.0)
{
y = 700.0;
}
if (y < -700.0)
{
y = -700.0;
}
epsilon = (fabs(y) > 1.0) ? fabs(y) * DBL_EPSILON : DBL_EPSILON;
if (++iter >= LOGF_MAX_ITER)
{
relax_factor *= LOGF_RELAX_MULTIPLIER;
iter = 0;
}
if (relax_factor > 1)
{
epsilon *= relax_factor;
}
}
if (y == 700.0)
{
return INFINITY;
}
if (y == -700.0)
{
return INFINITY;
}
return y;
}
#endif