Mercurial > hg > octave-nkf
diff scripts/sparse/sprandsym.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 | 9ac2357f19bc |
line wrap: on
line diff
--- a/scripts/sparse/sprandsym.m +++ b/scripts/sparse/sprandsym.m @@ -20,15 +20,15 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} sprandsym (@var{n}, @var{d}) ## @deftypefnx {Function File} {} sprandsym (@var{s}) -## Generate a symmetric random sparse matrix. The size of the matrix will be -## @var{n} by @var{n}, with a density of values given by @var{d}. -## @var{d} should be between 0 and 1. Values will be normally -## distributed with mean of zero and variance 1. +## Generate a symmetric random sparse matrix. ## -## If called with a single matrix argument, a random sparse matrix is -## generated wherever the matrix @var{S} is non-zero in its lower -## triangular part. -## @seealso{sprand, sprandn} +## The size of the matrix will be @var{n}x@var{n}, with a density of values +## given by @var{d}. @var{d} must be between 0 and 1 inclusive. Values will +## be normally distributed with a mean of zero and a variance of 1. +## +## If called with a single matrix argument, a random sparse matrix is generated +## wherever the matrix @var{S} is non-zero in its lower triangular part. +## @seealso{sprand, sprandn, spones, sparse} ## @end deftypefn function S = sprandsym (n, d)