Mercurial > hg > octave-shane
changeset 9154:761fc0d3d980
Update section 17.2 (Complex Arithmetic) of arith.txi
Use Tex in more of the doc strings for pretty printing in pdf format.
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 24 Apr 2009 20:32:01 -0700 |
parents | 5247e89688e1 |
children | ad20b967e1c9 |
files | doc/ChangeLog doc/interpreter/arith.txi scripts/general/cplxpair.m src/mappers.cc |
diffstat | 4 files changed, 21 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2009-04-24 Rik <rdrider0-list@yahoo.com> + * interpreter/arith.txi: Update section 17.2 (Complex Arithmetic) of + arith.txi + Use Tex in more of the doc strings for pretty printing in pdf format. + 2009-04-24 Rik <rdrider0-list@yahoo.com> * interpreter/octave.pdf: Eliminate most overfull errors when running texi2pdf for generating
--- a/doc/interpreter/arith.txi +++ b/doc/interpreter/arith.txi @@ -76,10 +76,7 @@ @node Complex Arithmetic @section Complex Arithmetic -The following functions are available for working with complex -numbers. Each expects a single argument. Given a matrix they work on -an element by element basis. In the descriptions of the following -functions, +In the descriptions of the following functions, @iftex @tex $z$ is the complex number $x + iy$, where $i$ is defined as
--- a/scripts/general/cplxpair.m +++ b/scripts/general/cplxpair.m @@ -26,16 +26,16 @@ ## @code{abs (imag (@var{z}) / @var{z}) < @var{tol})}) after the ## complex pairs. ## -## If @var{tol} is unspecified the default value is 100*@var{eps}. +## If @var{tol} is unspecified the default value is 100*@code{eps}. ## ## By default the complex pairs are sorted along the first non-singleton ## dimension of @var{z}. If @var{dim} is specified, then the complex ## pairs are sorted along this dimension. ## -## Signal an error if some complex numbers could not be paired. Requires -## all complex numbers to be exact conjugates within @var{tol}, or signals an -## error. Note that there are no guarantees on the order of the returned -## pairs with identical real parts but differing imaginary parts. +## Signal an error if some complex numbers could not be paired. Signal an +## error if all complex numbers are not exact conjugates (to within +## @var{tol}). Note that there is no defined order for pairs with identical +## real parts but differing imaginary parts. ## ## @c Set example in small font to prevent overfull line ## @smallexample
--- a/src/mappers.cc +++ b/src/mappers.cc @@ -174,9 +174,16 @@ "-*- texinfo -*-\n\ @deftypefn {Mapping Function} {} arg (@var{z})\n\ @deftypefnx {Mapping Function} {} angle (@var{z})\n\ -Compute the argument of @var{z}, defined as\n\ -@var{theta} = @code{atan2 (@var{y}, @var{x})}.\n\ -in radians. \n\ +Compute the argument of @var{z}, defined as,\n\ +@iftex\n\ +@tex\n\ +$\\theta = atan2 (y, x),$\n\ +@end tex\n\ +@end iftex\n\ +@ifnottex\n\ +@var{theta} = @code{atan2 (@var{y}, @var{x})},\n\ +@end ifnottex\n\ +in radians.\n\ \n\ For example,\n\ \n\