Documentation Center

  • Trial Software
  • Product Updates

fipref Object Properties

The properties associated with fipref objects are described in the following sections in alphabetical order.

DataTypeOverride

Data type override options for fi objects

  • ForceOff — No data type override

  • ScaledDoubles — Override with scaled doubles

  • TrueDoubles — Override with doubles

  • TrueSingles — Override with singles

Data type override only occurs when the fi constructor function is called.

The default value of this property is ForceOff.

DataTypeOverrideAppliesTo

Data type override application to fi objects

  • AllNumericTypes — Apply data type override to all fi data types

  • Fixed-Point — Apply data type override only to fixed-point data types

  • Floating-Point — Apply data type override only to floating-point fi data types

DataTypeOverrideAppliesTo displays only if DataTypeOverride is not set to ForceOff.

The default value of this property is AllNumericTypes.

FimathDisplay

Display options for the fimath attributes of a fi object

  • full — Displays all of the fimath attributes of a fixed-point object

  • none — None of the fimath attributes are displayed

The default value of this property is full.

LoggingMode

Logging options for operations performed on fi objects

  • off — No logging

  • on — Information is logged for future operations

Overflows and underflows for assignment, plus, minus, and multiplication operations are logged as warnings when LoggingMode is set to on.

When LoggingMode is on, you can also use the following functions to return logged information about assignment and creation operations to the MATLAB® command line:

  • maxlog — Returns the maximum real-world value

  • minlog — Returns the minimum value

  • noverflows — Returns the number of overflows

  • nunderflows — Returns the number of underflows

LoggingMode must be set to on before you perform any operation in order to log information about it. To clear the log, use the function resetlog.

The default value of this property of off.

NumericTypeDisplay

Display options for the numerictype attributes of a fi object

  • full — Displays all the numerictype attributes of a fixed-point object

  • none — None of the numerictype attributes are displayed.

  • short — Displays an abbreviated notation of the fixed-point data type and scaling of a fixed-point object in the format xWL,FL where

    • x is s for signed and u for unsigned.

    • WL is the word length.

    • FL is the fraction length.

The default value of this property is full.

NumberDisplay

Display options for the value of a fi object

  • bin — Displays the stored integer value in binary format

  • dec — Displays the stored integer value in unsigned decimal format

  • RealWorldValue — Displays the stored integer value in the format specified by the MATLAB format function

  • hex — Displays the stored integer value in hexadecimal format

  • int — Displays the stored integer value in signed decimal format

  • none — No value is displayed.

The default value of this property is RealWorldValue. In this mode, the value of a fi object is displayed in the format specified by the MATLAB format function: +, bank, compact, hex, long, long e, long g, loose, rat, short, short e, or short g. fi objects in rat format are displayed according to

Was this topic helpful?