numpy.sign#

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

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

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

对于复数输入,函数 sign 返回 x / abs(x),这是上述定义的推广(并且 0 如果 x==0)。

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

参数:
xarray_like

输入值。

outndarray, None, or tuple of ndarray and None, optional

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

wherearray_like, optional

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

**kwargs

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

返回:
yndarray

x 的符号。如果 x 是标量,则此函数也返回标量。

另请参阅

signbit
copysign

备注

复数符号有多种常用定义。此处使用的定义 \(x/|x|\) 是更常见且有用的定义,但与 2.0 版本之前的 numpy 中使用的定义 \(x/\sqrt{x*x}\) 不同,后者等同于 sign(x.real) + 0j 如果 x.real != 0 否则 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 ])