changeset 9041:853f96e8008f

Cleanup documentation file matrix.texi Spellcheck Stylecheck (Mostly double spaces after periods)
author Rik <rdrider0-list@yahoo.com>
date Wed, 25 Mar 2009 08:05:35 -0700
parents dbd0c77e575e
children 97aa01a85ea4
files scripts/general/circshift.m scripts/general/diff.m scripts/general/repmat.m scripts/general/rotdim.m scripts/general/shiftdim.m scripts/general/sortrows.m scripts/special-matrix/magic.m scripts/special-matrix/pascal.m scripts/special-matrix/rosser.m scripts/special-matrix/toeplitz.m scripts/special-matrix/vander.m src/DLD-FUNCTIONS/bsxfun.cc src/DLD-FUNCTIONS/find.cc src/DLD-FUNCTIONS/rand.cc src/data.cc src/mappers.cc
diffstat 16 files changed, 36 insertions(+), 36 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/general/circshift.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/general/circshift.m	Wed Mar 25 08:05:35 2009 -0700
@@ -22,8 +22,8 @@
 ## a vector of integers no longer than the number of dimensions in 
 ## @var{x}. The values of @var{n} can be either positive or negative,
 ## which determines the direction in which the values or @var{x} are
-## shifted. If an element of @var{n} is zero, then the corresponding
-## dimension of @var{x} will not be shifted. For example
+## shifted.  If an element of @var{n} is zero, then the corresponding
+## dimension of @var{x} will not be shifted.  For example
 ##
 ## @example
 ## @group
--- a/scripts/general/diff.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/general/diff.m	Wed Mar 25 08:05:35 2009 -0700
@@ -35,8 +35,8 @@
 ##
 ## The second argument is optional.  If supplied, @code{diff (@var{x},
 ## @var{k})}, where @var{k} is a nonnegative integer, returns the
-## @var{k}-th differences. It is possible that @var{k} is larger than
-## then first non-singleton dimension of the matrix. In this case,
+## @var{k}-th differences.  It is possible that @var{k} is larger than
+## then first non-singleton dimension of the matrix.  In this case,
 ## @code{diff} continues to take the differences along the next
 ## non-singleton dimension.
 ##
--- a/scripts/general/repmat.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/general/repmat.m	Wed Mar 25 08:05:35 2009 -0700
@@ -20,7 +20,7 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} repmat (@var{A}, @var{m}, @var{n})
 ## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n}])
-## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n} @var{p} ...])
+## @deftypefnx {Function File} {} repmat (@var{A}, [@var{m} @var{n} @var{p} @dots{}])
 ## Form a block matrix of size @var{m} by @var{n}, with a copy of matrix
 ## @var{A} as each element.  If @var{n} is not specified, form an 
 ## @var{m} by @var{m} block matrix.
--- a/scripts/general/rotdim.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/general/rotdim.m	Wed Mar 25 08:05:35 2009 -0700
@@ -22,8 +22,8 @@
 ## 90-degree increments.  The second argument is optional, and specifies
 ## how many 90-degree rotations are to be applied (the default value is 1).
 ## The third argument is also optional and defines the plane of the
-## rotation. As such @var{plane} is a two element vector containing two
-## different valid dimensions of the matrix. If @var{plane} is not given
+## rotation.  As such @var{plane} is a two element vector containing two
+## different valid dimensions of the matrix.  If @var{plane} is not given
 ## Then the first two non-singleton dimensions are used.
 ##
 ## Negative values of @var{n} rotate the matrix in a clockwise direction.
--- a/scripts/general/shiftdim.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/general/shiftdim.m	Wed Mar 25 08:05:35 2009 -0700
@@ -20,9 +20,9 @@
 ## @deftypefn {Function File} {@var{y} =} shiftdim (@var{x}, @var{n})
 ## @deftypefnx {Function File} {[@var{y}, @var{ns}] =} shiftdim (@var{x})
 ## Shifts the dimension of @var{x} by @var{n}, where @var{n} must be
-## an integer scalar. When @var{n} is positive, the dimensions of
+## an integer scalar.  When @var{n} is positive, the dimensions of
 ## @var{x} are shifted to the left, with the leading dimensions
-## circulated to the end. If @var{n} is negative, then the dimensions
+## circulated to the end.  If @var{n} is negative, then the dimensions
 ## of @var{x} are shifted to the right, with @var{n} leading singleton
 ## dimensions added.
 ##
--- a/scripts/general/sortrows.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/general/sortrows.m	Wed Mar 25 08:05:35 2009 -0700
@@ -21,7 +21,7 @@
 ## @deftypefn {Function File} {} sortrows (@var{a}, @var{c})
 ## Sort the rows of the matrix @var{a} according to the order of the
 ## columns specified in @var{c}.  If @var{c} is omitted, a
-## lexicographical sort is used. By default ascending order is used 
+## lexicographical sort is used.  By default ascending order is used 
 ## however if elements of @var{c} are negative then the corresponding  
 ## column is sorted in descending order.
 ## @end deftypefn
--- a/scripts/special-matrix/magic.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/special-matrix/magic.m	Wed Mar 25 08:05:35 2009 -0700
@@ -19,7 +19,7 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} magic (@var{n})
 ##
-## Create an @var{n}-by-@var{n} magic square. Note that @code{magic
+## Create an @var{n}-by-@var{n} magic square.  Note that @code{magic
 ## (@var{2})} is undefined since there is no 2-by-2 magic square.
 ##
 ## @end deftypefn
--- a/scripts/special-matrix/pascal.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/special-matrix/pascal.m	Wed Mar 25 08:05:35 2009 -0700
@@ -25,7 +25,7 @@
 ## inverse, that is @code{pascal (@var{n}, 1) ^ 2 == eye (@var{n})}.
 ## If @code{@var{t} = 2}, return a transposed and  permuted version of
 ## @code{pascal (@var{n}, 1)}, which is the cube-root of the identity
-## matrix. That is @code{pascal (@var{n}, 2) ^ 3 == eye (@var{n})}.
+## matrix.  That is @code{pascal (@var{n}, 2) ^ 3 == eye (@var{n})}.
 ##
 ## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb, toeplitz
 ##           hadamard, wilkinson, compan, rosser}
--- a/scripts/special-matrix/rosser.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/special-matrix/rosser.m	Wed Mar 25 08:05:35 2009 -0700
@@ -19,7 +19,7 @@
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} rosser ()
 ##
-## Returns the Rosser matrix. This is a difficult test case used to test
+## Returns the Rosser matrix.  This is a difficult test case used to test
 ## eigenvalue algorithms.
 ##
 ## @seealso{hankel, vander, sylvester_matrix, hilb, invhilb, toeplitz
--- a/scripts/special-matrix/toeplitz.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/special-matrix/toeplitz.m	Wed Mar 25 08:05:35 2009 -0700
@@ -41,13 +41,13 @@
 ##
 ## @example
 ## @group
-## c(0)  r(1)   r(2)  ...  r(n)
-## c(1)  c(0)   r(1)  ... r(n-1)
-## c(2)  c(1)   c(0)  ... r(n-2)
+## c(0)  r(1)   r(2)  @dots{}  r(n)
+## c(1)  c(0)   r(1)  @dots{} r(n-1)
+## c(2)  c(1)   c(0)  @dots{} r(n-2)
 ##  .     ,      ,   .      .
 ##  .     ,      ,     .    .
 ##  .     ,      ,       .  .
-## c(n) c(n-1) c(n-2) ...  c(0)
+## c(n) c(n-1) c(n-2) @dots{}  c(0)
 ## @end group
 ## @end example
 ## @end ifnottex
--- a/scripts/special-matrix/vander.m	Sun Mar 22 14:40:24 2009 -0700
+++ b/scripts/special-matrix/vander.m	Wed Mar 25 08:05:35 2009 -0700
@@ -36,12 +36,12 @@
 ##
 ## @example
 ## @group
-## c(1)^(n-1) ... c(1)^2  c(1)  1
-## c(2)^(n-1) ... c(2)^2  c(2)  1
+## c(1)^(n-1) @dots{} c(1)^2  c(1)  1
+## c(2)^(n-1) @dots{} c(2)^2  c(2)  1
 ##     .     .      .      .    .
 ##     .       .    .      .    .
 ##     .         .  .      .    .
-## c(n)^(n-1) ... c(n)^2  c(n)  1
+## c(n)^(n-1) @dots{} c(n)^2  c(n)  1
 ## @end group
 ## @end example
 ## @end ifnottex
--- a/src/DLD-FUNCTIONS/bsxfun.cc	Sun Mar 22 14:40:24 2009 -0700
+++ b/src/DLD-FUNCTIONS/bsxfun.cc	Wed Mar 25 08:05:35 2009 -0700
@@ -130,11 +130,11 @@
   "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} bsxfun (@var{f}, @var{a}, @var{b})\n\
 Applies a binary function @var{f} element-wise to two matrix arguments\n\
-@var{a} and @var{b}. The function @var{f} must be capable of accepting\n\
+@var{a} and @var{b}.  The function @var{f} must be capable of accepting\n\
 two column vector arguments of equal length, or one column vector\n\
 argument and a scalar.\n\
 \n\
-The dimensions of @var{a} and @var{b} must be equal or singleton. The\n\
+The dimensions of @var{a} and @var{b} must be equal or singleton.  The\n\
 singleton dimensions of the matrices will be expanded to the same\n\
 dimensionality as the other matrix.\n\
 \n\
--- a/src/DLD-FUNCTIONS/find.cc	Sun Mar 22 14:40:24 2009 -0700
+++ b/src/DLD-FUNCTIONS/find.cc	Wed Mar 25 08:05:35 2009 -0700
@@ -493,7 +493,7 @@
 \n\
 Note that this function is particularly useful for sparse matrices, as\n\
 it extracts the non-zero elements as vectors, which can then be used to\n\
-create the original matrix. For example,\n\
+create the original matrix.  For example,\n\
 \n\
 @example\n\
 @group\n\
--- a/src/DLD-FUNCTIONS/rand.cc	Sun Mar 22 14:40:24 2009 -0700
+++ b/src/DLD-FUNCTIONS/rand.cc	Wed Mar 25 08:05:35 2009 -0700
@@ -353,9 +353,9 @@
 Older versions of Octave used a different random number generator.\n\
 The new generator is used by default\n\
 as it is significantly faster than the old generator, and produces\n\
-random numbers with a significantly longer cycle time. However, in\n\
+random numbers with a significantly longer cycle time.  However, in\n\
 some circumstances it might be desirable to obtain the same random\n\
-sequences as used by the old generators. To do this the keyword\n\
+sequences as used by the old generators.  To do this the keyword\n\
 \"seed\" is used to specify that the old generators should be use,\n\
 as in\n\
 \n\
@@ -474,11 +474,11 @@
 @deftypefnx {Loadable Function} {} randn (\"state\", @var{x})\n\
 @deftypefnx {Loadable Function} {} randn (\"seed\", @var{x})\n\
 Return a matrix with normally distributed pseudo-random\n\
-elements having zero mean and variance one. The arguments are\n\
+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 the Marsaglia and Tsang ``Ziggurat technique'' to\n\
-transform from a uniform to a normal distribution. (G. Marsaglia and\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\
 @url{http://www.jstatsoft.org/v05/i08/})\n\
@@ -548,11 +548,11 @@
 @deftypefnx {Loadable Function} {} rande (@var{n}, @var{m})\n\
 @deftypefnx {Loadable Function} {} rande (\"state\", @var{x})\n\
 @deftypefnx {Loadable Function} {} rande (\"seed\", @var{x})\n\
-Return a matrix with exponentially distributed random elements. The\n\
+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 the Marsaglia and Tsang ``Ziggurat technique'' to\n\
-transform from a uniform to a exponential distribution. (G. Marsaglia and\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\
 @url{http://www.jstatsoft.org/v05/i08/})\n\
@@ -672,9 +672,9 @@
 r(r > 0) = 2 * randg (r(r > 0))\n\
 r(df > 0) += 2 * randg (df(df > 0)/2)\n\
 @end example\n\
-@item @code{Dirichlet (a1, ..., ak)}\n\
+@item @code{Dirichlet (a1, @dots{} ak)}\n\
 @example\n\
-r = (randg (a1), ..., randg (ak))\n\
+r = (randg (a1), @dots{}, randg (ak))\n\
 r = r / sum (r)\n\
 @end example\n\
 @end table\n\
--- a/src/data.cc	Sun Mar 22 14:40:24 2009 -0700
+++ b/src/data.cc	Wed Mar 25 08:05:35 2009 -0700
@@ -4475,7 +4475,7 @@
 DEFUN (reshape, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} reshape (@var{a}, @var{m}, @var{n}, @dots{})\n\
-@deftypefnx {Built-in Function} {} reshape (@var{a}, @var{siz})\n\
+@deftypefnx {Built-in Function} {} reshape (@var{a}, @var{size})\n\
 Return a matrix with the given dimensions whose elements are taken\n\
 from the matrix @var{a}.  The elements of the matrix are accessed in\n\
 column-major order (like Fortran arrays are stored).\n\
@@ -5341,8 +5341,8 @@
 @end example\n\
 \n\
 If the optional argument @var{dim} is given, then the matrix is sorted\n\
-along the dimension defined by @var{dim}. The optional argument @code{mode}\n\
-defines the order in which the values will be sorted. Valid values of\n\
+along the dimension defined by @var{dim}.  The optional argument @code{mode}\n\
+defines the order in which the values will be sorted.  Valid values of\n\
 @code{mode} are `ascend' or `descend'.\n\
 \n\
 For equal elements, the indices are such that the equal elements are listed\n\
--- a/src/mappers.cc	Sun Mar 22 14:40:24 2009 -0700
+++ b/src/mappers.cc	Wed Mar 25 08:05:35 2009 -0700
@@ -633,7 +633,7 @@
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} finite (@var{x})\n\
 Return 1 for elements of @var{x} that are finite values and zero\n\
-otherwise. For example,\n\
+otherwise.  For example,\n\
 \n\
 @example\n\
 @group\n\
@@ -893,7 +893,7 @@
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} isinf (@var{x})\n\
 Return 1 for elements of @var{x} that are infinite and zero\n\
-otherwise. For example,\n\
+otherwise.  For example,\n\
 \n\
 @example\n\
 @group\n\