コレは何？/What is this?

C++上で行列/ベクトルの計算を手軽に超絶簡単にするクラス。 ヘッダをインクルードするだけで手軽に使用可能！
これで，C++でMATLABと同じように気軽に行列計算ができます。 行列とベクトルとスカラー間の加減乗演算、冪乗、LU/QR/コレスキー分解、SVD、逆行列、複素数行列、 constexprでの行列の定義、「コンパイル時」での行列演算…等々ができます。 旧版のMatrixクラスから大幅に改良されました。 言語はC++17。

コンパイル時(≠実行時)に特異値分解をする例

特徴/Feature

• 行列のサイズはコンパイル時定数！
• 実行時ではなくコンパイル時に予め行列演算することも可能！
• 「コードの表記」が「数式の表記」に似てる！
• 型はデフォルトでdouble型、適宜float、int、complex型などで宣言可能！
• コメントが日本語！
• #include <Matrix.hh>するだけ！

ダウンロード/Download

下記にアップロードしてあります。

• ヘッダファイル Matrix.hh
• ソースファイル Matrix.cc
• サンプルコード

テンプレートクラスなのでソースファイルの方はほぼカラです。 ARCS6には標準で搭載されています。 上記はARCS6の内部に実装してあるものを抽出して出力してあります。

C++での行列演算の書き方の例

C++で行列演算をする際にどのように書けば良いかの一例を示しておきます。 下記のコードを参照してみて下さい。

• C++での行列演算の書き方の一例

演算子の一覧/List of Operators

使用可能な演算子の一覧は下記になります。

演算子	演算結果の意味
+	行列/ベクトル/スカラー間の加算
-	行列/ベクトル/スカラー間の減算
*	行列/ベクトル/スカラー間の乗算
/	「行列/ベクトル」と「スカラー」との間の除算
+=	行列/ベクトル/スカラー間の加算代入
-=	行列/ベクトル/スカラー間の減算代入
^	行列/ベクトルのべき乗
&	行列/ベクトルのアダマール乗算(要素ごとの掛け算)
%	行列/ベクトルのアダマール除算(要素ごとの割り算)
[ ]	縦ベクトルの要素アクセス(普通の配列と同じ使い方)

良く使う関数の一覧/List of frequently-used Functions

行列演算で良く使う代表的な関数として下記のものが使用可能です。

関数	演算結果の意味
tp(A)	行列Aの転置
tr(A)	行列Aのトレース
diag(A)	行列Aの対角要素の抽出
det(A)	行列Aの行列式
inv(A)	行列Aの逆行列
rank(A)	行列Aのランク
eig(A)	行列Aの固有値
LU(A, L, U)	行列AのLU分解
Cholesky(A, L, D) or Cholesky(A, L)	行列Aのコレスキー分解
QR(A, Q, R)	行列AのQR分解
SVD(A, U, S, V)	行列Aの特異値分解

上記はほんの一部で、その他にも色々な関数が準備してあります。

すべての関数一覧/List of Functions

関数等々の一覧のdoxygenドキュメントを下記に置いておきます。

• 行列/ベクトル計算クラス(テンプレート版) [詳解]

なぜ独自に開発するのか？

なんでこんなんを独自に作ってるのかというと、他ライブラリの行列計算のコード表記法の不満、 導入の面倒くささ、ARCS6への埋め込みと付随する権利関係のクリアさ、constexpr未対応、コア部分のイジり難さ，などなど色々な理由がある。 車輪の再開発で内製化することで、自身の従来の不満を解消。

要望受付中！

「こんな機能・関数があったら便利だなあ」というのがあったら横倉までご連絡下さい。 暇を見つけて対応します。

ライセンス

このライブラリはBSDライセンスです。商用でもご自由にお使いください。（ご一報頂けると喜びます）

Copyright (c) 2011-2022, Yuki YOKOKURA
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.

SWL - The Side Warehouse Laboratory, 横倉研究室 - 技術倉庫
Copyright(C), The Side Warehouse Laboratory, All rights reserved.