おススメのMT5・MQL5対応FX業者はコチラ↓
おススメのMT5・MQL5対応FX業者
【※この記事にはプロモーションが含まれています。】 MQL5を使って自作したEAをシステムトレードに利用するには、取引プラットフォームとしてMT5を提供しているFX会社に口座を開設しなくてはいけません。 MQL5にて開発した、MT5用EAを...
mqlinvestmentlab.com
2023.08.04

【MQL5】MathArctanh関数について

MQL5リファレンス
2024.11.08
スポンサーリンク
スポンサーリンク

MathArctanh関数の働き・役割

MathArctanh関数は、与えられた数値の双曲線逆正接を計算するために使用されます。この関数は、-1と1の範囲内にある数値を引数として受け取り、その数値の双曲線逆正接の値を返します。

双曲線逆正接とは

双曲線逆正接（arctanh）は、「ある値が双曲線正接を通して得られる前の角度や数値を求める」ための数学的な関数です。まず、「双曲線正接」という言葉が難しく感じるかもしれませんので、順を追って簡単に説明します。

双曲線と双曲線関数

双曲線は、グラフ上で曲線を描く数学的な形の1つで、2つの曲線が開いたU字型に伸びた形をしています。双曲線関数（sinh、cosh、tanhなど）というのは、この双曲線の性質を利用して、特定の計算を行う関数です。例えば、tanhという関数は双曲線正接と呼ばれ、特定の角度に対応する値を求めるために使われます。

双曲線逆正接とは？

双曲線逆正接（arctanh）は、「双曲線正接の逆」を意味します。これは、「ある値が双曲線正接（tanh）を使った結果だとして、その元の角度を求めたい」というときに使う関数です。たとえば、tanh関数で0.5という値を得た場合、arctanhを使うことで、この0.5という結果に対応する角度がわかります。

arctanh関数の利用場面

双曲線逆正接は、物理学や工学、経済学などで数値の変化や成長のモデルを作るときに役立ちます。MQL5のMathArctanh関数は、このarctanhをプログラムの中で計算できるようにするものです。

MathArctanh関数の引数について

double  MathArctanh(
  double  value      // -1 < value < 1
  );

MathArctanh関数は1つの引数を受け取ります。

value
種類: double型
説明: 双曲線逆正接を求めたい数値を指定します。この数値は-1より大きく、1より小さい範囲である必要があります。範囲外の数値を指定すると、関数は正常に動作しません。

この引数は、MathArctanh関数に計算させたい「双曲線逆正接」の対象値を表します。

MathArctanh関数の戻り値について

MathArctanh関数は、指定された数値の双曲線逆正接の結果を返します。戻り値のデータ型はdouble型で、計算結果として得られる角度や数値が返されます。

この関数に与えられた数値は、範囲が-1から1の間である必要があります。入力値がこの範囲内にある場合は、その数値に対応する双曲線逆正接の結果が返されますが、範囲外の数値を入力するとエラーが発生する可能性があります。

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

#define GRAPH_WIDTH 750    // グラフの幅を設定
#define GRAPH_HEIGHT 350   // グラフの高さを設定
 
#include <Graphics\Graphic.mqh>  // グラフィック描画用のライブラリをインクルード
 
CGraphic ExtGraph;  // グラフィックオブジェクトのインスタンスを作成
//+------------------------------------------------------------------+
//| スクリプトプログラム開始関数                                              |
//+------------------------------------------------------------------+
void OnStart()
{
    // deltaベクトルを作成し、-1から2πまでの34個の値をステップとして設定
    vector delta = vector::Full(34, 2 * M_PI / 100);
    delta[0] = -1;  // deltaの最初の値を-1に設定
    //--- deltaのステップで値を累積し、Xベクトルとして保存
    vector X = delta.CumSum();
    //--- Xベクトルの各値の双曲線逆正弦値を計算し、Yベクトルに格納
    vector Y = MathArctanh(X);
 
    //--- 計算結果を配列に転送
    double x_array[], y_array[];
    X.Swap(x_array);  // Xベクトルのデータをx_array配列にコピー
    Y.Swap(y_array);  // Yベクトルのデータをy_array配列にコピー
 
    //--- 計算されたベクトル値のグラフを描画
    CurvePlot(x_array, y_array, clrDodgerBlue);
 
    //--- EscapeキーまたはPgDnキーを押すまで待機し、グラフを削除
    while (!IsStopped())
    {
        if (StopKeyPressed())  // キーが押されたらループを終了
            break;
        Sleep(16);  // スリープで待機（CPU負荷を軽減）
    }
 
    //--- グラフオブジェクトを削除してクリーンアップ
    ExtGraph.Destroy();
}
//+------------------------------------------------------------------+
//| ESCが押されたら「true」を返す                                            |
//| PgDnが押されたら、グラフのスクリーンショットを撮り、「true」を返す                     |
//| その他の場合は「false」を返す                                           |
//+------------------------------------------------------------------+
bool StopKeyPressed()
{
    //--- ESCキーが押された場合に「true」を返す
    if (TerminalInfoInteger(TERMINAL_KEYSTATE_ESCAPE) != 0)
        return (true);
    //--- PgDnキーが押され、スクリーンショットが正常に取得された場合に「true」を返す
    if (TerminalInfoInteger(TERMINAL_KEYSTATE_PAGEDOWN) != 0 && MakeAndSaveScreenshot(MQLInfoString(MQL_PROGRAM_NAME) + "_Screenshot"))
        return (true);
    //--- 上記のいずれでもない場合、「false」を返す
    return (false);
}
//+------------------------------------------------------------------+
//| グラフオブジェクトを作成して曲線を描画する                                      |
//+------------------------------------------------------------------+
void CurvePlot(double &x_array[], double &y_array[], const color colour)
{
    // グラフオブジェクトを作成し、指定された位置とサイズで配置
    ExtGraph.Create(ChartID(), "Graphic", 0, 0, 0, GRAPH_WIDTH, GRAPH_HEIGHT);
    // グラフに曲線を追加
    ExtGraph.CurveAdd(x_array, y_array, ColorToARGB(colour), CURVE_LINES);
    ExtGraph.IndentUp(30);

このコードは、まず-1から2πまでの範囲で34個の数値を生成し、それぞれに双曲線逆正接を適用して結果を得ます。その結果をグラフにプロットし、グラフィックウィンドウに表示します。ユーザーが「ESC」キーを押すとグラフが削除されスクリプトが終了し、「PgDn」キーを押すとスクリーンショットが保存された後にグラフが削除されスクリプトが終了します。

サンプルコード解説1: グローバル領域での定義

#define GRAPH_WIDTH 750    // グラフの幅を設定
#define GRAPH_HEIGHT 350   // グラフの高さを設定

#include <Graphics\Graphic.mqh> // グラフィック描画用のライブラリをインクルード

CGraphic ExtGraph; // CGraphicクラスのインスタンスを作成

定義の詳細

グラフの幅と高さの定義

グラフの幅を750ピクセル（デジタル画像を構成する最小の単位）に、グラフの高さを350ピクセルに設定しています。defineディレクティブを使用して定数を定義することで、コード内でこれらの値を使用する際に簡単に参照できるようになります。

グラフィックライブラリのインクルード

includeディレクティブを使用して、グラフィック関連の機能を提供するライブラリファイル「Graphic.mqh」をインクルードしています。このライブラリには、グラフの描画や曲線の追加など、グラフィック操作に必要な関数やクラスが定義されています。

グラフィックオブジェクトの作成

CGraphicクラスのインスタンスであるExtGraphオブジェクトを作成しています。このインスタンスは、グラフの描画や操作に使用されます。

クラスはオブジェクト指向プログラミングの基本要素であり、特定の機能を持つオブジェクト（変数や配列など）を作成するためのテンプレートです。

サンプルコード解説2：OnStart関数の中その1

//+------------------------------------------------------------------+
//| スクリプトプログラム開始関数                                              |
//+------------------------------------------------------------------+
void OnStart()
{
    // deltaベクトルを作成し、-1から2πまでの34個の値をステップとして設定
    vector delta = vector::Full(34, 2 * M_PI / 100);
    delta[0] = -1;  // deltaの最初の値を-1に設定
    //--- deltaのステップで値を累積し、Xベクトルとして保存
    vector X = delta.CumSum();
    //--- Xベクトルの各値の双曲線逆正弦値を計算し、Yベクトルに格納
    vector Y = MathArctanh(X);

この部分のコードでは、双曲線逆正接（arctanh）を計算するために必要な数値を生成し、それをベクトル形式で保持しています。

  1. deltaベクトルの作成と初期化
    最初にdeltaベクトルが作成され、Fullメソッドを使用して、-1から2πまでの範囲内で34個のステップを設定しています。各ステップは「2 * π / 100」という値で構成され、約0.0628ずつ増加します。また、deltaの最初の値を手動で-1に設定しており、これは双曲線逆正接計算の開始点を決めるためです。
  2. deltaの累積値をXベクトルとして保存
    deltaベクトルに設定された各ステップの値を累積し、Xベクトルに格納します。CumSumメソッドは、各ステップの累積値を計算してベクトルに保存するため、-1から始まって徐々に2πに向かって増加する一連の数値がXベクトルに保存されます。この操作により、双曲線逆正接の計算対象となる一連の値が準備されます。
  3. 双曲線逆正接の計算結果をYベクトルに格納
    Xベクトルに含まれる各値に双曲線逆正接（arctanh）を適用し、その結果をYベクトルに格納します。MathArctanh関数は、与えられた数値の双曲線逆正接を計算し、Yベクトルに一連の計算結果を保存します。このYベクトルは、Xベクトルの各要素に対応する双曲線逆正接の値を持ち、グラフ描画の際に使用されます。

このコードによって、-1から2πまでの範囲の数値とその双曲線逆正接値がそれぞれXベクトルとYベクトルに格納され、後続の処理で使用できるように準備されます。

サンプルコード解説3：OnStart関数の中その2

// ベクトルの計算結果を配列に転送
  double x_array[],y_array[];
  X.Swap(x_array);    // Xベクトルの値をx_array配列に転送
  Y.Swap(y_array);    // Yベクトルの値をy_array配列に転送
 
  // 計算結果をもとに、グラフを描画する
  CurvePlot(x_array, y_array, clrDodgerBlue);

このセクションでは、ベクトルの計算結果を配列に転送し、グラフを描画する手順について解説します。

まず、x_arrayおよびy_arrayと宣言し、x座標とy座標の値を保持する配列を用意しています。次に、XベクトルとYベクトルの計算結果を、それぞれx_arrayとy_arrayという配列に転送しています。この転送にはSwapメソッドが使用され、これによってXベクトルの内容がx_array配列に、Yベクトルの内容がy_array配列に簡単にコピーされます。

その後、CurvePlot関数を使用して、x_arrayとy_arrayの値をもとにグラフを描画しています。CurvePlot関数の引数には描画するデータの配列であるx_arrayとy_array、および色指定のためのclrDodgerBlueが渡され、指定された色でグラフが描かれます。

サンプルコード解説4：OnStart関数部分その3

//--- EscapeキーまたはPgDnキーを押してグラフを削除し、終了するまで待機
  while (!IsStopped())
    {
    if (StopKeyPressed()) // 停止ボタンが押されているかを確認
        break;
    Sleep(16); // 16ミリ秒待機してから次のループへ
    }
 
  //--- グラフィックのクリーンアップ
  ExtGraph.Destroy(); // ExtGraphオブジェクトを削除してメモリを解放
 }

この部分のコードは、グラフを表示させたまま、ESCキーまたはPgDnキーが押されるのを待機する処理です。

まず、while文でループを開始し、スクリプトが停止されていない間、つまりIsStopped関数がfalseを返す間はループが続きます。ループの中でStopKeyPressed関数が呼ばれ、ESCキーまたはPgDnキーが押されたかを確認します。もし、いずれかのキーが押されている場合、break文によってループを抜け、待機処理を終了します。これにより、ユーザーが任意のタイミングでグラフの表示を終了できるようになっています。

ループ内でSleep関数が16ミリ秒の待機を挟むことで、CPU負荷を軽減しながらキーの入力を定期的に確認します。待機処理が終了すると、グラフのクリーンアップに移ります。ExtGraphインスタンスに対してDestroyメソッドを呼び出し、グラフを破棄して使用していたメモリを解放します。これにより、スクリプトの終了時にリソースが適切に解放されます。

サンプルコード解説5: StopKeyPressed関数（オリジナル関数）部分

//+------------------------------------------------------------------+
//| ESCが押されたら「true」を返す                                    |
//| PgDnが押されたら、グラフのスクリーンショットを撮り、「true」を返す  |
//| その他の場合は「false」を返す                                    |
//+------------------------------------------------------------------+
bool StopKeyPressed()
{
    // --- ESCが押されたら「true」を返す
    if (TerminalInfoInteger(TERMINAL_KEYSTATE_ESCAPE) != 0)
        return(true);

    // --- PgDnが押されてグラフのスクリーンショットが正常に取得されたら、「true」を返す
    if (TerminalInfoInteger(TERMINAL_KEYSTATE_PAGEDOWN) != 0 && MakeAndSaveScreenshot(MQLInfoString(MQL_PROGRAM_NAME) + "_Screenshot"))
        return(true);

    // --- その他の場合は「false」を返す
    return(false);
}

StopKeyPressed関数は、ESCキーやPgDnキーが押されたかどうかを検出し、特定の動作を行うためのカスタム関数です。この関数は、グラフ表示の終了条件を管理する重要な役割を持っています。

まず、TerminalInfoInteger関数を使用してESCキーの状態を確認しています。引数として、TERMINAL_KEYSTATE_ESCAPEという識別子を指定しています。この識別子は、ESCキーの押下状態を取得するために使用され、キーが押されている場合には非ゼロの値が返されます。もし非ゼロが返された場合、関数はtrueを返し、スクリプト内でグラフの表示を終了させることができます。

次に、PgDnキーが押されているかどうかを確認しています。この場合もTerminalInfoInteger関数を使用しており、引数としてTERMINAL_KEYSTATE_PAGEDOWNという識別子を指定しています。この識別子は、PgDnキーの押下状態を取得するために使用され、押されていれば非ゼロが返されます。PgDnキーが押されているときには、さらにMakeAndSaveScreenshot関数を呼び出してスクリーンショットをファイルに保存します。

MakeAndSaveScreenshot関数には、スクリーンショットのファイル名を指定するための文字列が引数として渡されています。この文字列は、MQLInfoString関数を使用して生成されています。MQLInfoString関数の引数には、MQL_PROGRAM_NAMEという識別子が指定されており、これによって現在のスクリプト名が取得されます。スクリーンショットのファイル名には、このスクリプト名に「_Screenshot」という文字列を追加し、ファイルが保存されます。

スクリーンショットの保存に成功した場合にはtrueが返され、PgDnキーによる終了動作とスクリーンショットの保存が同時に行われます。いずれのキーも押されていない場合にはfalseが返され、スクリプトは実行を続行します。この構造により、ESCまたはPgDnが押されるまでグラフを表示し、必要に応じてスクリーンショットを保存してからスクリプトを終了する動作が可能になります。

サンプルコード解説6：CurvePlot関数（オリジナル関数）部分

//+------------------------------------------------------------------+
//| グラフオブジェクトを作成して曲線を描画                            |
//+------------------------------------------------------------------+
void CurvePlot(double &x_array[], double &y_array[], const color colour)
 {
  // グラフオブジェクトを作成（チャートID、名前、座標などを設定）
  ExtGraph.Create(ChartID(), "Graphic", 0, 0, 0, GRAPH_WIDTH, GRAPH_HEIGHT);
  
  // カーブ（曲線）を追加し、色とラインの種類を指定
  ExtGraph.CurveAdd(x_array, y_array, ColorToARGB(colour), CURVE_LINES);
  
  // テキストのインデント位置を少し上に設定
  ExtGraph.IndentUp(30);
  
  // すべての曲線を描画
  ExtGraph.CurvePlotAll();
  
  // ESCキーとPgDnキーに関する操作方法の説明を追加
  string text1 = "Press ESC to delete the graph and stop the script, or";
  string text2 = "Press PgDn to create a screen, delete the graph and stop the script";
  ExtGraph.TextAdd(54, 9, text1, ColorToARGB(clrBlack));
  ExtGraph.TextAdd(54, 21, text2, ColorToARGB(clrBlack));
  
  // グラフの更新
  ExtGraph.Update();
 }

CurvePlot関数は、渡された配列データをもとにグラフを作成し、指定した色で曲線を描画するためのカスタム関数です。この関数には、x軸とy軸のデータ配列、および曲線の色を指定するための引数が含まれています。

最初に、ExtGraphインスタンスのCreateメソッドを使用してグラフを作成しています。Createメソッドの引数には、ChartID、グラフの名前（”Graphic”）、座標（0, 0）、および幅と高さ（GRAPH_WIDTHとGRAPH_HEIGHT）が指定されています。ChartID関数は、現在のチャートIDを取得する関数で、これにより生成されたグラフは現在のチャートに描画されます。

次に、ExtGraphインスタンスのCurveAddメソッドを使用して、x軸とy軸の配列データをもとに曲線を追加します。CurveAddメソッドの引数には、x_arrayとy_arrayの配列、指定した色をARGB形式に変換するためのColorToARGB関数、そして曲線のスタイル（CURVE_LINES）が渡されています。この処理によって、指定の色とスタイルで曲線が描画されます。

続いて、IndentUpメソッドを使用してグラフの上部に30ピクセル（デジタル画像を構成する最小の単位）の空白を追加しています。これにより、グラフ上に余白が確保され、グラフが画面に適切に配置されるようになります。

その後、CurvePlotAllメソッドを使用して、追加した曲線をグラフに描画しています。

さらに、グラフの操作方法についての説明文を追加しています。text1およびtext2という文字列には、それぞれ「ESCキーでグラフを削除してスクリプトを停止する」「PgDnキーでスクリーンショットを作成してからグラフを削除し、スクリプトを停止する」という内容の説明が含まれています。TextAddメソッドを使って、これらのテキストを画面の指定位置（x=54, y=9 と x=54, y=21）に描画し、説明が表示されるようにしています。

また、色の指定にはColorToARGB関数を使用しています。ColorToARGB関数は、指定された色をARGB（Alpha、Red、Green、Blue）形式に変換し、透過度や色の設定が反映されるようにします。これにより、TextAddメソッドで追加するテキストや曲線が指定の色で正しく表示されます。

最後に、Updateメソッドを呼び出してグラフの描画を更新し、設定したデータやテキストを反映させます。この一連の処理により、x軸とy軸のデータに基づく曲線が描画され、操作の説明が表示されたグラフが完成します。

サンプルコード解説7：MakeAndSaveScreenshot関数（オリジナル関数）部分

//+------------------------------------------------------------------+
//| スクリーンショットを撮り、画像をファイルに保存する                |
//+------------------------------------------------------------------+
bool MakeAndSaveScreenshot(const string file_name)
 {
  string file_names[]; // ファイル名を格納するための配列を初期化
  ResetLastError(); // 最後のエラーをリセット
  
  // ファイル保存用のダイアログを表示し、選択されたファイルを取得
  int selected = FileSelectDialog("Save Picture", NULL, "All files (*.*)|*.*", FSD_WRITE_FILE, file_names, file_name + ".png");
  if (selected < 1)
    {
    // ファイル選択エラーが発生した場合の処理
    if (selected < 0)
        PrintFormat("%s: FileSelectDialog() function returned error %d", __FUNCTION__, GetLastError());
    return false; // エラー時はfalseを返す
    }
 
  bool res = false; // 成功判定の変数
  // 一時的にチャート表示を無効化し、スクリーンショットを撮影
  if (ChartSetInteger(0, CHART_SHOW, false))
    res = ChartScreenShot(0, file_names[0], GRAPH_WIDTH, GRAPH_HEIGHT);
  
  // チャート表示を再度有効に設定
  ChartSetInteger(0, CHART_SHOW, true);
  
  return (res); // スクリーンショットが正常に保存できた場合はtrueを返す
 }

MakeAndSaveScreenshot関数は、スクリーンショットを撮影し、指定したファイル名で保存する機能を持っています。この関数は、ユーザーがPgDnキーを押した際に呼び出され、現在のチャートのスクリーンショットをファイルに保存する手順を実行します。

最初に、file_namesという空の文字列配列を作成しています。これは、ファイル選択ダイアログから選ばれたファイル名を格納するための配列です。また、ResetLastError関数を呼び出してエラー状態をリセットし、後の処理で発生するエラーが過去のエラーと混在しないようにします。

次に、FileSelectDialog関数を使って、ファイルの保存ダイアログを表示します。この関数の最初の引数にはダイアログタイトル（”Save Picture”）、次の引数にNULL、そしてファイルの種類として”All files (.)|.“を指定しています。
この”(.)|.“の形式は、ファイルダイアログでのファイルフィルターを設定するための書式です。
左側の(.)はフィルターの表示名で「すべてのファイル」を示し、右側の.はフィルターの実際の条件を指定しています。
これにより、ダイアログにすべてのファイルを表示するようになります。最後の引数には、デフォルトのファイル名として指定されたfile_nameに拡張子”.png”を追加した文字列を渡しています。FileSelectDialog関数が成功すると、選ばれたファイル名がfile_names配列に格納され、選択数が返されます。

ファイルが選択されなかった場合、またはエラーが発生した場合はfalseを返します。選択にエラーが発生した場合、GetLastError関数で取得したエラーコードをPrintFormat関数でエラーメッセージとして出力します。

スクリーンショットの保存処理では、まずChartSetInteger関数でチャート表示を一時的に非表示にします。引数には、チャート識別子として0、プロパティとしてCHART_SHOW、表示を無効にするためのfalseが指定されています。次に、ChartScreenShot関数を呼び出し、file_names配列の最初の要素に指定されたファイル名で、GRAPH_WIDTHとGRAPH_HEIGHTのサイズでスクリーンショットを保存します。最後にChartSetInteger関数でチャートを再表示します。

関数の戻り値として、スクリーンショットが正常に保存されたかどうかの成否が返されます。

この関数を使ってEAを作る際のアイディア

MathArctanh関数を使用してエキスパートアドバイザー（EA）を作成する場合、双曲線逆正接の特性を活かして以下のようなアイディアが考えられます。

  1. 価格変動の相対的な強さを示すインジケータ作成
    MathArctanh関数の双曲線逆正接は、値が中心に近い範囲でなだらかに変化し、両端（±1）に近づくほど急激に変化する特徴があります。この特性を活かして、価格変動の小さな動きを強調したインジケータを作成できます。例えば、短期間で急激に動いた価格の強さを強調表示し、トレンドの転換点やエントリーポイントの検出に役立てることができます。
  2. リスク管理に基づいたポジションサイズの調整
    ポジションサイズを調整する際に、リスクやボラティリティの強さを双曲線逆正接で計算し、動きの急激な変化に対応するようにサイズを制御することができます。例えば、値が-1に近い場合にはリスクを抑え、0に近づくほどリスクを増やす設計にすることで、リスクとリターンのバランスを取ったトレードが可能です。
  3. 双曲線を用いた複雑な価格パターンの解析
    MathArctanh関数は価格の変動を異なる視点で解析するために使用できます。具体的には、価格の変動データを双曲線変換し、特定のパターンが出現する場面を検出することで、トレンドの発生やその継続を分析することが可能です。この手法は、従来のシンプルな移動平均線やオシレーターに対する補完的なツールとして活用できます。
  4. 相関関係を解析して複数シンボルでのトレード戦略
    MathArctanh関数を活用して複数のシンボル間での双曲線変換値を計算し、その値の相関関係を解析することで、異なるシンボル同士の連動性や逆相関を見つけることができます。特定のシンボル同士が特定の相関関係を示すタイミングでエントリーやエグジットを判断する戦略を構築することが可能です。
  5. テクニカル分析と心理的水準を組み合わせたEA
    MathArctanh関数で得られる逆双曲線正接の特徴を使い、相場の心理的水準を取り入れたEAを作成することも考えられます。価格が心理的な節目に近づくと、取引量が増えやすいことが知られていますが、これを双曲線逆正接を使って表現し、価格が重要な水準に近づいた際にアラートを出したり、取引判断の補助指標として利用することができます。

これらのアイディアを活用することで、MathArctanh関数を利用したEAがより多様で有用な分析を行い、トレード戦略の精度を向上させることが期待できます。

スポンサーリンク
タイトルとURLをコピーしました