Mercurial > hg > octave-lyh

diff scripts/linear-algebra/isdefinite.m @ 10687:a8ce6bdecce5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve documentation strings.
author Rik <octave@nomad.inbox5.com>
date Tue, 08 Jun 2010 20:22:38 -0700
parents 5b733adba096
children 0d9640d755b1
line wrap: on
line diff
--- a/scripts/linear-algebra/isdefinite.m
+++ b/scripts/linear-algebra/isdefinite.m
@@ -17,12 +17,13 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {} isdefinite (@var{x}, @var{tol})
+## @deftypefn  {Function File} {} isdefinite (@var{x})
+## @deftypefnx {Function File} {} isdefinite (@var{x}, @var{tol})
 ## Return 1 if @var{x} is symmetric positive definite within the
 ## tolerance specified by @var{tol} or 0 if @var{x} is symmetric
 ## positive semidefinite.  Otherwise, return -1.  If @var{tol}
-## is omitted, use a tolerance equal to 100 times the machine precision,
-## multiplied by the Frobeniusm norm of @var{x}.
+## is omitted, use a tolerance of 
+## @code{100 * eps * norm (@var{x}, "fro")}
 ## @seealso{issymmetric}
 ## @end deftypefn