C 共有ライブラリの呼び出し

MATLAB^® Compiler SDK™ で生成された 1 つ以上の C 共有ライブラリを C アプリケーションで使用するには、次のようにします。

生成された各ライブラリのヘッダーファイルをアプリケーションに含めます。
生成された各共有ライブラリに libname.h という名前のヘッダーファイルが関連付けられています。
mclmcrInitialize を呼び出して MATLAB Runtime プロキシ層を初期化します。
MATLAB で生成された共有ライブラリを使用するドライバーコードで、mclRunMain を使用して C 関数を呼び出します。
mclRunMain() は、共有ライブラリの MATLAB コードの実行をラップする便利なクロスプラットフォームのメカニズムを提供します。
注意
Mac では、アプリケーション自体で完全なグラフィカル環境を立ち上げる場合は mclRunMain() を使用しないでください。
変数を定義し、入力引数を処理します。
関数 mclInitializeApplication を呼び出して MATLAB Runtime を初期化します。この関数は、グローバルな MATLAB Runtime の状態を設定し、MATLAB Runtime インスタンスの構成を可能にします。
関数 mclInitializeApplication() はアプリケーションごとに 1 回呼び出します。他のいずれの MATLAB API 関数よりも前に呼び出す必要があります。この関数には、アプリケーションレベルのオプションを渡すことができます。mclInitializeApplication() は boolean のステータスコードを返します。
注意
mclInitializeApplication を呼び出す前にドライバーアプリケーションから cd コマンドを発行することは避けてください。そうしないと、MATLAB Runtime の初期化に失敗することがあります。
アプリケーションに含める各 C 共有ライブラリについて、ライブラリの初期化関数を呼び出します。
初期化関数は、ライブラリのローカルの初期化を実行します。デプロイ可能なアーカイブをアンパックし、そのアーカイブのコードを実行するために必要な情報を使用して MATLAB Runtime インスタンスを開始します。ライブラリの初期化関数の名前は libnameInitialize() です。この関数は boolean のステータスコードを返します。
メモ:
Windows^® では、共有ライブラリにより MATLAB 共有ライブラリを呼び出す場合、DllMain(DLL_ATTACH_PROCESS) の呼び出しで共有ライブラリから MATLAB ライブラリ初期化関数 (たとえば、<libname>Initialize, <libname>Terminate, mclInitialize, mclTerminate) を呼び出すことはできません。これは、中間共有ライブラリを暗黙的に読み込む場合にも明示的に読み込む場合にも当てはまります。この呼び出しは DllMain() の後に配置してください。
ライブラリの関数を呼び出し、結果を処理します。(これがプログラムの本体です。)
メモ:
ドライバーアプリケーションで MATLAB Figure ウィンドウを表示する場合は、次の 2 つの手順で関数 Terminate および mclTerminateApplication を呼び出す前に、mclWaitForFiguresToDie の呼び出しを含めます。
アプリケーションで特定のライブラリが不要になった場合は、そのライブラリの終了関数を呼び出します。
終了関数は、ライブラリの MATLAB Runtime インスタンスに関連付けられているリソースを解放します。ライブラリの終了関数の名前は libnameTerminate() です。ライブラリを終了すると、そのライブラリによってエクスポートされた関数をアプリケーション内に再度呼び出すことはできなくなります。

注意
<lib>Terminate の呼び出しの後に <lib>Initialize の呼び出しを発行すると (ライブラリが同じ場合も同じでない場合も同様)、予期しない結果になることがあります。
アプリケーションでいずれの共有ライブラリも呼び出す必要がなくなった場合は、API 関数 mclTerminateApplication を呼び出します。
この関数は、MATLAB Runtime で使用されるアプリケーションレベルのリソースを解放します。この関数を呼び出すと、アプリケーションで共有ライブラリの呼び出しをそれ以上できなくなります。
変数をクリーンアップし、ファイルを閉じて終了します。

次の matrix.c の例は、上記のすべての手順を示しています。

/*=================================================================
 *
 * MATRIX.C Sample driver code that calls a shared library created
 *          using MATLAB Compiler SDK. Refer to the MATLAB Compiler 
 *          SDK documentation for more information.
 *
 * Copyright 1984-2017 The MathWorks, Inc.
 *
 *=================================================================*/

#include <stdio.h>

/* Include the MATLAB Runtime header file and the library specific header file 
 * as generated by MATLAB Compiler SDK. */
#include "libmatrix.h"

/* This function is used to display a double matrix stored in an mxArray */
void display(const mxArray* in);

int run_main(int argc, const char **argv)
{
    mxArray *in1, *in2; /* Define input parameters */
    mxArray *out = NULL;/* and output parameters to be passed to the library functions */
    
    double data[] = {1,2,3,4,5,6,7,8,9};
    
    /* Create the input data */
    in1 = mxCreateDoubleMatrix(3,3,mxREAL);
    in2 = mxCreateDoubleMatrix(3,3,mxREAL);
    memcpy(mxGetPr(in1), data, 9*sizeof(double));
    memcpy(mxGetPr(in2), data, 9*sizeof(double));
    
    /* Call the library initialization routine and make sure that the
     * library was initialized properly. */
    if (!libmatrixInitialize()){
        fprintf(stderr,"Could not initialize the library.\n");
        return -2;
    }
    else
    {
        /* Call the library function */
        mlfAddmatrix(1, &out, in1, in2);
        /* Display the return value of the library function */
        printf("The sum of the matrix with itself is:\n");
        display(out);
        /* Destroy the return value since this variable will be reused in
         * the next function call. Since we are going to reuse the variable,
         * we must set it to NULL. Refer to MATLAB Compiler SDK documentation
         * for more information. */
        mxDestroyArray(out); 
        out=0;
        mlfMultiplymatrix(1, &out, in1, in2);
        printf("The product of the matrix with itself is:\n");
        display(out);
        mxDestroyArray(out); 
        out=0;
        mlfEigmatrix(1, &out, in1);
        printf("The eigenvalues of the original matrix are:\n");
        display(out);
        mxDestroyArray(out); 
        out=0;
        
        /* Call the library termination routine */
        libmatrixTerminate();
        
        /* Free the memory created */
        mxDestroyArray(in1); 
        in1=0;
        mxDestroyArray(in2); 
        in2=0;
    }

    /* Note that you should call mclTerminateApplication at the end of
     * your application.
     */
    mclTerminateApplication();
    return 0;
}


/*DISPLAY This function will display the double matrix stored in an mxArray.
 * This function assumes that the mxArray passed as input contains double
 * array.
 */
void display(const mxArray* in)
{
    size_t i=0, j=0; /* loop index variables */
    size_t r=0, c=0; /* variables to store the row and column length of the matrix */
    double *data; /* variable to point to the double data stored within the mxArray */

    /* Get the size of the matrix */
    r = mxGetM(in);
    c = mxGetN(in);
    /* Get a pointer to the double data in mxArray */
    data = mxGetPr(in);
    
    /* Loop through the data and display it in matrix format */
    for( i = 0; i < c; i++ )
    {
        for( j = 0; j < r; j++)
        {
            printf("%4.2f\t",data[j*c+i]);
        }
        printf("\n");
    }
    printf("\n");
}

int main(int argc, const char ** argv)
{
    /* Call the mclInitializeApplication routine. Make sure that the application
     * was initialized properly by checking the return status. This initialization
     * has to be done before calling any MATLAB APIs or MATLAB Compiler SDK
     * generated shared library functions.  */
    if( !mclInitializeApplication(NULL,0) )
    {
        fprintf(stderr, "Could not initialize the application.\n");
        return -1;
    }
    return mclRunMain((mclMainFcnType)run_main, argc, argv);
}

MATLAB 関数 `loadlibrary` を使用する際の制限

MATLAB Compiler SDK でビルドされた C 共有ライブラリを MATLAB で MATLAB 関数 loadlibrary を使用して読み込むことはできません。

loadlibrary の使用の詳細については、デプロイアプリケーションでの共有ライブラリの呼び出しを参照してください。

参考

mclmcrInitialize | mclRunMain | mclInitializeApplication | mclTerminateApplication | mclWaitForFiguresToDie

C 共有ライブラリの呼び出し

MATLAB 関数 loadlibrary を使用する際の制限

参考

関連するトピック

MATLAB 関数 `loadlibrary` を使用する際の制限