bundles / scipy latest / scipy / linalg / _matfuncs / signm
function
scipy.linalg._matfuncs:signm
source: /scipy/linalg/_matfuncs.py :902
Signature
def signm ( A , disp = <object object at 0x0000> ) Summary
Matrix sign function.
Extended Summary
Extension of the scalar sign(x) to matrices.
The documentation is written assuming array arguments are of specified "core" shapes. However, array argument(s) of this function may have additional "batch" dimensions prepended to the core shape. In this case, the array is treated as a batch of lower-dimensional slices; see linalg_batch for details. Note that calls with zero-size batches are unsupported and will raise a ValueError.
Parameters
A: (N, N) array_likeMatrix at which to evaluate the sign function
disp: bool, optionalPrint warning if error in the result is estimated large instead of returning estimated error. (Default: True)
Returns
signm: (N, N) ndarrayValue of the sign function at
Aerrest: float(if disp == False)
1-norm of the estimated error, ||err||_1 / ||A||_1
Examples
from scipy.linalg import signm, eigvals a = [[1,2,3], [1,2,1], [1,1,1]]✓
eigvals(a)
✗eigvals(signm(a))
✓Aliases
-
scipy.linalg.signm