log1p

(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)

log1p Возвращает результат log(1 + number), вычисленный так, чтобы он был точным, даже если значение числа близко к нулю.

Описание

log1p(float $num): float

Функция log1p() возвращает результат log(1 + num), вычисленный так, чтобы он был точным, даже если значение числа num близко к нулю. Из-за недостатка точности функция log() иногда возвращает результат log(1).

Список параметров

num

Аргумент для вычисления.

Возвращаемые значения

Возвращает результат вычисления выражения log(1 + num).

Смотрите также

  • expm1() - Возвращает результат exp($num) - 1, вычисленный так, чтобы он был точным, даже если значение числа близко к нулю.
  • log() - Вычисляет натуральный логарифм
  • log10() - Вычисляет десятичный логарифм

add a note add a note

User Contributed Notes 1 note

up
2
Anonymous
22 years ago
Note that the benefit of this function for small argument values is lost if PHP is compiled against a C library that that not have builtin support for the log1p() function.

In this case, log1p() will be compiled by using log() instead, and the precision of the result will be identical to log(1), i.e. it will always be 0 for small numbers.
Sample log1p(1.0e-20):
- returns 0.0 if log1p() is approximated by using log()
- returns something very near from 1.0e-20, if log1p() is supported by the underlying C library.

One way to support log1p() correctly on any platform, so that the magnitude of the expected result is respected:

function log1p($x) {
return ($x>-1.0e-8 && $x<1.0e-8) ? ($x - $x*$x/2) : log(1+$x);
}

If you want better precision, you may use a better limited development, for small positive or negative values of x:

log(1+x) = x - x^2/2 + x^3/3 - ... + (-1)^(n-1)*x^n/n + ...

(This serial sum converges only for values of x in [0 ... 1] inclusive, and the ^ operator in the above formula means the exponentiation operator, not the PHP xor operation)

Note that log1p() is undefined for arguments lower than or equal to -1, and that the implied base of the log function is the Neperian "e" constant.
To Top