Mercurial > hg > octave-nkf
diff scripts/linear-algebra/orth.m @ 11470:eb9e0b597d61
Use common names for variables in documentation and code for a few more m-script files.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sun, 09 Jan 2011 13:44:15 -0800 |
| parents | a8ce6bdecce5 |
| children | fd0a3ac60b0e |
line wrap: on
line diff
--- a/scripts/linear-algebra/orth.m +++ b/scripts/linear-algebra/orth.m @@ -18,15 +18,15 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} orth (@var{a}, @var{tol}) -## Return an orthonormal basis of the range space of @var{a}. +## @deftypefn {Function File} {} orth (@var{A}, @var{tol}) +## Return an orthonormal basis of the range space of @var{A}. ## ## The dimension of the range space is taken as the number of singular -## values of @var{a} greater than @var{tol}. If the argument @var{tol} is +## values of @var{A} greater than @var{tol}. If the argument @var{tol} is ## missing, it is computed as ## ## @example -## max (size (@var{a})) * max (svd (@var{a})) * eps +## max (size (@var{A})) * max (svd (@var{A})) * eps ## @end example ## @seealso{null} ## @end deftypefn