【MQL5】Row関数について

Row関数の働き・役割
Row関数の引数について
1. 書式1：行ベクトルを取得する場合
2. 書式2：行ベクトルを設定する場合
関数の戻り値について
Row関数を使ったサンプルコード
Row関数サンプルコードの解説
Row関数を使ってEAを作る際のアイディア

Row関数の働き・役割

Row関数は、指定した行番号に対応する行ベクトルを取得したり、指定した行に新しいベクトルを書き込むための関数です。この関数には2つの形式があり、それぞれ以下のような役割を持ちます。

指定した行番号に対応する行ベクトルを取得します。
指定した行番号に新しい行ベクトルを書き込みます。この際、行列の次元が未割り当ての場合は、自動的にゼロ行列が生成され、ベクトルの値が設定されます。既存の行列に対して操作を行う場合は、行列の次元は変更されませんが、指定した行の値だけが更新されます。

この関数は、行列操作を柔軟に管理するために利用され、行ごとのデータ処理や動的な行列の編集に適しています。

Row関数の引数について

Row関数は、行ベクトルを取得する場合と設定する場合で異なる2つの書式を持ちます。それぞれの書式と引数について説明します。

書式1：行ベクトルを取得する場合

vector matrix::Row(const ulong nrow);

引数
nrow（行番号）

種類：ulong型
説明：行列から取得する行の番号を指定します。この番号は、0から始まるインデックス（通し番号）を示します。指定された行のデータがベクトル形式で返されます。

書式2：行ベクトルを設定する場合

void matrix::Row(const vector v, const ulong nrow);

引数
v（行ベクトル）

種類：vector型
説明：行列の指定した行に設定するベクトルを指定します。このベクトルのサイズが現在の列数と異なる場合、自動的に対応する列が拡張または無視される形で適用されます。

nrow（行番号）

種類：ulong型
説明：行列においてベクトルを設定する行の番号を指定します。この番号は、0から始まるインデックス（通し番号）を示します。指定された行番号に従って行列が更新されます。

関数の戻り値について

Row関数の戻り値は、使用する書式によって異なります。それぞれの戻り値について説明します。

書式1：行ベクトルを取得する場合

書式1では、指定された行のデータを行ベクトル形式で返します。

戻り値の種類
vector型
内容
指定された行番号に対応する行ベクトルを返します。返されるベクトルは、行列内の該当行のデータを反映しています。
例として、行列が[ [1, 2, 3], [4, 5, 6] ]の場合にRow(0)を呼び出すと、ベクトル[1, 2, 3]が返されます。
特記事項
指定した行番号が行列の範囲外の場合、エラーが発生する可能性があります。

書式2：行ベクトルを設定する場合

書式2はvoid型のため、戻り値はありません。

戻り値の種類
なし（void型）
内容
行ベクトルを指定された行に設定する操作を実行します。設定後の行列全体の状態は、行列の次元や行ベクトルのサイズに応じて変化します。
特記事項
未割り当て行列に行を設定する場合、行列は自動的に拡張されます。この際、新たに生成される行や列の値はすべて0で初期化されます。

未割り当て行列について

未割り当て行列とは、次元（行数や列数）が設定されておらず、どのようなデータも持たない状態の行列を指します。
これは、matrix型の変数を初期化した直後や、Resizeメソッドなどで次元をリセットした場合に発生します。未割り当て状態では行列内の要素を参照することはできませんが、新たな行や列を設定する操作を行うと、自動的にゼロで初期化された行列が作成されます。

Row関数を使ったサンプルコード

以下はRow関数の使用例です。それぞれ、行ベクトルの設定と取得の動作を確認するコードを含んでいます。

void OnStart()
{
    // ベクトルを作成します。これは行ベクトルとして使用されます。
    vector v1 = {1, 2, 3};

    // 空の行列を作成します。現在は何の要素も含まれていません。
    matrix m1;

    // m1の行1にv1を設定します。
    m1.Row(v1, 1);

    // m1の内容をエキスパートログに出力します。
    Print("m1\n", m1);

    // サイズ4x5の行列m2を作成し、初期値をすべて7に設定します。
    matrix m2 = matrix::Full(4, 5, 7);

    // m2の行2にv1を設定します。
    m2.Row(v1, 2);

    // m2の内容をエキスパートログに出力します。
    Print("m2\n", m2);

    // m2の行1を取得し、その内容をエキスパートログに出力します。
    Print("row 1 - ", m2.Row(1));

    // m2の行2を取得し、その内容をエキスパートログに出力します。
    Print("row 2 - ", m2.Row(2));
}

このコードの実行結果

m1
[[0,0,0]
 [1,2,3]]
m2
[[7,7,7,7,7]
 [7,7,7,7,7]
 [1,2,3,7,7]
 [7,7,7,7,7]]
row 1 - [7,7,7,7,7]
row 2 - [1,2,3,7,7]

Row関数サンプルコードの解説

このサンプルコードでは、Row関数を使い、以下の2つの操作を行っています。

ベクトルを指定した行に設定する。
指定した行のデータを取得する。

コードの中で使用されている各部分について詳しく説明します。

ベクトルの作成

この部分では、vector型の変数v1を作成し、初期値として1, 2, 3を代入しています。
vectorは、行や列のデータを格納するために使用されるMQL5のデータ型です。リテラル（直接値を示す文字列）として、1, 2, 3は3つの値を持つベクトルを表します。