最終更新日時: 2025年05月22日 16時35分09秒 (JST)
Akira Takahashi が更新

履歴 編集

function
<cmath>

# std::log1p(C++11)

    namespace std {
      float log1p(float x);             // (1) C++11からC++20まで
      double log1p(double x);           // (2) C++11からC++20まで
      long double log1p(long double x); // (3) C++11からC++20まで

      floating-point-type
        log1p(floating-point-type x);   // (4) C++23
      constexpr floating-point-type
        log1p(floating-point-type x);   // (4) C++26

      double
        log1p(Integral x);              // (5) C++11
      constexpr double
        log1p(Integral x);              // (5) C++26

      float
        log1pf(float x);                // (6) C++17
      constexpr float
        log1pf(float x);                // (6) C++26

      long double
        log1pl(long double x);          // (7) C++17
      constexpr long double
        log1pl(long double x);          // (7) C++26
    }

## 概要

引数に 1 を足した値の、`e` (ネイピア数) を底とする自然対数を求める。

引数が 0 近傍において `log(1 + x)` より高精度な計算になる。

- (1) : `float`に対するオーバーロード
- (2) : `double`に対するオーバーロード
- (3) : `long double`に対するオーバーロード
- (4) : 浮動小数点数型に対するオーバーロード
- (5) : 整数型に対するオーバーロード (`double`にキャストして計算される)
- (6) : `float`型規定
- (7) : `long double`型規定

## 戻り値

引数 `x` に対して `1 + x` の `e` (ネイピア数) を底とする自然対数を返す。

`x < -1` の場合には、定義域エラーとなり、戻り値は処理系定義である。`x = -1` の場合には、処理系によっては極エラーとなり、戻り値は処理系定義である。（備考参照）

## 備考

- $$ f(x) = \log_e (1 + x) $$
- 定義域エラー、極エラーが発生した場合の挙動については、`<cmath>` を参照。
- 処理系が IEC 60559 に準拠している場合（`std::numeric_limits<T>::is_iec559() != false`）、以下の規定が追加される。
  - `x = ±0` の場合、戻り値は `±0` となる。
  - `x = -1` の場合、戻り値は `-∞` となり、`FE_DIVBYZERO`（ゼロ除算浮動小数点例外）が発生する。
  - `x < -1` の場合、戻り値は quiet NaN となり、`FE_INVALID`（無効演算浮動小数点例外）が発生する。
  - `x = +∞` の場合、戻り値は `+∞` となる。
- C++23では、(1), (2), (3)が(4)に統合され、拡張浮動小数点数型を含む浮動小数点数型へのオーバーロードとして定義された

## 例

    #include <cmath>
    #include <limits>
    #include <iostream>

    int main() {
      static const double e = 2.718281828459045;
      std::cout << std::fixed;
      std::cout << "log1p(0.0)  = " << std::log1p(0.0) << std::endl;
      std::cout << "log1p(0.01) = " << std::log1p(0.01) << std::endl;
      std::cout << "log1p(-1.0) = " << std::log1p(-1.0) << std::endl;
      std::cout << "log1p(e-1)  = " << std::log1p(e-1) << std::endl;
      std::cout << "log1p(+∞)  = " << std::log1p(std::numeric_limits<double>::infinity()) << std::endl;
      std::cout << "log1p(-2.0) = " << std::log1p(-2.0) << std::endl;
    }

### 出力例

    log1p(0.0)  = 0.000000
    log1p(0.01) = 0.009950
    log1p(-1.0) = -inf
    log1p(e-1)  = 1.000000
    log1p(+∞)  = inf
    log1p(-2.0) = -nan

## バージョン

### 言語

- C++11

### 処理系

- Clang: 2.9 ✅, 3.1 ✅
- GCC: 4.3.4 ✅, 4.4.5 ✅, 4.5.2 ✅, 4.6.1 ✅, 4.7.0 ✅

#### 備考

特定の環境では、早期に `constexpr` 対応されている場合がある：

- GCC 4.6.1 以上

## 参照

- P1467R9 Extended floating-point types and standard names
  - C++23で導入された拡張浮動小数点数型への対応として、`float`、`double`、`long double`のオーバーロードを`floating-point-type`のオーバーロードに統合し、拡張浮動小数点数型も扱えるようにした
- P1383R2 More constexpr for `<cmath>` and `<complex>`
  - C++26で`constexpr`対応した