Mercurial > octave-nkf

comparison src/DLD-FUNCTIONS/chol.cc @ 9065:8207b833557f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Cleanup documentation for arith.texi, linalg.texi, nonlin.texi Grammarcheck input .txi files Spellcheck .texi files
author Rik <rdrider0-list@yahoo.com>
date Sat, 28 Mar 2009 17:43:22 -0700
parents 7c02ec148a3c
children 5fcf008c7c41
comparison
equal deleted inserted replaced
9064:7c02ec148a3c 9065:8207b833557f
69 \n\ 69 \n\
70 Called with one output argument @code{chol} fails if @var{a} or @var{s} is\n\ 70 Called with one output argument @code{chol} fails if @var{a} or @var{s} is\n\
71 not positive definite. With two or more output arguments @var{p} flags\n\ 71 not positive definite. With two or more output arguments @var{p} flags\n\
72 whether the matrix was positive definite and @code{chol} does not fail. A\n\ 72 whether the matrix was positive definite and @code{chol} does not fail. A\n\
73 zero value indicated that the matrix was positive definite and the @var{r}\n\ 73 zero value indicated that the matrix was positive definite and the @var{r}\n\
74 gives the factorization, annd @var{p} will have a positive value otherwise.\n\ 74 gives the factorization, and @var{p} will have a positive value otherwise.\n\
75 \n\ 75 \n\
76 If called with 3 outputs then a sparsity preserving row/column permutation\n\ 76 If called with 3 outputs then a sparsity preserving row/column permutation\n\
77 is applied to @var{a} prior to the factorization. That is @var{r}\n\ 77 is applied to @var{a} prior to the factorization. That is @var{r}\n\
78 is the factorization of @code{@var{a}(@var{q},@var{q})} such that\n\ 78 is the factorization of @code{@var{a}(@var{q},@var{q})} such that\n\
79 @iftex\n\ 79 @iftex\n\
101 @example\n\ 101 @example\n\
102 @var{r}' * @var{r} = a (@var{q}, @var{q}).\n\ 102 @var{r}' * @var{r} = a (@var{q}, @var{q}).\n\
103 @end example\n\ 103 @end example\n\
104 @end ifnottex\n\ 104 @end ifnottex\n\
105 \n\ 105 \n\
106 Called with either a sparse or full matrix and uing the 'lower' flag,\n\ 106 Called with either a sparse or full matrix and using the 'lower' flag,\n\
107 @code{chol} returns the lower triangular factorization such that\n\ 107 @code{chol} returns the lower triangular factorization such that\n\
108 @iftex\n\ 108 @iftex\n\
109 @tex\n\ 109 @tex\n\
110 $ L L^T = A $.\n\ 110 $ L L^T = A $.\n\
111 @end tex\n\ 111 @end tex\n\
115 @example\n\ 115 @example\n\
116 @var{l} * @var{l}' = @var{a}.\n\ 116 @var{l} * @var{l}' = @var{a}.\n\
117 @end example\n\ 117 @end example\n\
118 @end ifnottex\n\ 118 @end ifnottex\n\
119 \n\ 119 \n\
120 In general the lower trinagular factorization is significantly faster for\n\ 120 In general the lower triangular factorization is significantly faster for\n\
121 sparse matrices.\n\ 121 sparse matrices.\n\
122 @seealso{cholinv, chol2inv}\n\ 122 @seealso{cholinv, chol2inv}\n\
123 @end deftypefn") 123 @end deftypefn")
124 { 124 {
125 octave_value_list retval; 125 octave_value_list retval;