fimath

设置定点数学设置

全页展开

说明

fimath 对象允许您设置确定对 fi 对象进行定点算术运算的规则的属性。

创建对象

语法

F = fimath

F = fimath(a)

F = fimath(PropertyName = Value)

描述

F = fimath 使用默认 fimath 属性设置创建一个 fimath 对象。

示例

F = fimath(a) 创建一个 fimath 对象，该对象具有 fi 对象 a 的定点数学属性。

示例

F = fimath(PropertyName = Value) 通过使用一个或多个名称-值对组参量来指定 fimath 对象的属性。所有未在构造函数中指定的属性都使用默认值。

示例

属性

全部展开

fimath 属性确定对 fi 对象执行定点算术运算的规则。根据传递性，fimath 属性也是 fi 对象的属性。您可以为单个 fi 对象设置这些属性。fimath 对象属性始终可写。

加和数据类型属性

`CastBeforeSum` — 在执行加法前将操作数转换为加和数据类型
`1` `(true)` (默认) | `0` `(false)`

在加法运算之前是否将两个操作数都转换为加和数据类型，指定为 logical 值：

1 或 true - 在求和之前进行转换
0 或 false - 不要在求和之前进行转换

此属性始终返回 logical 值。

注意

当 SumMode 设置为 FullPrecision 时，此属性隐藏。

`MaxSumWordLength` — 加和数据类型允许的最大字长
`65535` (默认) | 正整数

加和数据类型允许的最大字长，指定为正整数。

`SumBias` — 加和数据类型的偏置
`0` (默认) | 浮点数

加和数据类型的偏置，指定为浮点数。

示例: F = fimath('SumBias',0)

数据类型: single | double | half

`SumFixedExponent` — 加和数据类型的固定指数
`-30` (默认) | 整数

加和数据类型的固定指数，指定为整数。

注意

SumFixedExponent 是 SumFractionLength 的负数。更改一个属性会更改另一个属性。

`SumFractionLength` — 加和数据类型的小数长度（以位为单位）
`30` (默认) | 整数

加和数据类型的小数长度（以位为单位），指定为整数。

注意

SumFractionLength 是 SumFixedExponent 的负数。更改一个属性会更改另一个属性。

`SumMode` — 如何确定加和数据类型
`FullPrecision` (默认) | `KeepLSB` | `KeepMSB` | `SpecifyPrecision`

如何确定加和数据类型，指定为以下项之一：

FullPrecision - 保留结果的全精度。
KeepLSB - 保留最低有效位。指定加和数据类型的字长，同时将小数长度设置为保持总和的最低有效位。
KeepMSB - 保留最高有效位。指定加和数据类型字长，同时将小数长度设置为保持总和的最高有效位并且不超出必要的小数位。
SpecifyPrecision - 指定加和数据类型的字长和小数长度或斜率和偏置。

数据类型: char

`SumSlope` — 加和数据类型的斜率
`9.3132e-010` (默认) | 浮点数

加和数据类型的斜率，指定为浮点数。

注意

$S u m S l o p e = S u m S l o p e A d j u s t m e n t F a c t o r \times 2^{S u m F i x e d E x p o n e n t}$

更改其中一个属性会影响其他属性。

数据类型: single | double | half

`SumSlopeAdjustmentFactor` — 加和数据类型的斜率调整因子
`1` (默认) | 大于或等于 1 且小于 2 的浮点数

加和数据类型的斜率调整因子，指定为大于或等于 1 且小于 2 的浮点数。

注意

$S u m S l o p e = S u m S l o p e A d j u s t m e n t F a c t o r \times 2^{S u m F i x e d E x p o n e n t}$

更改其中一个属性会影响其他属性。

数据类型: single | double | half

`SumWordLength` — 加和数据类型的字长（以位为单位）
`32` (默认) | 正整数

加和数据类型的字长（以位为单位），指定为正整数。

乘积数据类型属性

`MaxProductWordLength` — 乘积数据类型允许的最大字长
`65535` (默认) | 正整数

乘积数据类型允许的最大字长，指定为正整数。

`ProductBias` — 乘积数据类型的偏置
`0` (默认) | 浮点数

乘积数据类型的偏置，指定为浮点数。

数据类型: single | double | half

`ProductFixedExponent` — 乘积数据类型的固定指数
`-30` (默认) | 整数

乘积数据类型的固定指数，指定为整数。

注意

ProductFixedExponent 是 ProductFractionLength 的负数。更改一个属性会更改另一个属性。

`ProductFractionLength` — 乘积数据类型的小数长度（以位为单位）
`30` (默认) | 整数

乘积数据类型的小数长度（以位为单位），指定为整数。

注意

ProductFractionLength 是 ProductFixedExponent 的负数。更改一个属性会更改另一个属性。

`ProductMode` — 如何确定乘积数据类型
`FullPrecision` (默认) | `KeepLSB` | `KeepMSB` | `SpecifyPrecision`

如何确定乘积数据类型，指定为以下值之一：

FullPrecision - 保留结果的全精度。
KeepLSB - 保留最低有效位。指定乘积字长，而小数长度设置为保持乘积的最低有效位。
KeepMSB - 保留最高有效位。指定乘积字长，而小数长度设置为保持乘积的最高有效位。
SpecifyPrecision - 指定乘积的字长和小数长度或乘积的斜率和偏置。

数据类型: char

`ProductSlope` — 乘积数据类型的斜率
`9.3132e-010` (默认) | 浮点数

乘积数据类型的斜率，指定为浮点数。

注意

$P r o d u c t S l o p e = P r o d u c t S l o p e A d j u s t m e n t F a c t o r \times 2^{P r o d u c t F i x e d E x p o n e n t}$

更改其中一个属性会影响其他属性。

数据类型: single | double | half

`ProductSlopeAdjustmentFactor` — 乘积数据类型的斜率调整因子
`1` (默认) | 大于或等于 1 且小于 2 的浮点数

乘积数据类型的斜率调整因子，指定为大于或等于 1 且小于 2 的浮点数。

注意

$P r o d u c t S l o p e = P r o d u c t S l o p e A d j u s t m e n t F a c t o r \times 2^{P r o d u c t F i x e d E x p o n e n t}$

更改其中一个属性会影响其他属性。

数据类型: single | double | half

`ProductWordLength` — 乘积数据类型的字长（以位为单位）
`32` (默认) | 正整数

乘积数据类型的字长（以位为单位），指定为正整数。

舍入和溢出属性

`OverflowAction` — 对溢出采取的操作
`Saturate` (默认) | `Wrap`

对溢出采取的操作，指定为以下值之一：

Saturate - 溢出时饱和处理为定点范围的最大或最小值。
Wrap - 溢出时绕回。

数据类型: char

`RoundingMethod` — 要使用的舍入方法
`Nearest` (默认) | `Ceiling` | `Convergent` | `Zero` | `Floor` | `Round`

要使用的舍入方法，指定为以下项之一：

Nearest - 向最邻近值方向舍入。结值向正无穷方向舍入。
Ceiling - 向正无穷方向舍入。
Convergent - 向最邻近值方向舍入。结值舍入到最接近的偶数存储整数（偏置最小）。
Zero - 向零方向舍入。
Floor - 向负无穷方向舍入。
Round - 向最邻近值方向舍入。负结值向负无穷方向舍入，正结值向正无穷方向舍入。

数据类型: char

示例

全部折叠

创建默认 fimath 对象

打开实时脚本

此示例说明如何使用默认属性设置创建 fimath 对象。

F = fimath

F = 
        RoundingMethod: Nearest
        OverflowAction: Saturate
           ProductMode: FullPrecision
               SumMode: FullPrecision

设置 fimath 对象的属性

打开实时脚本

使用名称-值对组在创建对象时设置 fimath 对象的属性。例如，将溢出操作设置为饱和，将舍入方法设置为收敛。

F = fimath('OverflowAction','Saturate','RoundingMethod','Convergent')

F = 
        RoundingMethod: Convergent
        OverflowAction: Saturate
           ProductMode: FullPrecision
               SumMode: FullPrecision

从 `fi` 对象创建 `fimath` 对象

打开实时脚本

此示例说明如何从现有 fi 对象创建 fimath 对象。

创建一个具有默认属性且未指定值的 fi 对象。

a = fi

a = 

[]

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 16
        FractionLength: 15

查询 a 的 fimath 属性。

a.fimath

ans = 
        RoundingMethod: Nearest
        OverflowAction: Saturate
           ProductMode: FullPrecision
               SumMode: FullPrecision

创建一个以 a 作为输入的 fimath 对象。

F = fimath(a)

F = 
        RoundingMethod: Nearest
        OverflowAction: Saturate
           ProductMode: FullPrecision
               SumMode: FullPrecision

F 具有与 a 相同的 fimath 属性。

扩展功能

全部展开

C/C++ 代码生成
使用 MATLAB® Coder™ 生成 C 代码和 C++ 代码。

使用说明和限制：

从 Simulink^® 进入 MATLAB^® Function 模块的定点信号会被分配一个 fimath 对象。您可以在模型资源管理器的 MATLAB Function 模块对话框中定义此对象。
用于在生成代码中创建 fimath 对象。
如果 fimath 对象的 ProductMode 属性设置为 FullPrecision 以外的任何值，则 ProductWordLength 和 ProductFractionLength 属性必须为常量。
如果 fimath 对象的 SumMode 属性设置为 FullPrecision 以外的任何值，则 SumWordLength 和 SumFractionLength 属性必须为常量。

HDL 代码生成
使用 HDL Coder™ 为 FPGA 和 ASIC 设计生成 VHDL、Verilog 和 SystemVerilog 代码。

版本历史记录

在 R2006a 之前推出

全部展开

R2021a: 不支持 `fi`、`fimath` 和 `numerictype` 对象的不精确的属性名称

在以前的版本中，对象 fi、fimath 和 numerictype 的不精确的属性名称会导致警告。在 R2021a 中，不再支持不精确的属性名称。请改用精确的属性名称。

另请参阅

fimath

说明

创建对象

语法

描述

属性

加和数据类型属性

CastBeforeSum — 在执行加法前将操作数转换为加和数据类型 1 (true) (默认) | 0 (false)

MaxSumWordLength — 加和数据类型允许的最大字长 65535 (默认) | 正整数

SumBias — 加和数据类型的偏置 0 (默认) | 浮点数

SumFixedExponent — 加和数据类型的固定指数 -30 (默认) | 整数

SumFractionLength — 加和数据类型的小数长度（以位为单位） 30 (默认) | 整数

SumMode — 如何确定加和数据类型 FullPrecision (默认) | KeepLSB | KeepMSB | SpecifyPrecision

SumSlope — 加和数据类型的斜率 9.3132e-010 (默认) | 浮点数

SumSlopeAdjustmentFactor — 加和数据类型的斜率调整因子 1 (默认) | 大于或等于 1 且小于 2 的浮点数

SumWordLength — 加和数据类型的字长（以位为单位） 32 (默认) | 正整数

乘积数据类型属性

MaxProductWordLength — 乘积数据类型允许的最大字长 65535 (默认) | 正整数

ProductBias — 乘积数据类型的偏置 0 (默认) | 浮点数

ProductFixedExponent — 乘积数据类型的固定指数 -30 (默认) | 整数

ProductFractionLength — 乘积数据类型的小数长度（以位为单位） 30 (默认) | 整数

ProductMode — 如何确定乘积数据类型 FullPrecision (默认) | KeepLSB | KeepMSB | SpecifyPrecision

ProductSlope — 乘积数据类型的斜率 9.3132e-010 (默认) | 浮点数

ProductSlopeAdjustmentFactor — 乘积数据类型的斜率调整因子 1 (默认) | 大于或等于 1 且小于 2 的浮点数

ProductWordLength — 乘积数据类型的字长（以位为单位） 32 (默认) | 正整数

舍入和溢出属性

OverflowAction — 对溢出采取的操作 Saturate (默认) | Wrap

RoundingMethod — 要使用的舍入方法 Nearest (默认) | Ceiling | Convergent | Zero | Floor | Round

示例

创建默认 fimath 对象

设置 fimath 对象的属性

从 fi 对象创建 fimath 对象

扩展功能

C/C++ 代码生成 使用 MATLAB® Coder™ 生成 C 代码和 C++ 代码。

HDL 代码生成 使用 HDL Coder™ 为 FPGA 和 ASIC 设计生成 VHDL、Verilog 和 SystemVerilog 代码。

版本历史记录

R2021a: 不支持 fi、fimath 和 numerictype 对象的不精确的属性名称

另请参阅

主题

`CastBeforeSum` — 在执行加法前将操作数转换为加和数据类型
`1` `(true)` (默认) | `0` `(false)`

`MaxSumWordLength` — 加和数据类型允许的最大字长
`65535` (默认) | 正整数

`SumBias` — 加和数据类型的偏置
`0` (默认) | 浮点数

`SumFixedExponent` — 加和数据类型的固定指数
`-30` (默认) | 整数

`SumFractionLength` — 加和数据类型的小数长度（以位为单位）
`30` (默认) | 整数

`SumMode` — 如何确定加和数据类型
`FullPrecision` (默认) | `KeepLSB` | `KeepMSB` | `SpecifyPrecision`

`SumSlope` — 加和数据类型的斜率
`9.3132e-010` (默认) | 浮点数

`SumSlopeAdjustmentFactor` — 加和数据类型的斜率调整因子
`1` (默认) | 大于或等于 1 且小于 2 的浮点数

`SumWordLength` — 加和数据类型的字长（以位为单位）
`32` (默认) | 正整数

`MaxProductWordLength` — 乘积数据类型允许的最大字长
`65535` (默认) | 正整数

`ProductBias` — 乘积数据类型的偏置
`0` (默认) | 浮点数

`ProductFixedExponent` — 乘积数据类型的固定指数
`-30` (默认) | 整数

`ProductFractionLength` — 乘积数据类型的小数长度（以位为单位）
`30` (默认) | 整数

`ProductMode` — 如何确定乘积数据类型
`FullPrecision` (默认) | `KeepLSB` | `KeepMSB` | `SpecifyPrecision`

`ProductSlope` — 乘积数据类型的斜率
`9.3132e-010` (默认) | 浮点数

`ProductSlopeAdjustmentFactor` — 乘积数据类型的斜率调整因子
`1` (默认) | 大于或等于 1 且小于 2 的浮点数

`ProductWordLength` — 乘积数据类型的字长（以位为单位）
`32` (默认) | 正整数

`OverflowAction` — 对溢出采取的操作
`Saturate` (默认) | `Wrap`

`RoundingMethod` — 要使用的舍入方法
`Nearest` (默认) | `Ceiling` | `Convergent` | `Zero` | `Floor` | `Round`

从 `fi` 对象创建 `fimath` 对象

C/C++ 代码生成
使用 MATLAB® Coder™ 生成 C 代码和 C++ 代码。

HDL 代码生成
使用 HDL Coder™ 为 FPGA 和 ASIC 设计生成 VHDL、Verilog 和 SystemVerilog 代码。

R2021a: 不支持 `fi`、`fimath` 和 `numerictype` 对象的不精确的属性名称