【MQL5】StringReserve関数について

StringReserve関数の働き・役割
バッファを確保するとは？
1. メモリの簡単な仕組みについて
StringReserve関数の引数について
StringReserve関数の戻り値について
StringReserve関数を使う際の注意点
StringReserve関数を使ったサンプルコード
1. なぜループ範囲を1024にしているのか？
2. キャスト（型変換）について
  1. キャストの利点
その他サンプルコードに使われた関数や文法要素の簡単な解説

StringReserve関数の働き・役割

StringReserve関数は、指定されたサイズのバッファ（＝データの保存領域）を文字列のために確保するために使用されます。
StringReserve関数を使用することで、文字列のバッファサイズを事前に確保し、メモリ操作の効率を向上させることができます。特に大きな文字列を扱う場合や頻繁に文字列を操作する場合に役立ちます。

バッファを確保するとは？

バッファを確保することは、プログラムが将来使用するメモリ領域を事前に予約することを意味します。これにより、文字列の操作中に必要となるメモリの再割り当て回数を減らし、パフォーマンスを向上させることができます。

例えば、大きな文字列を作成する際に、必要なメモリを一度に確保しておけば、後で文字列を追加するたびにメモリを再割り当てする必要がなくなります。

メモリの簡単な仕組みについて

メモリの割り当て: 通常、文字列にデータを追加するたびにメモリが不足すると、追加のメモリが割り当てられます。この操作は頻繁に行われるとパフォーマンスに悪影響を及ぼします。
バッファの予約: StringReserve関数を使用すると、最初に大きなメモリブロックが一度に割り当てられます。これにより、以降の文字列操作が高速になります。
メモリの再割り当ての回避: 事前に大きなバッファを確保することで、後でメモリを再割り当てする必要がなくなり、操作の効率が上がります。

StringReserve関数の引数について

bool  StringReserve( 
   string&    string_var,      // バッファサイズを変更する対象の文字列
   uint       new_capacity     // 文字列のために必要なバッファサイズ
);

StringReserve関数は、以下の2つの引数を取ります：

string& string_var: バッファサイズを変更する対象の文字列。
uint new_capacity: 文字列のために必要なバッファサイズ。このサイズが現在の文字列の長さより小さい場合、バッファサイズは変更されません。

StringReserve関数の戻り値について

StringReserve関数は、成功した場合にはtrueを返し、失敗した場合にはfalseを返します。エラーコードを取得するためには、GetLastError関数を使用します。

※GetLastError関数についての詳細は↓の記事をご参照ください

StringReserve関数を使う際の注意点

・StringReserve関数は、バッファサイズを変更するだけで、文字列の内容は変更しません。
※StringInit関数も文字列を特定の長さに初期化する関数ですが、StringInit関数は第3引数で文字列の内容を変更できます。

StringInit関数の詳細は↓の記事をご参照ください。

バッファサイズは、通常、文字列の長さよりも大きく確保されます。StringReserve関数を使用することで、将来の操作に対して最適なバッファサイズを指定できます。
置換や追加の操作が多い場合に、メモリ再割り当ての回数を減らすことでパフォーマンスを向上させます。

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

以下に、StringReserve関数を使用してバッファサイズを確保し、パフォーマンスを比較する例を示します。

// OnStart関数はスクリプトの実行が開始されたときに自動的に呼び出されます
void OnStart() 
{
    // 文字列を定義します
    string s;
    
    // StringReserveを使用しない場合の動作速度をチェックします
    ulong t0 = GetMicrosecondCount();
    for (int i = 0; i < 1024; i++) 
    {
        s += " " + (string)i;
    }
    ulong msc_no_reserve = GetMicrosecondCount() - t0;
    s = NULL; // 文字列をリセットします
    
    // StringReserveを使用する場合の動作速度をチェックします
    StringReserve(s, 1024 * 3);
    t0 = GetMicrosecondCount();
    for (int i = 0; i < 1024; i++) 
    {
        s += " " + (string)i;
    }
    ulong msc_reserve = GetMicrosecondCount() - t0;
    
    // 結果をエキスパートログに表示します
    Print("StringReserveを使用した場合のテスト時間: " + (string)msc_reserve + " マイクロ秒");
    Print("StringReserveを使用しない場合のテスト時間: " + (string)msc_no_reserve + " マイクロ秒");
    
    /*
    結果:
    StringReserveを使用した場合のテスト時間: 50 マイクロ秒
    StringReserveを使用しない場合のテスト時間: 121 マイクロ秒
    */
}

なぜループ範囲を1024にしているのか？

このサンプルコードでは、ループ範囲を1024に設定しています。これは、パフォーマンステストのために十分な回数の文字列操作を行うためです。

パフォーマンス評価: 1024回の操作は、メモリ割り当てと再割り当ての影響を観察するのに適した数です。少なすぎると、メモリ割り当ての影響が不明瞭になる可能性があり、多すぎると処理時間が長くなりすぎます。
適切な負荷: 適度な回数のループを設定することで、プログラムの負荷を評価しやすくなります。これにより、StringReserve関数を使用した場合と使用しない場合のパフォーマンスの違いを明確に示すことができます。
2の累乗: 1024は2の累乗（2の10乗）であるため、コンピュータのメモリ管理において効率的に扱われます。2の累乗の値は、メモリ割り当てやバッファ管理において最適化されやすい特徴があります。