Mercurial > hg > octave-nkf

comparison scripts/linear-algebra/rank.m @ 11470:eb9e0b597d61

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 95c3e38098bf
children fd0a3ac60b0e
comparison
equal deleted inserted replaced
11469:c776f063fefe 11470:eb9e0b597d61
16 ## You should have received a copy of the GNU General Public License 16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {} rank (@var{a}, @var{tol}) 21 ## @deftypefn {Function File} {} rank (@var{A}, @var{tol})
22 ## Compute the rank of @var{a}, using the singular value decomposition. 22 ## Compute the rank of @var{A}, using the singular value decomposition.
23 ## The rank is taken to be the number of singular values of @var{a} that 23 ## The rank is taken to be the number of singular values of @var{A} that
24 ## are greater than the specified tolerance @var{tol}. If the second 24 ## are greater than the specified tolerance @var{tol}. If the second
25 ## argument is omitted, it is taken to be 25 ## argument is omitted, it is taken to be
26 ## 26 ##
27 ## @example 27 ## @example
28 ## tol = max (size (@var{a})) * sigma(1) * eps; 28 ## tol = max (size (@var{A})) * sigma(1) * eps;
29 ## @end example 29 ## @end example
30 ## 30 ##
31 ## @noindent 31 ## @noindent
32 ## where @code{eps} is machine precision and @code{sigma(1)} is the largest 32 ## where @code{eps} is machine precision and @code{sigma(1)} is the largest
33 ## singular value of @var{a}. 33 ## singular value of @var{A}.
34 ## @end deftypefn 34 ## @end deftypefn
35 35
36 ## Author: jwe 36 ## Author: jwe
37 37
38 function retval = rank (A, tol) 38 function retval = rank (A, tol)