namespace std::linalg {
template<scalar Scalar,
in-matrix InMat,
possibly-packed-out-matrix OutMat,
class Triangle>
void hermitian_matrix_rank_k_update(
Scalar alpha,
InMat A,
OutMat C,
Triangle t); // (1)
template<class ExecutionPolicy,
scalar Scalar,
in-matrix InMat,
possibly-packed-out-matrix OutMat,
class Triangle>
void hermitian_matrix_rank_k_update(
ExecutionPolicy&& exec,
Scalar alpha,
InMat A,
OutMat C,
Triangle t); // (2)
template<scalar Scalar,
in-matrix InMat1,
in-matrix InMat2,
possibly-packed-out-matrix OutMat,
class Triangle>
void hermitian_matrix_rank_k_update(
Scalar alpha,
InMat1 A,
InMat2 E,
OutMat C,
Triangle t); // (3)
template<class ExecutionPolicy,
scalar Scalar,
in-matrix InMat1,
in-matrix InMat2,
possibly-packed-out-matrix OutMat,
class Triangle>
void hermitian_matrix_rank_k_update(
ExecutionPolicy&& exec,
Scalar alpha,
InMat1 A,
InMat2 E,
OutMat C,
Triangle t); // (4)
}
概要
エルミートな(対称かつ共役を取る)rank-k updateをエルミート行列に行う。
引数tはエルミート行列の成分が上三角にあるのか、それとも下三角にあるのかを示す。
(1), (2)は結果をCに上書きするoverwriting版、(3), (4)は入力行列Eに更新項を加えてCに書き込むupdating版である。
- (1): $C = \alpha AA^*$
- (2): (1)を指定された実行ポリシーで実行する。
- (3): $C = E + \alpha AA^*$
- (4): (3)を指定された実行ポリシーで実行する。
適格要件
- 共通:
Triangleはupper_triangle_tまたはlower_triangle_tOutMatがlayout_blas_packedを持つなら、レイアウトのTriangleテンプレート引数とこの関数のTriangleテンプレート引数が同じ型possibly-multipliable<decltype(A), decltype(transposed(A)), decltype(C)>()がtrue
- (2), (4):
is_execution_policy<ExecutionPolicy>::valueがtrue - (3), (4): 追加で、
InMat2がlayout_blas_packedを持つなら、レイアウトのTriangleテンプレート引数とこの関数のTriangleテンプレート引数が同じ型possibly-addable<decltype(C), decltype(E), decltype(C)>()がtrue
事前条件
multipliable(A,transposed(A), C) == true(これはCが正方行列であることを含意する)- (3), (4):
addable(C, E, C) == true
効果
- (1), (2): $C = \alpha AA^*$
- (3), (4): $C = E + \alpha AA^*$
戻り値
なし
計算量
$O(\verb|A.extent(0)| \times \verb|A.extent(1)| \times \verb|A.extent(0)|)$
備考
- overwriting版(1), (2)は
Cに結果を上書きする。加算更新$C = C + \alpha AA^*$を行いたい場合は、updating版(3), (4)に更新前の行列をEとして渡す。 - エルミート性を維持するため、
alphaは実部のみが使用される。 - エルミート行列
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) {
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, j);
}
}
}
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 size_t N = 2;
using Scalar = std::complex<double>;
using Vector = std::vector<Scalar>;
using HermitianMatrix = std::mdspan<
Scalar,
std::extents<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 E_vec(N * N);
Vector C_vec(N * N);
std::mdspan A(A_vec.data());
HermitianMatrix E(E_vec.data());
HermitianMatrix C(C_vec.data());
init_mat(A);
init_herm_mat(E);
// (1) overwriting: C = alpha AA^*
std::cout << "overwriting (1)\n";
std::linalg::hermitian_matrix_rank_k_update(
-1.0,
A,
C,
std::linalg::upper_triangle);
print_mat(C);
// (3) updating: C = E + alpha AA^*
std::cout << "updating (3)\n";
std::linalg::hermitian_matrix_rank_k_update(
-1.0,
A,
E,
C,
std::linalg::upper_triangle);
print_mat(C);
return 0;
}
出力
overwriting (1)
(-1,0) (-1,-1)
(-1,-1) (-3,0)
updating (3)
(-1,0) (-1,0)
(-1,0) (-2,0)
バージョン
言語
- C++26
処理系
- Clang: ??
- GCC: ??
- ICC: ??
- Visual C++: ??
関連項目
参照
- P1673R13 A free function linear algebra interface based on the BLAS
- LAPACK: {he,sy}rk: Hermitian/symmetric rank-k 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