Mercurial > hg > octave-nkf

diff scripts/linear-algebra/cond.m @ 3372:f16c2ce14886
[project @ 1999-11-23 19:07:09 by jwe]
author: jwe
date: Tue, 23 Nov 1999 19:07:18 +0000
parents: a2b3a1413d28
children: 5e0a0b1cba43
--- a/scripts/linear-algebra/cond.m
+++ b/scripts/linear-algebra/cond.m
@@ -17,12 +17,13 @@
 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 ## 02111-1307, USA.
 
-## usage: cond (A)
-##
-## Return the condition number of A, computed using the singular values
-## of A.  If the maximum and minimum singular values of A are both zero,
-## cond returns Inf rather than NaN.
-##
+## -*- texinfo -*-
+## @deftypefn {Function File} {} cond (@var{a})
+## Compute the (two-norm) condition number of a matrix. @code{cond (a)} is
+## defined as @code{norm (a) * norm (inv (a))}, and is computed via a
+## singular value decomposition.
+## @end deftypefn
+
 ## See also: norm, svd, rank
 
 ## Author: jwe