randi

均匀分布的随机整数

全页折叠

语法

X = randi(imax)

X = randi(imax,n)

X = randi(imax,sz1,...,szN)

X = randi(imax,sz)

X = randi(___,typename)

X = randi(___,like=p)

X = randi([imin,imax],___)

X = randi(s,___)

说明

X = randi(imax) 返回介于 1 和 imax 之间的随机整数标量。

X = randi(imax,n) 返回 n×n 矩阵，其中包含从区间 [1,imax] 的均匀离散分布中得到的随机整数。

示例

X = randi(imax,sz1,...,szN) 返回 sz1×...×szN 数组，其中 sz1,...,szN 指示每个维度的大小。例如，randi(10,3,4) 返回一个由介于 1 和 10 之间的随机整数组成的 3×4 数组。

X = randi(imax,sz) 返回一个数组，其中大小向量 sz 定义 size(X)。例如，randi(10,[3 4]) 返回一个由介于 1 和 10 之间的随机整数组成的 3×4 数组。

示例

X = randi(___,typename) 返回一个由数据类型为 typename 的介于 1 和 imax 之间的随机整数组成的数组。typename 输入可以是 "single"、"double"、"int8"、"uint8"、"int16"、"uint16"、"int32"、"uint32" 或 "logical"。您可以使用上述语法中的任何输入参量。

示例

X = randi(___,like=p) 返回一个与 p 类似的随机整数数组；即具有与 p 相同的数据类型和复/实性（实数或复数）。您可以指定 typename 或 like，但不能同时指定两者。

示例

X = randi([imin,imax],___) 使用以上任何语法返回一个数组，其中包含从区间 [imin,imax] 的均匀离散分布中得到的整数。

示例

X = randi(s,___) 从随机数流 s 而不是默认全局流生成整数。要创建一个流，请使用 RandStream。您可以指定 s，后跟上述语法中的任何输入参量组合。

示例

全部折叠

由随机整数组成的方阵

打开实时脚本

生成一个由介于 1 和 10 之间的随机整数组成的 5×5 矩阵。randi 的第一个输入指示采样区间中的最大整数（采样区间中的最小整数为 1）。

r = randi(10,5)

r = 5×5

     9     1     2     2     7
    10     3    10     5     1
     2     6    10    10     9
    10    10     5     8    10
     7    10     9    10     7

指定区间内的随机整数

打开实时脚本

生成一个由样本区间 [-5,5] 中均匀分布的随机整数组成的 10×1 列向量。

r = randi([-5,5],10,1)

控制随机数生成

打开实时脚本

保存随机数生成器的当前状态并创建一个由随机整数组成的 1×5 向量。

s = rng;
r = randi(10,1,5)

r = 1×5

     9    10     2    10     7

将随机数生成器的状态恢复为 s，然后创建一个由随机整数组成的新 1×5 向量。值与之前相同。

rng(s);
r1 = randi(10,1,5)

r1 = 1×5

     9    10     2    10     7

由随机整数组成的三维数组

打开实时脚本

创建一个由介于 1 和 500 之间的均匀分布的随机整数组成的 3×2×3 数组。

X = randi(500,[3,2,3])

其他数据类型的随机整数

打开实时脚本

创建一个由 1 到 100 之间的随机数组成的 1×4 向量，其元素类型为 int16。

r = randi(100,1,4,"int16")

r = 1×4 int16 row vector

   82   91   13   92

class(r)

ans = 
'int16'

现有数组定义的大小

打开实时脚本

创建一个由介于 1 和 10 之间的均匀分布的随机整数组成并且大小与现有数组相同的矩阵。

A = [3 2; -2 1];
sz = size(A);
X = randi(10,sz)

它是一种将前两行代码合并成一行的常见模式：

X = randi(10,size(A));

现有数组定义的大小和数值数据类型

打开实时脚本

创建一个由 8 位有符号整数组成的 2×2 矩阵。

p = int8([3 2; -2 1]);

创建一个与 p 具有相同大小和数据类型的由随机整数组成的数组。

X = randi(10,size(p),like=p)

X = 2×2 int8 matrix

    9    2
   10   10

class(X)

ans = 
'int8'

随机复整数

自 R2022a 起

打开实时脚本

从一个方域上的离散均匀分布生成 10 个实部和虚部位于区间 [-5,5] 内的随机复整数。

a = randi([-5,5],10,1,like=1i)

a = 10×1 complex

   3.0000 + 4.0000i
  -4.0000 + 5.0000i
   1.0000 - 4.0000i
  -2.0000 + 1.0000i
   5.0000 + 5.0000i
  -4.0000 + 5.0000i
   5.0000 + 0.0000i
   3.0000 - 4.0000i
  -1.0000 + 5.0000i
   3.0000 + 5.0000i

随机逻辑数组

自 R2023a 起

打开实时脚本

创建一个由服从某离散均匀分布的随机逻辑值（0 和 1）组成的 5×5 矩阵。

r = randi([0 1],5,"logical")

r = 5×5 logical array

   1   0   0   0   1
   1   0   1   0   0
   0   1   1   1   1
   1   1   0   1   1
   1   1   1   1   1

输入参数

全部折叠

`imax` — 示例区间中的最大整数
正整数

示例区间中的最大整数，指定为一个正整数。randi 绘制示例区间 [1,imax] 中均匀分布的值。

示例: randi(10,5)

`imin` — 示例区间中的最小整数
`1` (默认) | 整数标量

示例区间中的最小整数，指定为整数标量。

imin 和 imax 都必须为满足 imin ≤ imax 的整数。

例如，randi([50,100],5) 返回一个由介于 50 和 100（包括二者）之间的随机整数组成的 5×5 矩阵。

`n` — 方阵的大小
整数值

方阵的大小，指定为整数值。

如果 n 为 0，则 X 为一个空矩阵。
如果 n 为负数，则将其视为 0。

`sz1,...,szN` — 每个维度的大小（作为单独参量）
整数值

每个维度的大小，指定为包含整数值的单独参量。

如果任一维度的大小为 0，则 X 为空数组。
如果任何维度的大小为负值，则其将被视为 0。
对于第二个维度以上的维度，randi 忽略大小为 1 的尾部维度。例如，randi([5,10],3,1,1,1) 生成由 5 和 10 之间的随机整数组成的 3×1 向量。

`sz` — 每个维度的大小（作为行向量）
整数值

每个维度的大小，指定为由整数组成的行向量。此向量的每个元素指示对应维度的大小：

如果任一维度的大小为 0，则 X 为空数组。
如果任何维度的大小为负值，则其将被视为 0。
对于第二个维度以上的维度，randi 忽略大小为 1 的尾部维度。例如，randi([5,10],[3 1 1 1]) 生成由 5 和 10 之间的随机整数组成的 3×1 向量。

`typename` — 要创建的数据类型（类）
`"double"` (默认) | `"single"` | `"int8"` | `"uint8"` | `"int16"` | `"uint16"` | ...

要创建的数据类型（类），指定为 "double"、"single"、"int8"、"uint8"、"int16"、"uint16"、"int32"、"uint32"、"logical" 或提供 randi 支持的其他类的名称。

示例: randi(5,5,"int8")

`p` — 要创建的数组的原型
数值数组 | 逻辑数组

要创建的数组的原型，指定为数值或逻辑数组。

示例: randi(5,5,like=p)

`s` — 随机数流
`RandStream` 对象

随机数流，指定为 RandStream 对象。

示例: s = RandStream("dsfmt19937"); randi(s,[5,10],[3 1])

输出参量

全部折叠

`X` — 输出数组
标量 | 向量 | 矩阵 | 多维数组

输出数组，以标量、向量、矩阵或多维数组形式返回。

详细信息

全部折叠

伪随机数生成器

randi 的基础数字生成器是伪随机数生成器，它创建一个看似随机的确定性数字序列。如果生成器的种子和确定性算法已知，则这些数字可预测。虽然并非真正随机，但生成的数字能够通过各种随机性统计检验，满足独立同分布 (i.i.d.) 条件，因此伪随机名副其实。

提示

randi 生成的数字序列由均匀伪随机数生成器的内部设置决定，该生成器是 rand、randi 和 randn 的基础。您可以使用 rng 控制这一共享的随机数生成器。
randi 返回的数组可以包含重复的整数值。此行为有时称为替换采样。如果您需要所有的唯一值，请使用 randperm。
如果 imin 和 imax 在输出类型（如 typename 或原型 p 所指定）的范围之外，则 randi 首先在区间 [imin,imax] 内创建随机整数，并将任何产生的超出范围的整数转换为输出类型的最小值或最大值。例如：
```
rng default;
r = randi([-10 10],1,10)
```
```
r =

     7     9    -8     9     3    -8    -5     1    10    10
```
```
rng default;
r = randi([-10 10],1,10,"logical")
```
```
r =

  1×10 logical array

   1   1   0   1   1   0   0   1   1   1
```

扩展功能

全部展开

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

用法说明和限制：

如果使用，输入参量 typename 必须为 "double"、"single"、"int8"、"uint8"、"int16"、"uint16"、"int32"、"uint32" 或 "logical"。不支持其他类，即使该类定义静态 randi 方法也是如此。
如果使用，大小参量 n、sz 和 sz1,...,szN 必须为固定大小。
代码生成器使用双精度数学计算单精度输出。
在大多数情况下，生成的 MEX 文件使用与 MATLAB^® 相同的随机数状态。如果您禁用外部调用或者从 parfor 循环内部调用 randi，则生成的 MEX 代码和独立代码保持其自己的随机数状态，该状态初始化为 MATLAB 默认值，即 rng(0,"twister")。

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

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

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

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

您可以将 typename 指定为 'gpuArray'。如果将 typename 指定为 'gpuArray'，则数组的默认基础类型是 double。
要创建基础类型 datatype 的 GPU 数组，请在 typename 之前将该基础类型指定为附加参量。例如，X = randi(imax,3,datatype,'gpuArray') 创建一个由基础类型 datatype 的 [1 imax] 范围内的随机整数组成的 3×3 GPU 数组。
您可以将基础类型 datatype 指定为以下选项之一：
- 'double'
- 'single'
- 'logical'
- 'int8'
- 'uint8'
- 'int16'
- 'uint16'
- 'int32'
- 'uint32'
您也可以将数值变量 p 指定为 gpuArray。
如果将 p 指定为 gpuArray，则返回的数组的基础类型与 p 相同。
要使用流语法 randi(s,___)，在 GPU 上 s 必须为 parallel.gpu.RandStream (Parallel Computing Toolbox) 对象。

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

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

用法说明和限制：

codistributed 或 distributed 数组不支持流语法 randi(s,___)。
您可以将 typename 指定为 'codistributed' 或 'distributed'。如果将 typename 指定为 'codistributed' 或 'distributed'，则返回的数组的默认基础类型为 double。
要创建基础类型 datatype 的分布式或共存分布式数组，请在 typename 之前将该基础类型指定为附加参量。例如，X = randi(imax,3,datatype,'distributed') 创建一个由基础类型 datatype 的 [1 imax] 范围内的随机整数组成的 3×3 分布式矩阵。
您可以将基础类型 datatype 指定为以下选项之一：
- 'double'
- 'single'
- 'int8'
- 'uint8'
- 'int16'
- 'uint16'
- 'int32'
- 'uint32'
- 'logical'
您也可以将 p 指定为 codistributed 或 distributed 数组。
如果将 p 指定为 codistributed 或 distributed 数组，则返回的数组的基础类型与 p 相同。
有关其他 codistributed 语法，请参阅 randi (codistributed) (Parallel Computing Toolbox)。

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

版本历史记录

在 R2008b 中推出

全部展开

R2023a: 创建随机逻辑数组

您可以通过将 typename 指定为 "logical" 或者将原型 p 指定为逻辑数组来创建随机逻辑数组。例如，请参阅随机逻辑数组。

R2022a: 使用 `like` 匹配复/实性，并将 `like` 与 `RandStream` 对象结合使用

like 名称-值参量既支持实数原型数组，也支持复数原型数组。例如：

r = randi(2,2,like=1i)

r =

   2.0000 + 2.0000i   2.0000 + 1.0000i
   1.0000 + 2.0000i   1.0000 + 2.0000i

所有语法都支持此功能。此外，您现在还可以将 like 与作为 randi 的第一个输入的 RandStream 对象一起使用。

R2014a: 使用 `'like'` 匹配现有变量的数据类型

要生成与现有变量具有相同数据类型的随机数，请使用语法 randi(__,'like',p)。例如：

A = single(pi);
r = randi(4,4,'like',A);
class(r)

ans = 
single

将 RandStream 对象作为 randi 的第一个输入进行传递时，此功能不可用。

R2013b: 不支持非整数大小输入

指定非整数维度会导致错误。使用 floor 将非整数大小输入转换为整数。

另请参阅

rand | randn | rng | RandStream | randperm

randi

语法

说明

示例

由随机整数组成的方阵

指定区间内的随机整数

控制随机数生成

由随机整数组成的三维数组

其他数据类型的随机整数

现有数组定义的大小

现有数组定义的大小和数值数据类型

随机复整数

随机逻辑数组

输入参数

imax — 示例区间中的最大整数 正整数

imin — 示例区间中的最小整数 1 (默认) | 整数标量

n — 方阵的大小 整数值

sz1,...,szN — 每个维度的大小（作为单独参量） 整数值

sz — 每个维度的大小（作为行向量） 整数值

typename — 要创建的数据类型（类） "double" (默认) | "single" | "int8" | "uint8" | "int16" | "uint16" | ...

p — 要创建的数组的原型 数值数组 | 逻辑数组

s — 随机数流 RandStream 对象

输出参量

X — 输出数组 标量 | 向量 | 矩阵 | 多维数组

详细信息

伪随机数生成器

提示

扩展功能

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

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

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

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

版本历史记录

R2023a: 创建随机逻辑数组

R2022a: 使用 like 匹配复/实性，并将 like 与 RandStream 对象结合使用

R2014a: 使用 'like' 匹配现有变量的数据类型

R2013b: 不支持非整数大小输入

另请参阅

主题

`imax` — 示例区间中的最大整数
正整数

`imin` — 示例区间中的最小整数
`1` (默认) | 整数标量

`n` — 方阵的大小
整数值

`sz1,...,szN` — 每个维度的大小（作为单独参量）
整数值

`sz` — 每个维度的大小（作为行向量）
整数值

`typename` — 要创建的数据类型（类）
`"double"` (默认) | `"single"` | `"int8"` | `"uint8"` | `"int16"` | `"uint16"` | ...

`p` — 要创建的数组的原型
数值数组 | 逻辑数组

`s` — 随机数流
`RandStream` 对象

`X` — 输出数组
标量 | 向量 | 矩阵 | 多维数组

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

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

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

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

R2022a: 使用 `like` 匹配复/实性，并将 `like` 与 `RandStream` 对象结合使用

R2014a: 使用 `'like'` 匹配现有变量的数据类型