coder.FiType クラス

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

MATLAB 固定小数点配列のセットを表す

説明

生成されたコードが受け入れる固定小数点配列の値のセットを指定します。codegen -args オプションでのみ使用します。生成された MEX 関数に入力として渡さないでください。

構築

メモ

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

t=coder.typeof(v) では、固定小数点入力 v に基づくプロパティをもつ固定小数点値のセットを表す coder.FiType オブジェクトが作成されます。

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('embedded.fi', numerictype, sz, variable_dims) では、numerictype と上限サイズ sz および可変の次元 variable_dims をもつ固定小数点値のセットを表す coder.Type オブジェクトが作成されます。sz で次元に inf を指定する場合は、次元のサイズは無限で、次元は可変サイズです。variable_dims を指定しないと、この型の制限付き次元は固定になります。variable_dims がスカラーの場合は、1 または 0 (固定) ではない制限付き次元に適用されます。

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

入力引数

v

新しい coder.FiType オブジェクトの作成に使用される固定小数点値。

sz

型オブジェクトの各次元を指定するサイズベクトル。

既定値: coder.newtype に対して [1 1]

variable_dims

各次元のサイズが可変 (true) か、固定 (false) かを指定する logical ベクトル。

既定値: coder.newtype に対して false(size(sz)) | sz ==Inf

名前と値の引数

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

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

complex

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

既定値: false

fimath

ローカル fimath を指定します。指定しない場合、既定の fimath が使用されます。

プロパティ

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

コピーのセマンティクス

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

例

新しい固定小数点データ型 t を作成します。

t = coder.typeof(fi(1));
% Returns
% coder.FiType
%   1x1 embedded.fi
%       DataTypeMode:Fixed-point: binary point scaling
%         Signedness:Signed
%         WordLength:16
%     FractionLength:14

コード生成で使用する新しい固定小数点データ型を作成します。固定小数点データ型では既定の fimath が使用されます。

t = coder.newtype('embedded.fi',numerictype(1, 16, 15), [1 2])

t = 
% Returns
% coder.FiType
%   1x2 embedded.fi 
%          DataTypeMode: Fixed-point: binary point scaling
%          Signedness: Signed
%          WordLength: 16
%          FractionLength: 15

この新しいデータ型では既定の fimath が使用されます。

バージョン履歴

R2011a で導入

参考

トピック

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