Skip to content

Commit

Permalink
updeted the description of rtol in takagi
Browse files Browse the repository at this point in the history
  • Loading branch information
RyosukeNORO committed Jul 8, 2024
1 parent 6fb38fe commit b5fbd06
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion thewalrus/decompositions.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def takagi(A, svd_order=True, rtol=1e-16):
Args:
A (array): square, symmetric matrix
svd_order (boolean): whether to return result by ordering the singular values of ``A`` in descending (``True``) or ascending (``False``) order.
rtol (float): relative tolerance when judging if the matrix is diagonal or not.
rtol (float): the relative tolerance parameter used in ``np.allclose`` when judging if the matrix is diagonal or not. Default to 1e-16.
Returns:
tuple[array, array]: (r, U), where r are the singular values,
Expand Down

0 comments on commit b5fbd06

Please sign in to comment.