Main Content

ssGetDataTypeTotalSlope

登録されたデータ型のスケーリングの総勾配を返す

構文

extern double ssGetDataTypeTotalSlope (SimStruct *S, DTypeId
                                       dataTypeId)

引数

S

S-Function ブロックを表す SimStruct。

dataTypeId

総勾配を調べるための登録されたデータ型のデータ型 ID。

説明

固定小数点数は以下のように表現することができます。

real-world value = (slope × integer) + bias

この場合、勾配は次のように表現できます。

slope = fractional slope × 2exponent

この関数は、dataTypeId で指定されたデータ型の小数部の勾配ではなく、総勾配を返します。小数部の勾配を取得する場合は、関数 ssGetDataTypeFracSlope を使用してください。

  • double データ型や single データ型など、登録されたデータ型が自明のスケーリングをもつ場合、関数は 1 の総勾配を返します。

  • 登録されたデータ型が ScaledDouble である場合、関数はオーバーライドされていないデータ型の総勾配を返します。次の例を参照してください。

この関数は、関数 ssGetDataTypeIsFxpFltApiCompat が FALSE を返すとエラーを発生します。

必要条件

この関数を使用するには、fixedpoint.h および fixedpoint.c をインクルードしなければなりません。詳細は、S-Function の構造を参照してください。

言語

C

例

データ型 sfix32_En4 は、データ型オーバーライドをもつ flts32_En4 になります。この関数で返される総勾配はいずれの場合も 0.0625 (2-4) です。

データ型 ufix16_s7p98 は、データ型オーバーライドをもつ fltu16_s7p98 になります。この関数で返される総勾配はいずれの場合も 7.98 です。

TLC 関数

FixPt_DataTypeTotalSlope

バージョン履歴

R2006a より前に導入