Mercurial > octave-antonio

diff scripts/linear-algebra/rank.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 4197fc428c7d
children
line wrap: on
line diff
--- a/scripts/linear-algebra/rank.m	Sun May 03 12:58:42 2015 -0700
+++ b/scripts/linear-algebra/rank.m	Sun May 03 15:36:23 2015 -0700
@@ -21,9 +21,9 @@
 ## @deftypefnx {Function File} {} rank (@var{A}, @var{tol})
 ## Compute the rank of matrix @var{A}, using the singular value decomposition.
 ##
-## The rank is taken to be the number of singular values of @var{A} that
-## are greater than the specified tolerance @var{tol}.  If the second
-## argument is omitted, it is taken to be
+## The rank is taken to be the number of singular values of @var{A} that are
+## greater than the specified tolerance @var{tol}.  If the second argument is
+## omitted, it is taken to be
 ##
 ## @example
 ## tol = max (size (@var{A})) * sigma(1) * eps;
@@ -33,10 +33,9 @@
 ## where @code{eps} is machine precision and @code{sigma(1)} is the largest
 ## singular value of @var{A}.
 ##
-## The rank of a matrix is the number of linearly independent rows or
-## columns and determines how many particular solutions exist to a system
-## of equations.  Use @code{null} for finding the remaining homogenous
-## solutions.
+## The rank of a matrix is the number of linearly independent rows or columns
+## and determines how many particular solutions exist to a system of equations.
+## Use @code{null} for finding the remaining homogenous solutions.
 ##
 ## Example:
 ##
@@ -51,8 +50,8 @@
 ## @end example
 ##
 ## @noindent
-## The number of linearly independent rows is only 2 because the final row
-## is a linear combination of -1*row1 + 2*row2.
+## The number of linearly independent rows is only 2 because the final row is a
+## linear combination of -1*row1 + 2*row2.
 ##
 ## @seealso{null, sprank, svd}
 ## @end deftypefn