From c612fffa44b711c3c19964aa97e111a80c4e8cec Mon Sep 17 00:00:00 2001 From: dhoegh Date: Sun, 8 Mar 2015 10:39:44 +0100 Subject: [PATCH] Add docs. --- doc/stdlib/linalg.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/stdlib/linalg.rst b/doc/stdlib/linalg.rst index 02c2d906c1f6c8..4cfdff251edf93 100644 --- a/doc/stdlib/linalg.rst +++ b/doc/stdlib/linalg.rst @@ -580,9 +580,9 @@ Linear algebra functions in Julia are largely implemented by calling functions f Computes the solution ``X`` to the Sylvester equation ``AX + XB + C = 0``, where ``A``, ``B`` and ``C`` have compatible dimensions and ``A`` and ``-B`` have no eigenvalues with equal real part. -.. function:: issym(A) -> Bool +.. function:: issym(A, [tol=1e-10]) -> Bool - Test whether a matrix is symmetric. + Test whether a matrix is symmetric. Tol is only used for arrays of FlotingPoint or ``Complex{T<:FlotingPoint}`` numbers, where it tests ``norm(A - A.', Inf) < tol*norm(A,Inf)``. .. function:: isposdef(A) -> Bool @@ -600,9 +600,9 @@ Linear algebra functions in Julia are largely implemented by calling functions f Test whether a matrix is upper triangular. -.. function:: ishermitian(A) -> Bool +.. function:: ishermitian(A, [tol=1e-10]) -> Bool - Test whether a matrix is Hermitian. + Test whether a matrix is Hermitian. Tol is only used for arrays of FlotingPoint or ``Complex{T<:FlotingPoint}`` numbers, where it tests ``norm(A - A', Inf) < tol*norm(A,Inf)``. .. function:: transpose(A)