DataTypeWorkflow.ProposalSettings

Proposal settings object for data type proposals

Description

The DataTypeWorkflow.ProposalSettings object manages the properties related to how data types are proposed for a model, including the default floating point data type, and safety margins for the proposed data types.

Creation

Syntax

propSettings = DataTypeWorkflow.ProposalSettings

Description

propSettings = DataTypeWorkflow.ProposalSettings creates a proposal settings object.

Properties

DefaultWordLength — Default word length for floating-point signals

16 (default) | scalar

Default word length for floating-point signals, specified as a scalar. Use this setting when the ProposeFractionLength property is set to true.

Example: propSettings.DefaultWordLength = 16

Data Types: double

DefaultFractionLength — Default fraction length for floating-point signals

4 (default) | scalar

Default fraction length for floating-point signals, specified as a scalar. Use this setting when the ProposeWordLength property is set to true.

Example: propSettings.DefaultFractionLength = 4

Data Types: double

ProposeFractionLength — Whether to propose fraction lengths for specified word length

true (default) | false

Whether to propose fraction lengths for the default word length specified in the DefaultWordLength property, specified as a Boolean. Setting this property to true automatically sets the ProposeWordLength property to false.

Example: propSettings.ProposeFractionLength = logical(true)

Data Types: logical

ProposeForInherited — Whether to propose fixed-point data types for objects with an inherited output data type

true (default) | false

Whether to propose fixed-point data types for objects in the system with inherited output data types, specified as a Boolean.

Example: propSettings.ProposeForInherited = logical(true)

Data Types: logical

ProposeForFloatingPoint — Whether to propose fixed-point data types for objects with a floating-point output data type

true (default) | false

Whether to propose fixed-point data types for objects in the system with floating-point output data types, specified as a Boolean.

Example: propSettings.ProposeForFloatingPoint = logical(true)

Data Types: logical

ProposeSignedness — Whether to propose signedness for objects in the system

true (default) | false

Whether to propose signedness for objects in the system, specified as a Boolean.

The software bases the signedness proposal on collected range information and block constraints. Signals that are always strictly positive are assigned an unsigned data type proposal, and gain an additional bit of precision. If you set this property to false, the software proposes a signed data type for all results that currently specify a floating-point or an inherited output data type unless other constraints are present. If a result specifies a fixed-point output data type, the software will propose a data type with the same signedness as the currently specified data type unless other constraints are present.

Example: propSettings.ProposeForFloatingPoint = logical(true)

Data Types: logical

ProposeWordLength — Whether to propose word lengths for specified default fraction lengths

false (default) | true

Whether to propose word lengths for the default fraction length in the DefaultFractionLength property, specified as a Boolean. Setting this property to true automatically sets the ProposeFractionLength property to false.

Example: propSettings.ProposeWordLength = logical(false)

Data Types: logical

SafetyMargin — Safety margin for simulation minimum and maximum values

0 (default) | scalar

Safety margin for simulation minimum and maximum values, specified as a scalar.

The simulation minimum and maximum values are adjusted by the percentage designated by this parameter. This parameter allows you to specify a range different from that obtained from the simulation run.

For example, a value of 55 specifies that a range at least 55 percent larger is desired. A value of –15 specifies that a range of up to 15 percent smaller is acceptable.

Example: propSettings.SafetyMargin = 55

Data Types: double

UseDerivedMinMax — Whether to use derived ranges to propose data types

true (default) | false

Whether to use derived ranges for data type proposals, specified as a Boolean.

Example: propSettings.UseDerivedMinMax = logical(true)

Data Types: logical

UseSimMinMax — Whether to use simulation ranges to propose data types

true (default) | false

Whether to use simulation ranges for data type proposals, specified as a Boolean.

Example: propSettings.UseSimMinMax = logical(true)

Data Types: logical

Object Functions

addTolerance	Specify numeric tolerance for converted system
clearTolerances	Clear all tolerances specified by a DataTypeWorkflow.ProposalSettings object
showTolerances	Show tolerances specified for a system

Alternatives

The properties of the DataTypeWorkflow.ProposalSettings object can also be controlled from the Settings menu in the Fixed-Point Tool. For more information, see Fixed-Point Tool.

Version History

Introduced in R2014b