Mercurial > octave-nkf
comparison src/DLD-FUNCTIONS/svd.cc @ 12584:7ef7e20057fa stable
Improve documentation strings in Linear Algebra chapter.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Fri, 08 Apr 2011 12:44:40 -0700 |
parents | 12df7854fa7c |
children | 5fa482628bf6 |
comparison
equal
deleted
inserted
replaced
12582:6a4e042b6114 | 12584:7ef7e20057fa |
---|---|
46 @deftypefnx {Loadable Function} {[@var{U}, @var{S}, @var{V}] =} svd (@var{A}, @var{econ})\n\ | 46 @deftypefnx {Loadable Function} {[@var{U}, @var{S}, @var{V}] =} svd (@var{A}, @var{econ})\n\ |
47 @cindex singular value decomposition\n\ | 47 @cindex singular value decomposition\n\ |
48 Compute the singular value decomposition of @var{A}\n\ | 48 Compute the singular value decomposition of @var{A}\n\ |
49 @tex\n\ | 49 @tex\n\ |
50 $$\n\ | 50 $$\n\ |
51 A = U S V^H\n\ | 51 A = U S V^{\\dagger}\n\ |
52 $$\n\ | 52 $$\n\ |
53 @end tex\n\ | 53 @end tex\n\ |
54 @ifnottex\n\ | 54 @ifnottex\n\ |
55 \n\ | 55 \n\ |
56 @example\n\ | 56 @example\n\ |
404 | 404 |
405 */ | 405 */ |
406 | 406 |
407 DEFUN_DLD (svd_driver, args, nargout, | 407 DEFUN_DLD (svd_driver, args, nargout, |
408 "-*- texinfo -*-\n\ | 408 "-*- texinfo -*-\n\ |
409 @deftypefn {Loadable Function} {@var{old} =} svd_driver (@var{new})\n\ | 409 @deftypefn {Loadable Function} {@var{val} =} svd_driver ()\n\ |
410 Set or query the underlying @sc{lapack} driver used by @code{svd}.\n\ | 410 @deftypefnx {Loadable Function} {@var{old_val} =} svd_driver (@var{new_val})\n\ |
411 Query or set the underlying @sc{lapack} driver used by @code{svd}.\n\ | |
411 Currently recognized values are \"gesvd\" and \"gesdd\". The default\n\ | 412 Currently recognized values are \"gesvd\" and \"gesdd\". The default\n\ |
412 is \"gesvd\".\n\ | 413 is \"gesvd\".\n\ |
413 @seealso{svd}\n\ | 414 @seealso{svd}\n\ |
414 @end deftypefn") | 415 @end deftypefn") |
415 { | 416 { |