Mercurial > octave-antonio
diff scripts/sparse/spaugment.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
| author | Rik <rdrider0-list@yahoo.com> |
|---|---|
| date | Fri, 27 Mar 2009 22:31:03 -0700 |
| parents | eb63fbe60fab |
| children | be150a172010 |
line wrap: on
line diff
--- a/scripts/sparse/spaugment.m Thu Mar 26 11:47:34 2009 -0700 +++ b/scripts/sparse/spaugment.m Fri Mar 27 22:31:03 2009 -0700 @@ -18,11 +18,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{s} =} spaugment (@var{a}, @var{c}) -## Creates the augmented matrix of @var{a}. This is given by +## Creates the augmented matrix of @var{a}. This is given by ## ## @example +## @group ## [@var{c} * eye(@var{m}, @var{m}),@var{a}; @var{a}', zeros(@var{n}, ## @var{n})] +## @end group ## @end example ## ## @noindent @@ -30,8 +32,10 @@ ## @code{@var{a} \\ @var{b}}, by ## ## @example +## @group ## @var{s} * [ @var{r} / @var{c}; x] = [@var{b}, zeros(@var{n}, ## columns(@var{b})] +## @end group ## @end example ## ## @noindent @@ -43,7 +47,7 @@ ## ## As the matrix @var{s} is symmetric indefinite it can be factorized ## with @code{lu}, and the minimum norm solution can therefore be found -## without the need for a @code{qr} factorization. As the residual +## without the need for a @code{qr} factorization. As the residual ## error will be @code{zeros (@var{m}, @var{m})} for under determined ## problems, and example can be ##