Mercurial > octave
diff scripts/sparse/eigs.m @ 21546:f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
* isrecording.m, soundsc.m, delaunay3.m, cell2mat.m, cumtrapz.m, del2.m,
inputParser.m, interp1.m, interp3.m, narginchk.m, profile.m,
validateattributes.m, delaunayn.m, tsearchn.m, voronoin.m, brighten.m,
cmunique.m, colorcube.m, imfinfo.m, imshow.m, edit.m, orderfields.m, run.m,
warning_ids.m, ode23.m, ode45.m, odeget.m, integrate_adaptive.m, kahan.m,
ode_struct_value_check.m, runge_kutta_23.m, fminunc.m, fsolve.m, fzero.m,
pkg.m, build.m, specular.m, view.m, bar.m, barh.m, contour3.m, isosurface.m,
line.m, pie.m, pie3.m, quiver3.m, scatter.m, scatter3.m, stem3.m, stemleaf.m,
surfl.m, tetramesh.m, isfigure.m, mkpp.m, pchip.m, residue.m, splinefit.m,
rmpref.m, unique.m, eigs.m, ilu.m, factor.m, factorial.m, gallery.m, hankel.m,
histc.m, ols.m, finv.m, fpdf.m, kruskal_wallis_test.m, weekday.m:
Wrap m-file docstrings to 79 characters + newline (80 total).
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 27 Mar 2016 15:50:01 -0700 |
| parents | a4faec57f4c8 |
| children | ecce63c99c3f |
line wrap: on
line diff
--- a/scripts/sparse/eigs.m Sun Mar 27 15:15:24 2016 -0700 +++ b/scripts/sparse/eigs.m Sun Mar 27 15:50:01 2016 -0700 @@ -107,7 +107,8 @@ ## @table @code ## @item issym ## If @var{af} is given, then flags whether the function @var{af} defines a -## symmetric problem. It is ignored if @var{A} is given. The default is false. +## symmetric problem. It is ignored if @var{A} is given. The default is +## false. ## ## @item isreal ## If @var{af} is given, then flags whether the function @var{af} defines a @@ -173,13 +174,13 @@ ## @end table ## ## The return arguments of @code{eigs} depend on the number of return arguments -## requested. With a single return argument, a vector @var{d} of length @var{k} -## is returned containing the @var{k} eigenvalues that have been found. With -## two return arguments, @var{V} is a @var{n}-by-@var{k} matrix whose columns -## are the @var{k} eigenvectors corresponding to the returned eigenvalues. The -## eigenvalues themselves are returned in @var{d} in the form of a -## @var{n}-by-@var{k} matrix, where the elements on the diagonal are the -## eigenvalues. +## requested. With a single return argument, a vector @var{d} of length +## @var{k} is returned containing the @var{k} eigenvalues that have been +## found. With two return arguments, @var{V} is a @var{n}-by-@var{k} matrix +## whose columns are the @var{k} eigenvectors corresponding to the returned +## eigenvalues. The eigenvalues themselves are returned in @var{d} in the +## form of a @var{n}-by-@var{k} matrix, where the elements on the diagonal +## are the eigenvalues. ## ## Given a third return argument @var{flag}, @code{eigs} returns the status ## of the convergence. If @var{flag} is 0 then all eigenvalues have converged.