Mercurial > hg > octave-max

changeset 11533:06c80c90a246

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add undocumented function svd_driver to documentation.
author Rik <octave@nomad.inbox5.com>
date Fri, 14 Jan 2011 14:21:23 -0800
parents 34bb8d38f19f
children 199543df2ece
files doc/ChangeLog doc/interpreter/linalg.txi src/ChangeLog src/DLD-FUNCTIONS/svd.cc
diffstat 4 files changed, 14 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,7 @@
+2011-01-14  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/linalg.txi: Add undocumented svd_driver to documentation.
+
 2011-01-14  Rik  <octave@nomad.inbox5.com>
 
 	* interpreter/arith.txi: Add undocumented cbrt to documentation.
--- a/doc/interpreter/linalg.txi
+++ b/doc/interpreter/linalg.txi
@@ -159,6 +159,8 @@
 
 @DOCSTRING(svd)
 
+@DOCSTRING(svd_driver)
+
 @c FIXME -- should there be a new section here?
 
 @DOCSTRING(housh)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,7 @@
+2011-01-14  Rik  <octave@nomad.inbox5.com>
+
+	* DLD-FUNCTIONS/svd.cc: Add Seealso references to svd.
+
 2011-01-14  Rik  <octave@nomad.inbox5.com>
 
 	* src/mappers.cc: Add Seealso links between sqrt, cbrt, nthroot
--- a/src/DLD-FUNCTIONS/svd.cc
+++ b/src/DLD-FUNCTIONS/svd.cc
@@ -121,6 +121,7 @@
 If given a second argument, @code{svd} returns an economy-sized\n\
 decomposition, eliminating the unnecessary rows or columns of @var{u} or\n\
 @var{v}.\n\
+@seealso{svd_driver, svds, eig}\n\
 @end deftypefn")
 {
   octave_value_list retval;
@@ -406,8 +407,9 @@
 DEFUN_DLD (svd_driver, args, nargout,
   "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{old} =} svd_driver (@var{new})\n\
-Sets or queries the underlying @sc{lapack} driver used by svd.\n\
-Currently recognized are \"gesvd\" and \"gesdd\".  Default is \"gesvd\".\n\
+Set or query the underlying @sc{lapack} driver used by @code{svd}.\n\
+Currently recognized values are \"gesvd\" and \"gesdd\".  The default\n\
+is \"gesvd\".\n\
 @seealso{svd}\n\
 @end deftypefn")
 {