ssGetDataTypeBias

Return bias of registered data type

Syntax

extern double ssGetDataTypeBias(SimStruct *S, DTypeId
                                dataTypeId)

Arguments

S

SimStruct representing an S-function block.

dataTypeId

Data type ID of the registered data type for which you want to know the bias.

Description

Fixed-point numbers can be represented as

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

This function returns the bias of a registered data type:

• For both trivial scaling and power-of-two scaling, 0 is returned.

• If the registered data type is ScaledDouble, the bias returned is that of the nonoverridden data type.

This function errors out when ssGetDataTypeIsFxpFltApiCompat returns FALSE.

Requirements

• To use this function, you must include fixedpoint.h and fixedpoint.c. For more information, see Structure of the S-Function.

• To build an S-function that utilizes this function, you must compile it using the mex function with -lfixedpoint argument. For more information, see Create MEX Files.

Languages

C

TLC Functions

FixPt_DataTypeBias