Mercurial > octave-antonio
diff doc/interpreter/sparse.txi @ 5837:55404f3b0da1
[project @ 2006-06-01 19:05:31 by jwe]
author | jwe |
---|---|
date | Thu, 01 Jun 2006 19:05:32 +0000 |
parents | dec8dd15a574 |
children | 877b80a8dee7 |
line wrap: on
line diff
--- a/doc/interpreter/sparse.txi Thu Jun 01 16:16:01 2006 +0000 +++ b/doc/interpreter/sparse.txi Thu Jun 01 19:05:32 2006 +0000 @@ -427,8 +427,8 @@ sprank, svds, spaugment) @item Iterative techniques: - @dfn{luinc}, (bicg, bicgstab, cholinc, cgs, gmres, lsqr, minres, - pcg, pcr, qmr, symmlq) + @dfn{luinc}, @dfn{pcg}, @dfn{pcr}, (bicg, bicgstab, cholinc, cgs, + gmres, lsqr, minres, qmr, symmlq) @item Miscellaneous: @dfn{spparms}, @dfn{symbfact}, @dfn{spstats}, @@ -744,7 +744,10 @@ @node Iterative Techniques, Real Life Example, Sparse Linear Algebra, Sparse Matrices @section Iterative Techniques applied to sparse matrices -WRITE ME OR DELETE ME IF THERE ARE NO ITERATIVE SOLVERS IN OCTAVE 3.0 +There are three functions currently to document here, these being +@dfn{luinc}, @dfn{pcg} and @dfn{pcr}. + +WRITE ME. @node Real Life Example, Oct-Files, Iterative Techniques, Sparse Matrices @section Real Life Example of the use of Sparse Matrices @@ -1478,9 +1481,13 @@ @item minres @emph{Not implemented} @item pcg -@emph{Not implemented} +Solves the linear system of equations @code{@var{A} * @var{x} = +@var{b}} by means of the Preconditioned Conjugate Gradient iterative +method. @item pcr -@emph{Not implemented} +Solves the linear system of equations @code{@var{A} * @var{x} = +@var{b}} by means of the Preconditioned Conjugate Residual iterative +method. @item qmr @emph{Not implemented} @item symmlq @@ -1548,6 +1555,10 @@ matrix S * nzmax:: Returns the amount of storage allocated to the sparse matrix SM. +* pcg:: Solves linear system of equations by means of the + Preconditioned Conjugate Gradient iterative method. +* pcr:: Solves linear system of equations by means of the + Preconditioned Conjugate Residual iterative method. * spalloc:: Returns an empty sparse matrix of size R-by-C. * sparse:: SPARSE: create a sparse matrix * spatan2:: Compute atan (Y / X) for corresponding sparse matrix @@ -1672,12 +1683,22 @@ @DOCSTRING(nonzeros) -@node nzmax, spalloc, nonzeros, Function Reference +@node nzmax, pcg, nonzeros, Function Reference @subsubsection nzmax @DOCSTRING(nzmax) -@node spalloc, sparse, nzmax, Function Reference +@node pcg, pcr, nzmax, Function Reference +@subsubsection pcg + +@DOCSTRING(pcg) + +@node pcr, spalloc, pcg, Function Reference +@subsubsection pcr + +@DOCSTRING(pcr) + +@node spalloc, sparse, pcr, Function Reference @subsubsection spalloc @DOCSTRING(spalloc)