数组 API 函数

备注

cupy.array_api 将在 CuPy v14 中被移除，因为它的 NumPy 对应物 numpy.array_api 已被移除。根模块 cupy.* 现在与数组 API 规范兼容，因为它反映了 NumPy v2 API。使用 Array API 兼容库 开发与各种数组库（包括 CuPy、NumPy 和 PyTorch）兼容的应用程序。

本节是已实现API的完整列表。有关详细文档，请参阅 数组 API 规范。

cupy.array_api.abs(x, /)

Array API 兼容的 np.abs 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.acos(x, /)

Array API 兼容的 np.arccos 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.acosh(x, /)

Array API 兼容的 np.arccosh 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.add(x1, x2, /)

与 np.add 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.all(x, /, *, axis=None, keepdims=False)

Array API 兼容的 np.all 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.any(x, /, *, axis=None, keepdims=False)

Array API 兼容的 np.any 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.arange(start, /, stop=None, step=1, *, dtype=None, device=None)

Array API 兼容的 np.arange 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.argmax(x, /, *, axis=None, keepdims=False)

Array API 兼容的 np.argmax 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.argmin(x, /, *, axis=None, keepdims=False)

Array API 兼容的 np.argmin 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.argsort(x, /, *, axis=-1, descending=False, stable=True)

Array API 兼容的 np.argsort 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.asarray(obj, /, *, dtype=None, device=None, copy=None)

与 Array API 兼容的 np.asarray 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.asin(x, /)

Array API 兼容的 np.arcsin 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.asinh(x, /)

Array API 兼容的 np.arcsinh 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.atan(x, /)

与 Array API 兼容的 np.arctan 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.atan2(x1, x2, /)

Array API 兼容的 np.arctan2 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.atanh(x, /)

Array API 兼容的 np.arctanh 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.bitwise_and(x1, x2, /)

Array API 兼容的 np.bitwise_and 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.bitwise_invert(x, /)

Array API 兼容的 np.invert 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.bitwise_left_shift(x1, x2, /)

Array API 兼容的 np.left_shift 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.bitwise_or(x1, x2, /)

Array API 兼容的 np.bitwise_or 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.bitwise_right_shift(x1, x2, /)

Array API 兼容的 np.right_shift 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.bitwise_xor(x1, x2, /)

Array API 兼容的 np.bitwise_xor 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.broadcast_arrays(*arrays)

Array API 兼容的 np.broadcast_arrays 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

List[Array]

cupy.array_api.broadcast_to(x, /, shape)

Array API 兼容的 np.broadcast_to 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.can_cast(from_, to, /)

Array API 兼容的 np.can_cast 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

bool

cupy.array_api.ceil(x, /)

Array API 兼容的 np.ceil 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.concat(arrays, /, *, axis=0)

Array API 兼容的 np.concatenate 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.cos(x, /)

Array API 兼容的 np.cos 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.cosh(x, /)

Array API 兼容的 np.cosh 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.divide(x1, x2, /)

Array API 兼容的 np.divide 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.empty(shape, *, dtype=None, device=None)

与 Array API 兼容的 np.empty 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.empty_like(x, /, *, dtype=None, device=None)

Array API 兼容的 np.empty_like 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.equal(x1, x2, /)

与 np.equal 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.exp(x, /)

Array API 兼容的 np.exp 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.expand_dims(x, /, *, axis)

Array API 兼容的 np.expand_dims 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.expm1(x, /)

与 np.expm1 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.eye(n_rows, n_cols=None, /, *, k=0, dtype=None, device=None)

与 Array API 兼容的 np.eye 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.finfo(type, /)

与 Array API 兼容的 np.finfo 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

finfo_object

cupy.array_api.flip(x, /, *, axis=None)

Array API 兼容的 np.flip 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.floor(x, /)

Array API 兼容的 np.floor 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.floor_divide(x1, x2, /)

Array API 兼容的 np.floor_divide 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.from_dlpack(x, /)

Array API 兼容的 np.from_dlpack 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.full(shape, fill_value, *, dtype=None, device=None)

Array API 兼容的 np.full 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.full_like(x, /, fill_value, *, dtype=None, device=None)

Array API 兼容的 np.full_like 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.greater(x1, x2, /)

Array API 兼容的 np.greater 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.greater_equal(x1, x2, /)

Array API 兼容的 np.greater_equal 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.iinfo(type, /)

与 Array API 兼容的 np.iinfo 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

iinfo_object

cupy.array_api.isfinite(x, /)

Array API 兼容的 np.isfinite 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.isinf(x, /)

Array API 兼容的 np.isinf 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.isnan(x, /)

Array API 兼容的 np.isnan 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.less(x1, x2, /)

与 np.less 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.less_equal(x1, x2, /)

Array API 兼容的 np.less_equal 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.linspace(start, stop, /, num, *, dtype=None, device=None, endpoint=True)

Array API 兼容的 np.linspace 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.log(x, /)

与 Array API 兼容的 np.log 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.log10(x, /)

Array API 兼容的 np.log10 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.log1p(x, /)

Array API 兼容的 np.log1p 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.log2(x, /)

Array API 兼容的 np.log2 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.logaddexp(x1, x2)

Array API 兼容的 np.logaddexp 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.logical_and(x1, x2, /)

与 np.logical_and 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.logical_not(x, /)

Array API 兼容的 np.logical_not 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.logical_or(x1, x2, /)

与 np.logical_or 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.logical_xor(x1, x2, /)

Array API 兼容的 np.logical_xor 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.matmul(x1, x2, /)

Array API 兼容的 np.matmul 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.meshgrid(*arrays, indexing='xy')

Array API 兼容的 np.meshgrid 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

List[Array]

cupy.array_api.multiply(x1, x2, /)

与 Array API 兼容的 np.multiply 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.negative(x, /)

Array API 兼容的 np.negative 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.nonzero(x, /)

Array API 兼容的 np.nonzero 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Tuple[Array, …]

cupy.array_api.not_equal(x1, x2, /)

Array API 兼容的 np.not_equal 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.ones(shape, *, dtype=None, device=None)

Array API 兼容的 np.ones 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.ones_like(x, /, *, dtype=None, device=None)

Array API 兼容的 np.ones_like 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.permute_dims(x, /, axes)

Array API 兼容的 np.transpose 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.positive(x, /)

Array API 兼容的 np.positive 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.pow(x1, x2, /)

与 np.power 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.remainder(x1, x2, /)

Array API 兼容的 np.remainder 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.reshape(x, /, shape)

Array API 兼容的 np.reshape 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.result_type(*arrays_and_dtypes)

Array API 兼容的 np.result_type 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Dtype

cupy.array_api.roll(x, /, shift, *, axis=None)

Array API 兼容的 np.roll 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.round(x, /)

Array API 兼容的 np.round 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.sign(x, /)

Array API 兼容的 np.sign 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.sin(x, /)

Array API 兼容的 np.sin 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.sinh(x, /)

Array API 兼容的 np.sinh 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.sort(x, /, *, axis=-1, descending=False, stable=True)

与 Array API 兼容的 np.sort 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.sqrt(x, /)

Array API 兼容的 np.sqrt 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.square(x, /)

与 np.square 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.squeeze(x, /, axis)

Array API 兼容的 np.squeeze 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.stack(arrays, /, *, axis=0)

Array API 兼容的 np.stack 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.subtract(x1, x2, /)

Array API 兼容的 np.subtract 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.take(x, indices, /, *, axis)

Array API 兼容的 np.take 包装器。更多信息请参阅其文档字符串。

返回类型:

Array

cupy.array_api.tan(x, /)

Array API 兼容的 np.tan 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.tanh(x, /)

Array API 兼容的 np.tanh 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.tril(x, /, *, k=0)

与 np.tril 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.triu(x, /, *, k=0)

Array API 兼容的 np.triu 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.trunc(x, /)

Array API 兼容的 np.trunc 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.unique_all(x, /)

Array API 兼容的 np.unique 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

UniqueAllResult

cupy.array_api.unique_inverse(x, /)

Array API 兼容的 np.unique 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

UniqueInverseResult

cupy.array_api.unique_values(x, /)

Array API 兼容的 np.unique 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.where(condition, x1, x2, /)

与 np.where 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.zeros(shape, *, dtype=None, device=None)

与 np.zeros 兼容的数组 API 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array

cupy.array_api.zeros_like(x, /, *, dtype=None, device=None)

Array API 兼容的 np.zeros_like 包装器。

有关更多信息，请参阅其文档字符串。

返回类型:

Array