coder.ref

参照渡しするデータを示す

ページ内をすべて折りたたむ

構文

coder.ref(arg)
coder.ref(arg,'gpu')

説明

coder.ref(arg) は、arg が外部 C/C++ 関数へ参照渡しする式または変数であることを示します。coder.ref は coder.ceval 呼び出しの内部でのみ使用します。C/C++ 関数は参照渡しされる変数に対して読み取りまたは書き込みできます。関数に参照渡しする引数ごとに、別個の coder.ref 構成を使用します。

coder.rref および coder.wref も参照してください。

例

coder.ref(arg,'gpu') は、arg が GPU の引数であることを示します。このオプションには有効な GPU Coder™ ライセンスが必要です。coder.ceval で CUDA® の GPU 関数 __device__ を呼び出す場合、'gpu' の指定はコード ジェネレーターで無視されます。

例

スカラー変数の参照渡し

入力に 1 を加算した値を返す C 関数 addone について考えます。

double addone(double* p) {
  return *p + 1;
}

C 関数は入力変数 p を double へのポインターとして定義します。

入力を addone へ参照渡しします。

...
y = 0;
u = 42;
y = coder.ceval('addone', coder.ref(u));
...

複数の引数の参照渡し

...
u = 1;
v = 2; 
y = coder.ceval('my_fcn', coder.ref(u), coder.ref(v));
...

クラス プロパティの参照渡し

...
x = myClass;
x.prop = 1;
coder.ceval('foo', coder.ref(x.prop));
...

構造体の参照渡し

構造体型が C ヘッダー ファイルで定義されることを示すには、coder.cstructname を使用します。

C 関数 incr_struct があるとします。この関数は入力引数に対する読み取りと書き込みを行います。

#include "MyStruct.h"

void incr_struct(struct MyStruct *my_struct)
{
  my_struct->f1 =  my_struct->f1 + 1;
  my_struct->f2 =  my_struct->f2 + 1;
}

C ヘッダー ファイル MyStruct.h は MyStruct という名前の構造体型を定義します。

#ifndef MYSTRUCT
#define MYSTRUCT

typedef struct MyStruct
{
    double f1;
    double f2;
} MyStruct;

void incr_struct(struct MyStruct *my_struct);

#endif

MATLAB® 関数で、incr_struct に構造体を参照で渡します。s の構造体型に C ヘッダー ファイル MyStruct.h で定義された名前 MyStruct が付いていることを示すには、coder.cstructname を使用します。

function y = foo
%#codegen
y = 0;
coder.updateBuildInfo('addSourceFiles','incr_struct.c');

s = struct('f1',1,'f2',2);
coder.cstructname(s,'MyStruct','extern','HeaderFile','MyStruct.h');
coder.ceval('incr_struct', coder.ref(s));

スタンドアロンのライブラリ コードを生成するには、以下を入力します。

codegen -config:lib foo -report

構造体フィールドの参照渡し

...
s = struct('s1', struct('a', [0 1]));
coder.ceval('foo', coder.ref(s.s1.a));
...

構造体の配列の要素を渡すこともできます。

...
c = repmat(struct('u',magic(2)),1,10);
b = repmat(struct('c',c),3,6);
a = struct('b',b);
coder.ceval('foo', coder.ref(a.b(3,4).c(2).u));
...

入力引数

すべて折りたたむ

外部 C/C++ 関数に参照渡しする引数。引数をクラス、System object™、cell 配列、cell 配列へのインデックスにすることはできません。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | struct
複素数のサポート: あり

制限

  • 次のデータ型を参照で渡すことはできません。

    • クラスまたは System object

    • cell 配列または cell 配列へのインデックス

  • プロパティに get メソッド、set メソッド、または検証関数がある場合、またはプロパティが特定の属性をもつ System object プロパティである場合、そのプロパティを外部関数に参照で渡すことはできません。一部のプロパティでサポートされない参照渡しを参照してください。

  • MATLAB コードで初期化されている配列のサイズは、coder.ref を使用して変更できません。

ヒント

  • arg が配列の場合、coder.ref(arg) は配列の最初の要素のアドレスを提供します。関数 coder.ref(arg) に、配列のサイズに関する情報は含まれません。C 関数がデータの要素数を把握しなければならない場合、その情報を別の引数として渡します。以下に例を示します。

    coder.ceval('myFun',coder.ref(arg),int32(numel(arg));

  • 外部 C/C++ 関数に構造体を参照渡しする場合、coder.cstructname を使用して C ヘッダー ファイルで定義される C 構造体型の名前を指定します。

  • MATLAB では、coder.ref はエラーになります。MATLAB コードをパラメーター化して MATLAB と生成されたコード内で実行できるようにするには、coder.target を使用します。

  • coder.opaque を使用して、外部 C/C++ 関数との間で受け渡す変数を宣言できます。

拡張機能

すべて展開する

C/C++ コード生成
MATLAB® Coder™ を使用して C および C++ コードを生成します。

GPU コード生成
GPU Coder™ を使用して NVIDIA® GPU のための CUDA® コードを生成します。

バージョン履歴

R2011a で導入

参考

| | | | |

トピック