4. matrix_one_norm

最終更新日時(UTC):
が更新

履歴 編集

function template
<linalg>

std::linalg::matrix_one_norm(C++26)

namespace std::linalg {
  template<in-matrix InMat, class Scalar>
  Scalar matrix_one_norm(InMat A, Scalar init);          // (1)

  template<class ExecutionPolicy,
           in-matrix InMat,
           class Scalar>
  Scalar matrix_one_norm(
    ExecutionPolicy&& exec,
    InMat A,
    Scalar init);                                        // (2)

  template<in-matrix InMat>
  auto matrix_one_norm(InMat A);                         // (3)

  template<class ExecutionPolicy, in-matrix InMat>
  auto matrix_one_norm(ExecutionPolicy&& exec, InMat A); // (4)
}

概要

行列の1ノルムを計算する。

  • (1): 逐次実行する。
  • (2): 指定された実行ポリシーに応じて実行する。
  • (3): (1)でinitにInMat::value_typeのデフォルト値を与えて逐次実行する。
  • (4): (2)でinitにInMat::value_typeのデフォルト値を与えて、指定された実行ポリシーに応じて実行する。

適格要件

  • (1), (2): decltype(abs-if-needed(declval<typename InMat::value_type>()))がScalarに変換可能。
  • (2), (4): is_execution_policy<ExecutionPolicy>::valueがtrue

効果

  • (3), (4): Tをdecltype(abs-if-needed(declval<typename InMat::value_type>()))とすると、
    • (3): matrix_one_norm(A, T{})を返す。
    • (4): matrix_one_norm(std::forward<ExecutionPolicy>(exec), A, T{})を返す。

戻り値

  • (1), (2): Aが $m \times n$ 行列とすると、以下の値を返す。
    1. もし、nが0ならinit
    2. そうでないなら、以下の式の値

$$ \verb|init| + \max_{j = 0, \dots ,n - 1}\sum_{i = 0}^{m - 1} |\verb|A[|i, j\verb|]|| $$

  • (3), (4): Tをdecltype(abs-if-needed(declval<typename InMat::value_type>()))とすると、
    • (3): matrix_one_norm(A, T{})を返す。
    • (4): matrix_one_norm(std::forward<ExecutionPolicy>(exec), A, T{})を返す。

備考

  • (1), (2): もしInMat::value_typeとScalarがどちらも浮動小数点数型またはstd::complexの特殊化で、ScalarがInMat::value_typeより精度が高い場合、和の各項はScalarまたはより高い精度の型が使われる。

例

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

#include <array>
#include <cmath>
#include <execution>
#include <iostream>
#include <linalg>
#include <mdspan>

int main()
{
  constexpr size_t M = 4;
  constexpr size_t N = 4;

  std::array<double, M * N> mat;

  std::mdspan A(mat.data(), M, N);

  for(int i = 0; i < A.extent(0); ++i) {
    for(int j = 0; j < A.extent(1); ++j) {
      A[i,j] = ((i + j) % 2 == 0 ? 1.0 : -1.0) / (i * A.extent(1) + j + 1);
    }
  }

  std::cout << std::linalg::matrix_one_norm(A, -1.0 / 9 - 1.0 / 13) << '\n'
            << std::linalg::matrix_one_norm(std::execution::par, A, -1.0 / 9 - 1.0 / 13) << '\n'
            << std::linalg::matrix_one_norm(A) << '\n'
            << std::linalg::matrix_one_norm(std::execution::par, A) << '\n';

  return 0;
}

出力

1.2
1.2
1.38803
1.38803

バージョン

言語

  • C++26

処理系

関連項目

参照