diff src/DLD-FUNCTIONS/pinv.cc @ 3365:7ed630f7b7be

[project @ 1999-11-20 03:11:17 by jwe]
author jwe
date Sat, 20 Nov 1999 03:12:52 +0000
parents 38de16594cb4
children f16c2ce14886
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/pinv.cc
+++ b/src/DLD-FUNCTIONS/pinv.cc
@@ -31,8 +31,16 @@
 #include "utils.h"
 
 DEFUN_DLD (pinv, args, ,
-  "pinv ( [, tol])\n\
-Returns the pseudoinverse of X; singular values less than tol are ignored.")
+  "-*- texinfo -*-\n\
+@deftypefn {Function File } { } pinv (@var{X}, @var{tol})\n\
+Returns the pseudoinverse of X; singular values less than tol are ignored.\n\
+\n\
+If the second arguement is ommited , it is assummed that\n\
+@example\n\
+tol = max (size (X)) * sigma_max (X) * eps,\n\
+@end example\n\
+where sigma_max(X) is the maximal singular value of X.\n\
+@end deftypefn")
 {
   octave_value_list retval;