Mercurial > octave-antonio

comparison scripts/linear-algebra/rref.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
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} rref (@var{A}) 20 ## @deftypefn {Function File} {} rref (@var{A})
21 ## @deftypefnx {Function File} {} rref (@var{A}, @var{tol}) 21 ## @deftypefnx {Function File} {} rref (@var{A}, @var{tol})
22 ## @deftypefnx {Function File} {[@var{r}, @var{k}] =} rref (@dots{}) 22 ## @deftypefnx {Function File} {[@var{r}, @var{k}] =} rref (@dots{})
23 ## Return the reduced row echelon form of @var{A}. @var{tol} defaults 23 ## Return the reduced row echelon form of @var{A}.
24 ## to @code{eps * max (size (@var{A})) * norm (@var{A}, inf)}.
25 ## 24 ##
26 ## Called with two return arguments, @var{k} returns the vector of 25 ## @var{tol} defaults to
27 ## "bound variables", which are those columns on which elimination 26 ## @code{eps * max (size (@var{A})) * norm (@var{A}, inf)}.
28 ## has been performed. 27 ##
28 ## The optional return argument @var{k} contains the vector of
29 ## "bound variables", which are those columns on which elimination has been
30 ## performed.
29 ## 31 ##
30 ## @end deftypefn 32 ## @end deftypefn
31 33
32 ## Author: Paul Kienzle <pkienzle@users.sf.net> 34 ## Author: Paul Kienzle <pkienzle@users.sf.net>
33 ## (based on an anonymous source from the public domain) 35 ## (based on an anonymous source from the public domain)