Skip to content

Latest commit

 

History

History
645 lines (563 loc) · 13.9 KB

README.md

File metadata and controls

645 lines (563 loc) · 13.9 KB

matrixCpp

概要

このプロジェクトはシンプルな実装かつ軽量な行列操作を可能とするライブラリの開発を目的としています。

Note

コンパイラはMSVC2022 Cpp14 or 17とします。

貢献方法

開発に協力してくださる方は以下の方法でお願いします。

貢献

  1. リポジトリをフォークします。
  2. 新しいブランチを作成します (git checkout -b feature/userName).
  3. 変更をコミットします (git commit -m 'comment').
  4. ブランチにプッシュします (git push origin feature/userName).
  5. プルリクエストを作成します。

クラス

matrix型

templateを用いてintやdouble型の行列を生成します。

template<typename Type>
class Matrix{
	// member
}

Matrix<int> mint;
Matrix<double> mdouble;

実装

  • データの格納 データはstd::vector<std::vector<Type>>で格納し処理します。 将来的にCUDAなどGPU上での処理を行わせる予定ですので一次元配列へ展開するメソッドを定義します。
  • 型エイリアス std::vector<std::vector<Type>>は実装する際に少し長いため以下のコードにより型エイリアスRowType,RowInitType,MatrixType,MatrixInitTypeを定義します。 またクラス外部でも使用できるようpublicにしておきます。
template<typename Type>
class matrix{
public:
	template<typename rowType    > using RowType     = std::vector<rowType>;
	template<typename rowInitType> using RowInitType = std::initializer_list<rowInitType>;

	template<typename matrixType = Type> using MatrixType     = std::vector          <RowType<matrixType>>;
	template<typename matrixType = Type> using MatrixInitType = std::initializer_list<RowInitType<matrixType>>;
}

ヘッダファイル

このプロジェクトのライブラリは保守性向上のため定義ファイルと実装ファイルに分ける事とします。

  • 定義ファイル
    • クラスの宣言
    • 関数のプロトタイプ宣言
    • マクロの定義など
  • 実装ファイル
    • 関数の実装
    • メンバ関数の実装

Include Guard

インクルードガードの命名はMATRIXCPP_ファイル名_拡張子とします。

// test.hppの場合
#ifndef MATRIXCPP_TEST_HPP
#define MATRIXCPP_TEST_HPP

// proc...

#endif

分割

.hは定義ファイル、.hppは実装ファイルを意味します。

  • matrix matrix.h matrixCalc.hppなどすべてのファイルをインクルードします。
  • matrix.h matrixクラスの定義,メンバ関数のプロトタイプ宣言などメンバの定義を行います。
  • matrixCtor.hpp コンストラクタを定義します。
  • matrixCalc.hpp 加算,減算,アダマール積など計算を行います。
  • matrixOp.hpp 演算子関数の実装を行います。
  • matrixDec.hpp LU分解など行列分解を行います。逆行列も含む。
  • matrixUtils.hpp 行入れ替えなど行列の操作を行います。
matrix ---- matrix.h
        |-- matrixCtor.hpp
        |-- matrixCalc.hpp
        |-- matrixOp.hpp
        |-- matrixDec.hpp
        |__ matrixUtils.hpp

命名

  • メンバ名はcamelCaseで記述します。
  • クラス名はPascalCaseで記述します。
  • プライベートメンバ プライベートメンバ名(camelCase)の後に_をつけます。
  • プロトタイプ宣言 返り値型 メンバ名(引数型1,引数型2,...);

記法

定義ファイル

template<typename Type, typename DcmpType = double> // Type:演算時に使用する型、DcmpType:分解時に保持する行列の型
class Matrix{
private:
	// プライベートメンバ

	// 変数メンバ
	Type testValuePrivate_ = 0; // コメント

	// 函数メンバ(プロトタイプ宣言)
	Type testFuncPrivate_(const Matrix&,const Matrix&); // コメント

public:
	// パブリックメンバ
	
	// 変数メンバ
	Type testValuePublic = 0; // コメント

	// 函数メンバ(プロトタイプ宣言)
	Type testFuncPublic(const Matrix&,const Matrix&); // コメント
}

実装ファイル

// コメント
template<typename Type>
Type Matrix<Type>::testFuncPrivate_(const Matrix& a,const Matrix& b){
	return Type();
}

// コメント
template<typename Type>
Type Matrix<Type>::testFuncPublic(const Matrix& a,const Matrix& b){
	return Type();
}

機能一覧

コンストラクタ

  • Matrix() = default;
    デフォルトコンストラクタ

  • Matrix(const MatrixInitType<>&);
    初期化用のパラメータ付きコンストラクタ

      using Type = int;
  Matrix<Type> mat = {
    {1,2,3},
    {4,5,6},
    {7,8,9}
  };

$$ mat = \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{bmatrix} $$

  • Matrix(const MatrixType<>&);
    コピーコンストラクタ

  • Matrix(const std::pair<size_t, size_t>&);
    サイズ指定のパラメータ付きコンストラクタ

      using Type = int;
  Matrix<int> mat({2,3}); // {rowCount,colCount}

$$ mat = \begin{bmatrix} 0 & 0 & 0 \\ 0 & 0 & 0 \end{bmatrix} $$

  • Matrix(const Matrix<Type, DcmpType>&);
    コピーコンストラクタ

  • Matrix(Matrix<Type>&&) noexcept;
    ムーブコンストラクタ

演算子オーバーロード

  • Matrix<Type>& operator=(const MatrixInitType<Type>&);
    代入演算子

  • Matrix<Type>& operator=(const Matrix<Type>&);
    代入演算子

  • Matrix<Type>& operator<<(const MatrixInitType<Type>&);
    ストリーム挿入演算子

  • Matrix<Type>& operator<<(const Matrix<Type>&);
    ストリーム挿入演算子

  • Matrix<Type>& operator=(Matrix<Type>&&);
    ムーブ代入演算子

  • Matrix<Type>& operator<<(Matrix<Type>&&);
    ムーブストリーム挿入演算子

  • RowType<Type>& operator[](const size_t&);
    行アクセス

      using Type = int;
  Matrix<Type> mat = {{1,2,3},{4,5,6},{7,8,9}};
  std::cout << mat[1] << std::endl;

$$ \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{bmatrix} \cdot \begin{bmatrix} 0 & 1 & 0 \\ 0 & 1 & 0 \\ 0 & 1 & 0 \end{bmatrix} = \begin{bmatrix} 4 & 5 & 6 \end{bmatrix} $$

  • Matrix<Type>& operator+=(const Matrix<Type>&);
    加算 
      using Type = int;
  Matrix<Type> mat1 = {{1,2,3},{4,5,6},{7,8,9}};
  Matrix<Type> mat2 = {{9,8,7},{6,5,4},{3,2,1}};
  mat1 += mat2; // mat1 = {{10,10,10},{10,10,10},{10,10,10}}

$$ \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{bmatrix} + \begin{bmatrix} 9 & 8 & 7 \\ 6 & 5 & 4 \\ 3 & 2 & 1 \end{bmatrix} = \begin{bmatrix} (1+9) & (2+8) & (3+7) \\ (4+6) & (5+5) & (6+4) \\ (7+3) & (8+2) & (9+1) \end{bmatrix} = \begin{bmatrix} 10 & 10 & 10 \\ 10 & 10 & 10 \\ 10 & 10 & 10 \end{bmatrix} $$

  • Matrix<Type>& operator-=(const Matrix<Type>&);
    減算 
      using Type = int;
  Matrix<Type> mat1 = {{1,2,3},{4,5,6},{7,8,9}};
  Matrix<Type> mat2 = {{9,8,7},{6,5,4},{3,2,1}};
  mat1 -= mat2; // mat1 = {{-8,-6,-4},{-2,0,2},{4,6,8}}

$$ \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{bmatrix} - \begin{bmatrix} 9 & 8 & 7 \\ 6 & 5 & 4 \\ 3 & 2 & 1 \end{bmatrix} = \begin{bmatrix} (1-9) & (2-8) & (3-7) \\ (4-6) & (5-5) & (6-4) \\ (7-3) & (8-2) & (9-1) \end{bmatrix} = \begin{bmatrix} -8 & -6 & -4 \\ -2 & 0 & 2 \\ 4 & 6 & 8 \end{bmatrix} $$

  • Matrix<Type>& operator*=(const Matrix<Type>&);
    乗算 
      using Type = int;
  Matrix<Type> mat1 = {{1,2,3},{4,5,6},{7,8,9}};
  Matrix<Type> mat2 = {{9,8,7},{6,5,4},{3,2,1}};
  mat1 *= mat2; // mat1 = {{30,24,18},{84,69,54},{138,114,90}}

$$ \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{bmatrix} \cdot \begin{bmatrix} 9 & 8 & 7 \\ 6 & 5 & 4 \\ 3 & 2 & 1 \end{bmatrix} = \begin{bmatrix} (1\cdot9 + 2\cdot6 + 3\cdot3) & (1\cdot8 + 2\cdot5 + 3\cdot2) & (1\cdot7 + 2\cdot4 + 3\cdot1) \\ (4\cdot9 + 5\cdot6 + 6\cdot3) & (4\cdot8 + 5\cdot5 + 6\cdot2) & (4\cdot7 + 5\cdot4 + 6\cdot1) \\ (7\cdot9 + 8\cdot6 + 9\cdot3) & (7\cdot8 + 8\cdot5 + 9\cdot2) & (7\cdot7 + 8\cdot4 + 9\cdot1) \end{bmatrix} = \begin{bmatrix} 30 & 24 & 18 \\ 84 & 69 & 54 \\ 138 & 114 &90 \end{bmatrix} $$ $$ mat1 \cdot mat2 = C $$ $$ C_{ij} = \sum_{k=1}^{n} a_{ik} b_{kj} $$

  • Matrix<Type>& operator^=(const Matrix<Type>&);
    アダマール積 
      using Type = int;
  Matrix<Type> mat1 = {{1,2,3},{4,5,6},{7,8,9}};
  Matrix<Type> mat2 = {{9,8,7},{6,5,4},{3,2,1}};
  mat1 ^= mat2; // mat1 = {{9,16,21},{24,25,24},{21,16,9}}

$$ \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{bmatrix} \circ \begin{bmatrix} 9 & 8 & 7 \\ 6 & 5 & 4 \\ 3 & 2 & 1 \end{bmatrix} = \begin{bmatrix} (1\cdot9) & (2\cdot8) & (3\cdot7) \\ (4\cdot6) & (5\cdot5) & (6\cdot4) \\ (7\cdot3) & (8\cdot2) & (9\cdot1) \end{bmatrix} = \begin{bmatrix} 9 & 16 & 21 \\ 24 & 25 & 24 \\ 21 & 16 & 9 \end{bmatrix} $$

  • Matrix<Type>& operator/=(const Matrix<Type>&);
    アダマール除算 
      using Type = int;
  Matrix<Type> mat1 = {{1,2,3},{4,5,6},{7,8,9}};
  Matrix<Type> mat2 = {{9,8,7},{6,5,4},{3,2,1}};
  mat1 /= mat2; // mat1 = {{0.111111,0.25,0.428571},{0.666667,1.0,1.5},{2.33333,4.0,9.0}}

$$ \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{bmatrix} \oslash \begin{bmatrix} 9 & 8 & 7 \\ 6 & 5 & 4 \\ 3 & 2 & 1 \end{bmatrix} = \begin{bmatrix} (1/9) & (2/8) & (3/7) \\ (4/6) & (5/5) & (6/4) \\ (7/3) & (8/2) & (9/1) \end{bmatrix} = \begin{bmatrix} 0.111111 & 0.25 & 0.428571 \\ 0.666667 & 1.0 & 1.5 \\ 2.33333 & 4.0 & 9.0 \end{bmatrix} $$

  • Matrix<Type>& operator*=(const Type&);
    スカラ乗算 
      using Type = int;
  Matrix<Type> mat = {{1,2,3},{4,5,6},{7,8,9}};
  mat *= 2; // mat = {{2,4,6},{8,10,12},{14,16,18}}

$$ \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{bmatrix} \cdot 2 = \begin{bmatrix} (1\cdot2) & (2\cdot2) & (3\cdot2) \\ (4\cdot2) & (5\cdot2) & (6\cdot2) \\ (7\cdot2) & (8\cdot2) & (9\cdot2) \end{bmatrix} = \begin{bmatrix} 2 & 4 & 6 \\ 8 & 10 & 12 \\ 14 & 16 & 18 \end{bmatrix} $$

  • Matrix<Type> operator+(const Matrix<Type>&);
    加算

  • Matrix<Type> operator-(const Matrix<Type>&);
    減算

  • Matrix<Type> operator*(const Matrix<Type>&);
    乗算

  • Matrix<Type> operator^(const Matrix<Type>&);
    アダマール積

  • Matrix<Type> operator/(const Matrix<Type>&);
    アダマール除算

  • Matrix<Type> operator*(const Type&);
    スカラ乗算

  • template<typename Type_>
    explicit operator Matrix<Type_>();
    型変換

メンバ関数

  • Matrix<Type>& add(const Matrix<Type>&);
    加算

$$ A + B = C $$ $$ C_{ij} = A_{ij} + B_{ij} $$

  • Matrix<Type>& sub(const Matrix<Type>&);
    減算

$$ A - B = C $$ $$ C_{ij} = A_{ij} - B_{ij} $$

  • Matrix<Type>& mul(const Matrix<Type>&);
    乗算

$$ A \cdot B = C $$ $$ C_{ij} = \sum_{k=1}^{n} A_{ik} B_{kj} $$

  • Matrix<Type>& scalarMul(const Type&);
    スカラ乗算

$$ A \cdot k = C $$ $$ C_{ij} = A_{ij} \cdot k $$

  • Matrix<Type>& hadamardMul(const Matrix<Type>&);
    アダマール積

$$ A \circ B = C $$ $$ C_{ij} = A_{ij} \cdot B_{ij} $$

  • Matrix<Type>& hadamardDiv(const Matrix<Type>&);
    アダマール除算

$$ A \oslash B = C $$ $$ C_{ij} = \frac{A_{ij}}{B_{ij}} $$

  • template<typename calcType>
    Matrix<Type>& scalarCalc(const Matrix<Type>&);
    スカラ計算

$$ A \cdot B = C $$ $$ C_{ij} = A_{ij} \cdot B_{ij} $$

  • std::vector<Matrix<DcmpType>> luDec(DcmpType epsilon = 1e-9);
    LU分解

$$ A = PLU $$ $$ P: \text{置換行列}, L: \text{下三角行列}, U: \text{上三角行列} $$ $$ P = identity $$ $$ L = zero $$ $$ U = A $$ $$ L_{ij} = \begin{cases} 1 & \text{if } i = j \\ 0 & \text{if } i < j \\ -\frac{A_{ij}}{A_{jj}} & \text{if } i > j \end{cases} $$ $$ U_{ij} = \begin{cases} A_{ij} & \text{if } i \leq j \\ 0 & \text{if } i > j \end{cases} $$ $$ P_{ij} = \begin{cases} 1 & \text{if } i = j \\ 0 & \text{if } i \neq j \end{cases} $$

  • Matrix<DcmpType> inverse(DcmpType epsilon = 1e-9);
    逆行列

  • DcmpType det(DcmpType epsilon = 1e-9);
    行列式

$$ \text{det}(A) = \prod_{i=1}^{n} U_{ii} $$

  • Matrix<Type> transpose();
    転置

$$ A^T = C $$ $$ C_{ij} = A_{ji} $$

  • Matrix<Type>& swapRow(const size_t&, const size_t&);
    行の入れ替え

  • Matrix<Type>& swapCol(const size_t&, const size_t&);
    列の入れ替え

  • Matrix<Type>& resize(const size_t&, const size_t&);
    サイズ変更

  • const size_t rows() const;
    行数の取得

  • const size_t cols() const;
    列数の取得

  • std::vector<std::reference_wrapper<Type>> rowRef(const size_t&);
    行参照

  • std::vector<std::reference_wrapper<Type>> colRef(const size_t&);
    列参照

  • Matrix<Type>& forEach(std::function<Type()>);
    各要素への操作

  • Matrix<Type>& forEach(std::function<Type(size_t, size_t, Type&)>);
    各要素への操作（行、列、そのポイントの値）

  • template<typename Type_ = Type>
    static Matrix<Type_> identity(const size_t&);
    単位行列生成

$$ I_n = \begin{bmatrix} 1 & 0 & \cdots & 0 \\ 0 & 1 & \cdots & 0 \\ \vdots & \vdots & \ddots & \vdots \\ 0 & 0 & \cdots & 1 \end{bmatrix} $$

ストリーム出力オーバーロード

  • template<typename CharT, typename Traits, typename MatrixType = double>
    std::basic_ostream<CharT, Traits>& operator <<(std::basic_ostream<CharT, Traits>&, Matrix<MatrixType>);
    行列の出力オーバーロード

  • template<typename CharT, typename Traits, typename MatrixType = double>
    std::basic_ostream<CharT, Traits>& operator <<(std::basic_ostream<CharT, Traits>&, std::vector<std::vector<MatrixType>>);
    2次元ベクトルの出力オーバーロード

Note

他の分解法は追加予定QR分解,コレスキー分解,固有値分解,SVD分解,ジョルダン標準形