typographic corrections
Brian Gough
bjg at network-theory.co.uk
Wed Dec 10 06:01:34 CST 2008
Here is a patch with some corrections for capitalisation, hyphenation
and quoting.
changeset: 8388:8b6ea4976908
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:44 2008 -0500
summary: [docs] @var{EXPR} => @var{expr}
diff -r 1567db1e166c -r 8b6ea4976908 src/ov-typeinfo.cc
--- a/src/ov-typeinfo.cc
+++ b/src/ov-typeinfo.cc
@@ -620,7 +620,7 @@
@deftypefn {Built-in Function} {} typeinfo (@var{expr})\n\
\n\
Return the type of the expression @var{expr}, as a string. If\n\
- at var{EXPR} is omitted, return an array of strings containing all the\n\
+ at var{expr} is omitted, return an array of strings containing all the\n\
currently installed data types.\n\
@end deftypefn")
{
changeset: 8389:1902261c4aea
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:44 2008 -0500
summary: [docs] octave => Octave
diff -r 8b6ea4976908 -r 1902261c4aea doc/interpreter/dynamic.txi
--- a/doc/interpreter/dynamic.txi
+++ b/doc/interpreter/dynamic.txi
@@ -68,7 +68,7 @@
of your time, relative to staying in Octave?
@end itemize
-Also, as oct- and mex-files are dynamically linked to octave, they
+Also, as oct- and mex-files are dynamically linked to Octave, they
introduce the possibility of Octave crashing due to errors in
the user code. For example a segmentation violation in the user's code
will cause Octave to abort.
changeset: 8390:86d4894455f6
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:44 2008 -0500
summary: [docs] fix case to match example
diff -r 1902261c4aea -r 86d4894455f6 doc/interpreter/intro.txi
--- a/doc/interpreter/intro.txi
+++ b/doc/interpreter/intro.txi
@@ -113,7 +113,7 @@
@subsection Matrix Arithmetic
Octave has a convenient operator notation for performing matrix
-arithmetic. For example, to multiply the matrix @code{a} by a scalar
+arithmetic. For example, to multiply the matrix @code{A} by a scalar
value, type the command
@example
@@ -121,7 +121,7 @@
@end example
@noindent
-To multiply the two matrices @code{a} and @code{b}, type the command
+To multiply the two matrices @code{A} and @code{B}, type the command
@example
octave:5> A * B
changeset: 8391:1d10e1221e23
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:44 2008 -0500
summary: [docs] octave => Octave
diff -r 86d4894455f6 -r 1d10e1221e23 src/DLD-FUNCTIONS/regexp.cc
--- a/src/DLD-FUNCTIONS/regexp.cc
+++ b/src/DLD-FUNCTIONS/regexp.cc
@@ -907,7 +907,7 @@
\n\
In addition the following escaped characters have special meaning. It should\n\
be noted that it is recommended to quote @var{pat} in single quotes rather\n\
-than double quotes, to avoid the escape sequences being interpreted by octave\n\
+than double quotes, to avoid the escape sequences being interpreted by Octave\n\
before being passed to @code{regexp}.\n\
\n\
@table @code\n\
changeset: 8392:33efbcb46e78
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:45 2008 -0500
summary: [docs] @var{XI}, @var{YI}. => @var{xi}, @var{yi}.
diff -r 1d10e1221e23 -r 33efbcb46e78 scripts/general/interp2.m
--- a/scripts/general/interp2.m
+++ b/scripts/general/interp2.m
@@ -32,7 +32,7 @@
## @table @code
## @item interp2 (@var{x}, @var{y}, @var{Z}, @var{xi}, @var{yi}, @dots{})
## Returns a matrix corresponding to the points described by the
-## matrices @var{XI}, @var{YI}.
+## matrices @var{xi}, @var{yi}.
##
## If the last argument is a string, the interpolation method can
## be specified. The method can be 'linear', 'nearest' or 'cubic'.
changeset: 8393:473fe123cd24
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:45 2008 -0500
summary: [docs] Matrix => matrix
diff -r 33efbcb46e78 -r 473fe123cd24 scripts/general/interp2.m
--- a/scripts/general/interp2.m
+++ b/scripts/general/interp2.m
@@ -43,7 +43,7 @@
## 1:columns (@var{z})}
##
## @item interp2 (@var{z}, @var{n})
-## Interleaves the Matrix @var{z} n-times. If @var{n} is omitted a value
+## Interleaves the matrix @var{z} n-times. If @var{n} is omitted a value
## of @code{@var{n} = 1} is assumed.
## @end table
##
changeset: 8394:4f1c79f48681
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:45 2008 -0500
summary: [docs] N-Simplex => N-simplex
diff -r 473fe123cd24 -r 4f1c79f48681 doc/interpreter/geometry.txi
--- a/doc/interpreter/geometry.txi
+++ b/doc/interpreter/geometry.txi
@@ -133,17 +133,17 @@
It is often necessary to identify whether a particular point in the
N-dimensional space is within the Delaunay tessellation of a set of
-points in this N-dimensional space, and if so which N-Simplex contains
+points in this N-dimensional space, and if so which N-simplex contains
the point and which point in the tessellation is closest to the desired
point. The functions @code{tsearch} and @code{dsearch} perform this
function in a triangulation, and @code{tsearchn} and @code{dsearchn} in
an N-dimensional tessellation.
To identify whether a particular point represented by a vector @var{p}
-falls within one of the simplices of an N-Simplex, we can write the
+falls within one of the simplices of an N-simplex, we can write the
Cartesian coordinates of the point in a parametric form with respect to
-the N-Simplex. This parametric form is called the Barycentric
-Coordinates of the point. If the points defining the N-Simplex are given
+the N-simplex. This parametric form is called the Barycentric
+Coordinates of the point. If the points defining the N-simplex are given
by @code{@var{N} + 1} vectors @var{t}(@var{i},:), then the Barycentric
coordinates defining the point @var{p} are given by
@@ -182,7 +182,7 @@
which gives the formula for the conversion of the Cartesian coordinates
of the point @var{p} to the Barycentric coordinates @var{beta}. An
important property of the Barycentric coordinates is that for all points
-in the N-Simplex
+in the N-simplex
@example
0 <= @var{beta}(@var{i}) <= 1
@@ -191,7 +191,7 @@
@noindent
Therefore, the test in @code{tsearch} and @code{tsearchn} essentially
only needs to express each point in terms of the Barycentric coordinates
-of each of the simplices of the N-Simplex and test the values of
+of each of the simplices of the N-simplex and test the values of
@var{beta}. This is exactly the implementation used in
@code{tsearchn}. @code{tsearch} is optimized for 2-dimensions and the
Barycentric coordinates are not explicitly formed.
changeset: 8395:970937b2f2b6
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:46 2008 -0500
summary: [docs] capitalize Octave consistently
diff -r 4f1c79f48681 -r 970937b2f2b6 doc/interpreter/eval.txi
--- a/doc/interpreter/eval.txi
+++ b/doc/interpreter/eval.txi
@@ -171,7 +171,7 @@
which evaluates @samp{code} in the caller's context and
checks that the error message it produces matches
the given pattern. Other examples such as @code{save} and @code{load}
-are written in C++ where all octave variables
+are written in C++ where all Octave variables
are in the @samp{caller} context and @code{evalin} is not needed.
@DOCSTRING(evalin)
diff -r 4f1c79f48681 -r 970937b2f2b6 doc/interpreter/install.txi
--- a/doc/interpreter/install.txi
+++ b/doc/interpreter/install.txi
@@ -215,7 +215,7 @@
@item
Once you have successfully compiled Octave, run @samp{make install}.
-This will install a copy of octave, its libraries, and its documentation
+This will install a copy of Octave, its libraries, and its documentation
in the destination directory. As distributed, Octave is installed in
the following directories. In the table below, @var{prefix} defaults to
@file{/usr/local}, @var{version} stands for the current version number
diff -r 4f1c79f48681 -r 970937b2f2b6 doc/interpreter/testfun.txi
--- a/doc/interpreter/testfun.txi
+++ b/doc/interpreter/testfun.txi
@@ -36,7 +36,7 @@
@code{test} scans the named script file looking for lines which
start with @code{%!}. The prefix is stripped off and the rest of the
-line is processed through the octave interpreter. If the code
+line is processed through the Octave interpreter. If the code
generates an error, then the test is said to fail.
Since @code{eval()} will stop at the first error it encounters, you must
@@ -285,7 +285,7 @@
but then the code will have to be on the load path and the user
will have to remember to type test('name.cc'). Conversely, you
-can separate the tests from normal octave script files by putting
+can separate the tests from normal Octave script files by putting
them in plain files with no extension rather than in script files.
@c DO I WANT TO INCLUDE THE EDITOR SPECIFIC STATEMENT BELOW???
@c Don't forget to tell emacs that the plain text file you are using
diff -r 4f1c79f48681 -r 970937b2f2b6 doc/interpreter/var.txi
--- a/doc/interpreter/var.txi
+++ b/doc/interpreter/var.txi
@@ -226,7 +226,7 @@
@end example
The behavior of persistent variables is equivalent to the behavior of
-static variables in C. The command @code{static} in octave is also
+static variables in C. The command @code{static} in Octave is also
recognized and is equivalent to @code{persistent}.
Like global variables, a persistent variable may only be initialized once.
diff -r 4f1c79f48681 -r 970937b2f2b6 scripts/testfun/demo.m
--- a/scripts/testfun/demo.m
+++ b/scripts/testfun/demo.m
@@ -25,7 +25,7 @@
## from the usual script code, all lines are prefixed by @code{%!}. Each
## example is introduced by the keyword 'demo' flush left to the prefix,
## with no intervening spaces. The remainder of the example can contain
-## arbitrary octave code. For example:
+## arbitrary Octave code. For example:
##
## @example
## %!demo
diff -r 4f1c79f48681 -r 970937b2f2b6 scripts/testfun/test.m
--- a/scripts/testfun/test.m
+++ b/scripts/testfun/test.m
@@ -47,7 +47,7 @@
##
## The argument @var{fid} can be used to allow batch processing. Errors
## can be written to the already open file defined by @var{fid}, and
-## hopefully when octave crashes this file will tell you what was happening
+## hopefully when Octave crashes this file will tell you what was happening
## when it did. You can use @code{stdout} if you want to see the results as
## they happen. You can also give a file name rather than an @var{fid}, in
## which case the contents of the file will be replaced with the log from
changeset: 8396:0ca0ced54f64
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:46 2008 -0500
summary: [docs] ``Mersenne Twister: A 623-dimensionally equidistributed uniform pseudorandom number generator'' => @cite{Mersenne Twister: A 623-dimensionally equidistributed uniform pseudorandom number generator}
diff -r 970937b2f2b6 -r 0ca0ced54f64 src/DLD-FUNCTIONS/rand.cc
--- a/src/DLD-FUNCTIONS/rand.cc
+++ b/src/DLD-FUNCTIONS/rand.cc
@@ -343,8 +343,7 @@
\n\
To compute the pseudo-random sequence, @code{rand} uses the Mersenne\n\
Twister with a period of 2^19937-1 (See M. Matsumoto and T. Nishimura,\n\
-``Mersenne Twister: A 623-dimensionally\n\
-equidistributed uniform pseudorandom number generator'', ACM Trans. on\n\
+ at cite{Mersenne Twister: A 623-dimensionally equidistributed uniform pseudorandom number generator}, ACM Trans. on\n\
Modeling and Computer Simulation Vol. 8, No. 1, January pp.3-30 1998,\n\
@url{http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html}).\n\
Do @strong{not} use for cryptography without securely hashing\n\
changeset: 8397:f3343223c123
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:46 2008 -0500
summary: [docs] 'Ziggurat method for generating random variables' => @cite{Ziggurat method for generating random variables}
diff -r 0ca0ced54f64 -r f3343223c123 src/DLD-FUNCTIONS/rand.cc
--- a/src/DLD-FUNCTIONS/rand.cc
+++ b/src/DLD-FUNCTIONS/rand.cc
@@ -476,7 +476,7 @@
\n\
By default, @code{randn} uses a Marsaglia and Tsang Ziggurat technique to\n\
transform from a uniform to a normal distribution. (G. Marsaglia and\n\
-W.W. Tsang, 'Ziggurat method for generating random variables',\n\
+W.W. Tsang, @cite{Ziggurat method for generating random variables},\n\
J. Statistical Software, vol 5, 2000,\n\
@url{http://www.jstatsoft.org/v05/i08/})\n\
\n\
@@ -550,7 +550,7 @@
\n\
By default, @code{randn} uses a Marsaglia and Tsang Ziggurat technique to\n\
transform from a uniform to a exponential distribution. (G. Marsaglia and\n\
-W.W. Tsang, 'Ziggurat method for generating random variables',\n\
+W.W. Tsang, @cite{Ziggurat method for generating random variables},\n\
J. Statistical Software, vol 5, 2000,\n\
@url{http://www.jstatsoft.org/v05/i08/})\n\
@seealso{rand, randn, randg, randp}\n\
changeset: 8398:4d34f2e243b2
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:47 2008 -0500
summary: [docs] "Discrete-Time Signal Processing" => @cite{Discrete-Time Signal Processing}
diff -r f3343223c123 -r 4d34f2e243b2 scripts/signal/bartlett.m
--- a/scripts/signal/bartlett.m
+++ b/scripts/signal/bartlett.m
@@ -23,7 +23,7 @@
## length @var{m}.
##
## For a definition of the Bartlett window, see e.g. A. V. Oppenheim &
-## R. W. Schafer, "Discrete-Time Signal Processing".
+## R. W. Schafer, @cite{Discrete-Time Signal Processing}.
## @end deftypefn
## Author: AW <Andreas.Weingessel at ci.tuwien.ac.at>
diff -r f3343223c123 -r 4d34f2e243b2 scripts/signal/blackman.m
--- a/scripts/signal/blackman.m
+++ b/scripts/signal/blackman.m
@@ -22,7 +22,7 @@
## Return the filter coefficients of a Blackman window of length @var{m}.
##
## For a definition of the Blackman window, see e.g. A. V. Oppenheim &
-## R. W. Schafer, "Discrete-Time Signal Processing".
+## R. W. Schafer, @cite{Discrete-Time Signal Processing}.
## @end deftypefn
## Author: AW <Andreas.Weingessel at ci.tuwien.ac.at>
diff -r f3343223c123 -r 4d34f2e243b2 scripts/signal/hamming.m
--- a/scripts/signal/hamming.m
+++ b/scripts/signal/hamming.m
@@ -22,7 +22,7 @@
## Return the filter coefficients of a Hamming window of length @var{m}.
##
## For a definition of the Hamming window, see e.g. A. V. Oppenheim &
-## R. W. Schafer, "Discrete-Time Signal Processing".
+## R. W. Schafer, @cite{Discrete-Time Signal Processing}.
## @end deftypefn
## Author: AW <Andreas.Weingessel at ci.tuwien.ac.at>
diff -r f3343223c123 -r 4d34f2e243b2 scripts/signal/hanning.m
--- a/scripts/signal/hanning.m
+++ b/scripts/signal/hanning.m
@@ -22,7 +22,7 @@
## Return the filter coefficients of a Hanning window of length @var{m}.
##
## For a definition of this window type, see e.g. A. V. Oppenheim &
-## R. W. Schafer, "Discrete-Time Signal Processing".
+## R. W. Schafer, @cite{Discrete-Time Signal Processing}.
## @end deftypefn
## Author: AW <Andreas.Weingessel at ci.tuwien.ac.at>
changeset: 8399:edea5c400ca6
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:47 2008 -0500
summary: [docs] commandline => command-line
diff -r 4d34f2e243b2 -r edea5c400ca6 doc/interpreter/debug.txi
--- a/doc/interpreter/debug.txi
+++ b/doc/interpreter/debug.txi
@@ -26,7 +26,7 @@
where execution has stopped can be examined and modified to check for
errors.
-The normal commandline editing and history functions are available in
+The normal command-line editing and history functions are available in
debug mode.
@menu
changeset: 8400:8f3ed7d2195c
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:47 2008 -0500
summary: [docs] add
diff -r edea5c400ca6 -r 8f3ed7d2195c doc/interpreter/dynamic.txi
--- a/doc/interpreter/dynamic.txi
+++ b/doc/interpreter/dynamic.txi
@@ -1204,7 +1204,7 @@
The basic command to build a mex-file is either @code{mkoctfile --mex} or
@code{mex}. The first can either be used from within Octave or from the
-commandline. However, to avoid issues with the installation of other
+command line. However, to avoid issues with the installation of other
products, the use of the command @code{mex} is limited to within Octave.
@DOCSTRING(mex)
changeset: 8401:64df9e1d8676
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:48 2008 -0500
summary: [docs] 64 bit => 64-bit
diff -r 8f3ed7d2195c -r 64df9e1d8676 src/data.cc
--- a/src/data.cc
+++ b/src/data.cc
@@ -3752,7 +3752,7 @@
the machine precision. More precisely, @code{eps} is the largest\n\
relative spacing between any two adjacent numbers in the machine's\n\
floating point system. This number is obviously system-dependent. On\n\
-machines that support 64 bit IEEE floating point arithmetic, @code{eps}\n\
+machines that support 64-bit IEEE floating point arithmetic, @code{eps}\n\
is approximately\n\
@ifinfo\n\
2.2204e-16.\n\
changeset: 8402:119aafd7045d
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:48 2008 -0500
summary: [docs] poly-morphic => polymorphic
diff -r 64df9e1d8676 -r 119aafd7045d doc/interpreter/linalg.txi
--- a/doc/interpreter/linalg.txi
+++ b/doc/interpreter/linalg.txi
@@ -34,7 +34,7 @@
@node Techniques used for Linear Algebra
@section Techniques used for Linear Algebra
-Octave includes a poly-morphic solver, that selects an appropriate
+Octave includes a polymorphic solver, that selects an appropriate
matrix factorization depending on the properties of the matrix itself.
Generally, the cost of determining the matrix type is small relative to
the cost of factorizing the matrix itself, but in any case the matrix
diff -r 64df9e1d8676 -r 119aafd7045d doc/interpreter/sparse.txi
--- a/doc/interpreter/sparse.txi
+++ b/doc/interpreter/sparse.txi
@@ -726,7 +726,7 @@
@node Sparse Linear Algebra, Iterative Techniques, Basics, Sparse Matrices
@section Linear Algebra on Sparse Matrices
-Octave includes a poly-morphic solver for sparse matrices, where
+Octave includes a polymorphic solver for sparse matrices, where
the exact solver used to factorize the matrix, depends on the properties
of the sparse matrix itself. Generally, the cost of determining the matrix type
is small relative to the cost of factorizing the matrix itself, but in any
changeset: 8403:8f4621d7b23c
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:48 2008 -0500
summary: [docs] low cost => low-cost
diff -r 119aafd7045d -r 8f4621d7b23c src/DLD-FUNCTIONS/matrix_type.cc
--- a/src/DLD-FUNCTIONS/matrix_type.cc
+++ b/src/DLD-FUNCTIONS/matrix_type.cc
@@ -99,7 +99,7 @@
and so it is entirely the responsibility of the user to correctly identify the\n\
matrix type.\n\
\n\
-Also the test for positive definiteness is a low cost test for a hermitian\n\
+Also the test for positive definiteness is a low-cost test for a hermitian\n\
matrix with a real positive diagonal. This does not guarantee that the matrix\n\
is positive definite, but only that it is a probable candidate. When such a\n\
matrix is factorized, a Cholesky factorization is first attempted, and if\n\
changeset: 8404:0a673f36dd84
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:49 2008 -0500
summary: [docs] non singleton => non-singleton
diff -r 8f4621d7b23c -r 0a673f36dd84 scripts/general/cumtrapz.m
--- a/scripts/general/cumtrapz.m
+++ b/scripts/general/cumtrapz.m
@@ -23,7 +23,7 @@
##
## Cumulative numerical integration using trapezoidal method.
## @code{cumtrapz (@var{y})} computes the cumulative integral of the
-## @var{y} along the first non singleton dimension. If the argument
+## @var{y} along the first non-singleton dimension. If the argument
## @var{x} is omitted a equally spaced vector is assumed. @code{cumtrapz
## (@var{x}, @var{y})} evaluates the cumulative integral with respect
## to @var{x}.
diff -r 8f4621d7b23c -r 0a673f36dd84 scripts/general/trapz.m
--- a/scripts/general/trapz.m
+++ b/scripts/general/trapz.m
@@ -23,7 +23,7 @@
##
## Numerical integration using trapezoidal method. @code{trapz
## (@var{y})} computes the integral of the @var{y} along the first
-## non singleton dimension. If the argument @var{x} is omitted a
+## non-singleton dimension. If the argument @var{x} is omitted a
## equally spaced vector is assumed. @code{trapz (@var{x}, @var{y})}
## evaluates the integral with respect to @var{x}.
##
diff -r 8f4621d7b23c -r 0a673f36dd84 scripts/statistics/base/iqr.m
--- a/scripts/statistics/base/iqr.m
+++ b/scripts/statistics/base/iqr.m
@@ -22,7 +22,7 @@
## If @var{x} is a vector, return the interquartile range, i.e., the
## difference between the upper and lower quartile, of the input data.
##
-## If @var{x} is a matrix, do the above for first non singleton
+## If @var{x} is a matrix, do the above for first non-singleton
## dimension of @var{x}. If the option @var{dim} argument is given,
## then operate along this dimension.
## @end deftypefn
changeset: 8405:38970c024dbd
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:49 2008 -0500
summary: [docs] fix hypenation: x - axis => x-axis, etc
diff -r 0a673f36dd84 -r 38970c024dbd scripts/general/cart2pol.m
--- a/scripts/general/cart2pol.m
+++ b/scripts/general/cart2pol.m
@@ -21,8 +21,8 @@
## @deftypefnx {Function File} {[@var{theta}, @var{r}, @var{z}] =} cart2pol (@var{x}, @var{y}, @var{z})
## Transform cartesian to polar or cylindrical coordinates.
## @var{x}, @var{y} (and @var{z}) must be of same shape.
-## @var{theta} describes the angle relative to the x - axis.
-## @var{r} is the distance to the z - axis (0, 0, z).
+## @var{theta} describes the angle relative to the x-axis.
+## @var{r} is the distance to the z-axis (0, 0, z).
## @seealso{pol2cart, cart2sph, sph2cart}
## @end deftypefn
diff -r 0a673f36dd84 -r 38970c024dbd scripts/general/cart2sph.m
--- a/scripts/general/cart2sph.m
+++ b/scripts/general/cart2sph.m
@@ -20,8 +20,8 @@
## @deftypefn {Function File} {[@var{theta}, @var{phi}, @var{r}] =} cart2sph (@var{x}, @var{y}, @var{z})
## Transform cartesian to spherical coordinates.
## @var{x}, @var{y} and @var{z} must be of same shape.
-## @var{theta} describes the angle relative to the x - axis.
-## @var{phi} is the angle relative to the xy - plane.
+## @var{theta} describes the angle relative to the x-axis.
+## @var{phi} is the angle relative to the xy-plane.
## @var{r} is the distance to the origin (0, 0, 0).
## @seealso{pol2cart, cart2pol, sph2cart}
## @end deftypefn
diff -r 0a673f36dd84 -r 38970c024dbd scripts/general/pol2cart.m
--- a/scripts/general/pol2cart.m
+++ b/scripts/general/pol2cart.m
@@ -21,8 +21,8 @@
## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} pol2cart (@var{theta}, @var{r}, @var{z})
## Transform polar or cylindrical to cartesian coordinates.
## @var{theta}, @var{r} (and @var{z}) must be of same shape.
-## @var{theta} describes the angle relative to the x - axis.
-## @var{r} is the distance to the z - axis (0, 0, z).
+## @var{theta} describes the angle relative to the x-axis.
+## @var{r} is the distance to the z-axis (0, 0, z).
## @seealso{cart2pol, cart2sph, sph2cart}
## @end deftypefn
changeset: 8406:ee40b907c01a
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:50 2008 -0500
summary: [docs] remove
diff -r 38970c024dbd -r ee40b907c01a src/bitfcns.cc
--- a/src/bitfcns.cc
+++ b/src/bitfcns.cc
@@ -408,7 +408,7 @@
"-*- texinfo -*-\n\
@deftypefn {Built-in Function} {} bitshift (@var{a}, @var{k})\n\
@deftypefnx {Built-in Function} {} bitshift (@var{a}, @var{k}, @var{n})\n\
-Return a @var{k} bit shift of @var{n}- digit unsigned\n\
+Return a @var{k} bit shift of @var{n}-digit unsigned\n\
integers in @var{a}. A positive @var{k} leads to a left shift.\n\
A negative value to a right shift. If @var{n} is omitted it defaults\n\
to log2(bitmax)+1.\n\
changeset: 8407:5ae72dbe0aaa
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:50 2008 -0500
summary: [docs] user specified => user-specified
diff -r ee40b907c01a -r 5ae72dbe0aaa doc/interpreter/container.txi
--- a/doc/interpreter/container.txi
+++ b/doc/interpreter/container.txi
@@ -681,7 +681,7 @@
depending on the actual data. The most simple way to process that data
is to iterate through it using one or more @code{for} loops. The same
idea can be implemented easier through the use of the @code{cellfun}
-function that calls a user specified function on all elements of a cell
+function that calls a user-specified function on all elements of a cell
array.
@DOCSTRING(cellfun)
changeset: 8408:cd05af0f8a38
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:50 2008 -0500
summary: [docs] add hyphen
diff -r 5ae72dbe0aaa -r cd05af0f8a38 scripts/general/nthroot.m
--- a/scripts/general/nthroot.m
+++ b/scripts/general/nthroot.m
@@ -22,7 +22,7 @@
## -*- texinfo -*-
## @deftypefn {Function File} {} nthroot (@var{x}, @var{n})
##
-## Compute the nth root of @var{x}, returning real results for real
+## Compute the n-th root of @var{x}, returning real results for real
## components of @var{x}. For example
##
## @example
diff -r 5ae72dbe0aaa -r cd05af0f8a38 scripts/geometry/rectint.m
--- a/scripts/geometry/rectint.m
+++ b/scripts/geometry/rectint.m
@@ -25,8 +25,8 @@
## dimensions.
##
## If @var{a} or @var{b} are matrices, then the output, @var{area}, is a
-## matrix where the ith row corresponds to the ith row of a and the jth
-## column corresponds to the jth row of b.
+## matrix where the i-th row corresponds to the i-th row of a and the j-th
+## column corresponds to the j-th row of b.
##
## @seealso{polyarea}
## @end deftypefn
diff -r 5ae72dbe0aaa -r cd05af0f8a38 scripts/linear-algebra/housh.m
--- a/scripts/linear-algebra/housh.m
+++ b/scripts/linear-algebra/housh.m
@@ -20,7 +20,7 @@
## -*- texinfo -*-
## @deftypefn {Function File} {[@var{housv}, @var{beta}, @var{zer}] =} housh (@var{x}, @var{j}, @var{z})
## Compute Householder reflection vector @var{housv} to reflect @var{x}
-## to be the jth column of identity, i.e.,
+## to be the j-th column of identity, i.e.,
##
## @example
## @group
diff -r 5ae72dbe0aaa -r cd05af0f8a38 scripts/plot/ndgrid.m
--- a/scripts/plot/ndgrid.m
+++ b/scripts/plot/ndgrid.m
@@ -20,9 +20,9 @@
## @deftypefn {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x1}, @var{x2}, @dots{}, @var{x}n)
## @deftypefnx {Function File} {[@var{y1}, @var{y2}, @dots{}, @var{y}n] =} ndgrid (@var{x})
## Given n vectors @var{x1}, @dots{} @var{x}n, @code{ndgrid} returns
-## n arrays of dimension n. The elements of the ith output argument
+## n arrays of dimension n. The elements of the i-th output argument
## contains the elements of the vector @var{x}i repeated over all
-## dimensions different from the ith dimension. Calling ndgrid with
+## dimensions different from the i-th dimension. Calling ndgrid with
## only one input argument @var{x} is equivalent of calling ndgrid with
## all n input arguments equal to @var{x}:
##
diff -r 5ae72dbe0aaa -r cd05af0f8a38 scripts/polynomial/mkpp.m
--- a/scripts/polynomial/mkpp.m
+++ b/scripts/polynomial/mkpp.m
@@ -21,7 +21,7 @@
## @deftypefnx {Function File} {@var{pp} =} mkpp (@var{x}, @var{p}, @var{d})
##
## Construct a piece-wise polynomial structure from sample points
-## @var{x} and coefficients @var{p}. The ith row of @var{p},
+## @var{x} and coefficients @var{p}. The i-th row of @var{p},
## @code{@var{p} (@var{i},:)}, contains the coefficients for the polynomial
## over the @var{i}-th interval, ordered from highest to
## lowest. There must be one row for each interval in @var{x}, so
diff -r 5ae72dbe0aaa -r cd05af0f8a38 scripts/polynomial/residue.m
--- a/scripts/polynomial/residue.m
+++ b/scripts/polynomial/residue.m
@@ -44,7 +44,7 @@
## where @math{M} is the number of poles (the length of the @var{r},
## @var{p}, and @var{e}), the @var{k} vector is a polynomial of order @math{N-1}
## representing the direct contribution, and the @var{e} vector specifies
-## the multiplicity of the mth residue's pole.
+## the multiplicity of the m-th residue's pole.
##
## For example,
##
changeset: 8409:0e4db611b476
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:51 2008 -0500
summary: [docs] non periodic => non-periodic
diff -r cd05af0f8a38 -r 0e4db611b476 doc/interpreter/interp.txi
--- a/doc/interpreter/interp.txi
+++ b/doc/interpreter/interp.txi
@@ -95,7 +95,7 @@
@DOCSTRING(interpft)
There are two significant limitations on Fourier interpolation. Firstly,
-the function signal is assumed to be periodic, and so non periodic
+the function signal is assumed to be periodic, and so non-periodic
signals will be poorly represented at the edges. Secondly, both the
signal and its interpolation are required to be sampled at equispaced
points. An example of the use of @code{interpft} is
@@ -114,17 +114,14 @@
@end example
@ifinfo
-which demonstrates the poor behavior of Fourier interpolation for non
-periodic functions.
+which demonstrates the poor behavior of Fourier interpolation for non-periodic functions.
@end ifinfo
@ifnotinfo
-which demonstrates the poor behavior of Fourier interpolation for non
-periodic functions, as can be seen in @ref{fig:interpft}.
+which demonstrates the poor behavior of Fourier interpolation for non-periodic functions, as can be seen in @ref{fig:interpft}.
@float Figure,fig:interpft
@image{interpft,8cm}
- at caption{Comparison of @code{interp1} and @code{interpft} for non
-periodic data}
+ at caption{Comparison of @code{interp1} and @code{interpft} for non-periodic data}
@end float
@end ifnotinfo
changeset: 8410:285f3c098f8c
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:51 2008 -0500
summary: [docs] add hyphen
diff -r 0e4db611b476 -r 285f3c098f8c src/DLD-FUNCTIONS/fft2.cc
--- a/src/DLD-FUNCTIONS/fft2.cc
+++ b/src/DLD-FUNCTIONS/fft2.cc
@@ -170,7 +170,7 @@
DEFUN_DLD (fft2, args, ,
"-*- texinfo -*-\n\
@deftypefn {Loadable Function} {} fft2 (@var{a}, @var{n}, @var{m})\n\
-Compute the two dimensional FFT of @var{a} using subroutines from\n"
+Compute the two-dimensional FFT of @var{a} using subroutines from\n"
FFTSRC
". The optional arguments @var{n} and @var{m} may be used specify the\n\
number of rows and columns of @var{a} to use. If either of these is\n\
@@ -189,7 +189,7 @@
DEFUN_DLD (ifft2, args, ,
"-*- texinfo -*-\n\
@deftypefn {Loadable Function} {} fft2 (@var{a}, @var{n}, @var{m})\n\
-Compute the inverse two dimensional FFT of @var{a} using subroutines from\n"
+Compute the inverse two-dimensional FFT of @var{a} using subroutines from\n"
FFTSRC
". The optional arguments @var{n} and @var{m} may be used specify the\n\
number of rows and columns of @var{a} to use. If either of these is\n\
diff -r 0e4db611b476 -r 285f3c098f8c src/DLD-FUNCTIONS/fftn.cc
--- a/src/DLD-FUNCTIONS/fftn.cc
+++ b/src/DLD-FUNCTIONS/fftn.cc
@@ -152,7 +152,7 @@
DEFUN_DLD (fftn, args, ,
"-*- texinfo -*-\n\
@deftypefn {Loadable Function} {} fftn (@var{a}, @var{size})\n\
-Compute the N dimensional FFT of @var{a} using subroutines from\n"
+Compute the N-dimensional FFT of @var{a} using subroutines from\n"
FFTSRC
". The optional vector argument @var{size} may be used specify the\n\
dimensions of the array to be used. If an element of @var{size} is\n\
@@ -169,7 +169,7 @@
DEFUN_DLD (ifftn, args, ,
"-*- texinfo -*-\n\
@deftypefn {Loadable Function} {} ifftn (@var{a}, @var{size})\n\
-Compute the inverse N dimensional FFT of @var{a} using subroutines from\n"
+Compute the inverse N-dimensional FFT of @var{a} using subroutines from\n"
FFTSRC
". The optional vector argument @var{size} may be used specify the\n\
dimensions of the array to be used. If an element of @var{size} is\n\
changeset: 8411:a04786917d95
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 05:19:51 2008 -0500
summary: [docs] Ziggurat technique => ``Ziggurat technique''
diff -r 285f3c098f8c -r a04786917d95 src/DLD-FUNCTIONS/rand.cc
--- a/src/DLD-FUNCTIONS/rand.cc
+++ b/src/DLD-FUNCTIONS/rand.cc
@@ -474,7 +474,7 @@
elements having zero mean and variance one. The arguments are\n\
handled the same as the arguments for @code{rand}.\n\
\n\
-By default, @code{randn} uses a Marsaglia and Tsang Ziggurat technique to\n\
+By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique'' to\n\
transform from a uniform to a normal distribution. (G. Marsaglia and\n\
W.W. Tsang, @cite{Ziggurat method for generating random variables},\n\
J. Statistical Software, vol 5, 2000,\n\
@@ -548,7 +548,7 @@
Return a matrix with exponentially distributed random elements. The\n\
arguments are handled the same as the arguments for @code{rand}.\n\
\n\
-By default, @code{randn} uses a Marsaglia and Tsang Ziggurat technique to\n\
+By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique'' to\n\
transform from a uniform to a exponential distribution. (G. Marsaglia and\n\
W.W. Tsang, @cite{Ziggurat method for generating random variables},\n\
J. Statistical Software, vol 5, 2000,\n\
changeset: 8412:b8eb3a42e0f9
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 06:58:26 2008 -0500
summary: [docs] 2^19937-1 => @math{2^{19937}-1}
diff -r a04786917d95 -r b8eb3a42e0f9 src/DLD-FUNCTIONS/rand.cc
--- a/src/DLD-FUNCTIONS/rand.cc
+++ b/src/DLD-FUNCTIONS/rand.cc
@@ -342,7 +342,7 @@
fraction of a second.\n\
\n\
To compute the pseudo-random sequence, @code{rand} uses the Mersenne\n\
-Twister with a period of 2^19937-1 (See M. Matsumoto and T. Nishimura,\n\
+Twister with a period of @math{2^{19937}-1} (See M. Matsumoto and T. Nishimura,\n\
@cite{Mersenne Twister: A 623-dimensionally equidistributed uniform pseudorandom number generator}, ACM Trans. on\n\
Modeling and Computer Simulation Vol. 8, No. 1, January pp.3-30 1998,\n\
@url{http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html}).\n\
changeset: 8413:9363604da388
tag: tip
user: Brian Gough <bjg at gnu.org>
date: Wed Dec 10 06:58:26 2008 -0500
summary: [docs] use $$ for display
diff -r b8eb3a42e0f9 -r 9363604da388 scripts/general/del2.m
--- a/scripts/general/del2.m
+++ b/scripts/general/del2.m
@@ -27,7 +27,7 @@
##
## @iftex
## @tex
-## $d = {1 \over 4} \left( {d^2 \over dx^2} M(x,y) + {d^2 \over dy^2} M(x,y) \right)$
+## $$d = {1 \over 4} \left( {d^2 \over dx^2} M(x,y) + {d^2 \over dy^2} M(x,y) \right)$$
## @end tex
## @end iftex
## @ifnottex
More information about the Bug-octave
mailing list