最終更新日時(UTC): 2024年06月11日 13時45分38秒
Akira Takahashi が更新

履歴 編集

function template
<complex>

# std::sinh

    namespace std {
      template <class T>
      complex<T>
        sinh(const complex<T>& x); // (1) C++03
      template <class T>
      constexpr complex<T>
        sinh(const complex<T>& x); // (1) C++26
    }

## 概要

複素数値の双曲線正弦（ハイパボリックサイン：hyperbolic sine）を得る。

## 戻り値

引数 `x` の双曲線正弦。

## 備考

- 規格には、上記の戻り値に記載されている以上の規定・説明は無い。
  なお、C99 の規格にある本関数と等価の関数群（`complex.h` ヘッダの `csinh`、`csinhf`、`csinhl` の 3 つ。それぞれ C++ の `sinh<double>`、`sinh<float>`、`sinh<long double>` に相当）では、処理系が ISO IEC 60559（IEEE 754 と同一）に準拠している場合、以下のように規定されている。
  - `sinh(conj(x)) = conj(sinh(x))` で、また、`sinh` は奇関数（つまり、`sinh(-x) = -sinh(x)`）。
  - `sinh(complex(+0, +0))` は `complex(+0, +0)` を返す。
  - `sinh(complex(+0, +∞))` は `complex(±0, NaN)` を返し（結果の実部の符号は未規定）、無効演算の浮動小数点例外（`FE_INVALID`）を引き起こす。
  - `sinh(complex(+0, NaN))` は `complex(±0, NaN)` を返す（結果の実部の符号は未規定）。
  - 有限で正の `x` に対して、`sinh(complex(x, +∞))` は `complex(NaN, NaN)` を返し、無効演算の浮動小数点例外（`FE_INVALID`）を引き起こす。
  - 有限で非ゼロの `x` に対して、`sinh(complex(x, NaN))` は `complex(NaN, NaN)` を返し、無効演算の浮動小数点例外（`FE_INVALID`）を引き起こす可能性がある。
  - `sinh(complex(+∞, +0))` は `complex(+∞, +0)` を返す。
  - 有限で正の `y` に対して、`sinh(complex(+∞, y))` は `+∞ * complex(cos(y), sin(y))` を返す。
  - `sinh(complex(+∞, +∞))` は `complex(±∞, NaN)` を返し（結果の実部の符号は未規定）、無効演算の浮動小数点例外（`FE_INVALID`）を引き起こす。
  - `sinh(complex(+∞, NaN))` は `complex(±∞, NaN)` を返す（結果の実部の符号は未規定）。
  - `sinh(complex(NaN, +0))` は `complex(NaN, +0)` を返す。
  - あらゆる非ゼロの `y` に対して、`sinh(complex(NaN, y))` は `complex(NaN, NaN)` を返し、無効演算の浮動小数点例外（`FE_INVALID`）を引き起こす可能性がある。
  - `sinh(complex(NaN, NaN))` は `complex(NaN, NaN)` を返す。
- 処理系が ISO IEC 60559 に準拠しているかどうかは、C99 の場合はマクロ `__STDC_IEC_559_COMPLEX__` が `1` に定義されている事で判別可能であるが、C++ の規格書には該当する記載を見つける事ができなかった。

- 双曲線正弦の算出については、一部の算術型、および、`valarray` クラステンプレートに対しても、他のヘッダで定義されている。

  引数の型 | 関数 | ヘッダ | 備考
  --- | --- | --- | ---
  `float` | `sinh` | `cmath` |
  `double` | `sinh` | `cmath` |
  `long double` | `sinh` | `cmath` |
  任意の整数型 | `sinh` | `cmath` | C++11 から
  `valarray<T>` | `sinh` | `valarray` |

## 例

    #include <iostream>
    #include <complex>

    int main()
    {
      std::complex<double> c(1.0, 2.0);

      std::complex<double> result = std::sinh(c);
      std::cout << "sinh( " << c << " ) = " << result << std::endl;
    }

### 出力

    sinh( (1,2) ) = (-0.489056,1.40312)

## バージョン

### 言語

- C++98

### 処理系

- Clang: 3.0 ✅, 3.1 ✅, 3.2 ✅, 3.3 ✅, 3.4 ✅
- GCC: 4.3.6 ✅, 4.4.7 ✅, 4.5.4 ✅, 4.6.4 ✅, 4.7.3 ✅, 4.8.1 ✅, 4.8.2 ✅, 4.9.0 ✅
- ICC: ??
- Visual C++: ??

### 備考

- libstdc++ では、通常 glibc の対応する関数を呼び出すため、上記の備考に記載した C99 の ISO IEC 60559 準拠要件を満たす。
  しかし、glibc を使用していない libstdc++、および、libc++ は、当該要件を満たしていない（満たすつもりが無い？）ようである。

## 関連項目

名前 | 説明
--- | ---
`acos` | 複素数の逆余弦を求める。
`asin` | 複素数の逆正弦を求める。
`atan` | 複素数の逆正接を求める。
`acosh` | 複素数の逆双曲線余弦を求める。
`asinh` | 複素数の逆双曲線正弦を求める。
`atanh` | 複素数の逆双曲線正接を求める。
`cos` | 複素数の余弦を求める。
`cosh` | 複素数の双曲線余弦を求める。
`exp` | 自然対数の底 e の累乗（複素数）を求める。
`log` | 複素数の自然対数を求める。
`log10` | 複素数の常用対数を求める。
`pow` | 複素数の累乗を求める。
`sin` | 複素数の正弦を求める。
`sqrt` | 複素数の平方根を求める。
`tan` | 複素数の正接を求める。
`tanh` | 複素数の双曲線正接を求める。
`sinh` | 実数の双曲線正弦を求める。

## 参照

- P1383R2 More constexpr for `<cmath>` and `<complex>`
  - C++26で`constexpr`対応した