最終更新日時(UTC): 2024年07月24日 02時56分08秒
Yuya Asano が更新

履歴 編集

function template
<linalg>

# std::linalg::setup_givens_rotation(C++26)

    namespace std::linalg {
      template<class Real>
      setup_givens_rotation_result<Real>
        setup_givens_rotation(Real a, Real b) noexcept; // (1)

      template<class Real>
      setup_givens_rotation_result<complex<Real>>
        setup_givens_rotation(complex<Real> a, complex<Real> b) noexcept; // (2)
    }

## 概要

ギブンス回転を計算する。すなわち、以下の式が成り立つような、`Real`型の値`c`と `s`, `r`を計算する。

$$ \begin{split} \begin{pmatrix} c & s \\ -\overline{s} & c \end{pmatrix} \begin{pmatrix} a \\ b \end{pmatrix} &= \begin{pmatrix} r \\ 0 \end{pmatrix},\\ c^2 + |s|^2 &= 1 \end{split} $$

ただし、`s`と`r`の型は`a`と`b`の型による。

- (1) `a`と`b`の型が`Real`の場合、`s`と`r`の型も`Real`。`r`は$(a, b)^T$のユークリッドノルム、つまり$\sqrt{|a|^2 + |b|^2}$である。
- (2) `a`と`b`の型が`complex<Real>`の場合、`s`と`r`の型も`complex<Real>`。以下で定義される$sgn$関数を用いると、`r`は$sgn(a) * \sqrt{|a|^2 + |b|^2}$である。 $$ sgn(x):= \begin{cases} \frac{x}{|x|} & \text{($x \neq 0$)} \\ 1 & \text{($x = 0$)} \end{cases} $$

## 適格要件

- `Real`は`complex<Real>`が規定できる型であること。

## 戻り値

`c`と`s`が入力$(a, b)^T$に対するギブンス回転行列の成分で、`r`を入力$(a, b)^T$のユークリッドノルムとすると、戻り値は`{c, s, r}`である。

## 例

[注意] 処理系にあるコンパイラで確認していないため、間違っているかもしれません。

    #include <cmath>
    #include <complex>
    #include <iostream>
    #include <linalg>

    template <class T>
    void print(const std::linalg::setup_givens_rotation_result<T>& result) {
      std::cout << "c: " << result.c << '\n'
                << "s: " << result.s << '\n'
                << "r: " << result.r << '\n';
    }

    int main()
    {
      // (1)
      std::cout << "(1)\n";
      auto result1 = std::linalg::setup_givens_rotation(1.0, std::sqrt(3.0));
      print(result1);

      // (2)
      std::cout << "(2)\n";
      auto result2 = std::linalg::setup_givens_rotation(std::complex<double>(1.0, 0), std::complex<double>(0, std::sqrt(3.0)));
      print(result2);

      return 0;
    }

### 出力

    (1)
    c: 0.5
    s: -0.866025
    r: 2.0
    (2)
    c: 0.5
    s: (0,-0.866025)
    r: (2,0)

## バージョン

### 言語

- C++26

### 処理系

- Clang: ??
- GCC: ??
- ICC: ??
- Visual C++: ??

## 関連項目

- `setup_givens_rotation_result`

## 参照

- P1673R13 A free function linear algebra interface based on the BLAS
- Working Draft Programming Languages — C++: 28 Numerics libarary
- LAPACK: clartg