Mercurial > octave-antonio
diff scripts/sparse/eigs.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line diff
--- a/scripts/sparse/eigs.m Sun May 03 21:52:42 2015 -0700 +++ b/scripts/sparse/eigs.m Mon May 04 14:22:02 2015 -0700 @@ -38,8 +38,10 @@ ## @deftypefnx {Function File} {[@var{V}, @var{d}, @var{flag}] =} eigs (@var{A}, @dots{}) ## @deftypefnx {Function File} {[@var{V}, @var{d}, @var{flag}] =} eigs (@var{af}, @var{n}, @dots{}) ## Calculate a limited number of eigenvalues and eigenvectors of @var{A}, -## based on a selection criteria. The number of eigenvalues and eigenvectors to -## calculate is given by @var{k} and defaults to 6. +## based on a selection criteria. +## +## The number of eigenvalues and eigenvectors to calculate is given by +## @var{k} and defaults to 6. ## ## By default, @code{eigs} solve the equation ## @tex @@ -147,13 +149,13 @@ ## ## It is also possible to represent @var{A} by a function denoted @var{af}. ## @var{af} must be followed by a scalar argument @var{n} defining the length -## of the vector argument accepted by @var{af}. @var{af} can be -## a function handle, an inline function, or a string. When @var{af} is a -## string it holds the name of the function to use. +## of the vector argument accepted by @var{af}. @var{af} can be a function +## handle, an inline function, or a string. When @var{af} is a string it +## holds the name of the function to use. ## -## @var{af} is a function of the form @code{y = af (x)} -## where the required return value of @var{af} is determined by -## the value of @var{sigma}. The four possible forms are +## @var{af} is a function of the form @code{y = af (x)} where the required +## return value of @var{af} is determined by the value of @var{sigma}. The +## four possible forms are ## ## @table @code ## @item A * x @@ -163,8 +165,8 @@ ## if @var{sigma} is 0 or "sm". ## ## @item (A - sigma * I) \ x -## for the standard eigenvalue problem, where @code{I} is the identity matrix of -## the same size as @var{A}. +## for the standard eigenvalue problem, where @code{I} is the identity matrix +## of the same size as @var{A}. ## ## @item (A - sigma * B) \ x ## for the general eigenvalue problem.