Mercurial > octave-antonio
comparison scripts/sparse/spdiags.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 |
comparison
equal
deleted
inserted
replaced
| 20163:075a5e2e1ba5 | 20164:df437a52bcaf |
|---|---|
| 20 ## @deftypefn {Function File} {@var{B} =} spdiags (@var{A}) | 20 ## @deftypefn {Function File} {@var{B} =} spdiags (@var{A}) |
| 21 ## @deftypefnx {Function File} {[@var{B}, @var{d}] =} spdiags (@var{A}) | 21 ## @deftypefnx {Function File} {[@var{B}, @var{d}] =} spdiags (@var{A}) |
| 22 ## @deftypefnx {Function File} {@var{B} =} spdiags (@var{A}, @var{d}) | 22 ## @deftypefnx {Function File} {@var{B} =} spdiags (@var{A}, @var{d}) |
| 23 ## @deftypefnx {Function File} {@var{A} =} spdiags (@var{v}, @var{d}, @var{A}) | 23 ## @deftypefnx {Function File} {@var{A} =} spdiags (@var{v}, @var{d}, @var{A}) |
| 24 ## @deftypefnx {Function File} {@var{A} =} spdiags (@var{v}, @var{d}, @var{m}, @var{n}) | 24 ## @deftypefnx {Function File} {@var{A} =} spdiags (@var{v}, @var{d}, @var{m}, @var{n}) |
| 25 ## A generalization of the function @code{diag}. Called with a single | 25 ## A generalization of the function @code{diag}. |
| 26 ## input argument, the nonzero diagonals @var{d} of @var{A} are extracted. | |
| 27 ## With two arguments the diagonals to extract are given by the vector | |
| 28 ## @var{d}. | |
| 29 ## | 26 ## |
| 30 ## The other two forms of @code{spdiags} modify the input matrix by | 27 ## Called with a single input argument, the nonzero diagonals @var{d} of |
| 31 ## replacing the diagonals. They use the columns of @var{v} to replace | 28 ## @var{A} are extracted. |
| 32 ## the diagonals represented by the vector @var{d}. If the sparse matrix | |
| 33 ## @var{A} is defined then the diagonals of this matrix are replaced. | |
| 34 ## Otherwise a matrix of @var{m} by @var{n} is created with the | |
| 35 ## diagonals given by the columns of @var{v}. | |
| 36 ## | 29 ## |
| 37 ## Negative values of @var{d} represent diagonals below the main | 30 ## With two arguments the diagonals to extract are given by the vector @var{d}. |
| 38 ## diagonal, and positive values of @var{d} diagonals above the main | 31 ## |
| 39 ## diagonal. | 32 ## The other two forms of @code{spdiags} modify the input matrix by replacing |
| 33 ## the diagonals. They use the columns of @var{v} to replace the diagonals | |
| 34 ## represented by the vector @var{d}. If the sparse matrix @var{A} is | |
| 35 ## defined then the diagonals of this matrix are replaced. Otherwise a | |
| 36 ## matrix of @var{m} by @var{n} is created with the diagonals given by the | |
| 37 ## columns of @var{v}. | |
| 38 ## | |
| 39 ## Negative values of @var{d} represent diagonals below the main diagonal, and | |
| 40 ## positive values of @var{d} diagonals above the main diagonal. | |
| 40 ## | 41 ## |
| 41 ## For example: | 42 ## For example: |
| 42 ## | 43 ## |
| 43 ## @example | 44 ## @example |
| 44 ## @group | 45 ## @group |