namespace std::linalg {
template<in-matrix InMat1,
in-matrix InMat2,
possibly-packed-out-matrix OutMat,
class Triangle>
void hermitian_matrix_rank_2k_update(
InMat1 A,
InMat2 B,
OutMat C,
Triangle t); // (1)
template<class ExecutionPolicy,
in-matrix InMat1,
in-matrix InMat2,
possibly-packed-out-matrix OutMat,
class Triangle>
void hermitian_matrix_rank_2k_update(
ExecutionPolicy&& exec,
InMat1 A,
InMat2 B,
OutMat C,
Triangle t); // (2)
template<in-matrix InMat1,
in-matrix InMat2,
in-matrix InMat3,
possibly-packed-out-matrix OutMat,
class Triangle>
void hermitian_matrix_rank_2k_update(
InMat1 A,
InMat2 B,
InMat3 E,
OutMat C,
Triangle t); // (3)
template<class ExecutionPolicy,
in-matrix InMat1,
in-matrix InMat2,
in-matrix InMat3,
possibly-packed-out-matrix OutMat,
class Triangle>
void hermitian_matrix_rank_2k_update(
ExecutionPolicy&& exec,
InMat1 A,
InMat2 B,
InMat3 E,
OutMat C,
Triangle t); // (4)
}
概要
エルミートな(対称かつ共役を取る)rank-2k updateを対称行列に行う。
- (1), (2)は上書き(overwriting)版であり、出力行列
Cを計算結果で上書きする。 - (3), (4)は更新(updating)版であり、入力行列
Eに更新項を加えた結果を出力行列Cに書き込む。
引数tは対称行列の成分が上三角にあるのか、それとも下三角にあるのかを示す。
- (1): $C = AB^* + BA^*$
- (2): (1)を指定された実行ポリシーで実行する。
- (3): $C = E + AB^* + BA^*$
- (4): (3)を指定された実行ポリシーで実行する。
適格要件
- 共通:
Triangleはupper_triangle_tまたはlower_triangle_tOutMatがlayout_blas_packedを持つなら、レイアウトのTriangleテンプレート引数とこの関数のTriangleテンプレート引数が同じ型possibly-multipliable<decltype(A), decltype(transposed(B)), decltype(C)>()がtruepossibly-multipliable<decltype(B), decltype(transposed(A)), decltype(C)>()がtrue
- (3), (4): 上記に加えて、
InMat3がlayout_blas_packedを持つなら、レイアウトのTriangleテンプレート引数とこの関数のTriangleテンプレート引数が同じ型possibly-addable<decltype(C), decltype(E), decltype(C)>()がtrue
- (2), (4):
is_execution_policy<ExecutionPolicy>::valueがtrue
事前条件
multipliable(A,transposed(B), C) == truemultipliable(B,transposed(A), C) == true(上記と合わせてCが正方行列であることを含意する)- (3), (4):
addable(C, E, C) == true
効果
- (1), (2): $C = AB^* + BA^*$
- (3), (4): $C = E + AB^* + BA^*$
戻り値
なし
計算量
$O(\verb|A.extent(0)| \times \verb|A.extent(1)| \times \verb|B.extent(0)|)$
備考
- (1), (2)は出力行列
Cを上書きする。従来の加算更新 ($C \leftarrow C + AB^ + BA^$) を行いたい場合は、updating版 (3), (4)に元の行列をEとして渡す。 - エルミート行列
Cの対角成分については、real-if-neededにより実部のみが使用される。対角成分が非ゼロの虚部を持っていても、その虚部は無視される。
例
[注意] 処理系にあるコンパイラで確認していないため、間違っているかもしれません。
#include <array>
#include <iostream>
#include <linalg>
#include <mdspan>
#include <vector>
#include <complex>
template <class Matrix>
void print_mat(const Matrix& A) {
for(int i = 0; i < A.extent(0); ++i) {
for(int j = 0; j < i; ++j) {
std::cout << A[j, i] << ' ';
}
for(int j = i; j < A.extent(1) - 1; ++j) {
std::cout << A[i, j] << ' ';
}
std::cout << A[i, A.extent(1) - 1] << '\n';
}
}
template <class Matrix>
void init_mat(Matrix& A, double geta = 0.0) {
for(int i = 0; i < A.extent(0); ++i) {
for(int j = 0; j < A.extent(1); ++j) {
A[i,j] = std::complex<double>(i + geta, j + geta);
}
}
}
template <class Matrix>
void init_herm_mat(Matrix& A) {
for(int i = 0; i < A.extent(0); ++i) {
A[i, i] = std::complex<double>(i, 0);
for(int j = i + 1; j < A.extent(1); ++j) {
A[i, j] = std::complex<double>(i, j);
}
}
}
int main()
{
constexpr std::size_t N = 2;
using Scalar = std::complex<double>;
using Vector = std::vector<Scalar>;
using Matrix = std::mdspan<Scalar, std::extents<std::size_t, N, N>>;
using HermitianMatrix = std::mdspan<
Scalar,
std::extents<std::size_t, N, N>,
std::linalg::layout_blas_packed<
std::linalg::upper_triangle_t,
std::linalg::row_major_t>
>;
Vector A_vec(N * N);
Vector B_vec(N * N);
Vector E_vec(N * N);
Vector C_vec(N * N);
Matrix A(A_vec.data());
Matrix B(B_vec.data());
HermitianMatrix E(E_vec.data());
HermitianMatrix C(C_vec.data());
init_mat(A);
init_mat(B, 1);
init_herm_mat(E);
// (1) overwriting: C = A B^* + B A^*
std::cout << "(1)\n";
std::linalg::hermitian_matrix_rank_2k_update(
A,
B,
C,
std::linalg::upper_triangle);
print_mat(C);
// (3) updating: C = E + A B^* + B A^*
std::cout << "(3)\n";
std::linalg::hermitian_matrix_rank_2k_update(
A,
B,
E,
C,
std::linalg::upper_triangle);
print_mat(C);
return 0;
}
出力
(1)
(4,0) (6,4)
(6,4) (12,0)
(3)
(4,0) (6,5)
(6,5) (13,0)
バージョン
言語
- C++26
処理系
- Clang: ??
- GCC: ??
- ICC: ??
- Visual C++: ??
関連項目
参照
- P1673R13 A free function linear algebra interface based on the BLAS
- LAPACK: {he,sy}r2k: Hermitian/symmetric rank-2k update
- P3371R5 Fix C++26 BLAS rank updates consistency
- C++26で、上書き(overwriting)版と更新(updating)版のオーバーロードに再構成され、BLASと整合するようになった
- LWG Issue 4136. Specify behavior of [linalg] Hermitian algorithms on diagonal with nonzero imaginary part
- C++26で、エルミート行列の対角成分が非ゼロの虚部を持つ場合に実部のみ(
real-if-needed)が使用されることが明文化された。それまで対角成分の虚部の扱いが未規定だった問題を解消するもの
- C++26で、エルミート行列の対角成分が非ゼロの虚部を持つ場合に実部のみ(
- LWG Issue 4137. Fix
Mandates,Preconditions, andComplexityelements of [linalg] algorithms