Python からの MATLAB 関数のヘルプの取得

MATLAB ヘルプの見つけ方

Python^® からすべての MATLAB^® 関数に対応するドキュメンテーションにアクセスできます。このドキュメンテーションでは、例、入力引数、出力引数、それに各関数の呼び出し構文が説明されています。

Python 用 MATLAB エンジン API を使用すると、MATLAB 関数 doc および関数 help を使用できます。doc を使用して、システムの Web ブラウザーで MathWorks^® ドキュメンテーションを開きます。help を使用して Python プロンプトで MATLAB 関数の簡単な説明を取得します。

Python から MathWorks ドキュメンテーションを開く

Python から MATLAB 関数のリファレンスページを開き、ドキュメンテーションを検索できます。

たとえば、MATLAB 関数 plot のリファレンスページを開きます (doc は出力引数を返さないため、nargout=0 を設定しなければなりません)。

import matlab.engine
eng = matlab.engine.start_matlab()
eng.doc("plot",nargout=0)

リファレンスページには、関数、例、関連ドキュメンテーションへのリンクが含まれています。

メモ

MATLAB リファレンスページで例が表示されない場合は、例のタイトルまたはタイトルの横にある矢印をクリックします。例は、ページ内で折り畳みや展開ができます。

位置引数を指定しないで eng.doc を呼び出すと、ドキュメンテーションのホームページが開きます。(それでもキーワード引数 nargout=0 を設定する必要があります)。

eng.doc(nargout=0)

MATLAB ドキュメンテーションを検索するには、ドキュメンテーションのページ上部にある検索ボックスに語句を入力します。ブラウザーに検索結果のリストが返され、その語句に一致するワードが強調表示して示されます。

またドキュメンテーションは関数 docsearch を使用して検索することもできます。たとえば、plot を説明するページを検索します。

eng.docsearch("plot",nargout=0)

Python プロンプトに MATLAB ヘルプを表示

Python プロンプトに関数のヘルプテキストを表示するには、MATLAB 関数 help を呼び出します。たとえば、erf のヘルプテキストを表示します。

import matlab.engine
eng = matlab.engine.start_matlab()
eng.help("erf",nargout=0)

 ERF Error function.
    This MATLAB function returns the Error Function evaluated for each
    element of x.

    Syntax
      erf(x)

    Input Arguments
      x - Input
        real number | vector of real numbers | matrix of real numbers |
        multidimensional array of real numbers

    Examples
      Find Error Function
      Find Cumulative Distribution Function of Normal Distribution
      Calculate Solution of Heat Equation with Initial Condition

    See also erfc, erfcinv, erfcx, erfinv

    Introduced in MATLAB before R2006a
    Documentation for erf
    Other uses of erf

出力にヘルプテキストが表示されますが、説明されている可能性のある他の MATLAB 関数のヘルプへのリンクは含まれていません。