Mercurial > octave-antonio

comparison scripts/sparse/eigs.m @ 20164:df437a52bcaf 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 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
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
36 ## @deftypefnx {Function File} {[@var{V}, @var{d}] =} eigs (@var{A}, @dots{}) 36 ## @deftypefnx {Function File} {[@var{V}, @var{d}] =} eigs (@var{A}, @dots{})
37 ## @deftypefnx {Function File} {[@var{V}, @var{d}] =} eigs (@var{af}, @var{n}, @dots{}) 37 ## @deftypefnx {Function File} {[@var{V}, @var{d}] =} eigs (@var{af}, @var{n}, @dots{})
38 ## @deftypefnx {Function File} {[@var{V}, @var{d}, @var{flag}] =} eigs (@var{A}, @dots{}) 38 ## @deftypefnx {Function File} {[@var{V}, @var{d}, @var{flag}] =} eigs (@var{A}, @dots{})
39 ## @deftypefnx {Function File} {[@var{V}, @var{d}, @var{flag}] =} eigs (@var{af}, @var{n}, @dots{}) 39 ## @deftypefnx {Function File} {[@var{V}, @var{d}, @var{flag}] =} eigs (@var{af}, @var{n}, @dots{})
40 ## Calculate a limited number of eigenvalues and eigenvectors of @var{A}, 40 ## Calculate a limited number of eigenvalues and eigenvectors of @var{A},
41 ## based on a selection criteria. The number of eigenvalues and eigenvectors to 41 ## based on a selection criteria.
42 ## calculate is given by @var{k} and defaults to 6. 42 ##
43 ## The number of eigenvalues and eigenvectors to calculate is given by
44 ## @var{k} and defaults to 6.
43 ## 45 ##
44 ## By default, @code{eigs} solve the equation 46 ## By default, @code{eigs} solve the equation
45 ## @tex 47 ## @tex
46 ## $A \nu = \lambda \nu$, 48 ## $A \nu = \lambda \nu$,
47 ## @end tex 49 ## @end tex
145 ## 147 ##
146 ## @end table 148 ## @end table
147 ## 149 ##
148 ## It is also possible to represent @var{A} by a function denoted @var{af}. 150 ## It is also possible to represent @var{A} by a function denoted @var{af}.
149 ## @var{af} must be followed by a scalar argument @var{n} defining the length 151 ## @var{af} must be followed by a scalar argument @var{n} defining the length
150 ## of the vector argument accepted by @var{af}. @var{af} can be 152 ## of the vector argument accepted by @var{af}. @var{af} can be a function
151 ## a function handle, an inline function, or a string. When @var{af} is a 153 ## handle, an inline function, or a string. When @var{af} is a string it
152 ## string it holds the name of the function to use. 154 ## holds the name of the function to use.
153 ## 155 ##
154 ## @var{af} is a function of the form @code{y = af (x)} 156 ## @var{af} is a function of the form @code{y = af (x)} where the required
155 ## where the required return value of @var{af} is determined by 157 ## return value of @var{af} is determined by the value of @var{sigma}. The
156 ## the value of @var{sigma}. The four possible forms are 158 ## four possible forms are
157 ## 159 ##
158 ## @table @code 160 ## @table @code
159 ## @item A * x 161 ## @item A * x
160 ## if @var{sigma} is not given or is a string other than "sm". 162 ## if @var{sigma} is not given or is a string other than "sm".
161 ## 163 ##
162 ## @item A \ x 164 ## @item A \ x
163 ## if @var{sigma} is 0 or "sm". 165 ## if @var{sigma} is 0 or "sm".
164 ## 166 ##
165 ## @item (A - sigma * I) \ x 167 ## @item (A - sigma * I) \ x
166 ## for the standard eigenvalue problem, where @code{I} is the identity matrix of 168 ## for the standard eigenvalue problem, where @code{I} is the identity matrix
167 ## the same size as @var{A}. 169 ## of the same size as @var{A}.
168 ## 170 ##
169 ## @item (A - sigma * B) \ x 171 ## @item (A - sigma * B) \ x
170 ## for the general eigenvalue problem. 172 ## for the general eigenvalue problem.
171 ## @end table 173 ## @end table
172 ## 174 ##