C++ ライブラリに対する MATLAB インターフェイスのヘルプの表示

インターフェイスのメンバーに関する情報を表示するには、以下の MATLAB^® 関数を使用します。

doc および help — パッケージ内のクラスと関数を表示します。インターフェイスをパブリッシュするときに、説明テキストを追加できます。詳細については、C++ ライブラリに対する MATLAB インターフェイスのヘルプテキストのパブリッシュを参照してください。
methods — クラスのコンストラクター、メソッドおよびパッケージ関数の名前を表示します。
'-full' オプションを指定した methods — コンストラクター、メソッドおよびパッケージ関数のシグネチャを表示します。
methodsview — メソッドシグネチャのテーブル表現。methodsview ウィンドウは、情報の検索にコマンドウィンドウをスクロールする必要がないため、リファレンスガイドとしてより使いやすいかもしれません。

関数とメソッドの既定の引数のヘルプ

C++ 関数が既定の引数で定義されている場合は、1 つ以上の後続の引数を指定することなく関数を呼び出すことができます。関数のヘルプで既定値が示されます。たとえば、arg の型が double で、その既定値が 100 の場合は、ヘルプでは以下のように表示されます。

clib.libname.funcname(arg)
    Input Arguments
      arg             double = 100

関数とメソッドの配列サイズのヘルプ

関数またはメソッドが clib 配列または MATLAB 配列を取る場合、生成されるヘルプテキストに引数のサイズと型の情報が表示されます。たとえば、パブリッシャーが関数の C++ シグネチャを次のように定義したとします。

unsigned int const * fixedMultiFunc(unsigned int [2][3][4] in)

ライブラリインターフェイス demo の fixedMultiFunc のヘルプは次のようになります。

clib.demo.fixedMultiFunc Representation of C++ function fixedMultiFunc. 
RetVal=clib.demo.fixedMultiFunc(in) 

     Input Arguments 
      in             2x3x4 clib.array.demo.UnsignedInt   

     Output Arguments 
      RetVal         4 element vector read-only clib.array.demo.UnsignedInt

引数 in と RetVal は、どちらも UnsignedInt 型の clib 配列です。in 配列のサイズは 2x3x4 です。RetVal は 4 要素の固定サイズの clib ベクトルです。また、RetVal は読み取り専用です。

関数とメソッドの入出力引数のヘルプテキストは次の形式になります。

Input/Output Arguments 
  argname   dimension read-only null argtype

argname は引数の名前です。
dimension のヘルプテキストには、引数のサイズが記述されます。詳細については、次の表を参照してください。
配列が const の場合、ヘルプに read-only というテキストが表示されます。
配列が null の場合、ヘルプに null というテキストが表示されます。
argtype のテキストには、clib 配列の場合は clib.array.libname.type、MATLAB 配列の場合は mltype が表示されます。ここで、libname はインターフェイスライブラリ名、type は C++ 型、mltype は MATLAB 型です。

`dimension` のヘルプテキスト	サイズの記述
`n1x...xnN`	`N` 次元の配列に対する固定サイズの多次元 clib 配列。`n1,…,nN` は各次元のサイズを表します。
`n-D array`	可変サイズの多次元 clib 配列。
`nxm`	固定サイズの clib 行列。`n` と `m` は行列の列数と行数を表します。
`nxN` `Nxn`	可変サイズの clib 行列。`n` は行列の列数または行数、`N` は次元の可変の要素数を表します。
`matrix`	可変サイズの clib 行列。行列のどちらの次元も可変です。
`n element`	固定サイズの clib ベクトル。`n` はベクトルの固定の要素数を表します。
`vector`	可変サイズの clib ベクトル。
`n1x...xnN`	`N` 次元の配列に対する固定サイズの MATLAB 配列。`n1,…,nN` は各次元のサイズを表します。
`nxN` `Nxn`	可変サイズの MATLAB 配列。`n` は行列の列数または行数、`N` は次元の可変の要素数を表します。

`school` ライブラリに対するインターフェイスのヘルプの表示

school インターフェイスをヘッダー専用の HPP ファイルの例で作成した場合は、この例でそれを使用できます。現在のフォルダーにファイル schoolInterface.dll を配置して、次を入力します。

addpath('.')

クラスとパッケージ関数を表示します。

doc clib.school.

次に、Tab キーを押します。このコマンドはパッケージを読み込みます。MATLAB はメンバーのリストを表示します。このパッケージを表示するには、Backspace キーを押してピリオドを削除してから、Enter キーを押します。MATLAB は以下を表示します。

Classes contained in clib.school:
Person            - clib.school.Person    Representation of C++ class Person
Teacher           - clib.school.Teacher    Representation of C++ class Teacher
Student           - clib.school.Student    Representation of C++ class Student

Functions contained in clib.school:
getName           - clib.school.getName    Representation of C++ function getName

getName パッケージ関数の入出力を表示するには、getName リンクをクリックします。

clib.school.getName    Representation of C++ function getName
  Input Arguments
    p              clib.school.Person
  Output Arguments
    RetVal         string

クラスメソッドを表示するには、各クラスの関数 methods を呼び出します。たとえば、次のように入力します。

methods clib.school.Person

Methods for class clib.school.Person:

Person   eq       ge       getAge   getName  gt       le       lt       ne       setAge   setName  

Methods of clib.school.Person inherited from handle.

関数シグネチャを表示するには、各クラスの関数 methodsview を呼び出します。たとえば、次のように入力します。

methodsview clib.school.Person

関数によってウィンドウが開き、メソッドと、引数および戻り値に関する情報が表示されます。たとえば、コンストラクターのシグネチャは次のとおりです。

名前	戻り値の型	引数
`Person`	`clib.school.Person obj`	`(clib.school.Person input1)`
`Person`	`clib.school.Person obj`	`(name, uint64 scalar age)`
`Person`	`clib.school.Person obj`

参考

doc | methods | methodsview