fipref

固定小数点基本設定の指定

構文

P = fipref

P = fipref(Name,Value)

説明

P = fipref は既定の fipref オブジェクトを作成します。fipref オブジェクトはすべての fi オブジェクトに対する表示とログ作成の属性を定義します。

P = fipref(Name,Value) は、Name,Value のペアで指定されたプロパティをもつ fipref オブジェクトを作成します。

この fipref 設定は MATLAB^® セッション全体を通じて維持されます。セッション中に既定の設定に戻すには、reset(fipref) を使用します。後続の MATLAB セッション用に表示基本設定を保存するには、savefipref を使用します。

例

既定の fipref オブジェクトの作成

P = fipref

P = 
         NumberDisplay: 'RealWorldValue'
    NumericTypeDisplay: 'full'
         FimathDisplay: 'full'
           LoggingMode: 'Off'
      DataTypeOverride: 'ForceOff'

オブジェクト作成時の fipref プロパティの設定

コンストラクター関数 fipref の引数の後にプロパティを含めることにより、オブジェクト作成時に fipref オブジェクトのプロパティを設定できます。たとえば、NumberDisplay を bin に、NumericTypeDisplay を short に設定するには次のようにします。

P = fipref('NumberDisplay','bin','NumericTypeDisplay','short')

P = 
         NumberDisplay: 'bin'
    NumericTypeDisplay: 'short'
         FimathDisplay: 'full'
           LoggingMode: 'Off'
      DataTypeOverride: 'ForceOff'

入力引数

名前と値の引数

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

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

例: P = fipref('NumberDisplay','RealWorldValue','NumericTypeDisplay','short');

データ型オーバーライドのプロパティ

DataTypeOverride — データ型オーバーライドのオプション

'ForceOff' (既定値) | 'ScaledDoubles' | 'TrueDoubles' | 'TrueSingles'

fi オブジェクトのデータ型オーバーライドのオプション。'DataTypeOverride' と次の値のいずれかで構成されるコンマ区切りのペアとして指定します。

• 'ForceOff' — データ型をオーバーライドしません。

• 'ScaledDoubles' — スケーリングされた double でオーバーライドします。

• 'TrueDoubles' — double でオーバーライドします。

• 'TrueSingles' — single でオーバーライドします。

コンストラクター関数 fi が呼び出される場合にのみ、データ型オーバーライドが発生します。

データ型: char

DataTypeOverrideAppliesTo — データ型オーバーライド設定の適用方法

'AllNumericTypes' (既定値) | 'Fixed-Point' | 'Floating-Point'

fi オブジェクトに対するデータ型オーバーライド設定の適用方法。'DataTypeOverrideAppliesTo' と次の値のいずれかで構成されるコンマ区切りのペアとして指定します。

• 'AllNumericTypes' — すべての fi データ型にデータ型オーバーライドを適用します。この設定では組み込み整数型はオーバーライドしません。

• 'Fixed-Point' — 固定小数点データ型にのみデータ型オーバーライドを適用します。

• 'Floating-Point' — 浮動小数点の fi データ型にのみデータ型オーバーライドを適用します。

DataTypeOverrideAppliesTo は、DataTypeOverride が ForceOff に設定されている場合にのみ表示されます。

データ型: char

表示プロパティ

FimathDisplay — fi オブジェクトのローカルな fimath 属性の表示オプション

'full' (既定値) | 'none'

fi オブジェクトのローカルな fimath 属性の表示オプション。'FimathDisplay' と次の値のいずれかで構成されるコンマ区切りのペアとして指定します。

• 'full' — 固定小数点オブジェクトのすべての fimath 属性を表示します。

• 'none' — fimath 属性を表示しません。

データ型: char

NumberDisplay — fi オブジェクトの値のオプションを表示します。

'RealWorldValue' (既定値) | 'bin' | 'dec' | 'hex' | 'int' | 'none'

fi オブジェクトの値の表示オプション。'NumberDisplay' と次の値のいずれかで構成されるコンマ区切りのペアとして指定します。

• 'bin' — 格納された整数値を 2 進形式で表示します。

• 'dec' — 格納された整数値を符号なし 10 進形式で表示します。

• 'RealWorldValue' — 格納された整数値を、MATLAB 関数 format で指定された形式で表示します。

  rat 形式の fi オブジェクトは、次に従って表示されます。

  $$\frac{1}{\left(2^{fixed-pointexponent}\right)}\times storedinteger$$

• 'hex' — 格納された整数値を 16 進数形式で表示します。

• 'int' — 格納された整数値を符号付き 10 進形式で表示します。

• 'none' — 値を表示しません。

fipref オブジェクトを変更しても格納された整数値は変わりません。fipref オブジェクトは表示にのみ影響します。

データ型: char

NumericTypeDisplay — fi オブジェクトの numerictype 属性のオプションを表示します。

'full' (既定値) | 'none' | 'short'

fi オブジェクトの numerictype 属性の表示オプション。'NumericTypeDisplay' と次の値のいずれかで構成されるコンマ区切りのペアとして指定します。

• 'full' — fi オブジェクトのすべての numerictype 属性を表示します。

• 'none' — numerictype 属性を表示しません。

• 'short' — numerictype コンストラクターの省略表記を使用して fi オブジェクトの numerictype 属性を表示します。

データ型: char

ログのプロパティ

LoggingMode — fi オブジェクトで実行される演算のログ オプション。

'off' (既定値) | 'on'

fi オブジェクトで実行される演算のログ オプション。'LoggingMode' と次の値のいずれかで構成されるコンマ区切りのペアとして指定します。

• 'off' — ログを作成しません。

• 'on' — 今後の演算のために情報のログが作成されます。

LoggingMode が on に設定されている場合、代入、プラス、マイナス、および乗算の操作に関するオーバーフローおよびアンダーフローのログが警告として作成されます。

LoggingMode が on である場合、次の関数を使用し、代入および作成の演算に関するログ情報を MATLAB コマンド ラインに返すこともできます。

• maxlog — 最大の実際値を返す

• minlog — 最小値を返す

• noverflows — オーバーフローの数を返す

• nunderflows — アンダーフローの数を返す

演算情報のログを作成するには、演算を行う前に LoggingMode を on に設定しておかなければなりません。ログを消去するには、関数 resetlog を使用します。

データ型: char

バージョン履歴

R2006a より前に導入

参考

fi | fimath | numerictype | quantizer | savefipref