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

履歴 編集

function template
<complex>

# std::imag (非メンバ関数)

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

      complex<Promoted>
        imag(Arithmetic x);                 // (2) C++11
      constexpr complex<Promoted>
        imag(Arithmetic x);                 // (2) C++26
    }

## 概要

複素数の虚部を取得する。

- (1) : `complex<T>`に対するオーバーロード
- (2) : 算術型に対する追加のオーバーロード

(2)は、以下のように振る舞う：

- 実引数の型が浮動小数点数型 `T` の場合、`complex<T>` にキャストされているかのように振る舞う
- そうでなくて、実引数が整数型の場合、`complex<double>` にキャストされているかのように振る舞う (C++23)

また、これらの追加のオーバーロードが関数テンプレートなのか否か、あるいは、引数が参照型なのか否かなどについては、規格では何も言及されていない。

## 戻り値

引数に指定した複素数 `x` の虚部（`x.imag()`）

## 備考

- 同名のメンバ関数 `imag` も存在する。
- C++14 から `constexpr` 関数になっている。

## 例

    #include <iostream>
    #include <complex>

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

      double result = std::imag(c);
      std::cout << c << ", imag part = " << result << std::endl;
    }

### 出力

    (1,2), imag part = 2

## バージョン

### 言語

- C++98（追加のオーバーロードは C++11 から）

### 処理系

- 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（追加のオーバーロード以外） ✅
- 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++: ??

### 備考

- libc++（Clang）は C++11 モード以降でなくても追加のオーバーロードを使用可能だが、constexpr になるのは C++14 モードだけである。
  一方、libstdc++（GCC）は C++11 モード以降でないと追加のオーバーロードは使用不可能だが、C++11 モードでも追加のオーバーロード以外は constexpr である。
  なお、libstdc++ では追加のオーバーロードが constexpr になっていないが、これはバグであるものと思われる。

## 関連項目

名前 | 説明
--- | ---
`real` | 実部を取得、あるいは、設定する。（メンバ関数）
`imag` | 虚部を取得、あるいは、設定する。（メンバ関数）
`real` | 実部を取得する。
`abs` | 複素数の絶対値を得る。
`arg` | 複素数の偏角を得る。
`norm` | 複素数体のノルムを得る。
`conj` | 共役複素数を得る。
`proj` | リーマン球面への射影を得る。
`polar` | 指定した絶対値と偏角の複素数値を得る。

## 参照

- N3302 Constexpr Library Additions: complex, v2
- P1467R9 Extended floating-point types and standard names
  - C++23で拡張浮動小数点数型への対応が行われ、整数型も考慮されるようになった
- P1383R2 More constexpr for `<cmath>` and `<complex>`
  - C++26で(2)が`constexpr`対応した