numerictype Properties

Properties of the numerictype object

numerictype object properties define the data type and scaling attributes of a fixed-point object. All properties of a numerictype object are writable. However, the numerictype properties of a fi object become read-only after the fi object has been created. Any numerictype properties of a fi object that are unspecified at the time of fi object creation are automatically set to their default values.

numerictype Object Properties

Bias — Scaling bias

0 (default) | floating-point number

Bias associated with the object, specified as a floating-point number. Along with the slope, the bias forms the scaling of a fixed-point number.

Data Types: single | double | half

DataType — Data type category

Fixed (default) | double | single | boolean | ScaledDouble

Data type category, specified as one of the following:

• Fixed — Fixed-point or integer data type

• double — Built-in MATLAB^® double data type

• single — Built-in MATLAB single data type

• boolean — Built-in MATLAB boolean data type

• ScaledDouble — Scaled double data type

Data Types: char

DataTypeMode — Data type and scaling associated with the object

Fixed-point: binary point scaling (default) | Fixed-point: slope and bias scaling | Fixed-point: unspecified scaling | Scaled double: binary point scaling | Scaled double: slope and bias scaling | Scaled double: unspecified scaling | Double | Single | Boolean

Data type and scaling associated with the object, specified as one of the following:

• 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 data type

• Single — Built-in single data type

• Boolean — Built-in boolean data type

For more details on these data types, see Valid Values for numerictype Object Properties.

Data Types: char

FixedExponent — Fixed-point exponent

-15 (default) | integer

Fixed-point exponent, specified as an integer.

Note

The FixedExponent property is the negative of the FractionLength. Changing one property changes the other.

Data Types: single | double | half | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

FractionLength — Fraction length of the stored integer value in bits

best-precision fraction length (default) | integer

Fraction length of the stored integer value in bits, specified as an integer. The default is the best precision fraction length based on the value of the object and the word length.

Note

The FractionLength property is the negative of the FixedExponent. Changing one property changes the other.

Data Types: single | double | half | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Scaling — Scaling mode

BinaryPoint (default) | SlopeBias | Unspecified

Scaling mode of the object, specified as one of the following:

• BinaryPoint (default) — Scaling for the fi object is defined by the fraction length.

• SlopeBias — Scaling for the fi object is defined by the slope and bias.

• Unspecified — Unspecified scaling. This is a temporary setting that is only allowed at fi object creation to allow for the automatic assignment of a binary point best-precision scaling.

Data Types: char

Signed — Whether the object is signed (not recommended)

1 (true) (default) | 0 (false) | []

Whether the object is signed, specified as one of the following:

• 1 (true) — Signed

• 0 (false) — Unsigned

Note

The Signed property is not recommended. Use Signedness instead. There are no plans to remove the Signed property.

Although the Signed property is still supported, the Signedness property always appears in the numerictype object display. If you choose to change or set the signedness of your numerictype objects using the Signed property, MATLAB updates the corresponding value of the Signedness property.

Data Types: logical

Signedness — Whether the object is signed

Signed (default) | Unsigned | Auto

Whether the object is signed, specified as one of the following:

• Signed — Signed

• Unsigned — Unsigned

• Auto — Unspecified sign

Note

numerictype objects can have a Signedness of Auto, but all fi objects must be Signed or Unsigned. If a fi object with Auto Signedness is used to create a fi object, the Signedness property of the fi object automatically defaults to Signed.

Data Types: char

Slope — Slope

floating-point number

Slope associated with the object, specified as a finite floating-point number greater than zero. Along with the bias, the slope forms the scaling of a fixed-point number.

Note

Slope = SlopeAdjustmentFactor X 2^{FixedExponent} Changing one of these properties changes the other.

Data Types: single | double | half

SlopeAdjustmentFactor — Slope adjustment factor

double

Slope adjustment factor, specified as a double. The slope adjustment factor must be a value greater than or equal to 1 and less than 2.

Note

Slope = SlopeAdjustmentFactor X 2^{FixedExponent} Changing one of these properties changes the other.

Data Types: double

WordLength — Word length of the stored integer value in bits

16 (default) | integer

Word length of the stored integer value in bits, specified as:

• A positive integer if Signedness is Unsigned or unspecified

• An integer greater than one if Signedness is set to Signed

Data Types: single | double | half | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Version History

Introduced before R2006a