【NumPy】np.allclose() 函数：判断两个数组是否在数值上近似相等

np.allclose 是 NumPy 中的一个函数，用于判断两个数组是否在数值上近似相等。它非常适合在数值计算中比较结果时使用，尤其是因为浮点数运算可能会导致微小的误差。

---

1. 函数定义

numpy.allclose(a, b, rtol=1e-5, atol=1e-8, equal_nan=False)

2. 参数说明

• a, b: 输入的两个数组，需要比较它们是否相等。
• rtol: 相对误差的容忍度（默认值是 $1\times 10^{-5}$）。
  • 计算方式是基于两个数组对应元素的大小。
• atol: 绝对误差的容忍度（默认值是 $1\times 10^{-8}$）。
  • 计算方式是一个全局的固定误差容忍度。
• equal_nan: 是否将两个 NaN 视为相等。
  • 默认值是 False（即两个 NaN 不被视为相等）。
  • 设置为 True 后，两个对应位置的 NaN 将被视为相等。

3. 返回值

• 返回一个布尔值：
  • True：如果两个数组在误差范围内近似相等。
  • False：如果它们超出了误差范围。

---

4. 判断标准

两个数组对应元素 $a$ 和 $b$ 满足以下条件时，视为近似相等：
$$|a-b|\le \text{atol}+\text{rtol}\cdot |b|$$

• $\text{atol}$：绝对误差容忍度。
• $\text{rtol}$：相对误差容忍度。

---

5. 示例代码

示例 1：基本使用

import numpy as np

a = np.array([1.0, 2.0, 3.0])
b = np.array([1.00000001, 2.00000001, 3.00000001])

# 使用默认误差范围
print(np.allclose(a, b))  # 输出：True

示例 2：误差范围不满足

c = np.array([1.0, 2.0, 3.0])
d = np.array([1.0, 2.1, 3.0])

print(np.allclose(c, d))  # 输出：False

示例 3：调整误差范围

# 提高误差容忍度
print(np.allclose(c, d, atol=0.2))  # 输出：True

示例 4：处理 NaN 值

e = np.array([1.0, np.nan, 3.0])
f = np.array([1.0, np.nan, 3.0])

# 默认情况下，NaN 不视为相等
print(np.allclose(e, f))  # 输出：False

# 将 NaN 视为相等
print(np.allclose(e, f, equal_nan=True))  # 输出：True

---

6. 典型应用场景

1. 验证数值算法的正确性：
   • 比较浮点数运算结果是否在容忍范围内一致。
2. 机器学习模型：
   • 检查两个模型的预测输出是否近似相等。
3. 科学计算：
   • 比较矩阵或向量的计算结果是否在误差允许范围内一致。
4. 数组元素比较：
   • 判断两个高维数组的元素是否接近。

---

7. 注意事项

1. 浮点数误差：

   • 由于浮点数精度问题，直接使用 == 比较可能失败，但 np.allclose 可以通过误差容忍度解决这个问题。

2. 误差范围的设置：

   • 如果误差范围（rtol 和 atol）设置不当，可能导致误判。例如，误差范围过大可能使明显不同的值被认为是相等的。

3. NaN 的处理：

   • 默认情况下，NaN 值不被认为是相等的，除非显式设置 equal_nan=True。

---

总结

np.allclose 是一个强大的工具，专门用于检查两个数组的近似相等性，它考虑了浮点数精度误差，是数值计算中非常实用的函数。