diff doc/interpreter/sparse.txi @ 8417:654bcfb937bf

Add the eigs and svds functions
author David Bateman <dbateman@free.fr>
date Tue, 23 Dec 2008 08:28:23 +0100
parents fa78cb8d8a5c
children cdb4788879b3
line wrap: on
line diff
--- a/doc/interpreter/sparse.txi
+++ b/doc/interpreter/sparse.txi
@@ -473,9 +473,8 @@
   @dfn{dmperm}, @dfn{symamd}, @dfn{randperm}, @dfn{symrcm}
 
 @item Linear algebra:
-  @dfn{matrix_type}, @dfn{normest}, @dfn{condest}, @dfn{sprank}
-  @dfn{spaugment}
-@c @dfn{eigs}, @dfn{svds} but these are in octave-forge for now
+  @dfn{condest}, @dfn{eigs}, @dfn{matrix_type}, @dfn{normest}, @dfn{sprank},
+  @dfn{spaugment}, @dfn{svds}
 
 @item Iterative techniques:
   @dfn{luinc}, @dfn{pcg}, @dfn{pcr}
@@ -832,6 +831,15 @@
 
 @DOCSTRING(spaugment)
 
+Finally, the function @code{eigs} can be used to calculate a limited
+number of eigenvalues and eigenvectors based on a selection criteria
+and likewise for @code{svds} which calculates a limited number of
+singular values and vectors.
+
+@DOCSTRING(eigs)
+
+@DOCSTRING(svds)
+
 @node Iterative Techniques, Real Life Example, Sparse Linear Algebra, Sparse Matrices
 @section Iterative Techniques applied to sparse matrices