prod

数组元素的乘积

全页折叠

语法

B = prod(A)

B = prod(A,"all")

B = prod(A,dim)

B = prod(A,vecdim)

B = prod(___,outtype)

B = prod(___,nanflag)

说明

B = prod(A) 返回 A 的数组元素的乘积。

如果 A 是向量，则 prod(A) 返回元素的乘积。
如果 A 为非空矩阵，则 prod(A) 将 A 的各列视为向量，并返回一个包含每列乘积的行向量。
如果 A 为 0×0 空矩阵，prod(A) 返回 1。
如果 A 为多维数组，则 prod(A) 沿第一个非单一维度运算并返回乘积数组。此维度中 B 的大小将减少至 1，而所有其他维度的大小仍与在 A 中相同。
如果 A 是表或时间表，则 prod(A) 返回每个变量乘积的单行表。 (自 R2023a 起)

如果输入 A 为 single 类型，则 prod 会计算并将 B 以 single 类型返回。如果为任何其他数值和逻辑数据类型，prod 会计算并将 B 以 double 类型返回。

示例

B = prod(A,"all") 返回 A 的所有元素的乘积。

示例

B = prod(A,dim) 返回沿维度 dim 的乘积。例如，如果 A 为矩阵，则 prod(A,2) 为一个包含每一行乘积的列向量。

示例

B = prod(A,vecdim) 根据向量 vecdim 中指定的维度返回乘积。例如，如果 A 是矩阵，则 prod(A,[1 2]) 返回 A 中所有元素的乘积，因为矩阵的每个元素包含在由维度 1 和 2 定义的数组切片中。

示例

B = prod(___,outtype) 使用上述语法中的任何输入参量按 outtype 指定的类返回数组。outtype 可以是 "double"、"native" 或 "default"。

示例

B = prod(___,nanflag) 指定包含还是省略 A 中的 NaN 值。例如，prod(A,"omitnan") 在计算乘积时会忽略 NaN 值。默认情况下，prod 包括 NaN 值。

示例

全部折叠

每列中元素的乘积

打开实时脚本

创建其元素与其线性索引对应的 3×3 数组。

A=[1:3:7;2:3:8;3:3:9]

A = 3×3

     1     4     7
     2     5     8
     3     6     9

计算每列中元素的乘积。第一个维度的长度为 1，第二个维度的长度与 size(A,2) 匹配。

B = prod(A)

B = 1×3

     6   120   504

逻辑输入的乘积

打开实时脚本

创建一个逻辑值数组。

A = [true false; true true]

A = 2×2 logical array

   1   0
   1   1

计算每列中元素的乘积。

B = prod(A)

B = 1×2

     1     0

输出的类型为 double。

class(B)

ans = 
'double'

每行中元素的乘积

打开实时脚本

创建其元素与其线性索引对应的 3×3 数组。

A=[1:3:7;2:3:8;3:3:9]

A = 3×3

     1     4     7
     2     5     8
     3     6     9

计算每行中元素的乘积，并将第二个维度的长度减少到 1。第一个维度的长度与 size(A,1) 匹配，第二个维度的长度为 1。

dim = 2;
B = prod(A,dim)

数组页的乘积

打开实时脚本

创建一个三维数组并计算每页数据（行和列）的乘积。

A(:,:,1) = [2 4; -2 1];
A(:,:,2) = [1 2; -5 3];
A(:,:,3) = [4 4; 1 -3];
B1 = prod(A,[1 2])

B1 = 
B1(:,:,1) =

   -16


B1(:,:,2) =

   -30


B1(:,:,3) =

   -48

要计算一个数组的所有维度上的乘积，可以在向量维参量中指定每个维度，或使用 "all" 选项。

B2 = prod(A,[1 2 3])

B2 = 
-23040

Ball = prod(A,"all")

Ball = 
-23040

将单精度输入作为双精度处理

打开实时脚本

创建一个由单精度值组成的 3×3 数组。

A = single([1200 1500 1800; 1300 1600 1900; 1400 1700 2000])

A = 3×3 single matrix

        1200        1500        1800
        1300        1600        1900
        1400        1700        2000

执行双精度的乘法来计算每行中元素的乘积。

B = prod(A,2,"double")

输出为双精度值。

class(B)

ans = 
'double'

整数数据类型的输入和输出

打开实时脚本

创建一个由 8 位无符号整数组成的 3×3 数组。

A = uint8([1:3:7;2:3:8;3:3:9])

A = 3×3 uint8 matrix

   1   4   7
   2   5   8
   3   6   9

计算每列中本身为 uint8 的元素的乘积。

B = prod(A,"native")

B = 1×3 uint8 row vector

     6   120   255

结果为一个 8 位无符号整数数组。

class(B)

ans = 
'uint8'

排除缺失值的乘积

打开实时脚本

创建一个包含 NaN 值的矩阵。

A = [1.77 -0.005 NaN -2.95; NaN 0.34 NaN 0.19]

A = 2×4

    1.7700   -0.0050       NaN   -2.9500
       NaN    0.3400       NaN    0.1900

计算矩阵的乘积，不包括 NaN 值。对于包含任一 NaN 值的矩阵列，prod 使用非 NaN 元素进行计算。对于包含的值都是 NaN 的矩阵列，乘积为 1。

B = prod(A,"omitnan")

B = 1×4

    1.7700   -0.0017    1.0000   -0.5605

输入参数

全部折叠

`A` — 输入数组
向量 | 矩阵 | 多维数组 | 表 | 时间表

输入数组，指定为向量、矩阵、多维数组、表或时间表。

`dim` — 沿其运算的维度
正整数标量

沿其运算的维度，指定为正整数标量。如果不指定维度，则默认值是大小不等于 1 的第一个数组维度。

维度 dim 表示长度减至 1 的维度。size(B,dim) 为 1，而所有其他维度的大小保持不变。

以一个二维输入数组 A 为例。

如果 dim = 1，则 prod(A,1) 返回包含每一列中元素的乘积的行向量。
如果 dim = 2，则 prod(A,2) 返回包含每一行中元素的乘积的列向量。

当 dim 大于 ndims(A) 时，prod 返回 A。

`vecdim` — 维度向量
正整数向量

维度向量，指定为正整数向量。每个元素代表输入数组的一个维度。指定的操作维度的输出长度为 1，而其他保持不变。

以 2×3×3 输入数组 A 为例。然后 prod(A,[1 2]) 返回一个 1×1×3 数组，其元素是 A 的每个页面的乘积。

prod(A,[1 2]) collapses the pages of a 2-by-3-by-3 array into a 1-by-1-by-3 array.

`outtype` — 输出类
`"default"` (默认) | `"double"` | `"native"`

输出类，指定为 "default"、"double" 或 "native"，用于定义输出 B 的数据类型。

`outtype`	输出数据类型
`"default"`	`double`，除非输入数据类型为 `single`、`table` 或 `timetable`。在这种情况下，输出数据类型分别为 `single` 或 `table`。
`"double"`	`double`，除非输入数据类型为 `table` 或 `timetable`。在这种情况下，输出数据类型为 `table`。
`"native"`	与输入数组 `A` 的数据类型相同，除非输入数据类型为 `timetable`。在这种情况下，输出数据类型为 `table`。

`nanflag` — 缺失值条件
`"includemissing"` (默认) | `"includenan"` | `"omitmissing"` | `"omitnan"`

缺失值条件，指定为下列值之一：

"includemissing" 或 "includenan" - 在计算乘积时包括 A 中的 NaN 值。如果运算维度中的任一元素是 NaN，则 B 中的对应元素也是 NaN。"includemissing" 和 "includenan" 具有相同的行为。
"omitmissing" 或 "omitnan" - 忽略 A 中的 NaN 值，并基于较少的点计算乘积。如果运算维度中的所有元素均为 NaN，则 B 中的对应元素为 1。"omitmissing" 和 "omitnan" 具有相同的行为。

输出参量

全部折叠

`B` — 乘积数组
标量 | 向量 | 矩阵 | 多维数组 | 表

乘积数组，以标量、向量、矩阵、多维数组或表形式返回。

B 的类如下所示：

如果 outtype 参量指定为 "default" 或未使用它
- 并且输入不是 single、table 或 timetable，则输出为 double。
- 并且输入为 single，则输出为 single。
- 并且输入为 table 或 timetable，则输出为 table。
如果 outtype 参量指定 "double"，则输出为 double，这与输入数据类型无关，除非输入为 table 或 timetable。
如果 outtype 参量指定 "native"，则输出与输入具有相同的数据类型，除非输入为 timetable。在这种情况下，输出为 table。

详细信息

全部折叠

第一个非单一维度

第一个非单一维度是其大小不等于 1 的数组的第一维度。

例如：

如果 X 为 1×n 的行向量，则第二个维度是 X 的第一个非单一维度。
如果 X 为 1×0×n 的空数组，则第二个维度是 X 的第一个非单一维度。
如果 X 为 1×1×3 的数组，则第三个维度是 X 的第一个非单一维度。

扩展功能

全部展开

tall 数组
对行数太多而无法放入内存的数组进行计算。

prod 函数完全支持 tall 数组。有关详细信息，请参阅 tall 数组。

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

用法说明和限制：

如果使用参量 dim、vecdim、outtype 和 nanflag，它们在代码生成时必须为常量。
对于输入参量 A：
- 如果不指定维度，代码生成器将沿输入数组中具有可变大小或其大小不为 1 的第一个维度进行运算。如果此维度在代码生成时具有可变大小且在运行时为 1，则可能发生运行时错误。为避免此错误，请指定维度。
- 如果输入数组的所有维度在代码生成时都具有可变大小，则此数组在运行时不能为空。

GPU 代码生成
使用 GPU Coder™ 为 NVIDIA® GPU 生成 CUDA® 代码。

用法说明和限制：

如果提供 dim，则它必须为常量。

基于线程的环境
使用 MATLAB® `backgroundPool` 在后台运行代码或使用 Parallel Computing Toolbox™ `ThreadPool` 加快代码运行速度。

此函数完全支持基于线程的环境。有关详细信息，请参阅在基于线程的环境中运行 MATLAB 函数。

GPU 数组
通过使用 Parallel Computing Toolbox™ 在图形处理单元 (GPU) 上运行来加快代码执行。

prod 函数支持 GPU 数组输入，但有以下用法说明和限制：

未定义 prod 运算中的乘积顺序。因此，对 GPU 数组执行 prod 运算与对相应的数值数组执行 prod 运算所返回的值可能不完全相同。

有关详细信息，请参阅在 GPU 上运行 MATLAB 函数 (Parallel Computing Toolbox)。

分布式数组
使用 Parallel Computing Toolbox™ 在集群的组合内存中对大型数组进行分区。

用法说明和限制：

未定义 prod 运算中的乘积顺序。因此，对分布式数组执行 prod 运算与对相应的数值数组执行 prod 运算所返回的值可能不完全相同。当 A 是有符号整数类型且其乘积在本机累积时，差异可能相当大。

有关详细信息，请参阅使用分布式数组运行 MATLAB 函数 (Parallel Computing Toolbox)。

版本历史记录

在 R2006a 之前推出

全部展开

R2023a: 指定缺失值条件

在使用 "includemissing" 或 "omitmissing" 选项计算乘积时，包括还是忽略输入数组中的缺失值。这些选项的行为分别与 "includenan" 和 "omitnan" 选项相同。

R2023a: 直接对表和时间表执行计算

prod 函数可以对表或时间表中的所有变量执行计算，而无需通过索引访问这些变量。所有变量都必须具有支持计算的数据类型。有关详细信息，请参阅Direct Calculations on Tables and Timetables。

R2018b: 对多个维度执行运算

一次对输入数组的多个维度执行运算。指定一个由运算维度组成的向量，或指定 "all" 选项以对所有数组维度执行运算。

另请参阅

cumprod | diff | sum | ndims

prod

语法

说明

示例

每列中元素的乘积

逻辑输入的乘积

每行中元素的乘积

数组页的乘积

将单精度输入作为双精度处理

整数数据类型的输入和输出

排除缺失值的乘积

输入参数

A — 输入数组 向量 | 矩阵 | 多维数组 | 表 | 时间表

dim — 沿其运算的维度 正整数标量

vecdim — 维度向量 正整数向量

outtype — 输出类 "default" (默认) | "double" | "native"

nanflag — 缺失值条件 "includemissing" (默认) | "includenan" | "omitmissing" | "omitnan"

输出参量

B — 乘积数组 标量 | 向量 | 矩阵 | 多维数组 | 表

详细信息

第一个非单一维度

扩展功能

tall 数组 对行数太多而无法放入内存的数组进行计算。

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

GPU 代码生成 使用 GPU Coder™ 为 NVIDIA® GPU 生成 CUDA® 代码。

基于线程的环境 使用 MATLAB® backgroundPool 在后台运行代码或使用 Parallel Computing Toolbox™ ThreadPool 加快代码运行速度。

GPU 数组 通过使用 Parallel Computing Toolbox™ 在图形处理单元 (GPU) 上运行来加快代码执行。

分布式数组 使用 Parallel Computing Toolbox™ 在集群的组合内存中对大型数组进行分区。

版本历史记录

R2023a: 指定缺失值条件

R2023a: 直接对表和时间表执行计算

R2018b: 对多个维度执行运算

另请参阅

`A` — 输入数组
向量 | 矩阵 | 多维数组 | 表 | 时间表

`dim` — 沿其运算的维度
正整数标量

`vecdim` — 维度向量
正整数向量

`outtype` — 输出类
`"default"` (默认) | `"double"` | `"native"`

`nanflag` — 缺失值条件
`"includemissing"` (默认) | `"includenan"` | `"omitmissing"` | `"omitnan"`

`B` — 乘积数组
标量 | 向量 | 矩阵 | 多维数组 | 表

tall 数组
对行数太多而无法放入内存的数组进行计算。

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

GPU 代码生成
使用 GPU Coder™ 为 NVIDIA® GPU 生成 CUDA® 代码。

基于线程的环境
使用 MATLAB® `backgroundPool` 在后台运行代码或使用 Parallel Computing Toolbox™ `ThreadPool` 加快代码运行速度。

GPU 数组
通过使用 Parallel Computing Toolbox™ 在图形处理单元 (GPU) 上运行来加快代码执行。

分布式数组
使用 Parallel Computing Toolbox™ 在集群的组合内存中对大型数组进行分区。