Main Content

coder.descriptor.types.Fixed Class

Namespace: coder.descriptor.types
Superclasses: coder.descriptor.types.Numeric

Return information about variable of fixed-point type

Since R2024a

Description

An object of the coder.descriptor.types.Fixed class describes a variable in the generated code that is of a fixed-point type.

Properties

expand all

Identifier of the data type used in generated code for the corresponding modeling element, specified as a character vector.

Data Types: char

Name of the data type that is represented in Simulink for the corresponding modeling element, specified as a character vector.

Data Types: char

Indication that the type qualifier contains const, specified as a numeric or logical 1 (true) or 0 (false). If you cannot change the value of the variable during execution, the variable is preceded by the const keyword as the type qualifier in the generated code.

  • 1 — The type qualifier contains const.

  • 0 — The type qualifier does not contain const.

Data Types: logical

Indication that the type qualifier contains volatile, specified as a numeric or logical 1 (true) or 0 (false). If the compiler cannot apply optimizations to the variable because its value can change due to external sources, the variable is preceded by the volatile keyword as the type qualifier in the generated code.

  • 1 — The type qualifier contains volatile.

  • 0 — The type qualifier does not contain volatile.

Data Types: logical

Word size of a numeric data type, specified as an integer number of bits.

Data Types: int32

Indication that the data type is signed, specified as a numeric or logical 1 (true) if signed or 0 (false) if unsigned.

Data Types: logical

Bias of the scaling, specified as a double.

The slope and the bias determine the scaling of a fixed-point number.

Data Types: double

Data type name and scaling mode, specified as a character vector with one of these values:

  • 'Fixed-point: binary point scaling' – Fixed-point data type and scaling defined by the word length and fraction length

  • 'Fixed-point: slope and bias scaling' – Fixed-point data type and scaling defined by the slope and bias

  • 'Fixed-point: unspecified scaling' – Fixed-point data type with unspecified scaling

  • 'Scaled double: binary point scaling' – Double data type with fixed-point word length and fraction length information retained

  • 'Scaled double: slope and bias scaling' – Double data type with fixed-point slope and bias information retained

  • 'Scaled double: unspecified scaling' – Double data type with unspecified fixed-point scaling

  • 'Double' – Built-in double

  • 'Single' – Built-in single

  • 'Half' – MATLAB® half-precision data type

  • 'Boolean' – Built-in boolean

This value is derived from the slope and bias values.

Scaling of the data type, represented as a character vector with one of these values:

  • 'BinaryPoint' – Scaling for the numerictype object is defined by the fraction length.

  • 'SlopeBias' – Scaling for the numerictype object is defined by the slope and bias.

  • 'Unspecified' – Temporary setting that is only available at numerictype object creation, and allows for the automatic assignment of a best-precision binary point scaling.

Slope of the scaling, specified as a double.

The slope and the bias determine the scaling of a fixed-point number.

Data Types: double

Slope adjustment factor of a slope and bias scaled number, specified as a positive scalar.

The slope adjustment is equivalent to the fractional slope of a fixed-point number.

Data Types: double

Fixed exponent of a slope and bias scaled number, specified as an integer.

Data Types: int32

Fraction length, in bits, specified as an integer.

Fraction length can be greater than word length. For more information, see Binary Point Interpretation (Fixed-Point Designer).

Data Types: int32

Version History

Introduced in R2024a