Mercurial > octave-nkf
diff src/DLD-FUNCTIONS/chol.cc @ 3372:f16c2ce14886
[project @ 1999-11-23 19:07:09 by jwe]
author | jwe |
---|---|
date | Tue, 23 Nov 1999 19:07:18 +0000 |
parents | 7f8827f4040a |
children | ab7fa5a8f23f |
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/chol.cc Sun Nov 21 17:31:10 1999 +0000 +++ b/src/DLD-FUNCTIONS/chol.cc Tue Nov 23 19:07:18 1999 +0000 @@ -34,7 +34,23 @@ #include "utils.h" DEFUN_DLD (chol, args, nargout, - "[R, p] = chol (X): cholesky factorization") + "-*- texinfo -*- +@deftypefn {Loadable Function} {} chol (@var{a})\n\ +@cindex Cholesky factorization\n\ +Compute the Cholesky factor, @var{r}, of the symmetric positive definite\n\ +matrix @var{a}, where\n\ +@iftex\n\ +@tex\n\ +$ R^T R = A $.\n\ +@end tex\n\ +@end iftex\n\ +@ifinfo\n\ +\n\ +@example\n\ +r' * r = a.\n\ +@end example\n\ +@end ifinfo\n\ +@end deftypefn") { octave_value_list retval;