Mercurial > octave-nkf

comparison src/DLD-FUNCTIONS/pinv.cc @ 3372:f16c2ce14886

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 1999-11-23 19:07:09 by jwe]
author jwe
date Tue, 23 Nov 1999 19:07:18 +0000
parents 7ed630f7b7be
children ccfdb55c8156
comparison
equal deleted inserted replaced
3371:86873384cd10 3372:f16c2ce14886
30 #include "oct-obj.h" 30 #include "oct-obj.h"
31 #include "utils.h" 31 #include "utils.h"
32 32
33 DEFUN_DLD (pinv, args, , 33 DEFUN_DLD (pinv, args, ,
34 "-*- texinfo -*-\n\ 34 "-*- texinfo -*-\n\
35 @deftypefn {Function File } { } pinv (@var{X}, @var{tol})\n\ 35 @deftypefn {Loadable Function} {} pinv (@var{x}, @var{tol})\n\
36 Returns the pseudoinverse of X; singular values less than tol are ignored.\n\ 36 Return the pseudoinverse of @var{x}. Singular values less than\n\
37 @var{tol} are ignored. \n\
37 \n\ 38 \n\
38 If the second arguement is ommited , it is assummed that\n\ 39 If the second argument is omitted, it is assumed that\n\
40 \n\
39 @example\n\ 41 @example\n\
40 tol = max (size (X)) * sigma_max (X) * eps,\n\ 42 tol = max (size (@var{x})) * sigma_max (@var{x}) * eps,\n\
41 @end example\n\ 43 @end example\n\
42 where sigma_max(X) is the maximal singular value of X.\n\ 44 \n\
45 @noindent\n\
46 where @code{sigma_max (@var{x})} is the maximal singular value of @var{x}.\n\
43 @end deftypefn") 47 @end deftypefn")
44 { 48 {
45 octave_value_list retval; 49 octave_value_list retval;
46 50
47 int nargin = args.length (); 51 int nargin = args.length ();