coder.PrimitiveType クラス

パッケージ: coder
スーパークラス: coder.ArrayType

論理値、数値または文字の配列のセットを表す

説明

生成されたコードが受け入れる logical 値、数値または文字の値のセットを指定します。サポートされているクラスは、half、double、single、int8、uint8、int16、uint16、int32、uint32、int64、uint64、char、および logical です。codegen -args オプションでのみ使用します。生成された MEX 関数に入力として渡さないでください。

構築

メモ

coder.Type オブジェクトの作成と編集は、コード生成の型エディターを使用して対話形式で行うこともできます。コード生成の型エディターを使用した入力の型の作成と編集を参照してください。

t=coder.typeof(v) では、v を含む最小の非定数型を表す coder.PrimitiveType オブジェクトが作成されます。v は MATLAB^® の数値、logical、または char でなければなりません。

t=coder.typeof(v, sz, variable_dims) では、sz で指定された上限のサイズと、可変の次元 variable_dims をもつ coder.typeof(v) の変更されたコピーが返されます。sz で次元に inf を指定する場合は、次元のサイズは無限で、次元は可変サイズとみなされます。sz が [] の場合は、v の上限のサイズは変化しません。variable_dims を指定しない場合は、制限のない次元を除き、この型の次元は固定とみなされます。variable_dims がスカラーの場合は、1 または 0 (固定とみなされる) ではない制限付き次元に適用されます。

t=coder.newtype(numeric_class, sz, variable_dims) では、上限サイズ sz と可変次元 variable_dims をもつ numeric_class クラスの値を表す coder.PrimitiveType オブジェクトが作成されます。sz で次元に inf を指定する場合は、次元のサイズは無限で、次元は可変サイズとみなされます。variable_dims を指定しない場合は、制限のない次元を除き、この型の次元は固定とみなされます。variable_dims がスカラーの場合は、1 または 0 (固定とみなされる) ではない型の次元に適用されます。

t=coder.newtype(numeric_class, sz, variable_dims, Name, Value) で作成される coder.PrimitiveType オブジェクトには、1 つ以上の名前と値のペアの引数で指定された追加オプションがあります。また、Name がプロパティ名、Value がその対応する値とすることもできます。Name を文字ベクトルまたは string スカラーとして指定します。Name1,Value1,…,NameN,ValueN のように、複数の名前/値の引数ペアを任意の順番で指定できます。

入力引数

`v`	`coder.Type` オブジェクトではない入力
`sz`	型オブジェクトの対応する次元のサイズサイズは有効なサイズのベクトルでなければなりません。既定値: `coder.newtype` に対して [1 1]
`variable_dims`	各次元のサイズが可変 (true) か、固定 (false) かを指定する logical ベクトル。既定値: `coder.newtype` に対して false(size(sz)) \| sz==Inf
`numeric_class`	型オブジェクトのクラス。

名前と値の引数

引数のオプションのペアを Name1=Value1,...,NameN=ValueN として指定します。Name は引数名、Value は対応する値です。名前と値の引数は他の引数の後に表示されなければなりませんが、ペアの順序は重要ではありません。

R2021a より前は、名前と値をそれぞれコンマを使って区切り、Name を引用符で囲みます。

complex

complex を true に設定すると、複素数値を表せる coder.PrimitiveType オブジェクトを作成できます。データ型で複素数がサポートされていなければなりません。

文字配列では複素数データはサポートされません。

既定値: false

sparse

sparse を true に設定すると、スパースデータを表す coder.PrimitiveType オブジェクトを作成できます。データ型でスパースデータがサポートされていなければなりません。

文字データ型および半精度データ型ではスパースデータはサポートされません。

既定値: false

gpu

gpu を true に設定すると、GPU 入力型を表せる coder.PrimitiveType オブジェクトを作成できます。このオプションには有効な GPU Coder™ ライセンスが必要です。

文字データ型および半精度データ型では GPU 配列はサポートされません。

既定値: false

プロパティ

`ClassName`	このセットの値のクラス。
`Complex`	このセット内の値が実数 (`false`) か複素数 (`true`) かを示します。
`SizeVector`	このセットの配列のサイズの上限。
`Sparse`	このセット内の値がスパース配列 (`true`) かどうかを示します。
`VariableDims`	配列の各次元のサイズが固定か可変かを指定するのに使用するベクトル。ベクトルの要素が `true` の場合、対応する次元のサイズは可変です。

コピーのセマンティクス

値。値クラスがコピー操作に与える影響については、オブジェクトのコピーを参照してください。

例

coder.PrimitiveType オブジェクトを作成します。

z = coder.typeof(0,[2 3 4],[1 1 0]) % returns double :2x:3x4
% ':' indicates variable-size dimensions

coder.PrimitiveType オブジェクトを作成し、次に codegen を呼び出して、この型の入力パラメーターを 1 つもつ関数 fcn.m のための C ライブラリを生成します。

coder.PrimitiveType オブジェクトを作成します。

z = coder.typeof(0,[2 3 4],[1 1 0]) % returns double :2x:3x4
% ':' indicates variable-size dimensions

codegen を呼び出して、z 型の入力パラメーターを 1 つもつ MATLAB 関数 fcn.m のための C ライブラリを生成します。
```
% Use the config:lib option to generate a C library
codegen -config:lib fcn -args {z}
```

バージョン履歴

R2011a で導入

参考

トピック

コード生成の型エディターを使用した入力の型の作成と編集