# HG changeset patch # User jwe # Date 1133367124 0 # Node ID dbdba35033a600f3973f0e97d93bd2e1170514f6 # Parent 3f1a39aa20120b38e173bc44bc5bd4b431644a64 [project @ 2005-11-30 16:12:04 by jwe] diff --git a/scripts/ChangeLog b/scripts/ChangeLog --- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,8 @@ +2005-11-30 John W. Eaton + + * linear-algebra/krylov.m: Format doc string. + From Jorge Barros de Abreu . + 2005-11-23 William Poetra Yoga Hadisoeseno * general/blkdiag.m: Import from octave-forge. diff --git a/scripts/linear-algebra/krylov.m b/scripts/linear-algebra/krylov.m --- a/scripts/linear-algebra/krylov.m +++ b/scripts/linear-algebra/krylov.m @@ -18,28 +18,34 @@ ## 02110-1301 USA. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{u}, @var{h}, @var{nu}] =} krylov (@var{a}, @var{v}, @var{k}, @var{eps1}, @var{pflg}); -## construct orthogonal basis U of block Krylov subspace; -## [v a*v a^2*v ... a^(k+1)*v]; -## method used: householder reflections to guard against loss of -## orthogonality -## eps1: threshhold for 0 (default: 1e-12) -## pflg: flag to use row pivoting (improves numerical behavior) -## 0 [default]: no pivoting; prints a warning message if trivial -## null space is corrupted -## 1 : pivoting performed +## @deftypefn {Function File} {[@var{u}, @var{h}, @var{nu}] =} krylov (@var{a}, @var{v}, @var{k}, @var{eps1}, @var{pflg}) +## Construct an orthogonal basis @var{u} of block Krylov subspace +## +## @example +## [v a*v a^2*v ... a^(k+1)*v] +## @end example +## +## @noindent +## Using Householder reflections to guard against loss of orthogonality. ## -## outputs: -## u: orthogonal basis of block krylov subspace -## h: Hessenberg matrix; if v is a vector then a u = u h -## otherwise h is meaningless -## nu: dimension of span of krylov subspace (based on eps1) -## if b is a vector and k > m-1, krylov returns h = the Hessenberg -## decompostion of a. +## If @var{v} is a vector, then @var{h} contains the Hessenberg matrix +## such that @code{a*u == u*h}. Otherwise, @var{h} is meaningless. +## +## The value of @var{nu} is the dimension of the span of the krylov +## subspace (based on @var{eps1}). +## +## If @var{b} is a vector and @var{k} is greater than @var{m-1}, then +## @var{h} contains the Hessenberg decompostion of @var{a}. +## +## The optional parameter @var{eps1} is the threshold for zero. The +## default value is 1e-12. +## +## If the optional parameter @var{pflg} is nonzero, row pivoting is used +## to improve numerical behavior. The default value is 0. ## ## Reference: Hodel and Misra, "Partial Pivoting in the Computation of -## Krylov Subspaces", to be submitted to Linear Algebra and its -## Applications +## Krylov Subspaces", to be submitted to Linear Algebra and its +## Applications ## @end deftypefn ## Author: A. Scottedward Hodel diff --git a/src/ChangeLog b/src/ChangeLog --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,8 @@ +2005-11-30 John W. Eaton + + * DLD-FUNCTIONS/schur.cc (Fschur): Doc string fix. + From Jorge Barros de Abreu . + 2005-11-28 John W. Eaton * syscalls.cc (Funame): New function. diff --git a/src/DLD-FUNCTIONS/schur.cc b/src/DLD-FUNCTIONS/schur.cc --- a/src/DLD-FUNCTIONS/schur.cc +++ b/src/DLD-FUNCTIONS/schur.cc @@ -92,11 +92,11 @@ are the diagonal elements of\n\ @iftex\n\ @tex\n\ -$S$\n\ +$S$.\n\ @end tex\n\ @end iftex\n\ @ifinfo\n\ -@code{s}\n\ +@code{s}.\n\ @end ifinfo\n\ If the matrix\n\ @iftex\n\