numpy.sign#

numpy.sign(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature]) = <ufunc 'sign'>#

返回一个数字符号的逐元素指示。

sign 函数返回 -1 if x < 0, 0 if x==0, 1 if x > 0。对于 nan 输入,返回 nan。

对于复数输入,sign 函数返回 x / abs(x),这是上述内容的泛化(以及 0 if x==0)。

在版本 2.0.0 中更改: 复数符号的定义已更改为遵循 Array API 标准。

参数:
x类似数组

输入值。

outndarray、None 或 ndarray 和 None 的元组,可选

结果存储的位置。如果提供,它必须具有输入广播到的形状。如果未提供或为 None,则返回一个新分配的数组。元组(只能作为关键字参数)的长度必须等于输出的数量。

where类似数组,可选

此条件在输入上广播。在条件为 True 的位置,out 数组将被设置为 ufunc 结果。在其他位置,out 数组将保留其原始值。请注意,如果通过默认的 out=None 创建一个未初始化的 out 数组,则其中条件为 False 的位置将保持未初始化。

**kwargs**

对于其他关键字参数,请参阅 ufunc 文档

返回值:
yndarray

x 的符号。如果 x 是标量,则它是一个标量。

注释

复数的符号存在多种常用的定义。这里使用的定义 \(x/|x|\) 是更常见且更有用的定义,但与 numpy 2.0 之前的版本中使用的定义不同,后者为 \(x/\sqrt{x*x}\),等效于 sign(x.real) + 0j if x.real != 0 else sign(x.imag) + 0j

示例

>>> import numpy as np
>>> np.sign([-5., 4.5])
array([-1.,  1.])
>>> np.sign(0)
0
>>> np.sign([3-4j, 8j])
array([0.6-0.8j, 0. +1.j ])