Mercurial > octave-antonio

comparison scripts/linear-algebra/orth.m @ 20160:03b9d17a2d95 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 15:36:23 -0700
parents 9fc020886ae9
children
comparison
equal deleted inserted replaced
20159:597991b19e40 20160:03b9d17a2d95
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} orth (@var{A}) 20 ## @deftypefn {Function File} {} orth (@var{A})
21 ## @deftypefnx {Function File} {} orth (@var{A}, @var{tol}) 21 ## @deftypefnx {Function File} {} orth (@var{A}, @var{tol})
22 ## Return an orthonormal basis of the range space of @var{A}. 22 ## Return an orthonormal basis of the range space of @var{A}.
23 ## 23 ##
24 ## The dimension of the range space is taken as the number of singular 24 ## The dimension of the range space is taken as the number of singular values
25 ## values of @var{A} greater than @var{tol}. If the argument @var{tol} is 25 ## of @var{A} greater than @var{tol}. If the argument @var{tol} is missing, it
26 ## missing, it is computed as 26 ## is computed as
27 ## 27 ##
28 ## @example 28 ## @example
29 ## max (size (@var{A})) * max (svd (@var{A})) * eps 29 ## max (size (@var{A})) * max (svd (@var{A})) * eps
30 ## @end example 30 ## @end example
31 ## @seealso{null} 31 ## @seealso{null}