International PHP Conference Berlin 2025

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(number) - 1 を返す
  • log() - 自然対数
  • log10() - 底が 10 の対数

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