added check for consistency of numeric input/output routines
[ginac.git] / doc / tutorial / ginac.texi
index 81bfb7f7b4725b573b2fcf39f87026a5fd72d75b..dcee9335e90270ccbc2ff045e7f792f9d258faa4 100644 (file)
@@ -23,7 +23,7 @@
 This is a tutorial that documents GiNaC @value{VERSION}, an open
 framework for symbolic computation within the C++ programming language.
 
-Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+Copyright (C) 1999-2002 Johannes Gutenberg University Mainz, Germany
 
 Permission is granted to make and distribute verbatim copies of
 this manual provided the copyright notice and this permission notice
@@ -52,7 +52,7 @@ notice identical to this one.
 
 @page
 @vskip 0pt plus 1filll
-Copyright @copyright{} 1999-2001 Johannes Gutenberg University Mainz, Germany
+Copyright @copyright{} 1999-2002 Johannes Gutenberg University Mainz, Germany
 @sp 2
 Permission is granted to make and distribute verbatim copies of
 this manual provided the copyright notice and this permission notice
@@ -101,7 +101,7 @@ The motivation behind GiNaC derives from the observation that most
 present day computer algebra systems (CAS) are linguistically and
 semantically impoverished.  Although they are quite powerful tools for
 learning math and solving particular problems they lack modern
-linguistical structures that allow for the creation of large-scale
+linguistic structures that allow for the creation of large-scale
 projects.  GiNaC is an attempt to overcome this situation by extending a
 well established and standardized computer language (C++) by some
 fundamental symbolic capabilities, thus allowing for integrated systems
@@ -135,7 +135,7 @@ the near future.
 
 @section License
 The GiNaC framework for symbolic computation within the C++ programming
-language is Copyright @copyright{} 1999-2001 Johannes Gutenberg
+language is Copyright @copyright{} 1999-2002 Johannes Gutenberg
 University Mainz, Germany.
 
 This program is free software; you can redistribute it and/or
@@ -179,6 +179,7 @@ manipulations.  Here is how to generate and print a simple (and rather
 pointless) bivariate polynomial with some large coefficients:
 
 @example
+#include <iostream>
 #include <ginac/ginac.h>
 using namespace std;
 using namespace GiNaC;
@@ -213,6 +214,7 @@ Next, there is a more meaningful C++ program that calls a function which
 generates Hermite polynomials in a specified free variable.
 
 @example
+#include <iostream>
 #include <ginac/ginac.h>
 using namespace std;
 using namespace GiNaC;
@@ -362,8 +364,11 @@ lambda^2-3*lambda+11
 [[1,1],[2,-1]]
 > A+2*M;
 [[1,1],[2,-1]]+2*[[1,3],[-3,2]]
-> evalm(");
+> evalm(%);
 [[3,7],[-4,3]]
+> B = [ [0, 0, a], [b, 1, -b], [-1/a, 0, 0] ];
+> evalm(B^(2^12345));
+[[1,0,0],[0,1,0],[0,0,1]]
 @end example
 
 Multivariate polynomials and rational functions may be expanded,
@@ -401,7 +406,7 @@ x^(-1)-1/3*x+Order(x^2)
 > series(tgamma(x),x==0,3);
 x^(-1)-Euler+(1/12*Pi^2+1/2*Euler^2)*x+
 (-1/3*zeta(3)-1/12*Pi^2*Euler-1/6*Euler^3)*x^2+Order(x^3)
-> evalf(");
+> evalf(%);
 x^(-1)-0.5772156649015328606+(0.9890559953279725555)*x
 -(0.90747907608088628905)*x^2+Order(x^3)
 > series(tgamma(2*sin(x)-2),x==Pi/2,6);
@@ -409,7 +414,7 @@ x^(-1)-0.5772156649015328606+(0.9890559953279725555)*x
 -Euler-1/12+Order((x-1/2*Pi)^3)
 @end example
 
-Here we have made use of the @command{ginsh}-command @code{"} to pop the
+Here we have made use of the @command{ginsh}-command @code{%} to pop the
 previously evaluated element from @command{ginsh}'s internal stack.
 
 If you ever wanted to convert units in C or C++ and found this is
@@ -450,15 +455,14 @@ installation.
 
 In order to install GiNaC on your system, some prerequisites need to be
 met.  First of all, you need to have a C++-compiler adhering to the
-ANSI-standard @cite{ISO/IEC 14882:1998(E)}.  We used @acronym{GCC} for
-development so if you have a different compiler you are on your own.
-For the configuration to succeed you need a Posix compliant shell
-installed in @file{/bin/sh}, GNU @command{bash} is fine.  Perl is needed
-by the built process as well, since some of the source files are
-automatically generated by Perl scripts.  Last but not least, Bruno
-Haible's library @acronym{CLN} is extensively used and needs to be
-installed on your system.  Please get it either from
-@uref{ftp://ftp.santafe.edu/pub/gnu/}, from
+ANSI-standard @cite{ISO/IEC 14882:1998(E)}.  We used GCC for development
+so if you have a different compiler you are on your own.  For the
+configuration to succeed you need a Posix compliant shell installed in
+@file{/bin/sh}, GNU @command{bash} is fine.  Perl is needed by the built
+process as well, since some of the source files are automatically
+generated by Perl scripts.  Last but not least, Bruno Haible's library
+CLN is extensively used and needs to be installed on your system.
+Please get it either from @uref{ftp://ftp.santafe.edu/pub/gnu/}, from
 @uref{ftp://ftpthep.physik.uni-mainz.de/pub/gnu/, GiNaC's FTP site} or
 from @uref{ftp://ftp.ilog.fr/pub/Users/haible/gnu/, Bruno Haible's FTP
 site} (it is covered by GPL) and install it prior to trying to install
@@ -519,15 +523,20 @@ want to have the documentation installed in some other directory than
 
 @end itemize
 
-In addition, you may specify some environment variables.
-@env{CXX} holds the path and the name of the C++ compiler
-in case you want to override the default in your path.  (The
-@command{configure} script searches your path for @command{c++},
-@command{g++}, @command{gcc}, @command{CC}, @command{cxx}
-and @command{cc++} in that order.)  It may be very useful to
-define some compiler flags with the @env{CXXFLAGS} environment
-variable, like optimization, debugging information and warning
-levels.  If omitted, it defaults to @option{-g -O2}.
+In addition, you may specify some environment variables.  @env{CXX}
+holds the path and the name of the C++ compiler in case you want to
+override the default in your path.  (The @command{configure} script
+searches your path for @command{c++}, @command{g++}, @command{gcc},
+@command{CC}, @command{cxx} and @command{cc++} in that order.)  It may
+be very useful to define some compiler flags with the @env{CXXFLAGS}
+environment variable, like optimization, debugging information and
+warning levels.  If omitted, it defaults to @option{-g
+-O2}.@footnote{The @command{configure} script is itself generated from
+the file @file{configure.ac}.  It is only distributed in packaged
+releases of GiNaC.  If you got the naked sources, e.g. from CVS, you
+must generate @command{configure} along with the various
+@file{Makefile.in} by using the @command{autogen.sh} script.  This will
+require a fair amount of support from your local toolchain, though.}
 
 The whole process is illustrated in the following two
 examples. (Substitute @command{setenv @var{VARIABLE} @var{value}} for
@@ -543,14 +552,14 @@ $ ./configure
 @end example
 
 And here is a configuration for a private static GiNaC library with
-several components sitting in custom places (site-wide @acronym{GCC} and
-private @acronym{CLN}).  The compiler is pursuaded to be picky and full
-assertions and debugging information are switched on:
+several components sitting in custom places (site-wide GCC and private
+CLN).  The compiler is persuaded to be picky and full assertions and
+debugging information are switched on:
 
 @example
 $ export CXX=/usr/local/gnu/bin/c++
 $ export CPPFLAGS="$(CPPFLAGS) -I$(HOME)/include"
-$ export CXXFLAGS="$(CXXFLAGS) -DDO_GINAC_ASSERT -ggdb -Wall -ansi -pedantic"
+$ export CXXFLAGS="$(CXXFLAGS) -DDO_GINAC_ASSERT -ggdb -Wall -pedantic"
 $ export LDFLAGS="$(LDFLAGS) -L$(HOME)/lib"
 $ ./configure --disable-shared --prefix=$(HOME)
 @end example
@@ -594,7 +603,7 @@ machine catches fire.  Another quite important intent is to allow people
 to fiddle around with optimization.
 
 Generally, the top-level Makefile runs recursively to the
-subdirectories.  It is therfore safe to go into any subdirectory
+subdirectories.  It is therefore safe to go into any subdirectory
 (@code{doc/}, @code{ginsh/}, @dots{}) and simply type @code{make}
 @var{target} there in case something went wrong.
 
@@ -664,6 +673,7 @@ meta-class for storing all mathematical objects.
 @menu
 * Expressions::                  The fundamental GiNaC class.
 * The Class Hierarchy::          Overview of GiNaC's classes.
+* Error handling::               How the library reports errors.
 * Symbols::                      Symbolic objects.
 * Numbers::                      Numerical objects.
 * Constants::                    Pre-defined constants.
@@ -711,7 +721,7 @@ hierarchy and describe the classes of objects that are handled by
 @code{ex}.
 
 
-@node The Class Hierarchy, Symbols, Expressions, Basic Concepts
+@node The Class Hierarchy, Error handling, Expressions, Basic Concepts
 @c    node-name, next, previous, up
 @section The Class Hierarchy
 
@@ -777,7 +787,64 @@ $\sqrt{2}$
 @end multitable
 @end cartouche
 
-@node Symbols, Numbers, The Class Hierarchy, Basic Concepts
+
+@node Error handling, Symbols, The Class Hierarchy, Basic Concepts
+@c    node-name, next, previous, up
+@section Error handling
+@cindex exceptions
+@cindex @code{pole_error} (class)
+
+GiNaC reports run-time errors by throwing C++ exceptions. All exceptions
+generated by GiNaC are subclassed from the standard @code{exception} class
+defined in the @file{<stdexcept>} header. In addition to the predefined
+@code{logic_error}, @code{domain_error}, @code{out_of_range},
+@code{invalid_argument}, @code{runtime_error}, @code{range_error} and
+@code{overflow_error} types, GiNaC also defines a @code{pole_error}
+exception that gets thrown when trying to evaluate a mathematical function
+at a singularity.
+
+The @code{pole_error} class has a member function
+
+@example
+int pole_error::degree(void) const;
+@end example
+
+that returns the order of the singularity (or 0 when the pole is
+logarithmic or the order is undefined).
+
+When using GiNaC it is useful to arrange for exceptions to be catched in
+the main program even if you don't want to do any special error handling.
+Otherwise whenever an error occurs in GiNaC, it will be delegated to the
+default exception handler of your C++ compiler's run-time system which
+usually only aborts the program without giving any information what went
+wrong.
+
+Here is an example for a @code{main()} function that catches and prints
+exceptions generated by GiNaC:
+
+@example
+#include <iostream>
+#include <stdexcept>
+#include <ginac/ginac.h>
+using namespace std;
+using namespace GiNaC;
+
+int main(void)
+@{
+    try @{
+        ...
+        // code using GiNaC
+        ...
+    @} catch (exception &p) @{
+        cerr << p.what() << endl;
+        return 1;
+    @}
+    return 0;
+@}
+@end example
+
+
+@node Symbols, Numbers, Error handling, Basic Concepts
 @c    node-name, next, previous, up
 @section Symbols
 @cindex @code{symbol} (class)
@@ -825,25 +892,24 @@ can use the expression's @code{.subs()} method (@pxref{Substituting Expressions}
 @cindex CLN
 @cindex rational
 @cindex fraction
-For storing numerical things, GiNaC uses Bruno Haible's library
-@acronym{CLN}.  The classes therein serve as foundation classes for
-GiNaC.  @acronym{CLN} stands for Class Library for Numbers or
-alternatively for Common Lisp Numbers.  In order to find out more about
-@acronym{CLN}'s internals the reader is refered to the documentation of
-that library.  @inforef{Introduction, , cln}, for more
-information. Suffice to say that it is by itself build on top of another
-library, the GNU Multiple Precision library @acronym{GMP}, which is an
+For storing numerical things, GiNaC uses Bruno Haible's library CLN.
+The classes therein serve as foundation classes for GiNaC.  CLN stands
+for Class Library for Numbers or alternatively for Common Lisp Numbers.
+In order to find out more about CLN's internals the reader is refered to
+the documentation of that library.  @inforef{Introduction, , cln}, for
+more information. Suffice to say that it is by itself build on top of
+another library, the GNU Multiple Precision library GMP, which is an
 extremely fast library for arbitrary long integers and rationals as well
 as arbitrary precision floating point numbers.  It is very commonly used
-by several popular cryptographic applications.  @acronym{CLN} extends
-@acronym{GMP} by several useful things: First, it introduces the complex
-number field over either reals (i.e. floating point numbers with
-arbitrary precision) or rationals.  Second, it automatically converts
-rationals to integers if the denominator is unity and complex numbers to
-real numbers if the imaginary part vanishes and also correctly treats
-algebraic functions.  Third it provides good implementations of
-state-of-the-art algorithms for all trigonometric and hyperbolic
-functions as well as for calculation of some useful constants.
+by several popular cryptographic applications.  CLN extends GMP by
+several useful things: First, it introduces the complex number field
+over either reals (i.e. floating point numbers with arbitrary precision)
+or rationals.  Second, it automatically converts rationals to integers
+if the denominator is unity and complex numbers to real numbers if the
+imaginary part vanishes and also correctly treats algebraic functions.
+Third it provides good implementations of state-of-the-art algorithms
+for all trigonometric and hyperbolic functions as well as for
+calculation of some useful constants.
 
 The user can construct an object of class @code{numeric} in several
 ways.  The following example shows the four most important constructors.
@@ -851,6 +917,7 @@ It uses construction from C-integer, construction of fractions from two
 integers, construction from C-float and construction from a string:
 
 @example
+#include <iostream>
 #include <ginac/ginac.h>
 using namespace GiNaC;
 
@@ -889,6 +956,7 @@ then on will be stored with a precision matching that number of decimal
 digits:
 
 @example
+#include <iostream>
 #include <ginac/ginac.h>
 using namespace std;
 using namespace GiNaC;
@@ -916,13 +984,22 @@ The above example prints the following output to screen:
 
 @example
 in 17 digits:
-0.333333333333333333
-3.14159265358979324
+0.33333333333333333334
+3.1415926535897932385
 in 60 digits:
-0.333333333333333333333333333333333333333333333333333333333333333333
-3.14159265358979323846264338327950288419716939937510582097494459231
+0.33333333333333333333333333333333333333333333333333333333333333333334
+3.1415926535897932384626433832795028841971693993751058209749445923078
 @end example
 
+@cindex rounding
+Note that the last number is not necessarily rounded as you would
+naively expect it to be rounded in the decimal system.  But note also,
+that in both cases you got a couple of extra digits.  This is because
+numbers are internally stored by CLN as chunks of binary digits in order
+to match your machine's word size and to not waste precision.  Thus, on
+architectures with differnt word size, the above output might even
+differ with regard to actually computed digits.
+
 It should be clear that objects of class @code{numeric} should be used
 for constructing numbers or for doing arithmetic with them.  The objects
 one deals with most of the time are the polymorphic expressions @code{ex}.
@@ -940,6 +1017,7 @@ As an example, let's construct some rational number, multiply it with
 some multiple of its denominator and test what comes out:
 
 @example
+#include <iostream>
 #include <ginac/ginac.h>
 using namespace std;
 using namespace GiNaC;
@@ -965,13 +1043,12 @@ by @code{numeric}'s copy constructor but in an intermediate step it
 holds a rational number represented as integer numerator and integer
 denominator.  When multiplied by 10, the denominator becomes unity and
 the result is automatically converted to a pure integer again.
-Internally, the underlying @acronym{CLN} is responsible for this
-behaviour and we refer the reader to @acronym{CLN}'s documentation.
-Suffice to say that the same behaviour applies to complex numbers as
-well as return values of certain functions.  Complex numbers are
-automatically converted to real numbers if the imaginary part becomes
-zero.  The full set of tests that can be applied is listed in the
-following table.
+Internally, the underlying CLN is responsible for this behavior and we
+refer the reader to CLN's documentation.  Suffice to say that
+the same behavior applies to complex numbers as well as return values of
+certain functions.  Complex numbers are automatically converted to real
+numbers if the imaginary part becomes zero.  The full set of tests that
+can be applied is listed in the following table.
 
 @cartouche
 @multitable @columnfractions .30 .70
@@ -1076,7 +1153,7 @@ interpret this as @code{x^(a^b)}.
 Also, expressions involving integer exponents are very frequently used,
 which makes it even more dangerous to overload @code{^} since it is then
 hard to distinguish between the semantics as exponentiation and the one
-for exclusive or.  (It would be embarassing to return @code{1} where one
+for exclusive or.  (It would be embarrassing to return @code{1} where one
 has requested @code{2^3}.)
 @end itemize
 
@@ -1216,7 +1293,7 @@ It must be noted that these pseudofunctions are created by inline
 functions, where the argument list is templated.  This means that
 whenever you call @code{GiNaC::sin(1)} it is equivalent to
 @code{sin(ex(1))} and will therefore not result in a floating point
-numeber.  Unless of course the function prototype is explicitly
+number.  Unless of course the function prototype is explicitly
 overridden -- which is the case for arguments of type @code{numeric}
 (not wrapped inside an @code{ex}).  Hence, in order to obtain a floating
 point number of class @code{numeric} you should call
@@ -1465,6 +1542,7 @@ not visible in the output.
 A simple example shall illustrate the concepts:
 
 @example
+#include <iostream>
 #include <ginac/ginac.h>
 using namespace std;
 using namespace GiNaC;
@@ -1490,7 +1568,7 @@ the symbol @code{A} as its base expression and the two indices @code{i} and
 @code{j}.
 
 Note the difference between the indices @code{i} and @code{j} which are of
-class @code{idx}, and the index values which are the sybols @code{i_sym}
+class @code{idx}, and the index values which are the symbols @code{i_sym}
 and @code{j_sym}. The indices of indexed objects cannot directly be symbols
 or numbers but must be index objects. For example, the following is not
 correct and will raise an exception:
@@ -1866,11 +1944,13 @@ that performs some more expensive operations:
 @itemize
 @item it checks the consistency of free indices in sums in the same way
   @code{get_free_indices()} does
-@item it tries to give dumy indices that appear in different terms of a sum
+@item it tries to give dummy indices that appear in different terms of a sum
   the same name to allow simplifications like @math{a_i*b_i-a_j*b_j=0}
 @item it (symbolically) calculates all possible dummy index summations/contractions
   with the predefined tensors (this will be explained in more detail in the
   next section)
+@item it detects contractions that vanish for symmetry reasons, for example
+  the contraction of a symmetric and a totally antisymmetric tensor
 @item as a special case of dummy index summation, it can replace scalar products
   of two tensors with a user-defined value
 @end itemize
@@ -2055,7 +2135,7 @@ The matrix representation of the spinor metric is @code{[[0, 1], [-1, 0]]}.
 The epsilon tensor is totally antisymmetric, its number of indices is equal
 to the dimension of the index space (the indices must all be of the same
 numeric dimension), and @samp{eps.1.2.3...} (resp. @samp{eps~0~1~2...}) is
-defined to be 1. Its behaviour with indices that have a variance also
+defined to be 1. Its behavior with indices that have a variance also
 depends on the signature of the metric. Epsilon tensors are output as
 @samp{eps}.
 
@@ -2072,7 +2152,27 @@ The first two functions create an epsilon tensor in 2 or 3 Euclidean
 dimensions, the last function creates an epsilon tensor in a 4-dimensional
 Minkowski space (the last @code{bool} argument specifies whether the metric
 has negative or positive signature, as in the case of the Minkowski metric
-tensor).
+tensor):
+
+@example
+@{
+    varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4),
+           sig(symbol("sig"), 4), lam(symbol("lam"), 4), bet(symbol("bet"), 4);
+    e = lorentz_eps(mu, nu, rho, sig) *
+        lorentz_eps(mu.toggle_variance(), nu.toggle_variance(), lam, bet);
+    cout << simplify_indexed(e) << endl;
+     // -> 2*eta~bet~rho*eta~sig~lam-2*eta~sig~bet*eta~rho~lam
+
+    idx i(symbol("i"), 3), j(symbol("j"), 3), k(symbol("k"), 3);
+    symbol A("A"), B("B");
+    e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(B, k);
+    cout << simplify_indexed(e) << endl;
+     // -> -B.k*A.j*eps.i.k.j
+    e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(A, k);
+    cout << simplify_indexed(e) << endl;
+     // -> 0
+@}
+@end example
 
 @subsection Linear algebra
 
@@ -2132,7 +2232,7 @@ physics:
 @end itemize
 
 The @code{clifford} and @code{color} classes are subclasses of
-@code{indexed} because the elements of these algebras ususally carry
+@code{indexed} because the elements of these algebras usually carry
 indices. The @code{matrix} class is described in more detail in
 @ref{Matrices}.
 
@@ -2299,8 +2399,10 @@ Finally, the function
 ex dirac_slash(const ex & e, const ex & dim, unsigned char rl = 0);
 @end example
 
-creates a term of the form @samp{e.mu gamma~mu} with a new and unique index
-whose dimension is given by the @code{dim} argument.
+creates a term that represents a contraction of @samp{e} with the Dirac
+Lorentz vector (it behaves like a term of the form @samp{e.mu gamma~mu}
+with a unique index whose dimension is given by the @code{dim} argument).
+Such slashed expressions are printed with a trailing backslash, e.g. @samp{e\}.
 
 In products of dirac gammas, superfluous unity elements are automatically
 removed, squares are replaced by their values and @samp{gamma5} is
@@ -2315,13 +2417,12 @@ contractions in gamma strings, for example
     ex e = dirac_gamma(mu) * dirac_slash(a, D)
          * dirac_gamma(mu.toggle_variance());
     cout << e << endl;
-     // -> (gamma~mu*gamma~symbol10*gamma.mu)*a.symbol10
+     // -> gamma~mu*a\*gamma.mu
     e = e.simplify_indexed();
     cout << e << endl;
-     // -> -gamma~symbol10*a.symbol10*D+2*gamma~symbol10*a.symbol10
+     // -> -D*a\+2*a\
     cout << e.subs(D == 4) << endl;
-     // -> -2*gamma~symbol10*a.symbol10
-     // [ == -2 * dirac_slash(a, D) ]
+     // -> -2*a\
     ...
 @}
 @end example
@@ -2763,7 +2864,7 @@ expressions), so something like @code{(pow(x,2)+x)/x==x+1} will return
 
 Actually, if you construct an expression like @code{a == b}, this will be
 represented by an object of the @code{relational} class (@pxref{Relations})
-which is not evaluated until (explicitly or implicitely) cast to a @code{bool}.
+which is not evaluated until (explicitly or implicitly) cast to a @code{bool}.
 
 There are also two methods
 
@@ -2957,7 +3058,7 @@ account for their commutativity and associativity:
 
 In general, having more than one single wildcard as a term of a sum or a
 factor of a product (such as @samp{a+$0+$1}) will lead to unpredictable or
-amgiguous results.
+ambiguous results.
 
 Here are some examples in @command{ginsh} to demonstrate how it works (the
 @code{match()} function in @command{ginsh} returns @samp{FAIL} if the
@@ -3072,7 +3173,7 @@ the list. @code{find()} returns false if no matches were found (in
   (Note the absence of "x".)
 > expand((sin(x)+sin(y))*(a+b));
 sin(y)*a+sin(x)*b+sin(x)*a+sin(y)*b
-> find(",sin($1));
+> find(%,sin($1));
 @{sin(y),sin(x)@}
 @end example
 
@@ -3160,8 +3261,8 @@ GiNaC offers the @code{map()} method to aid in the implementation of such
 operations:
 
 @example
-static ex ex::map(map_function & f) const;
-static ex ex::map(ex (*f)(const ex & e)) const;
+ex ex::map(map_function & f) const;
+ex ex::map(ex (*f)(const ex & e)) const;
 @end example
 
 In the first (preferred) form, @code{map()} takes a function object that
@@ -3201,7 +3302,7 @@ This function object could then be used like this:
 @}
 @end example
 
-Here is another example for you to meditate over. It removes quadratic
+Here is another example for you to meditate over.  It removes quadratic
 terms in a variable from an expanded polynomial:
 
 @example
@@ -3213,7 +3314,8 @@ struct map_rem_quad : public map_function @{
     @{
         if (is_a<add>(e) || is_a<mul>(e))
            return e.map(*this);
-        else if (is_a<power>(e) && e.op(0).is_equal(var) && e.op(1).info(info_flags::even))
+        else if (is_a<power>(e) && 
+                 e.op(0).is_equal(var) && e.op(1).info(info_flags::even))
             return 0;
         else
             return e;
@@ -3279,7 +3381,7 @@ to the factorized polynomial @math{(x + 5*y + 4*z)*(4*y + z)}.  Other
 representations are the recursive ones where one collects for exponents
 in one of the three variable.  Since the factors are themselves
 polynomials in the remaining two variables the procedure can be
-repeated.  In our expample, two possibilities would be @math{(4*y + z)*x
+repeated.  In our example, two possibilities would be @math{(4*y + z)*x
 + 20*y^2 + 21*y*z + 4*z^2} and @math{20*y^2 + (21*z + 4*x)*y + 4*z^2 +
 x*z}.
 
@@ -3363,11 +3465,6 @@ An application is illustrated in the next example, where a multivariate
 polynomial is analyzed:
 
 @example
-#include <ginac/ginac.h>
-using namespace std;
-using namespace GiNaC;
-
-int main()
 @{
     symbol x("x"), y("y");
     ex PolyInp = 4*pow(x,3)*y + 5*x*pow(y,2) + 3*y
@@ -3529,28 +3626,32 @@ GiNaC still lacks proper factorization support.  Some form of
 factorization is, however, easily implemented by noting that factors
 appearing in a polynomial with power two or more also appear in the
 derivative and hence can easily be found by computing the GCD of the
-original polynomial and its derivatives.  Any system has an interface
-for this so called square-free factorization.  So we provide one, too:
+original polynomial and its derivatives.  Any decent system has an
+interface for this so called square-free factorization.  So we provide
+one, too:
 @example
 ex sqrfree(const ex & a, const lst & l = lst());
 @end example
-Here is an example that by the way illustrates how the result may depend
-on the order of differentiation:
+Here is an example that by the way illustrates how the exact form of the
+result may slightly depend on the order of differentiation, calling for
+some care with subsequent processing of the result:
 @example
     ...
     symbol x("x"), y("y");
-    ex BiVarPol = expand(pow(x-2*y*x,3) * pow(x+y,2) * (x-y));
+    ex BiVarPol = expand(pow(2-2*y,3) * pow(1+x*y,2) * pow(x-2*y,2) * (x+y));
 
     cout << sqrfree(BiVarPol, lst(x,y)) << endl;
-     // -> (y+x)^2*(-1+6*y+8*y^3-12*y^2)*(y-x)*x^3
+     // -> 8*(1-y)^3*(y*x^2-2*y+x*(1-2*y^2))^2*(y+x)
 
     cout << sqrfree(BiVarPol, lst(y,x)) << endl;
-     // -> (1-2*y)^3*(y+x)^2*(-y+x)*x^3
+     // -> 8*(1-y)^3*(-y*x^2+2*y+x*(-1+2*y^2))^2*(y+x)
 
     cout << sqrfree(BiVarPol) << endl;
      // -> depending on luck, any of the above
     ...
 @end example
+Note also, how factors with the same exponents are not fully factorized
+with this method.
 
 
 @node Rational Expressions, Symbolic Differentiation, Polynomial Arithmetic, Methods and Functions
@@ -3577,13 +3678,9 @@ symbols afterwards. This algorithm is also available as a separate method
 @code{.to_rational()}, described below.
 
 This means that both expressions @code{t1} and @code{t2} are indeed
-simplified in this little program:
+simplified in this little code snippet:
 
 @example
-#include <ginac/ginac.h>
-using namespace GiNaC;
-
-int main()
 @{
     symbol x("x");
     ex t1 = (pow(x,2) + 2*x + 1)/(x + 1);
@@ -3668,17 +3765,16 @@ polynomial (class @code{add}) knows that its derivative is the sum of
 the derivatives of all the monomials:
 
 @example
-#include <ginac/ginac.h>
-using namespace GiNaC;
-
-int main()
 @{
     symbol x("x"), y("y"), z("z");
     ex P = pow(x, 5) + pow(x, 2) + y;
 
-    cout << P.diff(x,2) << endl;  // 20*x^3 + 2
+    cout << P.diff(x,2) << endl;
+     // -> 20*x^3 + 2
     cout << P.diff(y) << endl;    // 1
+     // -> 1
     cout << P.diff(z) << endl;    // 0
+     // -> 0
 @}
 @end example
 
@@ -3729,6 +3825,7 @@ When you run it, it produces the sequence @code{1}, @code{-1}, @code{5},
 @cindex Taylor expansion
 @cindex Laurent expansion
 @cindex @code{pseries} (class)
+@cindex @code{Order()}
 
 Expressions know how to expand themselves as a Taylor series or (more
 generally) a Laurent series.  As in most conventional Computer Algebra
@@ -3890,62 +3987,89 @@ GiNaC contains the following predefined mathematical functions:
 @item @strong{Name} @tab @strong{Function}
 @item @code{abs(x)}
 @tab absolute value
+@cindex @code{abs()}
 @item @code{csgn(x)}
 @tab complex sign
+@cindex @code{csgn()}
 @item @code{sqrt(x)}
 @tab square root (not a GiNaC function, rather an alias for @code{pow(x, numeric(1, 2))})
+@cindex @code{sqrt()}
 @item @code{sin(x)}
 @tab sine
+@cindex @code{sin()}
 @item @code{cos(x)}
 @tab cosine
+@cindex @code{cos()}
 @item @code{tan(x)}
 @tab tangent
+@cindex @code{tan()}
 @item @code{asin(x)}
 @tab inverse sine
+@cindex @code{asin()}
 @item @code{acos(x)}
 @tab inverse cosine
+@cindex @code{acos()}
 @item @code{atan(x)}
 @tab inverse tangent
+@cindex @code{atan()}
 @item @code{atan2(y, x)}
 @tab inverse tangent with two arguments
 @item @code{sinh(x)}
 @tab hyperbolic sine
+@cindex @code{sinh()}
 @item @code{cosh(x)}
 @tab hyperbolic cosine
+@cindex @code{cosh()}
 @item @code{tanh(x)}
 @tab hyperbolic tangent
+@cindex @code{tanh()}
 @item @code{asinh(x)}
 @tab inverse hyperbolic sine
+@cindex @code{asinh()}
 @item @code{acosh(x)}
 @tab inverse hyperbolic cosine
+@cindex @code{acosh()}
 @item @code{atanh(x)}
 @tab inverse hyperbolic tangent
+@cindex @code{atanh()}
 @item @code{exp(x)}
 @tab exponential function
+@cindex @code{exp()}
 @item @code{log(x)}
 @tab natural logarithm
+@cindex @code{log()}
 @item @code{Li2(x)}
 @tab Dilogarithm
+@cindex @code{Li2()}
 @item @code{zeta(x)}
 @tab Riemann's zeta function
+@cindex @code{zeta()}
 @item @code{zeta(n, x)}
 @tab derivatives of Riemann's zeta function
 @item @code{tgamma(x)}
 @tab Gamma function
+@cindex @code{tgamma()}
+@cindex Gamma function
 @item @code{lgamma(x)}
 @tab logarithm of Gamma function
+@cindex @code{lgamma()}
 @item @code{beta(x, y)}
 @tab Beta function (@code{tgamma(x)*tgamma(y)/tgamma(x+y)})
+@cindex @code{beta()}
 @item @code{psi(x)}
 @tab psi (digamma) function
+@cindex @code{psi()}
 @item @code{psi(n, x)}
 @tab derivatives of psi function (polygamma functions)
 @item @code{factorial(n)}
 @tab factorial function
+@cindex @code{factorial()}
 @item @code{binomial(n, m)}
 @tab binomial coefficients
+@cindex @code{binomial()}
 @item @code{Order(x)}
 @tab order term function in truncated power series
+@cindex @code{Order()}
 @end multitable
 @end cartouche
 
@@ -4163,19 +4287,19 @@ using namespace GiNaC;
 
 int main()
 @{
-     symbol x("x");
-     string s;
-
-     cout << "Enter an expression containing 'x': ";
-     getline(cin, s);
-
-     try @{
-         ex e(s, lst(x));
-         cout << "The derivative of " << e << " with respect to x is ";
-         cout << e.diff(x) << ".\n";
-     @} catch (exception &p) @{
-         cerr << p.what() << endl;
-     @}
+    symbol x("x");
+    string s;
+
+    cout << "Enter an expression containing 'x': ";
+    getline(cin, s);
+
+    try @{
+        ex e(s, lst(x));
+        cout << "The derivative of " << e << " with respect to x is ";
+        cout << e.diff(x) << ".\n";
+    @} catch (exception &p) @{
+        cerr << p.what() << endl;
+    @}
 @}
 @end example
 
@@ -4264,7 +4388,7 @@ create new symbols with that name. E.g. if you hadn't included @code{x} in
 the @code{syms} list above, the @code{ex1.subs(x == 2)} statement would
 have had no effect because the @code{x} in @code{ex1} would have been a
 different symbol than the @code{x} which was defined at the beginning of
-the program, altough both would appear as @samp{x} when printed.
+the program, although both would appear as @samp{x} when printed.
 
 You can also use the information stored in an @code{archive} object to
 output expressions in a format suitable for exact reconstruction. The
@@ -4296,19 +4420,19 @@ static void my_print2(const archive_node & n)
             switch (p[i].type) @{
                 case archive_node::PTYPE_BOOL: @{
                     bool x;
-                    n.find_bool(name, x);
+                    n.find_bool(name, x, j);
                     cout << (x ? "true" : "false");
                     break;
                 @}
                 case archive_node::PTYPE_UNSIGNED: @{
                     unsigned x;
-                    n.find_unsigned(name, x);
+                    n.find_unsigned(name, x, j);
                     cout << x;
                     break;
                 @}
                 case archive_node::PTYPE_STRING: @{
                     string x;
-                    n.find_string(name, x);
+                    n.find_string(name, x, j);
                     cout << '\"' << x << '\"';
                     break;
                 @}
@@ -4383,7 +4507,7 @@ GiNaC makes this even more clear: it doesn't even attempt to provide a
 language.  There are no loops or conditional expressions in
 @command{ginsh}, it is merely a window into the library for the
 programmer to test stuff (or to show off).  Still, the design of a
-complete CAS with a language of its own, graphical capabilites and all
+complete CAS with a language of its own, graphical capabilities and all
 this on top of GiNaC is possible and is without doubt a nice project for
 the future.
 
@@ -4393,7 +4517,7 @@ evaluate themselves numerically to a precision declared at runtime
 generally.  This ought to be fixed.  However, doing numerical
 computations with GiNaC's quite abstract classes is doomed to be
 inefficient.  For this purpose, the underlying foundation classes
-provided by @acronym{CLN} are much better suited.
+provided by CLN are much better suited.
 
 
 @node Symbolic functions, Adding classes, What does not belong into GiNaC, Extending GiNaC
@@ -4467,7 +4591,7 @@ write another method for Laurent expansion around that point.
 
 Now that all the ingredients for @code{cos} have been set up, we need
 to tell the system about it.  This is done by a macro and we are not
-going to descibe how it expands, please consult your preprocessor if you
+going to describe how it expands, please consult your preprocessor if you
 are curious:
 
 @example
@@ -4613,7 +4737,7 @@ GINAC_IMPLEMENT_REGISTERED_CLASS(mystring, basic)
 @end example
 
 The @code{GINAC_DECLARE_REGISTERED_CLASS} and @code{GINAC_IMPLEMENT_REGISTERED_CLASS}
-macros are defined in @file{registrar.h}. They take the name of the class
+macros are defined in @file{registrar.h}.  They take the name of the class
 and its direct superclass as arguments and insert all required declarations
 for the RTTI system. The @code{GINAC_DECLARE_REGISTERED_CLASS} should be
 the first line after the opening brace of the class definition. The
@@ -4622,10 +4746,10 @@ source (at global scope, of course, not inside a function).
 
 @code{GINAC_DECLARE_REGISTERED_CLASS} contains, among other things the
 declarations of the default and copy constructor, the destructor, the
-assignment operator and a couple of other functions that are required. It
+assignment operator and a couple of other functions that are required.  It
 also defines a type @code{inherited} which refers to the superclass so you
 don't have to modify your code every time you shuffle around the class
-hierarchy. @code{GINAC_IMPLEMENT_REGISTERED_CLASS} implements the copy
+hierarchy.  @code{GINAC_IMPLEMENT_REGISTERED_CLASS} implements the copy
 constructor, the destructor and the assignment operator.
 
 Now there are nine member functions we have to implement to get a working
@@ -4695,7 +4819,7 @@ The golden rule is that in all constructors you have to set the
 it will be set by the constructor of the superclass and all hell will break
 loose in the RTTI. For your convenience, the @code{basic} class provides
 a constructor that takes a @code{tinfo_key} value, which we are using here
-(remember that in our case @code{inherited = basic}). If the superclass
+(remember that in our case @code{inherited = basic}).  If the superclass
 didn't have such a constructor, we would have to set the @code{tinfo_key}
 to the right value manually.
 
@@ -4715,13 +4839,13 @@ void mystring::destroy(bool call_parent)
 @}
 @end example
 
-This function is where we free all dynamically allocated resources. We don't
-have any so we're not doing anything here, but if we had, for example, used
-a C-style @code{char *} to store our string, this would be the place to
-@code{delete[]} the string storage. If @code{call_parent} is true, we have
-to call the @code{destroy()} function of the superclass after we're done
-(to mimic C++'s automatic invocation of superclass destructors where
-@code{destroy()} is called from outside a destructor).
+This function is where we free all dynamically allocated resources.  We
+don't have any so we're not doing anything here, but if we had, for
+example, used a C-style @code{char *} to store our string, this would be
+the place to @code{delete[]} the string storage. If @code{call_parent}
+is true, we have to call the @code{destroy()} function of the superclass
+after we're done (to mimic C++'s automatic invocation of superclass
+destructors where @code{destroy()} is called from outside a destructor).
 
 The @code{copy()} function just copies over the member variables from
 another object:
@@ -4735,7 +4859,7 @@ void mystring::copy(const mystring &other)
 @end example
 
 We can simply overwrite the member variables here. There's no need to worry
-about dynamically allocated storage. The assignment operator (which is
+about dynamically allocated storage.  The assignment operator (which is
 automatically defined by @code{GINAC_IMPLEMENT_REGISTERED_CLASS}, as you
 recall) calls @code{destroy()} before it calls @code{copy()}. You have to
 explicitly call the @code{copy()} function of the superclass here so
@@ -4743,7 +4867,7 @@ all the member variables will get copied.
 
 Next are the three functions for archiving. You have to implement them even
 if you don't plan to use archives, but the minimum required implementation
-is really simple. First, the archiving function:
+is really simple.  First, the archiving function:
 
 @example
 void mystring::archive(archive_node &n) const
@@ -4756,7 +4880,7 @@ void mystring::archive(archive_node &n) const
 The only thing that is really required is calling the @code{archive()}
 function of the superclass. Optionally, you can store all information you
 deem necessary for representing the object into the passed
-@code{archive_node}. We are just storing our string here. For more
+@code{archive_node}.  We are just storing our string here. For more
 information on how the archiving works, consult the @file{archive.h} header
 file.
 
@@ -4784,14 +4908,14 @@ ex mystring::unarchive(const archive_node &n, const lst &sym_lst)
 @}
 @end example
 
-You don't have to understand how exactly this works. Just copy these four
-lines into your code literally (replacing the class name, of course). It
-calls the unarchiving constructor of the class and unless you are doing
-something very special (like matching @code{archive_node}s to global
-objects) you don't need a different implementation. For those who are
-interested: setting the @code{dynallocated} flag puts the object under
-the control of GiNaC's garbage collection. It will get deleted automatically
-once it is no longer referenced.
+You don't have to understand how exactly this works. Just copy these
+four lines into your code literally (replacing the class name, of
+course).  It calls the unarchiving constructor of the class and unless
+you are doing something very special (like matching @code{archive_node}s
+to global objects) you don't need a different implementation. For those
+who are interested: setting the @code{dynallocated} flag puts the object
+under the control of GiNaC's garbage collection.  It will get deleted
+automatically once it is no longer referenced.
 
 Our @code{compare_same_type()} function uses a provided function to compare
 the string members:
@@ -4919,6 +5043,7 @@ concatenation. You would have to implement this yourself.
 @subsection Automatic evaluation
 
 @cindex @code{hold()}
+@cindex @code{eval()}
 @cindex evaluation
 When dealing with objects that are just a little more complicated than the
 simple string objects we have implemented, chances are that you will want to
@@ -4955,13 +5080,13 @@ ex mystring::eval(int level) const
 @end example
 
 The @code{level} argument is used to limit the recursion depth of the
-evaluation. We don't have any subexpressions in the @code{mystring} class
-so we are not concerned with this. If we had, we would call the @code{eval()}
-functions of the subexpressions with @code{level - 1} as the argument if
-@code{level != 1}. The @code{hold()} member function sets a flag in the
-object that prevents further evaluation. Otherwise we might end up in an
-endless loop. When you want to return the object unmodified, use
-@code{return this->hold();}.
+evaluation.  We don't have any subexpressions in the @code{mystring}
+class so we are not concerned with this.  If we had, we would call the
+@code{eval()} functions of the subexpressions with @code{level - 1} as
+the argument if @code{level != 1}.  The @code{hold()} member function
+sets a flag in the object that prevents further evaluation.  Otherwise
+we might end up in an endless loop.  When you want to return the object
+unmodified, use @code{return this->hold();}.
 
 Let's confirm that it works:
 
@@ -5009,7 +5134,7 @@ other, traditional Computer Algebra Systems, like @emph{Maple},
 disadvantages over these systems.
 
 @menu
-* Advantages::                       Stengths of the GiNaC approach.
+* Advantages::                       Strengths of the GiNaC approach.
 * Disadvantages::                    Weaknesses of the GiNaC approach.
 * Why C++?::                         Attractiveness of C++.
 @end menu
@@ -5069,12 +5194,13 @@ expressions interactively, as in traditional CASs.  Currently, two such
 windows into GiNaC have been implemented and many more are possible: the
 tiny @command{ginsh} that is part of the distribution exposes GiNaC's
 types to a command line and second, as a more consistent approach, an
-interactive interface to the @acronym{Cint} C++ interpreter has been put
-together (called @acronym{GiNaC-cint}) that allows an interactive
-scripting interface consistent with the C++ language.
+interactive interface to the Cint C++ interpreter has been put together
+(called GiNaC-cint) that allows an interactive scripting interface
+consistent with the C++ language.  It is available from the usual GiNaC
+FTP-site.
 
 @item
-seemless integration: it is somewhere between difficult and impossible
+seamless integration: it is somewhere between difficult and impossible
 to call CAS functions from within a program written in C++ or any other
 programming language and vice versa.  With GiNaC, your symbolic routines
 are part of your program.  You can easily call third party libraries,
@@ -5113,15 +5239,17 @@ not planned for the near future).
 portability: While the GiNaC library itself is designed to avoid any
 platform dependent features (it should compile on any ANSI compliant C++
 compiler), the currently used version of the CLN library (fast large
-integer and arbitrary precision arithmetics) can be compiled only on
-systems with a recently new C++ compiler from the GNU Compiler
-Collection (@acronym{GCC}).@footnote{This is because CLN uses
-PROVIDE/REQUIRE like macros to let the compiler gather all static
-initializations, which works for GNU C++ only.}  GiNaC uses recent
-language features like explicit constructors, mutable members, RTTI,
-@code{dynamic_cast}s and STL, so ANSI compliance is meant literally.
-Recent @acronym{GCC} versions starting at 2.95, although itself not yet
-ANSI compliant, support all needed features.
+integer and arbitrary precision arithmetics) can only by compiled
+without hassle on systems with the C++ compiler from the GNU Compiler
+Collection (GCC).@footnote{This is because CLN uses PROVIDE/REQUIRE like
+macros to let the compiler gather all static initializations, which
+works for GNU C++ only.  Feel free to contact the authors in case you
+really believe that you need to use a different compiler.  We have
+occasionally used other compilers and may be able to give you advice.}
+GiNaC uses recent language features like explicit constructors, mutable
+members, RTTI, @code{dynamic_cast}s and STL, so ANSI compliance is meant
+literally.  Recent GCC versions starting at 2.95.3, although itself not
+yet ANSI compliant, support all needed features.
     
 @end itemize
 
@@ -5161,12 +5289,13 @@ any other programming language.
 @cindex garbage collection
 An expression is extremely light-weight since internally it works like a
 handle to the actual representation and really holds nothing more than a
-pointer to some other object. What this means in practice is that
+pointer to some other object.  What this means in practice is that
 whenever you create two @code{ex} and set the second equal to the first
 no copying process is involved. Instead, the copying takes place as soon
 as you try to change the second.  Consider the simple sequence of code:
 
 @example
+#include <iostream>
 #include <ginac/ginac.h>
 using namespace std;
 using namespace GiNaC;
@@ -5199,11 +5328,6 @@ differentiation using the chain-rule should make clear how powerful this
 can be:
 
 @example
-#include <ginac/ginac.h>
-using namespace std;
-using namespace GiNaC;
-
-int main()
 @{
     symbol x("x"), y("y");
 
@@ -5520,7 +5644,7 @@ AC_PROG_CXX
 AC_PROG_INSTALL
 AC_LANG_CPLUSPLUS
 
-AM_PATH_GINAC(0.7.0, [
+AM_PATH_GINAC(0.9.0, [
   LIBS="$LIBS $GINACLIB_LIBS"
   CPPFLAGS="$CPPFLAGS $GINACLIB_CPPFLAGS"  
 ], AC_MSG_ERROR([need to have GiNaC installed]))
@@ -5602,15 +5726,19 @@ and George Labahn, ISBN 0-7923-9259-0, 1992, Kluwer Academic Publishers, Norwell
 
 @item
 @cite{Computer Algebra: Systems and Algorithms for Algebraic Computation},
-J.H. Davenport, Y. Siret, and E. Tournier, ISBN 0-12-204230-1, 1988, 
+James H. Davenport, Yvon Siret, and Evelyne Tournier, ISBN 0-12-204230-1, 1988, 
 Academic Press, London
 
+@item
+@cite{Computer Algebra Systems - A Practical Guide},
+Michael J. Wester (editor), ISBN 0-471-98353-5, 1999, Wiley, Chichester
+
 @item
 @cite{The Art of Computer Programming, Vol 2: Seminumerical Algorithms},
-D.E. Knuth, ISBN 0-201-89684-2, 1998, Addison Wesley
+Donald E. Knuth, ISBN 0-201-89684-2, 1998, Addison Wesley
 
 @item
-@cite{The Role of gamma5 in Dimensional Regularization}, D. Kreimer, hep-ph/9401354
+@cite{The Role of gamma5 in Dimensional Regularization}, Dirk Kreimer, hep-ph/9401354
 
 @end itemize