Mercurial > octave-nkf

changeset 5343:be0bd7a760c9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2005-05-06 18:04:16 by jwe]
author jwe
date Fri, 06 May 2005 18:04:16 +0000
parents f9ab8e67ce7a
children b427cca320b8
files src/DLD-FUNCTIONS/chol.cc
diffstat 1 files changed, 5 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/chol.cc	Fri May 06 17:35:41 2005 +0000
+++ b/src/DLD-FUNCTIONS/chol.cc	Fri May 06 18:04:16 2005 +0000
@@ -181,10 +181,12 @@
 
 DEFUN_DLD (chol2inv, args, nargout,
   "-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} chol2inv (@var{r})\n\
+@deftypefn {Loadable Function} {} chol2inv (@var{u})\n\
 Invert a symmetric, positive definite square matrix from its Cholesky\n\
-decomposition, @var{r}.  Note that no check is performed to ensure\n\
-that @var{r} is actually a Cholesky factor.\n\
+decomposition, @var{u}.  Note that @var{u} should be an upper-triangular\n\
+matrix with positive diagonal elements.  @code{chol2inv (@var{u})}\n\
+provides @code{inv (@var{u}'*@var{u})} but it is much faster than\n\
+using @code{inv}.\n\
 @seealso{chol, cholinv}\n\
 @end deftypefn")
 {