Mercurial > octave-antonio
changeset 19153:431dc1da050c
doc: Periodic spellcheck of documentation.
* aspell-octave.en.pws: Add new words to Octave's exception dictionary.
* ichol.m, ilu.m, lscov.m: Use @nospell macro around certain words.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 22 Sep 2014 21:12:53 -0700 |
| parents | 0f9c5a15c8fa |
| children | 76baa2d10abb |
| files | doc/interpreter/doccheck/aspell-octave.en.pws scripts/sparse/ichol.m scripts/sparse/ilu.m scripts/statistics/base/lscov.m |
| diffstat | 4 files changed, 18 insertions(+), 14 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/doccheck/aspell-octave.en.pws Mon Sep 22 20:46:54 2014 -0700 +++ b/doc/interpreter/doccheck/aspell-octave.en.pws Mon Sep 22 21:12:53 2014 -0700 @@ -888,6 +888,7 @@ startup Startup statinfo +stdin stdnormal stdout stepsize @@ -1113,6 +1114,7 @@ xl xmax xmin +xon xPBTRF xPOTRF xPTSV
--- a/scripts/sparse/ichol.m Mon Sep 22 20:46:54 2014 -0700 +++ b/scripts/sparse/ichol.m Mon Sep 22 21:12:53 2014 -0700 @@ -41,14 +41,16 @@ ## String indicating which flavor of incomplete Cholesky to perform. Valid ## values of this field are @qcode{"nofill"} and @qcode{"ict"}. The ## @qcode{"nofill"} variant performs incomplete Cholesky with zero-fill -## [IC(0)]. The @qcode{"ict"} variant performs incomplete Cholesky with -## threshold dropping [ICT]. The default value is @qcode{"nofill"}. +## @nospell{[IC(0)]}. The @qcode{"ict"} variant performs incomplete Cholesky +## with threshold dropping @nospell{[ICT]}. The default value is +## @qcode{"nofill"}. ## ## @item droptol ## Drop tolerance when type is @qcode{"ict"}. -## Non-negative scalar used as a drop tolerance when performing ICT@. Elements -## which are smaller in magnitude than a local drop tolerance are dropped from -## the resulting factor except for the diagonal element which is never dropped. +## Non-negative scalar used as a drop tolerance when performing @nospell{ICT}@. +## Elements which are smaller in magnitude than a local drop tolerance are +## dropped from the resulting factor except for the diagonal element which is +## never dropped. ## The local drop tolerance at step j of the factorization is ## @code{norm (@var{A}(j:end, j), 1) * droptol}. @code{droptol} is ignored if ## @code{type} is @qcode{"nofill"}. The default value is 0. @@ -135,7 +137,7 @@ ## References for implemented algorithms: ## ## [1] @nospell{Y. Saad}. "Preconditioning Techniques." @cite{Iterative -## Methods for Sparse Linear Systems}, PWS Publishing Company, 1996. +## Methods for Sparse Linear Systems}, @nospell{PWS} Publishing Company, 1996. ## ## [2] @nospell{M. Jones, P. Plassmann}: @cite{An Improved Incomplete ## Cholesky Factorization}, 1992.
--- a/scripts/sparse/ilu.m Mon Sep 22 20:46:54 2014 -0700 +++ b/scripts/sparse/ilu.m Mon Sep 22 21:12:53 2014 -0700 @@ -45,17 +45,17 @@ ## fields are ignored. ## ## @item @qcode{"crout"} -## Perform the Crout version of ILU factorization, known as ILUC@. With type -## set to @qcode{crout}, only the @code{droptol} and @code{milu} options are -## used; all other fields are ignored. +## Perform the @nospell{Crout} version of ILU factorization, known as +## @nospell{ILUC}@. With type set to @qcode{crout}, only the @code{droptol} +## and @code{milu} options are used; all other fields are ignored. ## ## @item @qcode{"ilutp"} ## (default) Performs ILU factorization with threshold and pivoting. ## @end table ## -## If type is not specified, the ILU factorization with pivoting ILUTP is -## performed. Pivoting is never performed with type set to @qcode{"nofill"} or -## @qcode{"crout"}. +## If type is not specified, the ILU factorization with pivoting @nospell{ILUTP} +## is performed. Pivoting is never performed with type set to @qcode{"nofill"} +## or @qcode{"crout"}. ## ## @item droptol ## Drop tolerance of the incomplete LU factorization. @code{droptol} is a
--- a/scripts/statistics/base/lscov.m Mon Sep 22 20:46:54 2014 -0700 +++ b/scripts/statistics/base/lscov.m Mon Sep 22 21:12:53 2014 -0700 @@ -42,8 +42,8 @@ ## data error covariance scale factors (@math{\sigma^2}); and @var{S} ## (p-by-p, or p-by-p-by-k if k > 1), the error covariance of @var{x}. ## -## Reference: Golub and Van Loan (1996), Matrix Computations (3rd Ed.), Johns -## Hopkins, Section 5.6.3 +## Reference: @nospell{Golub and Van Loan} (1996), +## Matrix Computations (3rd Ed.), Johns Hopkins, Section 5.6.3 ## ## @end deftypefn ## @seealso{ols, gls, lsqnonneg}