Mercurial > hg > octave-nkf
diff scripts/sparse/spaugment.m @ 19004:53af80da6781 stable
doc: Update documentation of sparse functions including seealso links.
* data.cc (Fall, Fany): Use non-zero instead of nonzero.
* data.cc (Fnnz, Fnzmax, Ffull): Rewrite docstrings, include more seealso links.
* sparse.cc (Fsparse): Rewrite docstring to include example of "sum" behavior
and "unique" behavior. Add more seealso links.
* sparse.cc (Fspalloc): Rewrite docstring, include more seealso links.
* spparms.cc (Fspparms): Add seealso links.
* amd.cc (Famd): Use nonzero instead of "non zero".
* nonzeros.m: Add seealso links.
* spaugment.m: Rewrite docstring, include more seealso links.
* spconvert.m: Rewrite docstring, include more seealso links.
* speye.m: Rewrite docstring, include more seealso links.
* spones.m: Add seealso links.
* sprand.m: Rewrite docstring, include more seealso links.
* sprandn.m: Rewrite docstring, include more seealso links.
* sprandsym.m: Rewrite docstring, include more seealso links.
* spy.m: Rewrite docstring, include more seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 08 Jun 2014 16:32:12 -0700 |
parents | d63878346099 |
children | 4197fc428c7d |
line wrap: on
line diff
--- a/scripts/sparse/spaugment.m +++ b/scripts/sparse/spaugment.m @@ -18,7 +18,9 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{s} =} spaugment (@var{A}, @var{c}) -## Create the augmented matrix of @var{A}. This is given by +## Create the augmented matrix of @var{A}. +## +## This is given by ## ## @example ## @group @@ -47,7 +49,7 @@ ## As the matrix @var{s} is symmetric indefinite it can be factorized ## with @code{lu}, and the minimum norm solution can therefore be found ## without the need for a @code{qr} factorization. As the residual -## error will be @code{zeros (@var{m}, @var{m})} for under determined +## error will be @code{zeros (@var{m}, @var{m})} for underdetermined ## problems, and example can be ## ## @example @@ -69,6 +71,7 @@ ## ## In general the left division operator is more stable and faster than ## using the @code{spaugment} function. +## @seealso{mldivide} ## @end deftypefn function s = spaugment (A, c)