Mercurial > octave-nkf
changeset 9065:8207b833557f
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 | be150a172010 |
| files | doc/interpreter/linalg.txi doc/interpreter/nonlin.txi scripts/deprecated/dmult.m scripts/linear-algebra/expm.m scripts/optimization/fsolve.m src/DLD-FUNCTIONS/chol.cc src/DLD-FUNCTIONS/lu.cc src/DLD-FUNCTIONS/max.cc src/mappers.cc |
| diffstat | 9 files changed, 25 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/linalg.txi Sat Mar 28 13:57:22 2009 -0700 +++ b/doc/interpreter/linalg.txi Sat Mar 28 17:43:22 2009 -0700 @@ -62,13 +62,13 @@ hermitian with a real positive diagonal, and the matrix is square, factorize using the @sc{Lapack} xGETRF function. -@item If the matrix is not square, or any of the previous solvers flags +@item If the matrix is not square, or any of the previous solvers flags a singular or near singular matrix, find a least squares solution using the @sc{Lapack} xGELSD function. @end enumerate The user can force the type of the matrix with the @code{matrix_type} -function. This overcomes the cost of discovering the type of the matrix. +function. This overcomes the cost of discovering the type of the matrix. However, it should be noted that identifying the type of the matrix incorrectly will lead to unpredictable results, and so @code{matrix_type} should be used with care. @@ -76,7 +76,7 @@ It should be noted that the test for whether a matrix is a candidate for Cholesky factorization, performed above and by the @code{matrix_type} function, does not give a certainty that the matrix is -Hermitian. However, the attempt to factorize the matrix will quickly +Hermitian. However, the attempt to factorize the matrix will quickly flag a non-Hermitian matrix. @node Basic Matrix Functions
--- a/doc/interpreter/nonlin.txi Sat Mar 28 13:57:22 2009 -0700 +++ b/doc/interpreter/nonlin.txi Sat Mar 28 17:43:22 2009 -0700 @@ -56,8 +56,10 @@ @ifinfo @example +@group -2x^2 + 3xy + 4 sin(y) = 6 3x^2 - 2xy^2 + 3 cos(x) = -4 +@end group @end example @end ifinfo @@ -66,10 +68,12 @@ function. For example: @example +@group function y = f (x) y(1) = -2*x(1)^2 + 3*x(1)*x(2) + 4*sin(x(2)) - 6; y(2) = 3*x(1)^2 - 2*x(1)*x(2)^2 + 3*cos(x(1)) + 4; endfunction +@end group @end example Then, call @code{fsolve} with a specified initial condition to find the @@ -84,6 +88,7 @@ results in the solution @example +@group x = 0.57983 @@ -95,6 +100,7 @@ 5.5460e-10 info = 1 +@end group @end example @noindent @@ -132,12 +138,14 @@ @end iftex @example +@group function J = jacobian(x) J(1,1) = 3*x(2) - 4*x(1); J(1,2) = 4*cos(x(2)) + 3*x(1); J(2,1) = -2*x(2)^2 - 3*sin(x(1)) + 6*x(1); J(2,2) = -4*x(1)*x(2); endfunction +@end group @end example @noindent
--- a/scripts/deprecated/dmult.m Sat Mar 28 13:57:22 2009 -0700 +++ b/scripts/deprecated/dmult.m Sat Mar 28 17:43:22 2009 -0700 @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} dmult (@var{a}, @var{b}) -## This function has been deprecated. Use the direct syntax @code{diag(A)*B} +## This function has been deprecated. Use the direct syntax @code{diag(A)*B} ## which is more readable and now also more efficient. ## @end deftypefn
--- a/scripts/linear-algebra/expm.m Sat Mar 28 13:57:22 2009 -0700 +++ b/scripts/linear-algebra/expm.m Sat Mar 28 17:43:22 2009 -0700 @@ -16,7 +16,7 @@ ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. -##-*- texinfo -*- +## -*- texinfo -*- ## @deftypefn {Function File} {} expm (@var{a}) ## Return the exponential of a matrix, defined as the infinite Taylor ## series @@ -30,7 +30,7 @@ ## @ifnottex ## ## @example -## expm(a) = I + a + a^2/2! + a^3/3! + ... +## expm(a) = I + a + a^2/2! + a^3/3! + @dots{} ## @end example ## ## @end ifnottex @@ -65,8 +65,10 @@ ## @ifnottex ## ## @example +## @group ## -1 ## D (a) N (a) +## @end group ## @end example ## ## @end ifnottex
--- a/scripts/optimization/fsolve.m Sat Mar 28 13:57:22 2009 -0700 +++ b/scripts/optimization/fsolve.m Sat Mar 28 17:43:22 2009 -0700 @@ -49,7 +49,7 @@ ## false. ## ## @code{"ComplexEqn"} is @code{"on"}, @code{fsolve} will attempt to solve -## complex equations in complex variables, assuming that the equations posess a +## complex equations in complex variables, assuming that the equations possess a ## complex derivative (i.e., are holomorphic). If this is not what you want, ## should unpack the real and imaginary parts of the system to get a real ## system.
--- a/src/DLD-FUNCTIONS/chol.cc Sat Mar 28 13:57:22 2009 -0700 +++ b/src/DLD-FUNCTIONS/chol.cc Sat Mar 28 17:43:22 2009 -0700 @@ -71,7 +71,7 @@ not positive definite. With two or more output arguments @var{p} flags\n\ whether the matrix was positive definite and @code{chol} does not fail. A\n\ zero value indicated that the matrix was positive definite and the @var{r}\n\ -gives the factorization, annd @var{p} will have a positive value otherwise.\n\ +gives the factorization, and @var{p} will have a positive value otherwise.\n\ \n\ If called with 3 outputs then a sparsity preserving row/column permutation\n\ is applied to @var{a} prior to the factorization. That is @var{r}\n\ @@ -103,7 +103,7 @@ @end example\n\ @end ifnottex\n\ \n\ -Called with either a sparse or full matrix and uing the 'lower' flag,\n\ +Called with either a sparse or full matrix and using the 'lower' flag,\n\ @code{chol} returns the lower triangular factorization such that\n\ @iftex\n\ @tex\n\ @@ -117,7 +117,7 @@ @end example\n\ @end ifnottex\n\ \n\ -In general the lower trinagular factorization is significantly faster for\n\ +In general the lower triangular factorization is significantly faster for\n\ sparse matrices.\n\ @seealso{cholinv, chol2inv}\n\ @end deftypefn")
--- a/src/DLD-FUNCTIONS/lu.cc Sat Mar 28 13:57:22 2009 -0700 +++ b/src/DLD-FUNCTIONS/lu.cc Sat Mar 28 17:43:22 2009 -0700 @@ -114,7 +114,7 @@ Called with a fifth output argument and a sparse input matrix, then\n\ @dfn{lu} attempts to use a scaling factor @var{r} on the input matrix\n\ such that @code{@var{p} * (@var{r} \\ @var{a}) * @var{q} = @var{l} * @var{u}}.\n\ -This typically leads to a sparser and more stable factorsation.\n\ +This typically leads to a sparser and more stable factorization.\n\ \n\ An additional input argument @var{thres}, that defines the pivoting\n\ threshold can be given. @var{thres} can be a scalar, in which case\n\
--- a/src/DLD-FUNCTIONS/max.cc Sat Mar 28 13:57:22 2009 -0700 +++ b/src/DLD-FUNCTIONS/max.cc Sat Mar 28 17:43:22 2009 -0700 @@ -940,7 +940,7 @@ \n\ @noindent\n\ but computed in a much faster manner.\n\ -The behaviour if @var{dim} or @var{iw} is unspecified is analogous\n\ +The behavior if @var{dim} or @var{iw} is unspecified is analogous\n\ to @code{min}.\n\ @end deftypefn") { @@ -973,7 +973,7 @@ \n\ @noindent\n\ but computed in a much faster manner.\n\ -The behaviour if @var{dim} or @var{iw} is unspecified is analogous\n\ +The behavior if @var{dim} or @var{iw} is unspecified is analogous\n\ to @code{max}.\n\ @end deftypefn") {
--- a/src/mappers.cc Sat Mar 28 13:57:22 2009 -0700 +++ b/src/mappers.cc Sat Mar 28 17:43:22 2009 -0700 @@ -617,7 +617,7 @@ DEFUN (expm1, args, , "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} expm1 (@var{x})\n\ -Compute exp (@var{x}) - 1 accurately in neighbourhood of zero.\n\ +Compute exp (@var{x}) - 1 accurately in neighborhood of zero.\n\ @end deftypefn") { octave_value retval; @@ -1215,7 +1215,7 @@ DEFUN (log1p, args, , "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} log1p (@var{x})\n\ -Compute log (1 + @var{x}) accurately in neighbourhood of zero.\n\ +Compute log (1 + @var{x}) accurately in neighborhood of zero.\n\ @end deftypefn") { octave_value retval;