Mercurial > hg > octave-lyh
diff doc/interpreter/sparse.txi @ 7515:f3c00dc0912b
Eliminate the rest of the dispatched sparse functions
author | David Bateman <dbateman@free.fr> |
---|---|
date | Fri, 22 Feb 2008 15:50:51 +0100 |
parents | f5005d9510f4 |
children | 56012914972a |
line wrap: on
line diff
--- a/doc/interpreter/sparse.txi +++ b/doc/interpreter/sparse.txi @@ -174,7 +174,7 @@ @table @asis @item Returned from a function There are many functions that directly return sparse matrices. These include -@dfn{speye}, @dfn{sprand}, @dfn{spdiag}, etc. +@dfn{speye}, @dfn{sprand}, @dfn{diag}, etc. @item Constructed from matrices or vectors The function @dfn{sparse} allows a sparse matrix to be constructed from three vectors representing the row, column and data. Alternatively, the @@ -202,22 +202,17 @@ elements of @var{d}. Other functions of interest that directly create sparse matrices, are -@dfn{spdiag} or its generalization @dfn{spdiags}, that can take the +@dfn{diag} or its generalization @dfn{spdiags}, that can take the definition of the diagonals of the matrix and create the sparse matrix that corresponds to this. For example @example -s = spdiag (sparse(randn(1,n)), -1); +s = diag (sparse(randn(1,n)), -1); @end example creates a sparse (@var{n}+1)-by-(@var{n}+1) sparse matrix with a single diagonal defined. -@DOCSTRING(spcumprod) - -@DOCSTRING(spcumsum) - -@DOCSTRING(spdiag) @DOCSTRING(spdiags) @@ -231,18 +226,12 @@ @DOCSTRING(spones) -@DOCSTRING(spprod) - @DOCSTRING(sprand) @DOCSTRING(sprandn) @DOCSTRING(sprandsym) -@DOCSTRING(spsum) - -@DOCSTRING(spsumsq) - The recommended way for the user to create a sparse matrix, is to create two vectors containing the row and column index of the data and a third vector of the same size containing the data to be stored. For example @@ -484,10 +473,7 @@ @dfn{dmperm}, @dfn{symamd}, @dfn{randperm}, @dfn{symrcm} @item Linear algebra: - @dfn{matrix_type}, @dfn{spchol}, @dfn{cpcholinv}, - @dfn{spchol2inv}, @dfn{spinv}, - @dfn{splchol}, @dfn{splu}, @dfn{normest}, @dfn{condest}, - @dfn{sprank} + @dfn{matrix_type}, @dfn{normest}, @dfn{condest}, @dfn{sprank} @c @dfn{spaugment} @c @dfn{eigs}, @dfn{svds} but these are in octave-forge for now @@ -497,9 +483,7 @@ @c @dfn{lsqr}, @dfn{minres}, @dfn{qmr}, @dfn{symmlq} @item Miscellaneous: - @dfn{spparms}, @dfn{symbfact}, @dfn{spstats}, - @dfn{spprod}, @dfn{spcumsum}, @dfn{spsum}, - @dfn{spsumsq}, @dfn{spdiag} + @dfn{spparms}, @dfn{symbfact}, @dfn{spstats} @end table In addition all of the standard Octave mapper functions (ie. basic @@ -833,18 +817,6 @@ @DOCSTRING(condest) -@DOCSTRING(spchol) - -@DOCSTRING(spcholinv) - -@DOCSTRING(spchol2inv) - -@DOCSTRING(spinv) - -@DOCSTRING(splchol) - -@DOCSTRING(splu) - @DOCSTRING(spparms) @DOCSTRING(sprank)