Mercurial > hg > octave-nkf
diff scripts/sparse/spdiags.m @ 11471:994e2a93a8e2
Use uppercase 'A' to refer to matrix inputs in m-files.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sun, 09 Jan 2011 16:01:05 -0800 |
| parents | 693e22af08ae |
| children | fd0a3ac60b0e |
line wrap: on
line diff
--- a/scripts/sparse/spdiags.m +++ b/scripts/sparse/spdiags.m @@ -17,9 +17,9 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{b}, @var{c}] =} spdiags (@var{a}) -## @deftypefnx {Function File} {@var{b} =} spdiags (@var{a}, @var{c}) -## @deftypefnx {Function File} {@var{b} =} spdiags (@var{v}, @var{c}, @var{a}) +## @deftypefn {Function File} {[@var{b}, @var{c}] =} spdiags (@var{A}) +## @deftypefnx {Function File} {@var{b} =} spdiags (@var{A}, @var{c}) +## @deftypefnx {Function File} {@var{b} =} spdiags (@var{v}, @var{c}, @var{A}) ## @deftypefnx {Function File} {@var{b} =} spdiags (@var{v}, @var{c}, @var{m}, @var{n}) ## A generalization of the function @code{diag}. Called with a single ## input argument, the non-zero diagonals @var{c} of @var{A} are extracted. @@ -29,7 +29,7 @@ ## The other two forms of @code{spdiags} modify the input matrix by ## replacing the diagonals. They use the columns of @var{v} to replace ## the columns represented by the vector @var{c}. If the sparse matrix -## @var{a} is defined then the diagonals of this matrix are replaced. +## @var{A} is defined then the diagonals of this matrix are replaced. ## Otherwise a matrix of @var{m} by @var{n} is created with the ## diagonals given by @var{v}. ##