Mercurial > hg > octave-nkf
comparison src/DLD-FUNCTIONS/svd.cc @ 11533:06c80c90a246
Add undocumented function svd_driver to documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Fri, 14 Jan 2011 14:21:23 -0800 |
parents | fd0a3ac60b0e |
children | 01f703952eff |
comparison
equal
deleted
inserted
replaced
11532:34bb8d38f19f | 11533:06c80c90a246 |
---|---|
119 @end example\n\ | 119 @end example\n\ |
120 \n\ | 120 \n\ |
121 If given a second argument, @code{svd} returns an economy-sized\n\ | 121 If given a second argument, @code{svd} returns an economy-sized\n\ |
122 decomposition, eliminating the unnecessary rows or columns of @var{u} or\n\ | 122 decomposition, eliminating the unnecessary rows or columns of @var{u} or\n\ |
123 @var{v}.\n\ | 123 @var{v}.\n\ |
124 @seealso{svd_driver, svds, eig}\n\ | |
124 @end deftypefn") | 125 @end deftypefn") |
125 { | 126 { |
126 octave_value_list retval; | 127 octave_value_list retval; |
127 | 128 |
128 int nargin = args.length (); | 129 int nargin = args.length (); |
404 */ | 405 */ |
405 | 406 |
406 DEFUN_DLD (svd_driver, args, nargout, | 407 DEFUN_DLD (svd_driver, args, nargout, |
407 "-*- texinfo -*-\n\ | 408 "-*- texinfo -*-\n\ |
408 @deftypefn {Loadable Function} {@var{old} =} svd_driver (@var{new})\n\ | 409 @deftypefn {Loadable Function} {@var{old} =} svd_driver (@var{new})\n\ |
409 Sets or queries the underlying @sc{lapack} driver used by svd.\n\ | 410 Set or query the underlying @sc{lapack} driver used by @code{svd}.\n\ |
410 Currently recognized are \"gesvd\" and \"gesdd\". Default is \"gesvd\".\n\ | 411 Currently recognized values are \"gesvd\" and \"gesdd\". The default\n\ |
412 is \"gesvd\".\n\ | |
411 @seealso{svd}\n\ | 413 @seealso{svd}\n\ |
412 @end deftypefn") | 414 @end deftypefn") |
413 { | 415 { |
414 static const char *driver_names[] = { "gesvd", "gesdd", 0 }; | 416 static const char *driver_names[] = { "gesvd", "gesdd", 0 }; |
415 | 417 |