* Added fsolve() numerical univariate real-valued function solver.
[ginac.git] / doc / tutorial / ginac.texi
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename ginac.info
4 @settitle GiNaC, an open framework for symbolic computation within the C++ programming language
5 @setchapternewpage on
6 @afourpaper
7 @c For `info' only.
8 @paragraphindent 0
9 @c For TeX only.
10 @iftex
11 @c I hate putting "@noindent" in front of every paragraph.
12 @parindent=0pt
13 @end iftex
14 @c %**end of header
15
16 @include version.texi
17
18 @direntry
19 * ginac: (ginac).                   C++ library for symbolic computation.
20 @end direntry
21
22 @ifinfo
23 This is a tutorial that documents GiNaC @value{VERSION}, an open
24 framework for symbolic computation within the C++ programming language.
25
26 Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
27
28 Permission is granted to make and distribute verbatim copies of
29 this manual provided the copyright notice and this permission notice
30 are preserved on all copies.
31
32 @ignore
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission
35 notice identical to this one except for the removal of this paragraph
36
37 @end ignore
38 Permission is granted to copy and distribute modified versions of this
39 manual under the conditions for verbatim copying, provided that the entire
40 resulting derived work is distributed under the terms of a permission
41 notice identical to this one.
42 @end ifinfo
43
44 @finalout
45 @c finalout prevents ugly black rectangles on overfull hbox lines
46 @titlepage
47 @title GiNaC @value{VERSION}
48 @subtitle An open framework for symbolic computation within the C++ programming language
49 @subtitle @value{UPDATED}
50 @author The GiNaC Group:
51 @author Christian Bauer, Alexander Frink, Richard Kreckel, Jens Vollinga
52
53 @page
54 @vskip 0pt plus 1filll
55 Copyright @copyright{} 1999-2005 Johannes Gutenberg University Mainz, Germany
56 @sp 2
57 Permission is granted to make and distribute verbatim copies of
58 this manual provided the copyright notice and this permission notice
59 are preserved on all copies.
60
61 Permission is granted to copy and distribute modified versions of this
62 manual under the conditions for verbatim copying, provided that the entire
63 resulting derived work is distributed under the terms of a permission
64 notice identical to this one.
65 @end titlepage
66
67 @page
68 @contents
69
70 @page
71
72
73 @node Top, Introduction, (dir), (dir)
74 @c    node-name, next, previous, up
75 @top GiNaC
76
77 This is a tutorial that documents GiNaC @value{VERSION}, an open
78 framework for symbolic computation within the C++ programming language.
79
80 @menu
81 * Introduction::                 GiNaC's purpose.
82 * A Tour of GiNaC::              A quick tour of the library.
83 * Installation::                 How to install the package.
84 * Basic Concepts::               Description of fundamental classes.
85 * Methods and Functions::        Algorithms for symbolic manipulations.
86 * Extending GiNaC::              How to extend the library.
87 * A Comparison With Other CAS::  Compares GiNaC to traditional CAS.
88 * Internal Structures::          Description of some internal structures.
89 * Package Tools::                Configuring packages to work with GiNaC.
90 * Bibliography::
91 * Concept Index::
92 @end menu
93
94
95 @node Introduction, A Tour of GiNaC, Top, Top
96 @c    node-name, next, previous, up
97 @chapter Introduction
98 @cindex history of GiNaC
99
100 The motivation behind GiNaC derives from the observation that most
101 present day computer algebra systems (CAS) are linguistically and
102 semantically impoverished.  Although they are quite powerful tools for
103 learning math and solving particular problems they lack modern
104 linguistic structures that allow for the creation of large-scale
105 projects.  GiNaC is an attempt to overcome this situation by extending a
106 well established and standardized computer language (C++) by some
107 fundamental symbolic capabilities, thus allowing for integrated systems
108 that embed symbolic manipulations together with more established areas
109 of computer science (like computation-intense numeric applications,
110 graphical interfaces, etc.) under one roof.
111
112 The particular problem that led to the writing of the GiNaC framework is
113 still a very active field of research, namely the calculation of higher
114 order corrections to elementary particle interactions.  There,
115 theoretical physicists are interested in matching present day theories
116 against experiments taking place at particle accelerators.  The
117 computations involved are so complex they call for a combined symbolical
118 and numerical approach.  This turned out to be quite difficult to
119 accomplish with the present day CAS we have worked with so far and so we
120 tried to fill the gap by writing GiNaC.  But of course its applications
121 are in no way restricted to theoretical physics.
122
123 This tutorial is intended for the novice user who is new to GiNaC but
124 already has some background in C++ programming.  However, since a
125 hand-made documentation like this one is difficult to keep in sync with
126 the development, the actual documentation is inside the sources in the
127 form of comments.  That documentation may be parsed by one of the many
128 Javadoc-like documentation systems.  If you fail at generating it you
129 may access it from @uref{http://www.ginac.de/reference/, the GiNaC home
130 page}.  It is an invaluable resource not only for the advanced user who
131 wishes to extend the system (or chase bugs) but for everybody who wants
132 to comprehend the inner workings of GiNaC.  This little tutorial on the
133 other hand only covers the basic things that are unlikely to change in
134 the near future.
135
136 @section License
137 The GiNaC framework for symbolic computation within the C++ programming
138 language is Copyright @copyright{} 1999-2005 Johannes Gutenberg
139 University Mainz, Germany.
140
141 This program is free software; you can redistribute it and/or
142 modify it under the terms of the GNU General Public License as
143 published by the Free Software Foundation; either version 2 of the
144 License, or (at your option) any later version.
145
146 This program is distributed in the hope that it will be useful, but
147 WITHOUT ANY WARRANTY; without even the implied warranty of
148 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
149 General Public License for more details.
150
151 You should have received a copy of the GNU General Public License
152 along with this program; see the file COPYING.  If not, write to the
153 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
154 MA 02110-1301, USA.
155
156
157 @node A Tour of GiNaC, How to use it from within C++, Introduction, Top
158 @c    node-name, next, previous, up
159 @chapter A Tour of GiNaC
160
161 This quick tour of GiNaC wants to arise your interest in the
162 subsequent chapters by showing off a bit.  Please excuse us if it
163 leaves many open questions.
164
165 @menu
166 * How to use it from within C++::  Two simple examples.
167 * What it can do for you::         A Tour of GiNaC's features.
168 @end menu
169
170
171 @node How to use it from within C++, What it can do for you, A Tour of GiNaC, A Tour of GiNaC
172 @c    node-name, next, previous, up
173 @section How to use it from within C++
174
175 The GiNaC open framework for symbolic computation within the C++ programming
176 language does not try to define a language of its own as conventional
177 CAS do.  Instead, it extends the capabilities of C++ by symbolic
178 manipulations.  Here is how to generate and print a simple (and rather
179 pointless) bivariate polynomial with some large coefficients:
180
181 @example
182 #include <iostream>
183 #include <ginac/ginac.h>
184 using namespace std;
185 using namespace GiNaC;
186
187 int main()
188 @{
189     symbol x("x"), y("y");
190     ex poly;
191
192     for (int i=0; i<3; ++i)
193         poly += factorial(i+16)*pow(x,i)*pow(y,2-i);
194
195     cout << poly << endl;
196     return 0;
197 @}
198 @end example
199
200 Assuming the file is called @file{hello.cc}, on our system we can compile
201 and run it like this:
202
203 @example
204 $ c++ hello.cc -o hello -lcln -lginac
205 $ ./hello
206 355687428096000*x*y+20922789888000*y^2+6402373705728000*x^2
207 @end example
208
209 (@xref{Package Tools}, for tools that help you when creating a software
210 package that uses GiNaC.)
211
212 @cindex Hermite polynomial
213 Next, there is a more meaningful C++ program that calls a function which
214 generates Hermite polynomials in a specified free variable.
215
216 @example
217 #include <iostream>
218 #include <ginac/ginac.h>
219 using namespace std;
220 using namespace GiNaC;
221
222 ex HermitePoly(const symbol & x, int n)
223 @{
224     ex HKer=exp(-pow(x, 2));
225     // uses the identity H_n(x) == (-1)^n exp(x^2) (d/dx)^n exp(-x^2)
226     return normal(pow(-1, n) * diff(HKer, x, n) / HKer);
227 @}
228
229 int main()
230 @{
231     symbol z("z");
232
233     for (int i=0; i<6; ++i)
234         cout << "H_" << i << "(z) == " << HermitePoly(z,i) << endl;
235
236     return 0;
237 @}
238 @end example
239
240 When run, this will type out
241
242 @example
243 H_0(z) == 1
244 H_1(z) == 2*z
245 H_2(z) == 4*z^2-2
246 H_3(z) == -12*z+8*z^3
247 H_4(z) == -48*z^2+16*z^4+12
248 H_5(z) == 120*z-160*z^3+32*z^5
249 @end example
250
251 This method of generating the coefficients is of course far from optimal
252 for production purposes.
253
254 In order to show some more examples of what GiNaC can do we will now use
255 the @command{ginsh}, a simple GiNaC interactive shell that provides a
256 convenient window into GiNaC's capabilities.
257
258
259 @node What it can do for you, Installation, How to use it from within C++, A Tour of GiNaC
260 @c    node-name, next, previous, up
261 @section What it can do for you
262
263 @cindex @command{ginsh}
264 After invoking @command{ginsh} one can test and experiment with GiNaC's
265 features much like in other Computer Algebra Systems except that it does
266 not provide programming constructs like loops or conditionals.  For a
267 concise description of the @command{ginsh} syntax we refer to its
268 accompanied man page. Suffice to say that assignments and comparisons in
269 @command{ginsh} are written as they are in C, i.e. @code{=} assigns and
270 @code{==} compares.
271
272 It can manipulate arbitrary precision integers in a very fast way.
273 Rational numbers are automatically converted to fractions of coprime
274 integers:
275
276 @example
277 > x=3^150;
278 369988485035126972924700782451696644186473100389722973815184405301748249
279 > y=3^149;
280 123329495011708990974900260817232214728824366796574324605061468433916083
281 > x/y;
282 3
283 > y/x;
284 1/3
285 @end example
286
287 Exact numbers are always retained as exact numbers and only evaluated as
288 floating point numbers if requested.  For instance, with numeric
289 radicals is dealt pretty much as with symbols.  Products of sums of them
290 can be expanded:
291
292 @example
293 > expand((1+a^(1/5)-a^(2/5))^3);
294 1+3*a+3*a^(1/5)-5*a^(3/5)-a^(6/5)
295 > expand((1+3^(1/5)-3^(2/5))^3);
296 10-5*3^(3/5)
297 > evalf((1+3^(1/5)-3^(2/5))^3);
298 0.33408977534118624228
299 @end example
300
301 The function @code{evalf} that was used above converts any number in
302 GiNaC's expressions into floating point numbers.  This can be done to
303 arbitrary predefined accuracy:
304
305 @example
306 > evalf(1/7);
307 0.14285714285714285714
308 > Digits=150;
309 150
310 > evalf(1/7);
311 0.1428571428571428571428571428571428571428571428571428571428571428571428
312 5714285714285714285714285714285714285
313 @end example
314
315 Exact numbers other than rationals that can be manipulated in GiNaC
316 include predefined constants like Archimedes' @code{Pi}.  They can both
317 be used in symbolic manipulations (as an exact number) as well as in
318 numeric expressions (as an inexact number):
319
320 @example
321 > a=Pi^2+x;
322 x+Pi^2
323 > evalf(a);
324 9.869604401089358619+x
325 > x=2;
326 2
327 > evalf(a);
328 11.869604401089358619
329 @end example
330
331 Built-in functions evaluate immediately to exact numbers if
332 this is possible.  Conversions that can be safely performed are done
333 immediately; conversions that are not generally valid are not done:
334
335 @example
336 > cos(42*Pi);
337 1
338 > cos(acos(x));
339 x
340 > acos(cos(x));
341 acos(cos(x))
342 @end example
343
344 (Note that converting the last input to @code{x} would allow one to
345 conclude that @code{42*Pi} is equal to @code{0}.)
346
347 Linear equation systems can be solved along with basic linear
348 algebra manipulations over symbolic expressions.  In C++ GiNaC offers
349 a matrix class for this purpose but we can see what it can do using
350 @command{ginsh}'s bracket notation to type them in:
351
352 @example
353 > lsolve(a+x*y==z,x);
354 y^(-1)*(z-a);
355 > lsolve(@{3*x+5*y == 7, -2*x+10*y == -5@}, @{x, y@});
356 @{x==19/8,y==-1/40@}
357 > M = [ [1, 3], [-3, 2] ];
358 [[1,3],[-3,2]]
359 > determinant(M);
360 11
361 > charpoly(M,lambda);
362 lambda^2-3*lambda+11
363 > A = [ [1, 1], [2, -1] ];
364 [[1,1],[2,-1]]
365 > A+2*M;
366 [[1,1],[2,-1]]+2*[[1,3],[-3,2]]
367 > evalm(%);
368 [[3,7],[-4,3]]
369 > B = [ [0, 0, a], [b, 1, -b], [-1/a, 0, 0] ];
370 > evalm(B^(2^12345));
371 [[1,0,0],[0,1,0],[0,0,1]]
372 @end example
373
374 Multivariate polynomials and rational functions may be expanded,
375 collected and normalized (i.e. converted to a ratio of two coprime 
376 polynomials):
377
378 @example
379 > a = x^4 + 2*x^2*y^2 + 4*x^3*y + 12*x*y^3 - 3*y^4;
380 12*x*y^3+2*x^2*y^2+4*x^3*y-3*y^4+x^4
381 > b = x^2 + 4*x*y - y^2;
382 4*x*y-y^2+x^2
383 > expand(a*b);
384 8*x^5*y+17*x^4*y^2+43*x^2*y^4-24*x*y^5+16*x^3*y^3+3*y^6+x^6
385 > collect(a+b,x);
386 4*x^3*y-y^2-3*y^4+(12*y^3+4*y)*x+x^4+x^2*(1+2*y^2)
387 > collect(a+b,y);
388 12*x*y^3-3*y^4+(-1+2*x^2)*y^2+(4*x+4*x^3)*y+x^2+x^4
389 > normal(a/b);
390 3*y^2+x^2
391 @end example
392
393 You can differentiate functions and expand them as Taylor or Laurent
394 series in a very natural syntax (the second argument of @code{series} is
395 a relation defining the evaluation point, the third specifies the
396 order):
397
398 @cindex Zeta function
399 @example
400 > diff(tan(x),x);
401 tan(x)^2+1
402 > series(sin(x),x==0,4);
403 x-1/6*x^3+Order(x^4)
404 > series(1/tan(x),x==0,4);
405 x^(-1)-1/3*x+Order(x^2)
406 > series(tgamma(x),x==0,3);
407 x^(-1)-Euler+(1/12*Pi^2+1/2*Euler^2)*x+
408 (-1/3*zeta(3)-1/12*Pi^2*Euler-1/6*Euler^3)*x^2+Order(x^3)
409 > evalf(%);
410 x^(-1)-0.5772156649015328606+(0.9890559953279725555)*x
411 -(0.90747907608088628905)*x^2+Order(x^3)
412 > series(tgamma(2*sin(x)-2),x==Pi/2,6);
413 -(x-1/2*Pi)^(-2)+(-1/12*Pi^2-1/2*Euler^2-1/240)*(x-1/2*Pi)^2
414 -Euler-1/12+Order((x-1/2*Pi)^3)
415 @end example
416
417 Here we have made use of the @command{ginsh}-command @code{%} to pop the
418 previously evaluated element from @command{ginsh}'s internal stack.
419
420 Often, functions don't have roots in closed form.  Nevertheless, it's
421 quite easy to compute a solution numerically, to arbitrary precision:
422
423 @cindex fsolve
424 @example
425 > Digits=50:
426 > fsolve(cos(x)-x,x,0,2);
427 0.7390851332151606416553120876738734040134117589007574649658
428 > f=exp(sin(x))-x:
429 > X=fsolve(f,x,-10,10);
430 2.2191071489137460325957851882042901681753665565320678854155
431 > subs(f,x==X);
432 -6.372367644529809108115521591070847222364418220770475144296E-58
433 @end example
434
435 Notice how the final result above differs slightly from zero by about
436 @math{6*10^(-58)}.  This is because with 50 decimal digits precision the
437 root cannot be represented more accurately than @code{X}.  Such
438 inaccuracies are to be expected when computing with finite floating
439 point values.
440
441 If you ever wanted to convert units in C or C++ and found this is
442 cumbersome, here is the solution.  Symbolic types can always be used as
443 tags for different types of objects.  Converting from wrong units to the
444 metric system is now easy:
445
446 @example
447 > in=.0254*m;
448 0.0254*m
449 > lb=.45359237*kg;
450 0.45359237*kg
451 > 200*lb/in^2;
452 140613.91592783185568*kg*m^(-2)
453 @end example
454
455
456 @node Installation, Prerequisites, What it can do for you, Top
457 @c    node-name, next, previous, up
458 @chapter Installation
459
460 @cindex CLN
461 GiNaC's installation follows the spirit of most GNU software. It is
462 easily installed on your system by three steps: configuration, build,
463 installation.
464
465 @menu
466 * Prerequisites::                Packages upon which GiNaC depends.
467 * Configuration::                How to configure GiNaC.
468 * Building GiNaC::               How to compile GiNaC.
469 * Installing GiNaC::             How to install GiNaC on your system.
470 @end menu
471
472
473 @node Prerequisites, Configuration, Installation, Installation
474 @c    node-name, next, previous, up
475 @section Prerequisites
476
477 In order to install GiNaC on your system, some prerequisites need to be
478 met.  First of all, you need to have a C++-compiler adhering to the
479 ANSI-standard @cite{ISO/IEC 14882:1998(E)}.  We used GCC for development
480 so if you have a different compiler you are on your own.  For the
481 configuration to succeed you need a Posix compliant shell installed in
482 @file{/bin/sh}, GNU @command{bash} is fine.  Perl is needed by the built
483 process as well, since some of the source files are automatically
484 generated by Perl scripts.  Last but not least, Bruno Haible's library
485 CLN is extensively used and needs to be installed on your system.
486 Please get it either from @uref{ftp://ftp.santafe.edu/pub/gnu/}, from
487 @uref{ftp://ftpthep.physik.uni-mainz.de/pub/gnu/, GiNaC's FTP site} or
488 from @uref{ftp://ftp.ilog.fr/pub/Users/haible/gnu/, Bruno Haible's FTP
489 site} (it is covered by GPL) and install it prior to trying to install
490 GiNaC.  The configure script checks if it can find it and if it cannot
491 it will refuse to continue.
492
493
494 @node Configuration, Building GiNaC, Prerequisites, Installation
495 @c    node-name, next, previous, up
496 @section Configuration
497 @cindex configuration
498 @cindex Autoconf
499
500 To configure GiNaC means to prepare the source distribution for
501 building.  It is done via a shell script called @command{configure} that
502 is shipped with the sources and was originally generated by GNU
503 Autoconf.  Since a configure script generated by GNU Autoconf never
504 prompts, all customization must be done either via command line
505 parameters or environment variables.  It accepts a list of parameters,
506 the complete set of which can be listed by calling it with the
507 @option{--help} option.  The most important ones will be shortly
508 described in what follows:
509
510 @itemize @bullet
511
512 @item
513 @option{--disable-shared}: When given, this option switches off the
514 build of a shared library, i.e. a @file{.so} file.  This may be convenient
515 when developing because it considerably speeds up compilation.
516
517 @item
518 @option{--prefix=@var{PREFIX}}: The directory where the compiled library
519 and headers are installed. It defaults to @file{/usr/local} which means
520 that the library is installed in the directory @file{/usr/local/lib},
521 the header files in @file{/usr/local/include/ginac} and the documentation
522 (like this one) into @file{/usr/local/share/doc/GiNaC}.
523
524 @item
525 @option{--libdir=@var{LIBDIR}}: Use this option in case you want to have
526 the library installed in some other directory than
527 @file{@var{PREFIX}/lib/}.
528
529 @item
530 @option{--includedir=@var{INCLUDEDIR}}: Use this option in case you want
531 to have the header files installed in some other directory than
532 @file{@var{PREFIX}/include/ginac/}. For instance, if you specify
533 @option{--includedir=/usr/include} you will end up with the header files
534 sitting in the directory @file{/usr/include/ginac/}. Note that the
535 subdirectory @file{ginac} is enforced by this process in order to
536 keep the header files separated from others.  This avoids some
537 clashes and allows for an easier deinstallation of GiNaC. This ought
538 to be considered A Good Thing (tm).
539
540 @item
541 @option{--datadir=@var{DATADIR}}: This option may be given in case you
542 want to have the documentation installed in some other directory than
543 @file{@var{PREFIX}/share/doc/GiNaC/}.
544
545 @end itemize
546
547 In addition, you may specify some environment variables.  @env{CXX}
548 holds the path and the name of the C++ compiler in case you want to
549 override the default in your path.  (The @command{configure} script
550 searches your path for @command{c++}, @command{g++}, @command{gcc},
551 @command{CC}, @command{cxx} and @command{cc++} in that order.)  It may
552 be very useful to define some compiler flags with the @env{CXXFLAGS}
553 environment variable, like optimization, debugging information and
554 warning levels.  If omitted, it defaults to @option{-g
555 -O2}.@footnote{The @command{configure} script is itself generated from
556 the file @file{configure.ac}.  It is only distributed in packaged
557 releases of GiNaC.  If you got the naked sources, e.g. from CVS, you
558 must generate @command{configure} along with the various
559 @file{Makefile.in} by using the @command{autogen.sh} script.  This will
560 require a fair amount of support from your local toolchain, though.}
561
562 The whole process is illustrated in the following two
563 examples. (Substitute @command{setenv @var{VARIABLE} @var{value}} for
564 @command{export @var{VARIABLE}=@var{value}} if the Berkeley C shell is
565 your login shell.)
566
567 Here is a simple configuration for a site-wide GiNaC library assuming
568 everything is in default paths:
569
570 @example
571 $ export CXXFLAGS="-Wall -O2"
572 $ ./configure
573 @end example
574
575 And here is a configuration for a private static GiNaC library with
576 several components sitting in custom places (site-wide GCC and private
577 CLN).  The compiler is persuaded to be picky and full assertions and
578 debugging information are switched on:
579
580 @example
581 $ export CXX=/usr/local/gnu/bin/c++
582 $ export CPPFLAGS="$(CPPFLAGS) -I$(HOME)/include"
583 $ export CXXFLAGS="$(CXXFLAGS) -DDO_GINAC_ASSERT -ggdb -Wall -pedantic"
584 $ export LDFLAGS="$(LDFLAGS) -L$(HOME)/lib"
585 $ ./configure --disable-shared --prefix=$(HOME)
586 @end example
587
588
589 @node Building GiNaC, Installing GiNaC, Configuration, Installation
590 @c    node-name, next, previous, up
591 @section Building GiNaC
592 @cindex building GiNaC
593
594 After proper configuration you should just build the whole
595 library by typing
596 @example
597 $ make
598 @end example
599 at the command prompt and go for a cup of coffee.  The exact time it
600 takes to compile GiNaC depends not only on the speed of your machines
601 but also on other parameters, for instance what value for @env{CXXFLAGS}
602 you entered.  Optimization may be very time-consuming.
603
604 Just to make sure GiNaC works properly you may run a collection of
605 regression tests by typing
606
607 @example
608 $ make check
609 @end example
610
611 This will compile some sample programs, run them and check the output
612 for correctness.  The regression tests fall in three categories.  First,
613 the so called @emph{exams} are performed, simple tests where some
614 predefined input is evaluated (like a pupils' exam).  Second, the
615 @emph{checks} test the coherence of results among each other with
616 possible random input.  Third, some @emph{timings} are performed, which
617 benchmark some predefined problems with different sizes and display the
618 CPU time used in seconds.  Each individual test should return a message
619 @samp{passed}.  This is mostly intended to be a QA-check if something
620 was broken during development, not a sanity check of your system.  Some
621 of the tests in sections @emph{checks} and @emph{timings} may require
622 insane amounts of memory and CPU time.  Feel free to kill them if your
623 machine catches fire.  Another quite important intent is to allow people
624 to fiddle around with optimization.
625
626 By default, the only documentation that will be built is this tutorial
627 in @file{.info} format. To build the GiNaC tutorial and reference manual
628 in HTML, DVI, PostScript, or PDF formats, use one of
629
630 @example
631 $ make html
632 $ make dvi
633 $ make ps
634 $ make pdf
635 @end example
636
637 Generally, the top-level Makefile runs recursively to the
638 subdirectories.  It is therefore safe to go into any subdirectory
639 (@code{doc/}, @code{ginsh/}, @dots{}) and simply type @code{make}
640 @var{target} there in case something went wrong.
641
642
643 @node Installing GiNaC, Basic Concepts, Building GiNaC, Installation
644 @c    node-name, next, previous, up
645 @section Installing GiNaC
646 @cindex installation
647
648 To install GiNaC on your system, simply type
649
650 @example
651 $ make install
652 @end example
653
654 As described in the section about configuration the files will be
655 installed in the following directories (the directories will be created
656 if they don't already exist):
657
658 @itemize @bullet
659
660 @item
661 @file{libginac.a} will go into @file{@var{PREFIX}/lib/} (or
662 @file{@var{LIBDIR}}) which defaults to @file{/usr/local/lib/}.
663 So will @file{libginac.so} unless the configure script was
664 given the option @option{--disable-shared}.  The proper symlinks
665 will be established as well.
666
667 @item
668 All the header files will be installed into @file{@var{PREFIX}/include/ginac/}
669 (or @file{@var{INCLUDEDIR}/ginac/}, if specified).
670
671 @item
672 All documentation (info) will be stuffed into
673 @file{@var{PREFIX}/share/doc/GiNaC/} (or
674 @file{@var{DATADIR}/doc/GiNaC/}, if @var{DATADIR} was specified).
675
676 @end itemize
677
678 For the sake of completeness we will list some other useful make
679 targets: @command{make clean} deletes all files generated by
680 @command{make}, i.e. all the object files.  In addition @command{make
681 distclean} removes all files generated by the configuration and
682 @command{make maintainer-clean} goes one step further and deletes files
683 that may require special tools to rebuild (like the @command{libtool}
684 for instance).  Finally @command{make uninstall} removes the installed
685 library, header files and documentation@footnote{Uninstallation does not
686 work after you have called @command{make distclean} since the
687 @file{Makefile} is itself generated by the configuration from
688 @file{Makefile.in} and hence deleted by @command{make distclean}.  There
689 are two obvious ways out of this dilemma.  First, you can run the
690 configuration again with the same @var{PREFIX} thus creating a
691 @file{Makefile} with a working @samp{uninstall} target.  Second, you can
692 do it by hand since you now know where all the files went during
693 installation.}.
694
695
696 @node Basic Concepts, Expressions, Installing GiNaC, Top
697 @c    node-name, next, previous, up
698 @chapter Basic Concepts
699
700 This chapter will describe the different fundamental objects that can be
701 handled by GiNaC.  But before doing so, it is worthwhile introducing you
702 to the more commonly used class of expressions, representing a flexible
703 meta-class for storing all mathematical objects.
704
705 @menu
706 * Expressions::                  The fundamental GiNaC class.
707 * Automatic evaluation::         Evaluation and canonicalization.
708 * Error handling::               How the library reports errors.
709 * The Class Hierarchy::          Overview of GiNaC's classes.
710 * Symbols::                      Symbolic objects.
711 * Numbers::                      Numerical objects.
712 * Constants::                    Pre-defined constants.
713 * Fundamental containers::       Sums, products and powers.
714 * Lists::                        Lists of expressions.
715 * Mathematical functions::       Mathematical functions.
716 * Relations::                    Equality, Inequality and all that.
717 * Integrals::                    Symbolic integrals.
718 * Matrices::                     Matrices.
719 * Indexed objects::              Handling indexed quantities.
720 * Non-commutative objects::      Algebras with non-commutative products.
721 * Hash Maps::                    A faster alternative to std::map<>.
722 @end menu
723
724
725 @node Expressions, Automatic evaluation, Basic Concepts, Basic Concepts
726 @c    node-name, next, previous, up
727 @section Expressions
728 @cindex expression (class @code{ex})
729 @cindex @code{has()}
730
731 The most common class of objects a user deals with is the expression
732 @code{ex}, representing a mathematical object like a variable, number,
733 function, sum, product, etc@dots{}  Expressions may be put together to form
734 new expressions, passed as arguments to functions, and so on.  Here is a
735 little collection of valid expressions:
736
737 @example
738 ex MyEx1 = 5;                       // simple number
739 ex MyEx2 = x + 2*y;                 // polynomial in x and y
740 ex MyEx3 = (x + 1)/(x - 1);         // rational expression
741 ex MyEx4 = sin(x + 2*y) + 3*z + 41; // containing a function
742 ex MyEx5 = MyEx4 + 1;               // similar to above
743 @end example
744
745 Expressions are handles to other more fundamental objects, that often
746 contain other expressions thus creating a tree of expressions
747 (@xref{Internal Structures}, for particular examples).  Most methods on
748 @code{ex} therefore run top-down through such an expression tree.  For
749 example, the method @code{has()} scans recursively for occurrences of
750 something inside an expression.  Thus, if you have declared @code{MyEx4}
751 as in the example above @code{MyEx4.has(y)} will find @code{y} inside
752 the argument of @code{sin} and hence return @code{true}.
753
754 The next sections will outline the general picture of GiNaC's class
755 hierarchy and describe the classes of objects that are handled by
756 @code{ex}.
757
758 @subsection Note: Expressions and STL containers
759
760 GiNaC expressions (@code{ex} objects) have value semantics (they can be
761 assigned, reassigned and copied like integral types) but the operator
762 @code{<} doesn't provide a well-defined ordering on them. In STL-speak,
763 expressions are @samp{Assignable} but not @samp{LessThanComparable}.
764
765 This implies that in order to use expressions in sorted containers such as
766 @code{std::map<>} and @code{std::set<>} you have to supply a suitable
767 comparison predicate. GiNaC provides such a predicate, called
768 @code{ex_is_less}. For example, a set of expressions should be defined
769 as @code{std::set<ex, ex_is_less>}.
770
771 Unsorted containers such as @code{std::vector<>} and @code{std::list<>}
772 don't pose a problem. A @code{std::vector<ex>} works as expected.
773
774 @xref{Information About Expressions}, for more about comparing and ordering
775 expressions.
776
777
778 @node Automatic evaluation, Error handling, Expressions, Basic Concepts
779 @c    node-name, next, previous, up
780 @section Automatic evaluation and canonicalization of expressions
781 @cindex evaluation
782
783 GiNaC performs some automatic transformations on expressions, to simplify
784 them and put them into a canonical form. Some examples:
785
786 @example
787 ex MyEx1 = 2*x - 1 + x;  // 3*x-1
788 ex MyEx2 = x - x;        // 0
789 ex MyEx3 = cos(2*Pi);    // 1
790 ex MyEx4 = x*y/x;        // y
791 @end example
792
793 This behavior is usually referred to as @dfn{automatic} or @dfn{anonymous
794 evaluation}. GiNaC only performs transformations that are
795
796 @itemize @bullet
797 @item
798 at most of complexity
799 @tex
800 $O(n\log n)$
801 @end tex
802 @ifnottex
803 @math{O(n log n)}
804 @end ifnottex
805 @item
806 algebraically correct, possibly except for a set of measure zero (e.g.
807 @math{x/x} is transformed to @math{1} although this is incorrect for @math{x=0})
808 @end itemize
809
810 There are two types of automatic transformations in GiNaC that may not
811 behave in an entirely obvious way at first glance:
812
813 @itemize
814 @item
815 The terms of sums and products (and some other things like the arguments of
816 symmetric functions, the indices of symmetric tensors etc.) are re-ordered
817 into a canonical form that is deterministic, but not lexicographical or in
818 any other way easy to guess (it almost always depends on the number and
819 order of the symbols you define). However, constructing the same expression
820 twice, either implicitly or explicitly, will always result in the same
821 canonical form.
822 @item
823 Expressions of the form 'number times sum' are automatically expanded (this
824 has to do with GiNaC's internal representation of sums and products). For
825 example
826 @example
827 ex MyEx5 = 2*(x + y);   // 2*x+2*y
828 ex MyEx6 = z*(x + y);   // z*(x+y)
829 @end example
830 @end itemize
831
832 The general rule is that when you construct expressions, GiNaC automatically
833 creates them in canonical form, which might differ from the form you typed in
834 your program. This may create some awkward looking output (@samp{-y+x} instead
835 of @samp{x-y}) but allows for more efficient operation and usually yields
836 some immediate simplifications.
837
838 @cindex @code{eval()}
839 Internally, the anonymous evaluator in GiNaC is implemented by the methods
840
841 @example
842 ex ex::eval(int level = 0) const;
843 ex basic::eval(int level = 0) const;
844 @end example
845
846 but unless you are extending GiNaC with your own classes or functions, there
847 should never be any reason to call them explicitly. All GiNaC methods that
848 transform expressions, like @code{subs()} or @code{normal()}, automatically
849 re-evaluate their results.
850
851
852 @node Error handling, The Class Hierarchy, Automatic evaluation, Basic Concepts
853 @c    node-name, next, previous, up
854 @section Error handling
855 @cindex exceptions
856 @cindex @code{pole_error} (class)
857
858 GiNaC reports run-time errors by throwing C++ exceptions. All exceptions
859 generated by GiNaC are subclassed from the standard @code{exception} class
860 defined in the @file{<stdexcept>} header. In addition to the predefined
861 @code{logic_error}, @code{domain_error}, @code{out_of_range},
862 @code{invalid_argument}, @code{runtime_error}, @code{range_error} and
863 @code{overflow_error} types, GiNaC also defines a @code{pole_error}
864 exception that gets thrown when trying to evaluate a mathematical function
865 at a singularity.
866
867 The @code{pole_error} class has a member function
868
869 @example
870 int pole_error::degree() const;
871 @end example
872
873 that returns the order of the singularity (or 0 when the pole is
874 logarithmic or the order is undefined).
875
876 When using GiNaC it is useful to arrange for exceptions to be caught in
877 the main program even if you don't want to do any special error handling.
878 Otherwise whenever an error occurs in GiNaC, it will be delegated to the
879 default exception handler of your C++ compiler's run-time system which
880 usually only aborts the program without giving any information what went
881 wrong.
882
883 Here is an example for a @code{main()} function that catches and prints
884 exceptions generated by GiNaC:
885
886 @example
887 #include <iostream>
888 #include <stdexcept>
889 #include <ginac/ginac.h>
890 using namespace std;
891 using namespace GiNaC;
892
893 int main()
894 @{
895     try @{
896         ...
897         // code using GiNaC
898         ...
899     @} catch (exception &p) @{
900         cerr << p.what() << endl;
901         return 1;
902     @}
903     return 0;
904 @}
905 @end example
906
907
908 @node The Class Hierarchy, Symbols, Error handling, Basic Concepts
909 @c    node-name, next, previous, up
910 @section The Class Hierarchy
911
912 GiNaC's class hierarchy consists of several classes representing
913 mathematical objects, all of which (except for @code{ex} and some
914 helpers) are internally derived from one abstract base class called
915 @code{basic}.  You do not have to deal with objects of class
916 @code{basic}, instead you'll be dealing with symbols, numbers,
917 containers of expressions and so on.
918
919 @cindex container
920 @cindex atom
921 To get an idea about what kinds of symbolic composites may be built we
922 have a look at the most important classes in the class hierarchy and
923 some of the relations among the classes:
924
925 @image{classhierarchy}
926
927 The abstract classes shown here (the ones without drop-shadow) are of no
928 interest for the user.  They are used internally in order to avoid code
929 duplication if two or more classes derived from them share certain
930 features.  An example is @code{expairseq}, a container for a sequence of
931 pairs each consisting of one expression and a number (@code{numeric}).
932 What @emph{is} visible to the user are the derived classes @code{add}
933 and @code{mul}, representing sums and products.  @xref{Internal
934 Structures}, where these two classes are described in more detail.  The
935 following table shortly summarizes what kinds of mathematical objects
936 are stored in the different classes:
937
938 @cartouche
939 @multitable @columnfractions .22 .78
940 @item @code{symbol} @tab Algebraic symbols @math{a}, @math{x}, @math{y}@dots{}
941 @item @code{constant} @tab Constants like 
942 @tex
943 $\pi$
944 @end tex
945 @ifnottex
946 @math{Pi}
947 @end ifnottex
948 @item @code{numeric} @tab All kinds of numbers, @math{42}, @math{7/3*I}, @math{3.14159}@dots{}
949 @item @code{add} @tab Sums like @math{x+y} or @math{a-(2*b)+3}
950 @item @code{mul} @tab Products like @math{x*y} or @math{2*a^2*(x+y+z)/b}
951 @item @code{ncmul} @tab Products of non-commutative objects
952 @item @code{power} @tab Exponentials such as @math{x^2}, @math{a^b}, 
953 @tex
954 $\sqrt{2}$
955 @end tex
956 @ifnottex
957 @code{sqrt(}@math{2}@code{)}
958 @end ifnottex
959 @dots{}
960 @item @code{pseries} @tab Power Series, e.g. @math{x-1/6*x^3+1/120*x^5+O(x^7)}
961 @item @code{function} @tab A symbolic function like
962 @tex
963 $\sin 2x$
964 @end tex
965 @ifnottex
966 @math{sin(2*x)}
967 @end ifnottex
968 @item @code{lst} @tab Lists of expressions @{@math{x}, @math{2*y}, @math{3+z}@}
969 @item @code{matrix} @tab @math{m}x@math{n} matrices of expressions
970 @item @code{relational} @tab A relation like the identity @math{x}@code{==}@math{y}
971 @item @code{indexed} @tab Indexed object like @math{A_ij}
972 @item @code{tensor} @tab Special tensor like the delta and metric tensors
973 @item @code{idx} @tab Index of an indexed object
974 @item @code{varidx} @tab Index with variance
975 @item @code{spinidx} @tab Index with variance and dot (used in Weyl-van-der-Waerden spinor formalism)
976 @item @code{wildcard} @tab Wildcard for pattern matching
977 @item @code{structure} @tab Template for user-defined classes
978 @end multitable
979 @end cartouche
980
981
982 @node Symbols, Numbers, The Class Hierarchy, Basic Concepts
983 @c    node-name, next, previous, up
984 @section Symbols
985 @cindex @code{symbol} (class)
986 @cindex hierarchy of classes
987
988 @cindex atom
989 Symbolic indeterminates, or @dfn{symbols} for short, are for symbolic
990 manipulation what atoms are for chemistry.
991
992 A typical symbol definition looks like this:
993 @example
994 symbol x("x");
995 @end example
996
997 This definition actually contains three very different things:
998 @itemize
999 @item a C++ variable named @code{x}
1000 @item a @code{symbol} object stored in this C++ variable; this object
1001   represents the symbol in a GiNaC expression
1002 @item the string @code{"x"} which is the name of the symbol, used (almost)
1003   exclusively for printing expressions holding the symbol
1004 @end itemize
1005
1006 Symbols have an explicit name, supplied as a string during construction,
1007 because in C++, variable names can't be used as values, and the C++ compiler
1008 throws them away during compilation.
1009
1010 It is possible to omit the symbol name in the definition:
1011 @example
1012 symbol x;
1013 @end example
1014
1015 In this case, GiNaC will assign the symbol an internal, unique name of the
1016 form @code{symbolNNN}. This won't affect the usability of the symbol but
1017 the output of your calculations will become more readable if you give your
1018 symbols sensible names (for intermediate expressions that are only used
1019 internally such anonymous symbols can be quite useful, however).
1020
1021 Now, here is one important property of GiNaC that differentiates it from
1022 other computer algebra programs you may have used: GiNaC does @emph{not} use
1023 the names of symbols to tell them apart, but a (hidden) serial number that
1024 is unique for each newly created @code{symbol} object. In you want to use
1025 one and the same symbol in different places in your program, you must only
1026 create one @code{symbol} object and pass that around. If you create another
1027 symbol, even if it has the same name, GiNaC will treat it as a different
1028 indeterminate.
1029
1030 Observe:
1031 @example
1032 ex f(int n)
1033 @{
1034     symbol x("x");
1035     return pow(x, n);
1036 @}
1037
1038 int main()
1039 @{
1040     symbol x("x");
1041     ex e = f(6);
1042
1043     cout << e << endl;
1044      // prints "x^6" which looks right, but...
1045
1046     cout << e.degree(x) << endl;
1047      // ...this doesn't work. The symbol "x" here is different from the one
1048      // in f() and in the expression returned by f(). Consequently, it
1049      // prints "0".
1050 @}
1051 @end example
1052
1053 One possibility to ensure that @code{f()} and @code{main()} use the same
1054 symbol is to pass the symbol as an argument to @code{f()}:
1055 @example
1056 ex f(int n, const ex & x)
1057 @{
1058     return pow(x, n);
1059 @}
1060
1061 int main()
1062 @{
1063     symbol x("x");
1064
1065     // Now, f() uses the same symbol.
1066     ex e = f(6, x);
1067
1068     cout << e.degree(x) << endl;
1069      // prints "6", as expected
1070 @}
1071 @end example
1072
1073 Another possibility would be to define a global symbol @code{x} that is used
1074 by both @code{f()} and @code{main()}. If you are using global symbols and
1075 multiple compilation units you must take special care, however. Suppose
1076 that you have a header file @file{globals.h} in your program that defines
1077 a @code{symbol x("x");}. In this case, every unit that includes
1078 @file{globals.h} would also get its own definition of @code{x} (because
1079 header files are just inlined into the source code by the C++ preprocessor),
1080 and hence you would again end up with multiple equally-named, but different,
1081 symbols. Instead, the @file{globals.h} header should only contain a
1082 @emph{declaration} like @code{extern symbol x;}, with the definition of
1083 @code{x} moved into a C++ source file such as @file{globals.cpp}.
1084
1085 A different approach to ensuring that symbols used in different parts of
1086 your program are identical is to create them with a @emph{factory} function
1087 like this one:
1088 @example
1089 const symbol & get_symbol(const string & s)
1090 @{
1091     static map<string, symbol> directory;
1092     map<string, symbol>::iterator i = directory.find(s);
1093     if (i != directory.end())
1094         return i->second;
1095     else
1096         return directory.insert(make_pair(s, symbol(s))).first->second;
1097 @}
1098 @end example
1099
1100 This function returns one newly constructed symbol for each name that is
1101 passed in, and it returns the same symbol when called multiple times with
1102 the same name. Using this symbol factory, we can rewrite our example like
1103 this:
1104 @example
1105 ex f(int n)
1106 @{
1107     return pow(get_symbol("x"), n);
1108 @}
1109
1110 int main()
1111 @{
1112     ex e = f(6);
1113
1114     // Both calls of get_symbol("x") yield the same symbol.
1115     cout << e.degree(get_symbol("x")) << endl;
1116      // prints "6"
1117 @}
1118 @end example
1119
1120 Instead of creating symbols from strings we could also have
1121 @code{get_symbol()} take, for example, an integer number as its argument.
1122 In this case, we would probably want to give the generated symbols names
1123 that include this number, which can be accomplished with the help of an
1124 @code{ostringstream}.
1125
1126 In general, if you're getting weird results from GiNaC such as an expression
1127 @samp{x-x} that is not simplified to zero, you should check your symbol
1128 definitions.
1129
1130 As we said, the names of symbols primarily serve for purposes of expression
1131 output. But there are actually two instances where GiNaC uses the names for
1132 identifying symbols: When constructing an expression from a string, and when
1133 recreating an expression from an archive (@pxref{Input/Output}).
1134
1135 In addition to its name, a symbol may contain a special string that is used
1136 in LaTeX output:
1137 @example
1138 symbol x("x", "\\Box");
1139 @end example
1140
1141 This creates a symbol that is printed as "@code{x}" in normal output, but
1142 as "@code{\Box}" in LaTeX code (@xref{Input/Output}, for more
1143 information about the different output formats of expressions in GiNaC).
1144 GiNaC automatically creates proper LaTeX code for symbols having names of
1145 greek letters (@samp{alpha}, @samp{mu}, etc.).
1146
1147 @cindex @code{subs()}
1148 Symbols in GiNaC can't be assigned values. If you need to store results of
1149 calculations and give them a name, use C++ variables of type @code{ex}.
1150 If you want to replace a symbol in an expression with something else, you
1151 can invoke the expression's @code{.subs()} method
1152 (@pxref{Substituting Expressions}).
1153
1154 @cindex @code{realsymbol()}
1155 By default, symbols are expected to stand in for complex values, i.e. they live
1156 in the complex domain.  As a consequence, operations like complex conjugation,
1157 for example (@pxref{Complex Conjugation}), do @emph{not} evaluate if applied
1158 to such symbols. Likewise @code{log(exp(x))} does not evaluate to @code{x},
1159 because of the unknown imaginary part of @code{x}.
1160 On the other hand, if you are sure that your symbols will hold only real values, you
1161 would like to have such functions evaluated. Therefore GiNaC allows you to specify
1162 the domain of the symbol. Instead of @code{symbol x("x");} you can write
1163 @code{realsymbol x("x");} to tell GiNaC that @code{x} stands in for real values.
1164
1165
1166 @node Numbers, Constants, Symbols, Basic Concepts
1167 @c    node-name, next, previous, up
1168 @section Numbers
1169 @cindex @code{numeric} (class)
1170
1171 @cindex GMP
1172 @cindex CLN
1173 @cindex rational
1174 @cindex fraction
1175 For storing numerical things, GiNaC uses Bruno Haible's library CLN.
1176 The classes therein serve as foundation classes for GiNaC.  CLN stands
1177 for Class Library for Numbers or alternatively for Common Lisp Numbers.
1178 In order to find out more about CLN's internals, the reader is referred to
1179 the documentation of that library.  @inforef{Introduction, , cln}, for
1180 more information. Suffice to say that it is by itself build on top of
1181 another library, the GNU Multiple Precision library GMP, which is an
1182 extremely fast library for arbitrary long integers and rationals as well
1183 as arbitrary precision floating point numbers.  It is very commonly used
1184 by several popular cryptographic applications.  CLN extends GMP by
1185 several useful things: First, it introduces the complex number field
1186 over either reals (i.e. floating point numbers with arbitrary precision)
1187 or rationals.  Second, it automatically converts rationals to integers
1188 if the denominator is unity and complex numbers to real numbers if the
1189 imaginary part vanishes and also correctly treats algebraic functions.
1190 Third it provides good implementations of state-of-the-art algorithms
1191 for all trigonometric and hyperbolic functions as well as for
1192 calculation of some useful constants.
1193
1194 The user can construct an object of class @code{numeric} in several
1195 ways.  The following example shows the four most important constructors.
1196 It uses construction from C-integer, construction of fractions from two
1197 integers, construction from C-float and construction from a string:
1198
1199 @example
1200 #include <iostream>
1201 #include <ginac/ginac.h>
1202 using namespace GiNaC;
1203
1204 int main()
1205 @{
1206     numeric two = 2;                      // exact integer 2
1207     numeric r(2,3);                       // exact fraction 2/3
1208     numeric e(2.71828);                   // floating point number
1209     numeric p = "3.14159265358979323846"; // constructor from string
1210     // Trott's constant in scientific notation:
1211     numeric trott("1.0841015122311136151E-2");
1212     
1213     std::cout << two*p << std::endl;  // floating point 6.283...
1214     ...
1215 @end example
1216
1217 @cindex @code{I}
1218 @cindex complex numbers
1219 The imaginary unit in GiNaC is a predefined @code{numeric} object with the
1220 name @code{I}:
1221
1222 @example
1223     ...
1224     numeric z1 = 2-3*I;                    // exact complex number 2-3i
1225     numeric z2 = 5.9+1.6*I;                // complex floating point number
1226 @}
1227 @end example
1228
1229 It may be tempting to construct fractions by writing @code{numeric r(3/2)}.
1230 This would, however, call C's built-in operator @code{/} for integers
1231 first and result in a numeric holding a plain integer 1.  @strong{Never
1232 use the operator @code{/} on integers} unless you know exactly what you
1233 are doing!  Use the constructor from two integers instead, as shown in
1234 the example above.  Writing @code{numeric(1)/2} may look funny but works
1235 also.
1236
1237 @cindex @code{Digits}
1238 @cindex accuracy
1239 We have seen now the distinction between exact numbers and floating
1240 point numbers.  Clearly, the user should never have to worry about
1241 dynamically created exact numbers, since their `exactness' always
1242 determines how they ought to be handled, i.e. how `long' they are.  The
1243 situation is different for floating point numbers.  Their accuracy is
1244 controlled by one @emph{global} variable, called @code{Digits}.  (For
1245 those readers who know about Maple: it behaves very much like Maple's
1246 @code{Digits}).  All objects of class numeric that are constructed from
1247 then on will be stored with a precision matching that number of decimal
1248 digits:
1249
1250 @example
1251 #include <iostream>
1252 #include <ginac/ginac.h>
1253 using namespace std;
1254 using namespace GiNaC;
1255
1256 void foo()
1257 @{
1258     numeric three(3.0), one(1.0);
1259     numeric x = one/three;
1260
1261     cout << "in " << Digits << " digits:" << endl;
1262     cout << x << endl;
1263     cout << Pi.evalf() << endl;
1264 @}
1265
1266 int main()
1267 @{
1268     foo();
1269     Digits = 60;
1270     foo();
1271     return 0;
1272 @}
1273 @end example
1274
1275 The above example prints the following output to screen:
1276
1277 @example
1278 in 17 digits:
1279 0.33333333333333333334
1280 3.1415926535897932385
1281 in 60 digits:
1282 0.33333333333333333333333333333333333333333333333333333333333333333334
1283 3.1415926535897932384626433832795028841971693993751058209749445923078
1284 @end example
1285
1286 @cindex rounding
1287 Note that the last number is not necessarily rounded as you would
1288 naively expect it to be rounded in the decimal system.  But note also,
1289 that in both cases you got a couple of extra digits.  This is because
1290 numbers are internally stored by CLN as chunks of binary digits in order
1291 to match your machine's word size and to not waste precision.  Thus, on
1292 architectures with different word size, the above output might even
1293 differ with regard to actually computed digits.
1294
1295 It should be clear that objects of class @code{numeric} should be used
1296 for constructing numbers or for doing arithmetic with them.  The objects
1297 one deals with most of the time are the polymorphic expressions @code{ex}.
1298
1299 @subsection Tests on numbers
1300
1301 Once you have declared some numbers, assigned them to expressions and
1302 done some arithmetic with them it is frequently desired to retrieve some
1303 kind of information from them like asking whether that number is
1304 integer, rational, real or complex.  For those cases GiNaC provides
1305 several useful methods.  (Internally, they fall back to invocations of
1306 certain CLN functions.)
1307
1308 As an example, let's construct some rational number, multiply it with
1309 some multiple of its denominator and test what comes out:
1310
1311 @example
1312 #include <iostream>
1313 #include <ginac/ginac.h>
1314 using namespace std;
1315 using namespace GiNaC;
1316
1317 // some very important constants:
1318 const numeric twentyone(21);
1319 const numeric ten(10);
1320 const numeric five(5);
1321
1322 int main()
1323 @{
1324     numeric answer = twentyone;
1325
1326     answer /= five;
1327     cout << answer.is_integer() << endl;  // false, it's 21/5
1328     answer *= ten;
1329     cout << answer.is_integer() << endl;  // true, it's 42 now!
1330 @}
1331 @end example
1332
1333 Note that the variable @code{answer} is constructed here as an integer
1334 by @code{numeric}'s copy constructor but in an intermediate step it
1335 holds a rational number represented as integer numerator and integer
1336 denominator.  When multiplied by 10, the denominator becomes unity and
1337 the result is automatically converted to a pure integer again.
1338 Internally, the underlying CLN is responsible for this behavior and we
1339 refer the reader to CLN's documentation.  Suffice to say that
1340 the same behavior applies to complex numbers as well as return values of
1341 certain functions.  Complex numbers are automatically converted to real
1342 numbers if the imaginary part becomes zero.  The full set of tests that
1343 can be applied is listed in the following table.
1344
1345 @cartouche
1346 @multitable @columnfractions .30 .70
1347 @item @strong{Method} @tab @strong{Returns true if the object is@dots{}}
1348 @item @code{.is_zero()}
1349 @tab @dots{}equal to zero
1350 @item @code{.is_positive()}
1351 @tab @dots{}not complex and greater than 0
1352 @item @code{.is_integer()}
1353 @tab @dots{}a (non-complex) integer
1354 @item @code{.is_pos_integer()}
1355 @tab @dots{}an integer and greater than 0
1356 @item @code{.is_nonneg_integer()}
1357 @tab @dots{}an integer and greater equal 0
1358 @item @code{.is_even()}
1359 @tab @dots{}an even integer
1360 @item @code{.is_odd()}
1361 @tab @dots{}an odd integer
1362 @item @code{.is_prime()}
1363 @tab @dots{}a prime integer (probabilistic primality test)
1364 @item @code{.is_rational()}
1365 @tab @dots{}an exact rational number (integers are rational, too)
1366 @item @code{.is_real()}
1367 @tab @dots{}a real integer, rational or float (i.e. is not complex)
1368 @item @code{.is_cinteger()}
1369 @tab @dots{}a (complex) integer (such as @math{2-3*I})
1370 @item @code{.is_crational()}
1371 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
1372 @end multitable
1373 @end cartouche
1374
1375 @subsection Numeric functions
1376
1377 The following functions can be applied to @code{numeric} objects and will be
1378 evaluated immediately:
1379
1380 @cartouche
1381 @multitable @columnfractions .30 .70
1382 @item @strong{Name} @tab @strong{Function}
1383 @item @code{inverse(z)}
1384 @tab returns @math{1/z}
1385 @cindex @code{inverse()} (numeric)
1386 @item @code{pow(a, b)}
1387 @tab exponentiation @math{a^b}
1388 @item @code{abs(z)}
1389 @tab absolute value
1390 @item @code{real(z)}
1391 @tab real part
1392 @cindex @code{real()}
1393 @item @code{imag(z)}
1394 @tab imaginary part
1395 @cindex @code{imag()}
1396 @item @code{csgn(z)}
1397 @tab complex sign (returns an @code{int})
1398 @item @code{numer(z)}
1399 @tab numerator of rational or complex rational number
1400 @item @code{denom(z)}
1401 @tab denominator of rational or complex rational number
1402 @item @code{sqrt(z)}
1403 @tab square root
1404 @item @code{isqrt(n)}
1405 @tab integer square root
1406 @cindex @code{isqrt()}
1407 @item @code{sin(z)}
1408 @tab sine
1409 @item @code{cos(z)}
1410 @tab cosine
1411 @item @code{tan(z)}
1412 @tab tangent
1413 @item @code{asin(z)}
1414 @tab inverse sine
1415 @item @code{acos(z)}
1416 @tab inverse cosine
1417 @item @code{atan(z)}
1418 @tab inverse tangent
1419 @item @code{atan(y, x)}
1420 @tab inverse tangent with two arguments
1421 @item @code{sinh(z)}
1422 @tab hyperbolic sine
1423 @item @code{cosh(z)}
1424 @tab hyperbolic cosine
1425 @item @code{tanh(z)}
1426 @tab hyperbolic tangent
1427 @item @code{asinh(z)}
1428 @tab inverse hyperbolic sine
1429 @item @code{acosh(z)}
1430 @tab inverse hyperbolic cosine
1431 @item @code{atanh(z)}
1432 @tab inverse hyperbolic tangent
1433 @item @code{exp(z)}
1434 @tab exponential function
1435 @item @code{log(z)}
1436 @tab natural logarithm
1437 @item @code{Li2(z)}
1438 @tab dilogarithm
1439 @item @code{zeta(z)}
1440 @tab Riemann's zeta function
1441 @item @code{tgamma(z)}
1442 @tab gamma function
1443 @item @code{lgamma(z)}
1444 @tab logarithm of gamma function
1445 @item @code{psi(z)}
1446 @tab psi (digamma) function
1447 @item @code{psi(n, z)}
1448 @tab derivatives of psi function (polygamma functions)
1449 @item @code{factorial(n)}
1450 @tab factorial function @math{n!}
1451 @item @code{doublefactorial(n)}
1452 @tab double factorial function @math{n!!}
1453 @cindex @code{doublefactorial()}
1454 @item @code{binomial(n, k)}
1455 @tab binomial coefficients
1456 @item @code{bernoulli(n)}
1457 @tab Bernoulli numbers
1458 @cindex @code{bernoulli()}
1459 @item @code{fibonacci(n)}
1460 @tab Fibonacci numbers
1461 @cindex @code{fibonacci()}
1462 @item @code{mod(a, b)}
1463 @tab modulus in positive representation (in the range @code{[0, abs(b)-1]} with the sign of b, or zero)
1464 @cindex @code{mod()}
1465 @item @code{smod(a, b)}
1466 @tab modulus in symmetric representation (in the range @code{[-iquo(abs(b)-1, 2), iquo(abs(b), 2)]})
1467 @cindex @code{smod()}
1468 @item @code{irem(a, b)}
1469 @tab integer remainder (has the sign of @math{a}, or is zero)
1470 @cindex @code{irem()}
1471 @item @code{irem(a, b, q)}
1472 @tab integer remainder and quotient, @code{irem(a, b, q) == a-q*b}
1473 @item @code{iquo(a, b)}
1474 @tab integer quotient
1475 @cindex @code{iquo()}
1476 @item @code{iquo(a, b, r)}
1477 @tab integer quotient and remainder, @code{r == a-iquo(a, b)*b}
1478 @item @code{gcd(a, b)}
1479 @tab greatest common divisor
1480 @item @code{lcm(a, b)}
1481 @tab least common multiple
1482 @end multitable
1483 @end cartouche
1484
1485 Most of these functions are also available as symbolic functions that can be
1486 used in expressions (@pxref{Mathematical functions}) or, like @code{gcd()},
1487 as polynomial algorithms.
1488
1489 @subsection Converting numbers
1490
1491 Sometimes it is desirable to convert a @code{numeric} object back to a
1492 built-in arithmetic type (@code{int}, @code{double}, etc.). The @code{numeric}
1493 class provides a couple of methods for this purpose:
1494
1495 @cindex @code{to_int()}
1496 @cindex @code{to_long()}
1497 @cindex @code{to_double()}
1498 @cindex @code{to_cl_N()}
1499 @example
1500 int numeric::to_int() const;
1501 long numeric::to_long() const;
1502 double numeric::to_double() const;
1503 cln::cl_N numeric::to_cl_N() const;
1504 @end example
1505
1506 @code{to_int()} and @code{to_long()} only work when the number they are
1507 applied on is an exact integer. Otherwise the program will halt with a
1508 message like @samp{Not a 32-bit integer}. @code{to_double()} applied on a
1509 rational number will return a floating-point approximation. Both
1510 @code{to_int()/to_long()} and @code{to_double()} discard the imaginary
1511 part of complex numbers.
1512
1513
1514 @node Constants, Fundamental containers, Numbers, Basic Concepts
1515 @c    node-name, next, previous, up
1516 @section Constants
1517 @cindex @code{constant} (class)
1518
1519 @cindex @code{Pi}
1520 @cindex @code{Catalan}
1521 @cindex @code{Euler}
1522 @cindex @code{evalf()}
1523 Constants behave pretty much like symbols except that they return some
1524 specific number when the method @code{.evalf()} is called.
1525
1526 The predefined known constants are:
1527
1528 @cartouche
1529 @multitable @columnfractions .14 .30 .56
1530 @item @strong{Name} @tab @strong{Common Name} @tab @strong{Numerical Value (to 35 digits)}
1531 @item @code{Pi}
1532 @tab Archimedes' constant
1533 @tab 3.14159265358979323846264338327950288
1534 @item @code{Catalan}
1535 @tab Catalan's constant
1536 @tab 0.91596559417721901505460351493238411
1537 @item @code{Euler}
1538 @tab Euler's (or Euler-Mascheroni) constant
1539 @tab 0.57721566490153286060651209008240243
1540 @end multitable
1541 @end cartouche
1542
1543
1544 @node Fundamental containers, Lists, Constants, Basic Concepts
1545 @c    node-name, next, previous, up
1546 @section Sums, products and powers
1547 @cindex polynomial
1548 @cindex @code{add}
1549 @cindex @code{mul}
1550 @cindex @code{power}
1551
1552 Simple rational expressions are written down in GiNaC pretty much like
1553 in other CAS or like expressions involving numerical variables in C.
1554 The necessary operators @code{+}, @code{-}, @code{*} and @code{/} have
1555 been overloaded to achieve this goal.  When you run the following
1556 code snippet, the constructor for an object of type @code{mul} is
1557 automatically called to hold the product of @code{a} and @code{b} and
1558 then the constructor for an object of type @code{add} is called to hold
1559 the sum of that @code{mul} object and the number one:
1560
1561 @example
1562     ...
1563     symbol a("a"), b("b");
1564     ex MyTerm = 1+a*b;
1565     ...
1566 @end example
1567
1568 @cindex @code{pow()}
1569 For exponentiation, you have already seen the somewhat clumsy (though C-ish)
1570 statement @code{pow(x,2);} to represent @code{x} squared.  This direct
1571 construction is necessary since we cannot safely overload the constructor
1572 @code{^} in C++ to construct a @code{power} object.  If we did, it would
1573 have several counterintuitive and undesired effects:
1574
1575 @itemize @bullet
1576 @item
1577 Due to C's operator precedence, @code{2*x^2} would be parsed as @code{(2*x)^2}.
1578 @item
1579 Due to the binding of the operator @code{^}, @code{x^a^b} would result in
1580 @code{(x^a)^b}. This would be confusing since most (though not all) other CAS
1581 interpret this as @code{x^(a^b)}.
1582 @item
1583 Also, expressions involving integer exponents are very frequently used,
1584 which makes it even more dangerous to overload @code{^} since it is then
1585 hard to distinguish between the semantics as exponentiation and the one
1586 for exclusive or.  (It would be embarrassing to return @code{1} where one
1587 has requested @code{2^3}.)
1588 @end itemize
1589
1590 @cindex @command{ginsh}
1591 All effects are contrary to mathematical notation and differ from the
1592 way most other CAS handle exponentiation, therefore overloading @code{^}
1593 is ruled out for GiNaC's C++ part.  The situation is different in
1594 @command{ginsh}, there the exponentiation-@code{^} exists.  (Also note
1595 that the other frequently used exponentiation operator @code{**} does
1596 not exist at all in C++).
1597
1598 To be somewhat more precise, objects of the three classes described
1599 here, are all containers for other expressions.  An object of class
1600 @code{power} is best viewed as a container with two slots, one for the
1601 basis, one for the exponent.  All valid GiNaC expressions can be
1602 inserted.  However, basic transformations like simplifying
1603 @code{pow(pow(x,2),3)} to @code{x^6} automatically are only performed
1604 when this is mathematically possible.  If we replace the outer exponent
1605 three in the example by some symbols @code{a}, the simplification is not
1606 safe and will not be performed, since @code{a} might be @code{1/2} and
1607 @code{x} negative.
1608
1609 Objects of type @code{add} and @code{mul} are containers with an
1610 arbitrary number of slots for expressions to be inserted.  Again, simple
1611 and safe simplifications are carried out like transforming
1612 @code{3*x+4-x} to @code{2*x+4}.
1613
1614
1615 @node Lists, Mathematical functions, Fundamental containers, Basic Concepts
1616 @c    node-name, next, previous, up
1617 @section Lists of expressions
1618 @cindex @code{lst} (class)
1619 @cindex lists
1620 @cindex @code{nops()}
1621 @cindex @code{op()}
1622 @cindex @code{append()}
1623 @cindex @code{prepend()}
1624 @cindex @code{remove_first()}
1625 @cindex @code{remove_last()}
1626 @cindex @code{remove_all()}
1627
1628 The GiNaC class @code{lst} serves for holding a @dfn{list} of arbitrary
1629 expressions. They are not as ubiquitous as in many other computer algebra
1630 packages, but are sometimes used to supply a variable number of arguments of
1631 the same type to GiNaC methods such as @code{subs()} and some @code{matrix}
1632 constructors, so you should have a basic understanding of them.
1633
1634 Lists can be constructed by assigning a comma-separated sequence of
1635 expressions:
1636
1637 @example
1638 @{
1639     symbol x("x"), y("y");
1640     lst l;
1641     l = x, 2, y, x+y;
1642     // now, l is a list holding the expressions 'x', '2', 'y', and 'x+y',
1643     // in that order
1644     ...
1645 @end example
1646
1647 There are also constructors that allow direct creation of lists of up to
1648 16 expressions, which is often more convenient but slightly less efficient:
1649
1650 @example
1651     ...
1652     // This produces the same list 'l' as above:
1653     // lst l(x, 2, y, x+y);
1654     // lst l = lst(x, 2, y, x+y);
1655     ...
1656 @end example
1657
1658 Use the @code{nops()} method to determine the size (number of expressions) of
1659 a list and the @code{op()} method or the @code{[]} operator to access
1660 individual elements:
1661
1662 @example
1663     ...
1664     cout << l.nops() << endl;                // prints '4'
1665     cout << l.op(2) << " " << l[0] << endl;  // prints 'y x'
1666     ...
1667 @end example
1668
1669 As with the standard @code{list<T>} container, accessing random elements of a
1670 @code{lst} is generally an operation of order @math{O(N)}. Faster read-only
1671 sequential access to the elements of a list is possible with the
1672 iterator types provided by the @code{lst} class:
1673
1674 @example
1675 typedef ... lst::const_iterator;
1676 typedef ... lst::const_reverse_iterator;
1677 lst::const_iterator lst::begin() const;
1678 lst::const_iterator lst::end() const;
1679 lst::const_reverse_iterator lst::rbegin() const;
1680 lst::const_reverse_iterator lst::rend() const;
1681 @end example
1682
1683 For example, to print the elements of a list individually you can use:
1684
1685 @example
1686     ...
1687     // O(N)
1688     for (lst::const_iterator i = l.begin(); i != l.end(); ++i)
1689         cout << *i << endl;
1690     ...
1691 @end example
1692
1693 which is one order faster than
1694
1695 @example
1696     ...
1697     // O(N^2)
1698     for (size_t i = 0; i < l.nops(); ++i)
1699         cout << l.op(i) << endl;
1700     ...
1701 @end example
1702
1703 These iterators also allow you to use some of the algorithms provided by
1704 the C++ standard library:
1705
1706 @example
1707     ...
1708     // print the elements of the list (requires #include <iterator>)
1709     std::copy(l.begin(), l.end(), ostream_iterator<ex>(cout, "\n"));
1710
1711     // sum up the elements of the list (requires #include <numeric>)
1712     ex sum = std::accumulate(l.begin(), l.end(), ex(0));
1713     cout << sum << endl;  // prints '2+2*x+2*y'
1714     ...
1715 @end example
1716
1717 @code{lst} is one of the few GiNaC classes that allow in-place modifications
1718 (the only other one is @code{matrix}). You can modify single elements:
1719
1720 @example
1721     ...
1722     l[1] = 42;       // l is now @{x, 42, y, x+y@}
1723     l.let_op(1) = 7; // l is now @{x, 7, y, x+y@}
1724     ...
1725 @end example
1726
1727 You can append or prepend an expression to a list with the @code{append()}
1728 and @code{prepend()} methods:
1729
1730 @example
1731     ...
1732     l.append(4*x);   // l is now @{x, 7, y, x+y, 4*x@}
1733     l.prepend(0);    // l is now @{0, x, 7, y, x+y, 4*x@}
1734     ...
1735 @end example
1736
1737 You can remove the first or last element of a list with @code{remove_first()}
1738 and @code{remove_last()}:
1739
1740 @example
1741     ...
1742     l.remove_first();   // l is now @{x, 7, y, x+y, 4*x@}
1743     l.remove_last();    // l is now @{x, 7, y, x+y@}
1744     ...
1745 @end example
1746
1747 You can remove all the elements of a list with @code{remove_all()}:
1748
1749 @example
1750     ...
1751     l.remove_all();     // l is now empty
1752     ...
1753 @end example
1754
1755 You can bring the elements of a list into a canonical order with @code{sort()}:
1756
1757 @example
1758     ...
1759     lst l1, l2;
1760     l1 = x, 2, y, x+y;
1761     l2 = 2, x+y, x, y;
1762     l1.sort();
1763     l2.sort();
1764     // l1 and l2 are now equal
1765     ...
1766 @end example
1767
1768 Finally, you can remove all but the first element of consecutive groups of
1769 elements with @code{unique()}:
1770
1771 @example
1772     ...
1773     lst l3;
1774     l3 = x, 2, 2, 2, y, x+y, y+x;
1775     l3.unique();        // l3 is now @{x, 2, y, x+y@}
1776 @}
1777 @end example
1778
1779
1780 @node Mathematical functions, Relations, Lists, Basic Concepts
1781 @c    node-name, next, previous, up
1782 @section Mathematical functions
1783 @cindex @code{function} (class)
1784 @cindex trigonometric function
1785 @cindex hyperbolic function
1786
1787 There are quite a number of useful functions hard-wired into GiNaC.  For
1788 instance, all trigonometric and hyperbolic functions are implemented
1789 (@xref{Built-in Functions}, for a complete list).
1790
1791 These functions (better called @emph{pseudofunctions}) are all objects
1792 of class @code{function}.  They accept one or more expressions as
1793 arguments and return one expression.  If the arguments are not
1794 numerical, the evaluation of the function may be halted, as it does in
1795 the next example, showing how a function returns itself twice and
1796 finally an expression that may be really useful:
1797
1798 @cindex Gamma function
1799 @cindex @code{subs()}
1800 @example
1801     ...
1802     symbol x("x"), y("y");    
1803     ex foo = x+y/2;
1804     cout << tgamma(foo) << endl;
1805      // -> tgamma(x+(1/2)*y)
1806     ex bar = foo.subs(y==1);
1807     cout << tgamma(bar) << endl;
1808      // -> tgamma(x+1/2)
1809     ex foobar = bar.subs(x==7);
1810     cout << tgamma(foobar) << endl;
1811      // -> (135135/128)*Pi^(1/2)
1812     ...
1813 @end example
1814
1815 Besides evaluation most of these functions allow differentiation, series
1816 expansion and so on.  Read the next chapter in order to learn more about
1817 this.
1818
1819 It must be noted that these pseudofunctions are created by inline
1820 functions, where the argument list is templated.  This means that
1821 whenever you call @code{GiNaC::sin(1)} it is equivalent to
1822 @code{sin(ex(1))} and will therefore not result in a floating point
1823 number.  Unless of course the function prototype is explicitly
1824 overridden -- which is the case for arguments of type @code{numeric}
1825 (not wrapped inside an @code{ex}).  Hence, in order to obtain a floating
1826 point number of class @code{numeric} you should call
1827 @code{sin(numeric(1))}.  This is almost the same as calling
1828 @code{sin(1).evalf()} except that the latter will return a numeric
1829 wrapped inside an @code{ex}.
1830
1831
1832 @node Relations, Integrals, Mathematical functions, Basic Concepts
1833 @c    node-name, next, previous, up
1834 @section Relations
1835 @cindex @code{relational} (class)
1836
1837 Sometimes, a relation holding between two expressions must be stored
1838 somehow.  The class @code{relational} is a convenient container for such
1839 purposes.  A relation is by definition a container for two @code{ex} and
1840 a relation between them that signals equality, inequality and so on.
1841 They are created by simply using the C++ operators @code{==}, @code{!=},
1842 @code{<}, @code{<=}, @code{>} and @code{>=} between two expressions.
1843
1844 @xref{Mathematical functions}, for examples where various applications
1845 of the @code{.subs()} method show how objects of class relational are
1846 used as arguments.  There they provide an intuitive syntax for
1847 substitutions.  They are also used as arguments to the @code{ex::series}
1848 method, where the left hand side of the relation specifies the variable
1849 to expand in and the right hand side the expansion point.  They can also
1850 be used for creating systems of equations that are to be solved for
1851 unknown variables.  But the most common usage of objects of this class
1852 is rather inconspicuous in statements of the form @code{if
1853 (expand(pow(a+b,2))==a*a+2*a*b+b*b) @{...@}}.  Here, an implicit
1854 conversion from @code{relational} to @code{bool} takes place.  Note,
1855 however, that @code{==} here does not perform any simplifications, hence
1856 @code{expand()} must be called explicitly.
1857
1858 @node Integrals, Matrices, Relations, Basic Concepts
1859 @c    node-name, next, previous, up
1860 @section Integrals
1861 @cindex @code{integral} (class)
1862
1863 An object of class @dfn{integral} can be used to hold a symbolic integral.
1864 If you want to symbolically represent the integral of @code{x*x} from 0 to
1865 1, you would write this as
1866 @example
1867 integral(x, 0, 1, x*x)
1868 @end example
1869 The first argument is the integration variable. It should be noted that
1870 GiNaC is not very good (yet?) at symbolically evaluating integrals. In
1871 fact, it can only integrate polynomials. An expression containing integrals
1872 can be evaluated symbolically by calling the
1873 @example
1874 .eval_integ()
1875 @end example
1876 method on it. Numerical evaluation is available by calling the
1877 @example
1878 .evalf()
1879 @end example
1880 method on an expression containing the integral. This will only evaluate
1881 integrals into a number if @code{subs}ing the integration variable by a
1882 number in the fourth argument of an integral and then @code{evalf}ing the
1883 result always results in a number. Of course, also the boundaries of the
1884 integration domain must @code{evalf} into numbers. It should be noted that
1885 trying to @code{evalf} a function with discontinuities in the integration
1886 domain is not recommended. The accuracy of the numeric evaluation of
1887 integrals is determined by the static member variable
1888 @example
1889 ex integral::relative_integration_error
1890 @end example
1891 of the class @code{integral}. The default value of this is 10^-8.
1892 The integration works by halving the interval of integration, until numeric
1893 stability of the answer indicates that the requested accuracy has been
1894 reached. The maximum depth of the halving can be set via the static member
1895 variable
1896 @example
1897 int integral::max_integration_level
1898 @end example
1899 The default value is 15. If this depth is exceeded, @code{evalf} will simply
1900 return the integral unevaluated. The function that performs the numerical
1901 evaluation, is also available as
1902 @example
1903 ex adaptivesimpson(const ex & x, const ex & a, const ex & b, const ex & f,
1904 const ex & error)
1905 @end example
1906 This function will throw an exception if the maximum depth is exceeded. The
1907 last parameter of the function is optional and defaults to the
1908 @code{relative_integration_error}. To make sure that we do not do too
1909 much work if an expression contains the same integral multiple times,
1910 a lookup table is used.
1911
1912 If you know that an expression holds an integral, you can get the
1913 integration variable, the left boundary, right boundary and integrant by
1914 respectively calling @code{.op(0)}, @code{.op(1)}, @code{.op(2)}, and
1915 @code{.op(3)}. Differentiating integrals with respect to variables works
1916 as expected. Note that it makes no sense to differentiate an integral
1917 with respect to the integration variable.
1918
1919 @node Matrices, Indexed objects, Integrals, Basic Concepts
1920 @c    node-name, next, previous, up
1921 @section Matrices
1922 @cindex @code{matrix} (class)
1923
1924 A @dfn{matrix} is a two-dimensional array of expressions. The elements of a
1925 matrix with @math{m} rows and @math{n} columns are accessed with two
1926 @code{unsigned} indices, the first one in the range 0@dots{}@math{m-1}, the
1927 second one in the range 0@dots{}@math{n-1}.
1928
1929 There are a couple of ways to construct matrices, with or without preset
1930 elements. The constructor
1931
1932 @example
1933 matrix::matrix(unsigned r, unsigned c);
1934 @end example
1935
1936 creates a matrix with @samp{r} rows and @samp{c} columns with all elements
1937 set to zero.
1938
1939 The fastest way to create a matrix with preinitialized elements is to assign
1940 a list of comma-separated expressions to an empty matrix (see below for an
1941 example). But you can also specify the elements as a (flat) list with
1942
1943 @example
1944 matrix::matrix(unsigned r, unsigned c, const lst & l);
1945 @end example
1946
1947 The function
1948
1949 @cindex @code{lst_to_matrix()}
1950 @example
1951 ex lst_to_matrix(const lst & l);
1952 @end example
1953
1954 constructs a matrix from a list of lists, each list representing a matrix row.
1955
1956 There is also a set of functions for creating some special types of
1957 matrices:
1958
1959 @cindex @code{diag_matrix()}
1960 @cindex @code{unit_matrix()}
1961 @cindex @code{symbolic_matrix()}
1962 @example
1963 ex diag_matrix(const lst & l);
1964 ex unit_matrix(unsigned x);
1965 ex unit_matrix(unsigned r, unsigned c);
1966 ex symbolic_matrix(unsigned r, unsigned c, const string & base_name);
1967 ex symbolic_matrix(unsigned r, unsigned c, const string & base_name,
1968                    const string & tex_base_name);
1969 @end example
1970
1971 @code{diag_matrix()} constructs a diagonal matrix given the list of diagonal
1972 elements. @code{unit_matrix()} creates an @samp{x} by @samp{x} (or @samp{r}
1973 by @samp{c}) unit matrix. And finally, @code{symbolic_matrix} constructs a
1974 matrix filled with newly generated symbols made of the specified base name
1975 and the position of each element in the matrix.
1976
1977 Matrix elements can be accessed and set using the parenthesis (function call)
1978 operator:
1979
1980 @example
1981 const ex & matrix::operator()(unsigned r, unsigned c) const;
1982 ex & matrix::operator()(unsigned r, unsigned c);
1983 @end example
1984
1985 It is also possible to access the matrix elements in a linear fashion with
1986 the @code{op()} method. But C++-style subscripting with square brackets
1987 @samp{[]} is not available.
1988
1989 Here are a couple of examples for constructing matrices:
1990
1991 @example
1992 @{
1993     symbol a("a"), b("b");
1994
1995     matrix M(2, 2);
1996     M = a, 0,
1997         0, b;
1998     cout << M << endl;
1999      // -> [[a,0],[0,b]]
2000
2001     matrix M2(2, 2);
2002     M2(0, 0) = a;
2003     M2(1, 1) = b;
2004     cout << M2 << endl;
2005      // -> [[a,0],[0,b]]
2006
2007     cout << matrix(2, 2, lst(a, 0, 0, b)) << endl;
2008      // -> [[a,0],[0,b]]
2009
2010     cout << lst_to_matrix(lst(lst(a, 0), lst(0, b))) << endl;
2011      // -> [[a,0],[0,b]]
2012
2013     cout << diag_matrix(lst(a, b)) << endl;
2014      // -> [[a,0],[0,b]]
2015
2016     cout << unit_matrix(3) << endl;
2017      // -> [[1,0,0],[0,1,0],[0,0,1]]
2018
2019     cout << symbolic_matrix(2, 3, "x") << endl;
2020      // -> [[x00,x01,x02],[x10,x11,x12]]
2021 @}
2022 @end example
2023
2024 @cindex @code{transpose()}
2025 There are three ways to do arithmetic with matrices. The first (and most
2026 direct one) is to use the methods provided by the @code{matrix} class:
2027
2028 @example
2029 matrix matrix::add(const matrix & other) const;
2030 matrix matrix::sub(const matrix & other) const;
2031 matrix matrix::mul(const matrix & other) const;
2032 matrix matrix::mul_scalar(const ex & other) const;
2033 matrix matrix::pow(const ex & expn) const;
2034 matrix matrix::transpose() const;
2035 @end example
2036
2037 All of these methods return the result as a new matrix object. Here is an
2038 example that calculates @math{A*B-2*C} for three matrices @math{A}, @math{B}
2039 and @math{C}:
2040
2041 @example
2042 @{
2043     matrix A(2, 2), B(2, 2), C(2, 2);
2044     A =  1, 2,
2045          3, 4;
2046     B = -1, 0,
2047          2, 1;
2048     C =  8, 4,
2049          2, 1;
2050
2051     matrix result = A.mul(B).sub(C.mul_scalar(2));
2052     cout << result << endl;
2053      // -> [[-13,-6],[1,2]]
2054     ...
2055 @}
2056 @end example
2057
2058 @cindex @code{evalm()}
2059 The second (and probably the most natural) way is to construct an expression
2060 containing matrices with the usual arithmetic operators and @code{pow()}.
2061 For efficiency reasons, expressions with sums, products and powers of
2062 matrices are not automatically evaluated in GiNaC. You have to call the
2063 method
2064
2065 @example
2066 ex ex::evalm() const;
2067 @end example
2068
2069 to obtain the result:
2070
2071 @example
2072 @{
2073     ...
2074     ex e = A*B - 2*C;
2075     cout << e << endl;
2076      // -> [[1,2],[3,4]]*[[-1,0],[2,1]]-2*[[8,4],[2,1]]
2077     cout << e.evalm() << endl;
2078      // -> [[-13,-6],[1,2]]
2079     ...
2080 @}
2081 @end example
2082
2083 The non-commutativity of the product @code{A*B} in this example is
2084 automatically recognized by GiNaC. There is no need to use a special
2085 operator here. @xref{Non-commutative objects}, for more information about
2086 dealing with non-commutative expressions.
2087
2088 Finally, you can work with indexed matrices and call @code{simplify_indexed()}
2089 to perform the arithmetic:
2090
2091 @example
2092 @{
2093     ...
2094     idx i(symbol("i"), 2), j(symbol("j"), 2), k(symbol("k"), 2);
2095     e = indexed(A, i, k) * indexed(B, k, j) - 2 * indexed(C, i, j);
2096     cout << e << endl;
2097      // -> -2*[[8,4],[2,1]].i.j+[[-1,0],[2,1]].k.j*[[1,2],[3,4]].i.k
2098     cout << e.simplify_indexed() << endl;
2099      // -> [[-13,-6],[1,2]].i.j
2100 @}
2101 @end example
2102
2103 Using indices is most useful when working with rectangular matrices and
2104 one-dimensional vectors because you don't have to worry about having to
2105 transpose matrices before multiplying them. @xref{Indexed objects}, for
2106 more information about using matrices with indices, and about indices in
2107 general.
2108
2109 The @code{matrix} class provides a couple of additional methods for
2110 computing determinants, traces, characteristic polynomials and ranks:
2111
2112 @cindex @code{determinant()}
2113 @cindex @code{trace()}
2114 @cindex @code{charpoly()}
2115 @cindex @code{rank()}
2116 @example
2117 ex matrix::determinant(unsigned algo=determinant_algo::automatic) const;
2118 ex matrix::trace() const;
2119 ex matrix::charpoly(const ex & lambda) const;
2120 unsigned matrix::rank() const;
2121 @end example
2122
2123 The @samp{algo} argument of @code{determinant()} allows to select
2124 between different algorithms for calculating the determinant.  The
2125 asymptotic speed (as parametrized by the matrix size) can greatly differ
2126 between those algorithms, depending on the nature of the matrix'
2127 entries.  The possible values are defined in the @file{flags.h} header
2128 file.  By default, GiNaC uses a heuristic to automatically select an
2129 algorithm that is likely (but not guaranteed) to give the result most
2130 quickly.
2131
2132 @cindex @code{inverse()} (matrix)
2133 @cindex @code{solve()}
2134 Matrices may also be inverted using the @code{ex matrix::inverse()}
2135 method and linear systems may be solved with:
2136
2137 @example
2138 matrix matrix::solve(const matrix & vars, const matrix & rhs,
2139                      unsigned algo=solve_algo::automatic) const;
2140 @end example
2141
2142 Assuming the matrix object this method is applied on is an @code{m}
2143 times @code{n} matrix, then @code{vars} must be a @code{n} times
2144 @code{p} matrix of symbolic indeterminates and @code{rhs} a @code{m}
2145 times @code{p} matrix.  The returned matrix then has dimension @code{n}
2146 times @code{p} and in the case of an underdetermined system will still
2147 contain some of the indeterminates from @code{vars}.  If the system is
2148 overdetermined, an exception is thrown.
2149
2150
2151 @node Indexed objects, Non-commutative objects, Matrices, Basic Concepts
2152 @c    node-name, next, previous, up
2153 @section Indexed objects
2154
2155 GiNaC allows you to handle expressions containing general indexed objects in
2156 arbitrary spaces. It is also able to canonicalize and simplify such
2157 expressions and perform symbolic dummy index summations. There are a number
2158 of predefined indexed objects provided, like delta and metric tensors.
2159
2160 There are few restrictions placed on indexed objects and their indices and
2161 it is easy to construct nonsense expressions, but our intention is to
2162 provide a general framework that allows you to implement algorithms with
2163 indexed quantities, getting in the way as little as possible.
2164
2165 @cindex @code{idx} (class)
2166 @cindex @code{indexed} (class)
2167 @subsection Indexed quantities and their indices
2168
2169 Indexed expressions in GiNaC are constructed of two special types of objects,
2170 @dfn{index objects} and @dfn{indexed objects}.
2171
2172 @itemize @bullet
2173
2174 @cindex contravariant
2175 @cindex covariant
2176 @cindex variance
2177 @item Index objects are of class @code{idx} or a subclass. Every index has
2178 a @dfn{value} and a @dfn{dimension} (which is the dimension of the space
2179 the index lives in) which can both be arbitrary expressions but are usually
2180 a number or a simple symbol. In addition, indices of class @code{varidx} have
2181 a @dfn{variance} (they can be co- or contravariant), and indices of class
2182 @code{spinidx} have a variance and can be @dfn{dotted} or @dfn{undotted}.
2183
2184 @item Indexed objects are of class @code{indexed} or a subclass. They
2185 contain a @dfn{base expression} (which is the expression being indexed), and
2186 one or more indices.
2187
2188 @end itemize
2189
2190 @strong{Please notice:} when printing expressions, covariant indices and indices
2191 without variance are denoted @samp{.i} while contravariant indices are
2192 denoted @samp{~i}. Dotted indices have a @samp{*} in front of the index
2193 value. In the following, we are going to use that notation in the text so
2194 instead of @math{A^i_jk} we will write @samp{A~i.j.k}. Index dimensions are
2195 not visible in the output.
2196
2197 A simple example shall illustrate the concepts:
2198
2199 @example
2200 #include <iostream>
2201 #include <ginac/ginac.h>
2202 using namespace std;
2203 using namespace GiNaC;
2204
2205 int main()
2206 @{
2207     symbol i_sym("i"), j_sym("j");
2208     idx i(i_sym, 3), j(j_sym, 3);
2209
2210     symbol A("A");
2211     cout << indexed(A, i, j) << endl;
2212      // -> A.i.j
2213     cout << index_dimensions << indexed(A, i, j) << endl;
2214      // -> A.i[3].j[3]
2215     cout << dflt; // reset cout to default output format (dimensions hidden)
2216     ...
2217 @end example
2218
2219 The @code{idx} constructor takes two arguments, the index value and the
2220 index dimension. First we define two index objects, @code{i} and @code{j},
2221 both with the numeric dimension 3. The value of the index @code{i} is the
2222 symbol @code{i_sym} (which prints as @samp{i}) and the value of the index
2223 @code{j} is the symbol @code{j_sym} (which prints as @samp{j}). Next we
2224 construct an expression containing one indexed object, @samp{A.i.j}. It has
2225 the symbol @code{A} as its base expression and the two indices @code{i} and
2226 @code{j}.
2227
2228 The dimensions of indices are normally not visible in the output, but one
2229 can request them to be printed with the @code{index_dimensions} manipulator,
2230 as shown above.
2231
2232 Note the difference between the indices @code{i} and @code{j} which are of
2233 class @code{idx}, and the index values which are the symbols @code{i_sym}
2234 and @code{j_sym}. The indices of indexed objects cannot directly be symbols
2235 or numbers but must be index objects. For example, the following is not
2236 correct and will raise an exception:
2237
2238 @example
2239 symbol i("i"), j("j");
2240 e = indexed(A, i, j); // ERROR: indices must be of type idx
2241 @end example
2242
2243 You can have multiple indexed objects in an expression, index values can
2244 be numeric, and index dimensions symbolic:
2245
2246 @example
2247     ...
2248     symbol B("B"), dim("dim");
2249     cout << 4 * indexed(A, i)
2250           + indexed(B, idx(j_sym, 4), idx(2, 3), idx(i_sym, dim)) << endl;
2251      // -> B.j.2.i+4*A.i
2252     ...
2253 @end example
2254
2255 @code{B} has a 4-dimensional symbolic index @samp{k}, a 3-dimensional numeric
2256 index of value 2, and a symbolic index @samp{i} with the symbolic dimension
2257 @samp{dim}. Note that GiNaC doesn't automatically notify you that the free
2258 indices of @samp{A} and @samp{B} in the sum don't match (you have to call
2259 @code{simplify_indexed()} for that, see below).
2260
2261 In fact, base expressions, index values and index dimensions can be
2262 arbitrary expressions:
2263
2264 @example
2265     ...
2266     cout << indexed(A+B, idx(2*i_sym+1, dim/2)) << endl;
2267      // -> (B+A).(1+2*i)
2268     ...
2269 @end example
2270
2271 It's also possible to construct nonsense like @samp{Pi.sin(x)}. You will not
2272 get an error message from this but you will probably not be able to do
2273 anything useful with it.
2274
2275 @cindex @code{get_value()}
2276 @cindex @code{get_dimension()}
2277 The methods
2278
2279 @example
2280 ex idx::get_value();
2281 ex idx::get_dimension();
2282 @end example
2283
2284 return the value and dimension of an @code{idx} object. If you have an index
2285 in an expression, such as returned by calling @code{.op()} on an indexed
2286 object, you can get a reference to the @code{idx} object with the function
2287 @code{ex_to<idx>()} on the expression.
2288
2289 There are also the methods
2290
2291 @example
2292 bool idx::is_numeric();
2293 bool idx::is_symbolic();
2294 bool idx::is_dim_numeric();
2295 bool idx::is_dim_symbolic();
2296 @end example
2297
2298 for checking whether the value and dimension are numeric or symbolic
2299 (non-numeric). Using the @code{info()} method of an index (see @ref{Information
2300 About Expressions}) returns information about the index value.
2301
2302 @cindex @code{varidx} (class)
2303 If you need co- and contravariant indices, use the @code{varidx} class:
2304
2305 @example
2306     ...
2307     symbol mu_sym("mu"), nu_sym("nu");
2308     varidx mu(mu_sym, 4), nu(nu_sym, 4); // default is contravariant ~mu, ~nu
2309     varidx mu_co(mu_sym, 4, true);       // covariant index .mu
2310
2311     cout << indexed(A, mu, nu) << endl;
2312      // -> A~mu~nu
2313     cout << indexed(A, mu_co, nu) << endl;
2314      // -> A.mu~nu
2315     cout << indexed(A, mu.toggle_variance(), nu) << endl;
2316      // -> A.mu~nu
2317     ...
2318 @end example
2319
2320 A @code{varidx} is an @code{idx} with an additional flag that marks it as
2321 co- or contravariant. The default is a contravariant (upper) index, but
2322 this can be overridden by supplying a third argument to the @code{varidx}
2323 constructor. The two methods
2324
2325 @example
2326 bool varidx::is_covariant();
2327 bool varidx::is_contravariant();
2328 @end example
2329
2330 allow you to check the variance of a @code{varidx} object (use @code{ex_to<varidx>()}
2331 to get the object reference from an expression). There's also the very useful
2332 method
2333
2334 @example
2335 ex varidx::toggle_variance();
2336 @end example
2337
2338 which makes a new index with the same value and dimension but the opposite
2339 variance. By using it you only have to define the index once.
2340
2341 @cindex @code{spinidx} (class)
2342 The @code{spinidx} class provides dotted and undotted variant indices, as
2343 used in the Weyl-van-der-Waerden spinor formalism:
2344
2345 @example
2346     ...
2347     symbol K("K"), C_sym("C"), D_sym("D");
2348     spinidx C(C_sym, 2), D(D_sym);          // default is 2-dimensional,
2349                                             // contravariant, undotted
2350     spinidx C_co(C_sym, 2, true);           // covariant index
2351     spinidx D_dot(D_sym, 2, false, true);   // contravariant, dotted
2352     spinidx D_co_dot(D_sym, 2, true, true); // covariant, dotted
2353
2354     cout << indexed(K, C, D) << endl;
2355      // -> K~C~D
2356     cout << indexed(K, C_co, D_dot) << endl;
2357      // -> K.C~*D
2358     cout << indexed(K, D_co_dot, D) << endl;
2359      // -> K.*D~D
2360     ...
2361 @end example
2362
2363 A @code{spinidx} is a @code{varidx} with an additional flag that marks it as
2364 dotted or undotted. The default is undotted but this can be overridden by
2365 supplying a fourth argument to the @code{spinidx} constructor. The two
2366 methods
2367
2368 @example
2369 bool spinidx::is_dotted();
2370 bool spinidx::is_undotted();
2371 @end example
2372
2373 allow you to check whether or not a @code{spinidx} object is dotted (use
2374 @code{ex_to<spinidx>()} to get the object reference from an expression).
2375 Finally, the two methods
2376
2377 @example
2378 ex spinidx::toggle_dot();
2379 ex spinidx::toggle_variance_dot();
2380 @end example
2381
2382 create a new index with the same value and dimension but opposite dottedness
2383 and the same or opposite variance.
2384
2385 @subsection Substituting indices
2386
2387 @cindex @code{subs()}
2388 Sometimes you will want to substitute one symbolic index with another
2389 symbolic or numeric index, for example when calculating one specific element
2390 of a tensor expression. This is done with the @code{.subs()} method, as it
2391 is done for symbols (see @ref{Substituting Expressions}).
2392
2393 You have two possibilities here. You can either substitute the whole index
2394 by another index or expression:
2395
2396 @example
2397     ...
2398     ex e = indexed(A, mu_co);
2399     cout << e << " becomes " << e.subs(mu_co == nu) << endl;
2400      // -> A.mu becomes A~nu
2401     cout << e << " becomes " << e.subs(mu_co == varidx(0, 4)) << endl;
2402      // -> A.mu becomes A~0
2403     cout << e << " becomes " << e.subs(mu_co == 0) << endl;
2404      // -> A.mu becomes A.0
2405     ...
2406 @end example
2407
2408 The third example shows that trying to replace an index with something that
2409 is not an index will substitute the index value instead.
2410
2411 Alternatively, you can substitute the @emph{symbol} of a symbolic index by
2412 another expression:
2413
2414 @example
2415     ...
2416     ex e = indexed(A, mu_co);
2417     cout << e << " becomes " << e.subs(mu_sym == nu_sym) << endl;
2418      // -> A.mu becomes A.nu
2419     cout << e << " becomes " << e.subs(mu_sym == 0) << endl;
2420      // -> A.mu becomes A.0
2421     ...
2422 @end example
2423
2424 As you see, with the second method only the value of the index will get
2425 substituted. Its other properties, including its dimension, remain unchanged.
2426 If you want to change the dimension of an index you have to substitute the
2427 whole index by another one with the new dimension.
2428
2429 Finally, substituting the base expression of an indexed object works as
2430 expected:
2431
2432 @example
2433     ...
2434     ex e = indexed(A, mu_co);
2435     cout << e << " becomes " << e.subs(A == A+B) << endl;
2436      // -> A.mu becomes (B+A).mu
2437     ...
2438 @end example
2439
2440 @subsection Symmetries
2441 @cindex @code{symmetry} (class)
2442 @cindex @code{sy_none()}
2443 @cindex @code{sy_symm()}
2444 @cindex @code{sy_anti()}
2445 @cindex @code{sy_cycl()}
2446
2447 Indexed objects can have certain symmetry properties with respect to their
2448 indices. Symmetries are specified as a tree of objects of class @code{symmetry}
2449 that is constructed with the helper functions
2450
2451 @example
2452 symmetry sy_none(...);
2453 symmetry sy_symm(...);
2454 symmetry sy_anti(...);
2455 symmetry sy_cycl(...);
2456 @end example
2457
2458 @code{sy_none()} stands for no symmetry, @code{sy_symm()} and @code{sy_anti()}
2459 specify fully symmetric or antisymmetric, respectively, and @code{sy_cycl()}
2460 represents a cyclic symmetry. Each of these functions accepts up to four
2461 arguments which can be either symmetry objects themselves or unsigned integer
2462 numbers that represent an index position (counting from 0). A symmetry
2463 specification that consists of only a single @code{sy_symm()}, @code{sy_anti()}
2464 or @code{sy_cycl()} with no arguments specifies the respective symmetry for
2465 all indices.
2466
2467 Here are some examples of symmetry definitions:
2468
2469 @example
2470     ...
2471     // No symmetry:
2472     e = indexed(A, i, j);
2473     e = indexed(A, sy_none(), i, j);     // equivalent
2474     e = indexed(A, sy_none(0, 1), i, j); // equivalent
2475
2476     // Symmetric in all three indices:
2477     e = indexed(A, sy_symm(), i, j, k);
2478     e = indexed(A, sy_symm(0, 1, 2), i, j, k); // equivalent
2479     e = indexed(A, sy_symm(2, 0, 1), i, j, k); // same symmetry, but yields a
2480                                                // different canonical order
2481
2482     // Symmetric in the first two indices only:
2483     e = indexed(A, sy_symm(0, 1), i, j, k);
2484     e = indexed(A, sy_none(sy_symm(0, 1), 2), i, j, k); // equivalent
2485
2486     // Antisymmetric in the first and last index only (index ranges need not
2487     // be contiguous):
2488     e = indexed(A, sy_anti(0, 2), i, j, k);
2489     e = indexed(A, sy_none(sy_anti(0, 2), 1), i, j, k); // equivalent
2490
2491     // An example of a mixed symmetry: antisymmetric in the first two and
2492     // last two indices, symmetric when swapping the first and last index
2493     // pairs (like the Riemann curvature tensor):
2494     e = indexed(A, sy_symm(sy_anti(0, 1), sy_anti(2, 3)), i, j, k, l);
2495
2496     // Cyclic symmetry in all three indices:
2497     e = indexed(A, sy_cycl(), i, j, k);
2498     e = indexed(A, sy_cycl(0, 1, 2), i, j, k); // equivalent
2499
2500     // The following examples are invalid constructions that will throw
2501     // an exception at run time.
2502
2503     // An index may not appear multiple times:
2504     e = indexed(A, sy_symm(0, 0, 1), i, j, k); // ERROR
2505     e = indexed(A, sy_none(sy_symm(0, 1), sy_anti(0, 2)), i, j, k); // ERROR
2506
2507     // Every child of sy_symm(), sy_anti() and sy_cycl() must refer to the
2508     // same number of indices:
2509     e = indexed(A, sy_symm(sy_anti(0, 1), 2), i, j, k); // ERROR
2510
2511     // And of course, you cannot specify indices which are not there:
2512     e = indexed(A, sy_symm(0, 1, 2, 3), i, j, k); // ERROR
2513     ...
2514 @end example
2515
2516 If you need to specify more than four indices, you have to use the
2517 @code{.add()} method of the @code{symmetry} class. For example, to specify
2518 full symmetry in the first six indices you would write
2519 @code{sy_symm(0, 1, 2, 3).add(4).add(5)}.
2520
2521 If an indexed object has a symmetry, GiNaC will automatically bring the
2522 indices into a canonical order which allows for some immediate simplifications:
2523
2524 @example
2525     ...
2526     cout << indexed(A, sy_symm(), i, j)
2527           + indexed(A, sy_symm(), j, i) << endl;
2528      // -> 2*A.j.i
2529     cout << indexed(B, sy_anti(), i, j)
2530           + indexed(B, sy_anti(), j, i) << endl;
2531      // -> 0
2532     cout << indexed(B, sy_anti(), i, j, k)
2533           - indexed(B, sy_anti(), j, k, i) << endl;
2534      // -> 0
2535     ...
2536 @end example
2537
2538 @cindex @code{get_free_indices()}
2539 @cindex dummy index
2540 @subsection Dummy indices
2541
2542 GiNaC treats certain symbolic index pairs as @dfn{dummy indices} meaning
2543 that a summation over the index range is implied. Symbolic indices which are
2544 not dummy indices are called @dfn{free indices}. Numeric indices are neither
2545 dummy nor free indices.
2546
2547 To be recognized as a dummy index pair, the two indices must be of the same
2548 class and their value must be the same single symbol (an index like
2549 @samp{2*n+1} is never a dummy index). If the indices are of class
2550 @code{varidx} they must also be of opposite variance; if they are of class
2551 @code{spinidx} they must be both dotted or both undotted.
2552
2553 The method @code{.get_free_indices()} returns a vector containing the free
2554 indices of an expression. It also checks that the free indices of the terms
2555 of a sum are consistent:
2556
2557 @example
2558 @{
2559     symbol A("A"), B("B"), C("C");
2560
2561     symbol i_sym("i"), j_sym("j"), k_sym("k"), l_sym("l");
2562     idx i(i_sym, 3), j(j_sym, 3), k(k_sym, 3), l(l_sym, 3);
2563
2564     ex e = indexed(A, i, j) * indexed(B, j, k) + indexed(C, k, l, i, l);
2565     cout << exprseq(e.get_free_indices()) << endl;
2566      // -> (.i,.k)
2567      // 'j' and 'l' are dummy indices
2568
2569     symbol mu_sym("mu"), nu_sym("nu"), rho_sym("rho"), sigma_sym("sigma");
2570     varidx mu(mu_sym, 4), nu(nu_sym, 4), rho(rho_sym, 4), sigma(sigma_sym, 4);
2571
2572     e = indexed(A, mu, nu) * indexed(B, nu.toggle_variance(), rho)
2573       + indexed(C, mu, sigma, rho, sigma.toggle_variance());
2574     cout << exprseq(e.get_free_indices()) << endl;
2575      // -> (~mu,~rho)
2576      // 'nu' is a dummy index, but 'sigma' is not
2577
2578     e = indexed(A, mu, mu);
2579     cout << exprseq(e.get_free_indices()) << endl;
2580      // -> (~mu)
2581      // 'mu' is not a dummy index because it appears twice with the same
2582      // variance
2583
2584     e = indexed(A, mu, nu) + 42;
2585     cout << exprseq(e.get_free_indices()) << endl; // ERROR
2586      // this will throw an exception:
2587      // "add::get_free_indices: inconsistent indices in sum"
2588 @}
2589 @end example
2590
2591 @cindex @code{expand_dummy_sum()}
2592 A dummy index summation like 
2593 @tex
2594 $ a_i b^i$
2595 @end tex
2596 @ifnottex
2597 a.i b~i
2598 @end ifnottex
2599 can be expanded for indices with numeric
2600 dimensions (e.g. 3)  into the explicit sum like
2601 @tex
2602 $a_1b^1+a_2b^2+a_3b^3 $.
2603 @end tex
2604 @ifnottex
2605 a.1 b~1 + a.2 b~2 + a.3 b~3.
2606 @end ifnottex
2607 This is performed by the function
2608
2609 @example
2610     ex expand_dummy_sum(const ex & e, bool subs_idx = false);
2611 @end example
2612
2613 which takes an expression @code{e} and returns the expanded sum for all
2614 dummy indices with numeric dimensions. If the parameter @code{subs_idx}
2615 is set to @code{true} then all substitutions are made by @code{idx} class
2616 indices, i.e. without variance. In this case the above sum 
2617 @tex
2618 $ a_i b^i$
2619 @end tex
2620 @ifnottex
2621 a.i b~i
2622 @end ifnottex
2623 will be expanded to
2624 @tex
2625 $a_1b_1+a_2b_2+a_3b_3 $.
2626 @end tex
2627 @ifnottex
2628 a.1 b.1 + a.2 b.2 + a.3 b.3.
2629 @end ifnottex
2630
2631
2632 @cindex @code{simplify_indexed()}
2633 @subsection Simplifying indexed expressions
2634
2635 In addition to the few automatic simplifications that GiNaC performs on
2636 indexed expressions (such as re-ordering the indices of symmetric tensors
2637 and calculating traces and convolutions of matrices and predefined tensors)
2638 there is the method
2639
2640 @example
2641 ex ex::simplify_indexed();
2642 ex ex::simplify_indexed(const scalar_products & sp);
2643 @end example
2644
2645 that performs some more expensive operations:
2646
2647 @itemize
2648 @item it checks the consistency of free indices in sums in the same way
2649   @code{get_free_indices()} does
2650 @item it tries to give dummy indices that appear in different terms of a sum
2651   the same name to allow simplifications like @math{a_i*b_i-a_j*b_j=0}
2652 @item it (symbolically) calculates all possible dummy index summations/contractions
2653   with the predefined tensors (this will be explained in more detail in the
2654   next section)
2655 @item it detects contractions that vanish for symmetry reasons, for example
2656   the contraction of a symmetric and a totally antisymmetric tensor
2657 @item as a special case of dummy index summation, it can replace scalar products
2658   of two tensors with a user-defined value
2659 @end itemize
2660
2661 The last point is done with the help of the @code{scalar_products} class
2662 which is used to store scalar products with known values (this is not an
2663 arithmetic class, you just pass it to @code{simplify_indexed()}):
2664
2665 @example
2666 @{
2667     symbol A("A"), B("B"), C("C"), i_sym("i");
2668     idx i(i_sym, 3);
2669
2670     scalar_products sp;
2671     sp.add(A, B, 0); // A and B are orthogonal
2672     sp.add(A, C, 0); // A and C are orthogonal
2673     sp.add(A, A, 4); // A^2 = 4 (A has length 2)
2674
2675     e = indexed(A + B, i) * indexed(A + C, i);
2676     cout << e << endl;
2677      // -> (B+A).i*(A+C).i
2678
2679     cout << e.expand(expand_options::expand_indexed).simplify_indexed(sp)
2680          << endl;
2681      // -> 4+C.i*B.i
2682 @}
2683 @end example
2684
2685 The @code{scalar_products} object @code{sp} acts as a storage for the
2686 scalar products added to it with the @code{.add()} method. This method
2687 takes three arguments: the two expressions of which the scalar product is
2688 taken, and the expression to replace it with. After @code{sp.add(A, B, 0)},
2689 @code{simplify_indexed()} will replace all scalar products of indexed
2690 objects that have the symbols @code{A} and @code{B} as base expressions
2691 with the single value 0. The number, type and dimension of the indices
2692 don't matter; @samp{A~mu~nu*B.mu.nu} would also be replaced by 0.
2693
2694 @cindex @code{expand()}
2695 The example above also illustrates a feature of the @code{expand()} method:
2696 if passed the @code{expand_indexed} option it will distribute indices
2697 over sums, so @samp{(A+B).i} becomes @samp{A.i+B.i}.
2698
2699 @cindex @code{tensor} (class)
2700 @subsection Predefined tensors
2701
2702 Some frequently used special tensors such as the delta, epsilon and metric
2703 tensors are predefined in GiNaC. They have special properties when
2704 contracted with other tensor expressions and some of them have constant
2705 matrix representations (they will evaluate to a number when numeric
2706 indices are specified).
2707
2708 @cindex @code{delta_tensor()}
2709 @subsubsection Delta tensor
2710
2711 The delta tensor takes two indices, is symmetric and has the matrix
2712 representation @code{diag(1, 1, 1, ...)}. It is constructed by the function
2713 @code{delta_tensor()}:
2714
2715 @example
2716 @{
2717     symbol A("A"), B("B");
2718
2719     idx i(symbol("i"), 3), j(symbol("j"), 3),
2720         k(symbol("k"), 3), l(symbol("l"), 3);
2721
2722     ex e = indexed(A, i, j) * indexed(B, k, l)
2723          * delta_tensor(i, k) * delta_tensor(j, l);
2724     cout << e.simplify_indexed() << endl;
2725      // -> B.i.j*A.i.j
2726
2727     cout << delta_tensor(i, i) << endl;
2728      // -> 3
2729 @}
2730 @end example
2731
2732 @cindex @code{metric_tensor()}
2733 @subsubsection General metric tensor
2734
2735 The function @code{metric_tensor()} creates a general symmetric metric
2736 tensor with two indices that can be used to raise/lower tensor indices. The
2737 metric tensor is denoted as @samp{g} in the output and if its indices are of
2738 mixed variance it is automatically replaced by a delta tensor:
2739
2740 @example
2741 @{
2742     symbol A("A");
2743
2744     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
2745
2746     ex e = metric_tensor(mu, nu) * indexed(A, nu.toggle_variance(), rho);
2747     cout << e.simplify_indexed() << endl;
2748      // -> A~mu~rho
2749
2750     e = delta_tensor(mu, nu.toggle_variance()) * metric_tensor(nu, rho);
2751     cout << e.simplify_indexed() << endl;
2752      // -> g~mu~rho
2753
2754     e = metric_tensor(mu.toggle_variance(), nu.toggle_variance())
2755       * metric_tensor(nu, rho);
2756     cout << e.simplify_indexed() << endl;
2757      // -> delta.mu~rho
2758
2759     e = metric_tensor(nu.toggle_variance(), rho.toggle_variance())
2760       * metric_tensor(mu, nu) * (delta_tensor(mu.toggle_variance(), rho)
2761         + indexed(A, mu.toggle_variance(), rho));
2762     cout << e.simplify_indexed() << endl;
2763      // -> 4+A.rho~rho
2764 @}
2765 @end example
2766
2767 @cindex @code{lorentz_g()}
2768 @subsubsection Minkowski metric tensor
2769
2770 The Minkowski metric tensor is a special metric tensor with a constant
2771 matrix representation which is either @code{diag(1, -1, -1, ...)} (negative
2772 signature, the default) or @code{diag(-1, 1, 1, ...)} (positive signature).
2773 It is created with the function @code{lorentz_g()} (although it is output as
2774 @samp{eta}):
2775
2776 @example
2777 @{
2778     varidx mu(symbol("mu"), 4);
2779
2780     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
2781       * lorentz_g(mu, varidx(0, 4));       // negative signature
2782     cout << e.simplify_indexed() << endl;
2783      // -> 1
2784
2785     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
2786       * lorentz_g(mu, varidx(0, 4), true); // positive signature
2787     cout << e.simplify_indexed() << endl;
2788      // -> -1
2789 @}
2790 @end example
2791
2792 @cindex @code{spinor_metric()}
2793 @subsubsection Spinor metric tensor
2794
2795 The function @code{spinor_metric()} creates an antisymmetric tensor with
2796 two indices that is used to raise/lower indices of 2-component spinors.
2797 It is output as @samp{eps}:
2798
2799 @example
2800 @{
2801     symbol psi("psi");
2802
2803     spinidx A(symbol("A")), B(symbol("B")), C(symbol("C"));
2804     ex A_co = A.toggle_variance(), B_co = B.toggle_variance();
2805
2806     e = spinor_metric(A, B) * indexed(psi, B_co);
2807     cout << e.simplify_indexed() << endl;
2808      // -> psi~A
2809
2810     e = spinor_metric(A, B) * indexed(psi, A_co);
2811     cout << e.simplify_indexed() << endl;
2812      // -> -psi~B
2813
2814     e = spinor_metric(A_co, B_co) * indexed(psi, B);
2815     cout << e.simplify_indexed() << endl;
2816      // -> -psi.A
2817
2818     e = spinor_metric(A_co, B_co) * indexed(psi, A);
2819     cout << e.simplify_indexed() << endl;
2820      // -> psi.B
2821
2822     e = spinor_metric(A_co, B_co) * spinor_metric(A, B);
2823     cout << e.simplify_indexed() << endl;
2824      // -> 2
2825
2826     e = spinor_metric(A_co, B_co) * spinor_metric(B, C);
2827     cout << e.simplify_indexed() << endl;
2828      // -> -delta.A~C
2829 @}
2830 @end example
2831
2832 The matrix representation of the spinor metric is @code{[[0, 1], [-1, 0]]}.
2833
2834 @cindex @code{epsilon_tensor()}
2835 @cindex @code{lorentz_eps()}
2836 @subsubsection Epsilon tensor
2837
2838 The epsilon tensor is totally antisymmetric, its number of indices is equal
2839 to the dimension of the index space (the indices must all be of the same
2840 numeric dimension), and @samp{eps.1.2.3...} (resp. @samp{eps~0~1~2...}) is
2841 defined to be 1. Its behavior with indices that have a variance also
2842 depends on the signature of the metric. Epsilon tensors are output as
2843 @samp{eps}.
2844
2845 There are three functions defined to create epsilon tensors in 2, 3 and 4
2846 dimensions:
2847
2848 @example
2849 ex epsilon_tensor(const ex & i1, const ex & i2);
2850 ex epsilon_tensor(const ex & i1, const ex & i2, const ex & i3);
2851 ex lorentz_eps(const ex & i1, const ex & i2, const ex & i3, const ex & i4,
2852                bool pos_sig = false);
2853 @end example
2854
2855 The first two functions create an epsilon tensor in 2 or 3 Euclidean
2856 dimensions, the last function creates an epsilon tensor in a 4-dimensional
2857 Minkowski space (the last @code{bool} argument specifies whether the metric
2858 has negative or positive signature, as in the case of the Minkowski metric
2859 tensor):
2860
2861 @example
2862 @{
2863     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4),
2864            sig(symbol("sig"), 4), lam(symbol("lam"), 4), bet(symbol("bet"), 4);
2865     e = lorentz_eps(mu, nu, rho, sig) *
2866         lorentz_eps(mu.toggle_variance(), nu.toggle_variance(), lam, bet);
2867     cout << simplify_indexed(e) << endl;
2868      // -> 2*eta~bet~rho*eta~sig~lam-2*eta~sig~bet*eta~rho~lam
2869
2870     idx i(symbol("i"), 3), j(symbol("j"), 3), k(symbol("k"), 3);
2871     symbol A("A"), B("B");
2872     e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(B, k);
2873     cout << simplify_indexed(e) << endl;
2874      // -> -B.k*A.j*eps.i.k.j
2875     e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(A, k);
2876     cout << simplify_indexed(e) << endl;
2877      // -> 0
2878 @}
2879 @end example
2880
2881 @subsection Linear algebra
2882
2883 The @code{matrix} class can be used with indices to do some simple linear
2884 algebra (linear combinations and products of vectors and matrices, traces
2885 and scalar products):
2886
2887 @example
2888 @{
2889     idx i(symbol("i"), 2), j(symbol("j"), 2);
2890     symbol x("x"), y("y");
2891
2892     // A is a 2x2 matrix, X is a 2x1 vector
2893     matrix A(2, 2), X(2, 1);
2894     A = 1, 2,
2895         3, 4;
2896     X = x, y;
2897
2898     cout << indexed(A, i, i) << endl;
2899      // -> 5
2900
2901     ex e = indexed(A, i, j) * indexed(X, j);
2902     cout << e.simplify_indexed() << endl;
2903      // -> [[2*y+x],[4*y+3*x]].i
2904
2905     e = indexed(A, i, j) * indexed(X, i) + indexed(X, j) * 2;
2906     cout << e.simplify_indexed() << endl;
2907      // -> [[3*y+3*x,6*y+2*x]].j
2908 @}
2909 @end example
2910
2911 You can of course obtain the same results with the @code{matrix::add()},
2912 @code{matrix::mul()} and @code{matrix::trace()} methods (@pxref{Matrices})
2913 but with indices you don't have to worry about transposing matrices.
2914
2915 Matrix indices always start at 0 and their dimension must match the number
2916 of rows/columns of the matrix. Matrices with one row or one column are
2917 vectors and can have one or two indices (it doesn't matter whether it's a
2918 row or a column vector). Other matrices must have two indices.
2919
2920 You should be careful when using indices with variance on matrices. GiNaC
2921 doesn't look at the variance and doesn't know that @samp{F~mu~nu} and
2922 @samp{F.mu.nu} are different matrices. In this case you should use only
2923 one form for @samp{F} and explicitly multiply it with a matrix representation
2924 of the metric tensor.
2925
2926
2927 @node Non-commutative objects, Hash Maps, Indexed objects, Basic Concepts
2928 @c    node-name, next, previous, up
2929 @section Non-commutative objects
2930
2931 GiNaC is equipped to handle certain non-commutative algebras. Three classes of
2932 non-commutative objects are built-in which are mostly of use in high energy
2933 physics:
2934
2935 @itemize
2936 @item Clifford (Dirac) algebra (class @code{clifford})
2937 @item su(3) Lie algebra (class @code{color})
2938 @item Matrices (unindexed) (class @code{matrix})
2939 @end itemize
2940
2941 The @code{clifford} and @code{color} classes are subclasses of
2942 @code{indexed} because the elements of these algebras usually carry
2943 indices. The @code{matrix} class is described in more detail in
2944 @ref{Matrices}.
2945
2946 Unlike most computer algebra systems, GiNaC does not primarily provide an
2947 operator (often denoted @samp{&*}) for representing inert products of
2948 arbitrary objects. Rather, non-commutativity in GiNaC is a property of the
2949 classes of objects involved, and non-commutative products are formed with
2950 the usual @samp{*} operator, as are ordinary products. GiNaC is capable of
2951 figuring out by itself which objects commutate and will group the factors
2952 by their class. Consider this example:
2953
2954 @example
2955     ...
2956     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
2957     idx a(symbol("a"), 8), b(symbol("b"), 8);
2958     ex e = -dirac_gamma(mu) * (2*color_T(a)) * 8 * color_T(b) * dirac_gamma(nu);
2959     cout << e << endl;
2960      // -> -16*(gamma~mu*gamma~nu)*(T.a*T.b)
2961     ...
2962 @end example
2963
2964 As can be seen, GiNaC pulls out the overall commutative factor @samp{-16} and
2965 groups the non-commutative factors (the gammas and the su(3) generators)
2966 together while preserving the order of factors within each class (because
2967 Clifford objects commutate with color objects). The resulting expression is a
2968 @emph{commutative} product with two factors that are themselves non-commutative
2969 products (@samp{gamma~mu*gamma~nu} and @samp{T.a*T.b}). For clarification,
2970 parentheses are placed around the non-commutative products in the output.
2971
2972 @cindex @code{ncmul} (class)
2973 Non-commutative products are internally represented by objects of the class
2974 @code{ncmul}, as opposed to commutative products which are handled by the
2975 @code{mul} class. You will normally not have to worry about this distinction,
2976 though.
2977
2978 The advantage of this approach is that you never have to worry about using
2979 (or forgetting to use) a special operator when constructing non-commutative
2980 expressions. Also, non-commutative products in GiNaC are more intelligent
2981 than in other computer algebra systems; they can, for example, automatically
2982 canonicalize themselves according to rules specified in the implementation
2983 of the non-commutative classes. The drawback is that to work with other than
2984 the built-in algebras you have to implement new classes yourself. Symbols
2985 always commutate and it's not possible to construct non-commutative products
2986 using symbols to represent the algebra elements or generators. User-defined
2987 functions can, however, be specified as being non-commutative.
2988
2989 @cindex @code{return_type()}
2990 @cindex @code{return_type_tinfo()}
2991 Information about the commutativity of an object or expression can be
2992 obtained with the two member functions
2993
2994 @example
2995 unsigned ex::return_type() const;
2996 unsigned ex::return_type_tinfo() const;
2997 @end example
2998
2999 The @code{return_type()} function returns one of three values (defined in
3000 the header file @file{flags.h}), corresponding to three categories of
3001 expressions in GiNaC:
3002
3003 @itemize
3004 @item @code{return_types::commutative}: Commutates with everything. Most GiNaC
3005   classes are of this kind.
3006 @item @code{return_types::noncommutative}: Non-commutative, belonging to a
3007   certain class of non-commutative objects which can be determined with the
3008   @code{return_type_tinfo()} method. Expressions of this category commutate
3009   with everything except @code{noncommutative} expressions of the same
3010   class.
3011 @item @code{return_types::noncommutative_composite}: Non-commutative, composed
3012   of non-commutative objects of different classes. Expressions of this
3013   category don't commutate with any other @code{noncommutative} or
3014   @code{noncommutative_composite} expressions.
3015 @end itemize
3016
3017 The value returned by the @code{return_type_tinfo()} method is valid only
3018 when the return type of the expression is @code{noncommutative}. It is a
3019 value that is unique to the class of the object and usually one of the
3020 constants in @file{tinfos.h}, or derived therefrom.
3021
3022 Here are a couple of examples:
3023
3024 @cartouche
3025 @multitable @columnfractions 0.33 0.33 0.34
3026 @item @strong{Expression} @tab @strong{@code{return_type()}} @tab @strong{@code{return_type_tinfo()}}
3027 @item @code{42} @tab @code{commutative} @tab -
3028 @item @code{2*x-y} @tab @code{commutative} @tab -
3029 @item @code{dirac_ONE()} @tab @code{noncommutative} @tab @code{TINFO_clifford}
3030 @item @code{dirac_gamma(mu)*dirac_gamma(nu)} @tab @code{noncommutative} @tab @code{TINFO_clifford}
3031 @item @code{2*color_T(a)} @tab @code{noncommutative} @tab @code{TINFO_color}
3032 @item @code{dirac_ONE()*color_T(a)} @tab @code{noncommutative_composite} @tab -
3033 @end multitable
3034 @end cartouche
3035
3036 Note: the @code{return_type_tinfo()} of Clifford objects is only equal to
3037 @code{TINFO_clifford} for objects with a representation label of zero.
3038 Other representation labels yield a different @code{return_type_tinfo()},
3039 but it's the same for any two objects with the same label. This is also true
3040 for color objects.
3041
3042 A last note: With the exception of matrices, positive integer powers of
3043 non-commutative objects are automatically expanded in GiNaC. For example,
3044 @code{pow(a*b, 2)} becomes @samp{a*b*a*b} if @samp{a} and @samp{b} are
3045 non-commutative expressions).
3046
3047
3048 @cindex @code{clifford} (class)
3049 @subsection Clifford algebra
3050
3051
3052 Clifford algebras are supported in two flavours: Dirac gamma
3053 matrices (more physical) and generic Clifford algebras (more
3054 mathematical). 
3055
3056 @cindex @code{dirac_gamma()}
3057 @subsubsection Dirac gamma matrices
3058 Dirac gamma matrices (note that GiNaC doesn't treat them
3059 as matrices) are designated as @samp{gamma~mu} and satisfy
3060 @samp{gamma~mu*gamma~nu + gamma~nu*gamma~mu = 2*eta~mu~nu} where
3061 @samp{eta~mu~nu} is the Minkowski metric tensor. Dirac gammas are
3062 constructed by the function
3063
3064 @example
3065 ex dirac_gamma(const ex & mu, unsigned char rl = 0);
3066 @end example
3067
3068 which takes two arguments: the index and a @dfn{representation label} in the
3069 range 0 to 255 which is used to distinguish elements of different Clifford
3070 algebras (this is also called a @dfn{spin line index}). Gammas with different
3071 labels commutate with each other. The dimension of the index can be 4 or (in
3072 the framework of dimensional regularization) any symbolic value. Spinor
3073 indices on Dirac gammas are not supported in GiNaC.
3074
3075 @cindex @code{dirac_ONE()}
3076 The unity element of a Clifford algebra is constructed by
3077
3078 @example
3079 ex dirac_ONE(unsigned char rl = 0);
3080 @end example
3081
3082 @strong{Please notice:} You must always use @code{dirac_ONE()} when referring to
3083 multiples of the unity element, even though it's customary to omit it.
3084 E.g. instead of @code{dirac_gamma(mu)*(dirac_slash(q,4)+m)} you have to
3085 write @code{dirac_gamma(mu)*(dirac_slash(q,4)+m*dirac_ONE())}. Otherwise,
3086 GiNaC will complain and/or produce incorrect results.
3087
3088 @cindex @code{dirac_gamma5()}
3089 There is a special element @samp{gamma5} that commutates with all other
3090 gammas, has a unit square, and in 4 dimensions equals
3091 @samp{gamma~0 gamma~1 gamma~2 gamma~3}, provided by
3092
3093 @example
3094 ex dirac_gamma5(unsigned char rl = 0);
3095 @end example
3096
3097 @cindex @code{dirac_gammaL()}
3098 @cindex @code{dirac_gammaR()}
3099 The chiral projectors @samp{(1+/-gamma5)/2} are also available as proper
3100 objects, constructed by
3101
3102 @example
3103 ex dirac_gammaL(unsigned char rl = 0);
3104 ex dirac_gammaR(unsigned char rl = 0);
3105 @end example
3106
3107 They observe the relations @samp{gammaL^2 = gammaL}, @samp{gammaR^2 = gammaR},
3108 and @samp{gammaL gammaR = gammaR gammaL = 0}.
3109
3110 @cindex @code{dirac_slash()}
3111 Finally, the function
3112
3113 @example
3114 ex dirac_slash(const ex & e, const ex & dim, unsigned char rl = 0);
3115 @end example
3116
3117 creates a term that represents a contraction of @samp{e} with the Dirac
3118 Lorentz vector (it behaves like a term of the form @samp{e.mu gamma~mu}
3119 with a unique index whose dimension is given by the @code{dim} argument).
3120 Such slashed expressions are printed with a trailing backslash, e.g. @samp{e\}.
3121
3122 In products of dirac gammas, superfluous unity elements are automatically
3123 removed, squares are replaced by their values, and @samp{gamma5}, @samp{gammaL}
3124 and @samp{gammaR} are moved to the front.
3125
3126 The @code{simplify_indexed()} function performs contractions in gamma strings,
3127 for example
3128
3129 @example
3130 @{
3131     ...
3132     symbol a("a"), b("b"), D("D");
3133     varidx mu(symbol("mu"), D);
3134     ex e = dirac_gamma(mu) * dirac_slash(a, D)
3135          * dirac_gamma(mu.toggle_variance());
3136     cout << e << endl;
3137      // -> gamma~mu*a\*gamma.mu
3138     e = e.simplify_indexed();
3139     cout << e << endl;
3140      // -> -D*a\+2*a\
3141     cout << e.subs(D == 4) << endl;
3142      // -> -2*a\
3143     ...
3144 @}
3145 @end example
3146
3147 @cindex @code{dirac_trace()}
3148 To calculate the trace of an expression containing strings of Dirac gammas
3149 you use one of the functions
3150
3151 @example
3152 ex dirac_trace(const ex & e, const std::set<unsigned char> & rls,
3153                const ex & trONE = 4);
3154 ex dirac_trace(const ex & e, const lst & rll, const ex & trONE = 4);
3155 ex dirac_trace(const ex & e, unsigned char rl = 0, const ex & trONE = 4);
3156 @end example
3157
3158 These functions take the trace over all gammas in the specified set @code{rls}
3159 or list @code{rll} of representation labels, or the single label @code{rl};
3160 gammas with other labels are left standing. The last argument to
3161 @code{dirac_trace()} is the value to be returned for the trace of the unity
3162 element, which defaults to 4.
3163
3164 The @code{dirac_trace()} function is a linear functional that is equal to the
3165 ordinary matrix trace only in @math{D = 4} dimensions. In particular, the
3166 functional is not cyclic in
3167 @tex $D \ne 4$
3168 @end tex
3169 dimensions when acting on
3170 expressions containing @samp{gamma5}, so it's not a proper trace. This
3171 @samp{gamma5} scheme is described in greater detail in
3172 @cite{The Role of gamma5 in Dimensional Regularization}.
3173
3174 The value of the trace itself is also usually different in 4 and in
3175 @tex $D \ne 4$
3176 @end tex
3177 dimensions:
3178
3179 @example
3180 @{
3181     // 4 dimensions
3182     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
3183     ex e = dirac_gamma(mu) * dirac_gamma(nu) *
3184            dirac_gamma(mu.toggle_variance()) * dirac_gamma(rho);
3185     cout << dirac_trace(e).simplify_indexed() << endl;
3186      // -> -8*eta~rho~nu
3187 @}
3188 ...
3189 @{
3190     // D dimensions
3191     symbol D("D");
3192     varidx mu(symbol("mu"), D), nu(symbol("nu"), D), rho(symbol("rho"), D);
3193     ex e = dirac_gamma(mu) * dirac_gamma(nu) *
3194            dirac_gamma(mu.toggle_variance()) * dirac_gamma(rho);
3195     cout << dirac_trace(e).simplify_indexed() << endl;
3196      // -> 8*eta~rho~nu-4*eta~rho~nu*D
3197 @}
3198 @end example
3199
3200 Here is an example for using @code{dirac_trace()} to compute a value that
3201 appears in the calculation of the one-loop vacuum polarization amplitude in
3202 QED:
3203
3204 @example
3205 @{
3206     symbol q("q"), l("l"), m("m"), ldotq("ldotq"), D("D");
3207     varidx mu(symbol("mu"), D), nu(symbol("nu"), D);
3208
3209     scalar_products sp;
3210     sp.add(l, l, pow(l, 2));
3211     sp.add(l, q, ldotq);
3212
3213     ex e = dirac_gamma(mu) *
3214            (dirac_slash(l, D) + dirac_slash(q, D) + m * dirac_ONE()) *    
3215            dirac_gamma(mu.toggle_variance()) *
3216            (dirac_slash(l, D) + m * dirac_ONE());   
3217     e = dirac_trace(e).simplify_indexed(sp);
3218     e = e.collect(lst(l, ldotq, m));
3219     cout << e << endl;
3220      // -> (8-4*D)*l^2+(8-4*D)*ldotq+4*D*m^2
3221 @}
3222 @end example
3223
3224 The @code{canonicalize_clifford()} function reorders all gamma products that
3225 appear in an expression to a canonical (but not necessarily simple) form.
3226 You can use this to compare two expressions or for further simplifications:
3227
3228 @example
3229 @{
3230     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
3231     ex e = dirac_gamma(mu) * dirac_gamma(nu) + dirac_gamma(nu) * dirac_gamma(mu);
3232     cout << e << endl;
3233      // -> gamma~mu*gamma~nu+gamma~nu*gamma~mu
3234
3235     e = canonicalize_clifford(e);
3236     cout << e << endl;
3237      // -> 2*ONE*eta~mu~nu
3238 @}
3239 @end example
3240
3241 @cindex @code{clifford_unit()}
3242 @subsubsection A generic Clifford algebra
3243
3244 A generic Clifford algebra, i.e. a
3245 @tex
3246 $2^n$
3247 @end tex
3248 dimensional algebra with
3249 generators 
3250 @tex $e_k$
3251 @end tex 
3252 satisfying the identities 
3253 @tex
3254 $e_i e_j + e_j e_i = M(i, j) + M(j, i) $
3255 @end tex
3256 @ifnottex
3257 e~i e~j + e~j e~i = M(i, j) + M(j, i) 
3258 @end ifnottex
3259 for some bilinear form (@code{metric})
3260 @math{M(i, j)}, which may be non-symmetric (see arXiv:math.QA/9911180) 
3261 and contain symbolic entries. Such generators are created by the
3262 function 
3263
3264 @example
3265     ex clifford_unit(const ex & mu, const ex & metr, unsigned char rl = 0, 
3266                                 bool anticommuting = false);    
3267 @end example
3268
3269 where @code{mu} should be a @code{varidx} class object indexing the
3270 generators, an index @code{mu} with a numeric value may be of type
3271 @code{idx} as well.
3272 Parameter @code{metr} defines the metric @math{M(i, j)} and can be
3273 represented by a square @code{matrix}, @code{tensormetric} or @code{indexed} class
3274 object. Optional parameter @code{rl} allows to distinguish different
3275 Clifford algebras, which will commute with each other. The last
3276 optional parameter @code{anticommuting} defines if the anticommuting
3277 assumption (i.e.
3278 @tex
3279 $e_i e_j + e_j e_i = 0$)
3280 @end tex
3281 @ifnottex
3282 e~i e~j + e~j e~i = 0)
3283 @end ifnottex
3284 will be used for contraction of Clifford units. If the @code{metric} is
3285 supplied by a @code{matrix} object, then the value of
3286 @code{anticommuting} is calculated automatically and the supplied one
3287 will be ignored. One can overcome this by giving @code{metric} through
3288 matrix wrapped into an @code{indexed} object.
3289
3290 Note that the call @code{clifford_unit(mu, minkmetric())} creates
3291 something very close to @code{dirac_gamma(mu)}, although
3292 @code{dirac_gamma} have more efficient simplification mechanism. 
3293 @cindex @code{clifford::get_metric()}
3294 The method @code{clifford::get_metric()} returns a metric defining this
3295 Clifford number.
3296 @cindex @code{clifford::is_anticommuting()}
3297 The method @code{clifford::is_anticommuting()} returns the
3298 @code{anticommuting} property of a unit.
3299
3300 If the matrix @math{M(i, j)} is in fact symmetric you may prefer to create
3301 the Clifford algebra units with a call like that
3302
3303 @example
3304     ex e = clifford_unit(mu, indexed(M, sy_symm(), i, j));
3305 @end example
3306
3307 since this may yield some further automatic simplifications. Again, for a
3308 metric defined through a @code{matrix} such a symmetry is detected
3309 automatically. 
3310
3311 Individual generators of a Clifford algebra can be accessed in several
3312 ways. For example 
3313
3314 @example
3315 @{
3316     ... 
3317     varidx nu(symbol("nu"), 4);
3318     realsymbol s("s");
3319     ex M = diag_matrix(lst(1, -1, 0, s));
3320     ex e = clifford_unit(nu, M);
3321     ex e0 = e.subs(nu == 0);
3322     ex e1 = e.subs(nu == 1);
3323     ex e2 = e.subs(nu == 2);
3324     ex e3 = e.subs(nu == 3);
3325     ...
3326 @}
3327 @end example
3328
3329 will produce four anti-commuting generators of a Clifford algebra with properties
3330 @tex
3331 $e_0^2=1 $, $e_1^2=-1$,  $e_2^2=0$ and $e_3^2=s$.
3332 @end tex
3333 @ifnottex
3334 @code{pow(e0, 2) = 1}, @code{pow(e1, 2) = -1}, @code{pow(e2, 2) = 0} and
3335 @code{pow(e3, 2) = s}.
3336 @end ifnottex
3337
3338 @cindex @code{lst_to_clifford()}
3339 A similar effect can be achieved from the function
3340
3341 @example
3342     ex lst_to_clifford(const ex & v, const ex & mu,  const ex & metr,
3343                        unsigned char rl = 0, bool anticommuting = false);
3344     ex lst_to_clifford(const ex & v, const ex & e);
3345 @end example
3346
3347 which converts a list or vector 
3348 @tex
3349 $v = (v^0, v^1, ..., v^n)$
3350 @end tex
3351 @ifnottex
3352 @samp{v = (v~0, v~1, ..., v~n)} 
3353 @end ifnottex
3354 into the
3355 Clifford number 
3356 @tex
3357 $v^0 e_0 + v^1 e_1 + ... + v^n e_n$
3358 @end tex
3359 @ifnottex
3360 @samp{v~0 e.0 + v~1 e.1 + ... + v~n e.n}
3361 @end ifnottex
3362 with @samp{e.k}
3363 directly supplied in the second form of the procedure. In the first form
3364 the Clifford unit @samp{e.k} is generated by the call of
3365 @code{clifford_unit(mu, metr, rl, anticommuting)}. The previous code may be rewritten
3366 with the help of @code{lst_to_clifford()} as follows
3367
3368 @example
3369 @{
3370     ...
3371     varidx nu(symbol("nu"), 4);
3372     realsymbol s("s");
3373     ex M = diag_matrix(lst(1, -1, 0, s));
3374     ex e0 = lst_to_clifford(lst(1, 0, 0, 0), nu, M);
3375     ex e1 = lst_to_clifford(lst(0, 1, 0, 0), nu, M);
3376     ex e2 = lst_to_clifford(lst(0, 0, 1, 0), nu, M);
3377     ex e3 = lst_to_clifford(lst(0, 0, 0, 1), nu, M);
3378   ...
3379 @}
3380 @end example
3381
3382 @cindex @code{clifford_to_lst()}
3383 There is the inverse function 
3384
3385 @example
3386     lst clifford_to_lst(const ex & e, const ex & c, bool algebraic = true);
3387 @end example
3388
3389 which takes an expression @code{e} and tries to find a list
3390 @tex
3391 $v = (v^0, v^1, ..., v^n)$
3392 @end tex
3393 @ifnottex
3394 @samp{v = (v~0, v~1, ..., v~n)} 
3395 @end ifnottex
3396 such that 
3397 @tex
3398 $e = v^0 c_0 + v^1 c_1 + ... + v^n c_n$
3399 @end tex
3400 @ifnottex
3401 @samp{e = v~0 c.0 + v~1 c.1 + ... + v~n c.n}
3402 @end ifnottex
3403 with respect to the given Clifford units @code{c} and with none of the
3404 @samp{v~k} containing Clifford units @code{c} (of course, this
3405 may be impossible). This function can use an @code{algebraic} method
3406 (default) or a symbolic one. With the @code{algebraic} method the @samp{v~k} are calculated as
3407 @tex
3408 $(e c_k + c_k e)/c_k^2$. If $c_k^2$
3409 @end tex
3410 @ifnottex
3411 @samp{(e c.k + c.k e)/pow(c.k, 2)}.   If @samp{pow(c.k, 2)} 
3412 @end ifnottex
3413 is zero or is not @code{numeric} for some @samp{k}
3414 then the method will be automatically changed to symbolic. The same effect
3415 is obtained by the assignment (@code{algebraic = false}) in the procedure call.
3416
3417 @cindex @code{clifford_prime()}
3418 @cindex @code{clifford_star()}
3419 @cindex @code{clifford_bar()}
3420 There are several functions for (anti-)automorphisms of Clifford algebras:
3421
3422 @example
3423     ex clifford_prime(const ex & e)
3424     inline ex clifford_star(const ex & e) @{ return e.conjugate(); @}
3425     inline ex clifford_bar(const ex & e) @{ return clifford_prime(e.conjugate()); @}
3426 @end example
3427
3428 The automorphism of a Clifford algebra @code{clifford_prime()} simply
3429 changes signs of all Clifford units in the expression. The reversion
3430 of a Clifford algebra @code{clifford_star()} coincides with the
3431 @code{conjugate()} method and effectively reverses the order of Clifford
3432 units in any product. Finally the main anti-automorphism
3433 of a Clifford algebra @code{clifford_bar()} is the composition of the
3434 previous two, i.e. it makes the reversion and changes signs of all Clifford units
3435 in a product. These functions correspond to the notations
3436 @math{e'},
3437 @tex
3438 $e^*$
3439 @end tex
3440 @ifnottex
3441 e*
3442 @end ifnottex
3443 and
3444 @tex
3445 $\overline{e}$
3446 @end tex
3447 @ifnottex
3448 @code{\bar@{e@}}
3449 @end ifnottex
3450 used in Clifford algebra textbooks.
3451
3452 @cindex @code{clifford_norm()}
3453 The function
3454
3455 @example
3456     ex clifford_norm(const ex & e);
3457 @end example
3458
3459 @cindex @code{clifford_inverse()}
3460 calculates the norm of a Clifford number from the expression
3461 @tex
3462 $||e||^2 = e\overline{e}$.
3463 @end tex
3464 @ifnottex
3465 @code{||e||^2 = e \bar@{e@}}
3466 @end ifnottex
3467  The inverse of a Clifford expression is returned by the function
3468
3469 @example
3470     ex clifford_inverse(const ex & e);
3471 @end example
3472
3473 which calculates it as 
3474 @tex
3475 $e^{-1} = \overline{e}/||e||^2$.
3476 @end tex
3477 @ifnottex
3478 @math{e^@{-1@} = \bar@{e@}/||e||^2}
3479 @end ifnottex
3480  If
3481 @tex
3482 $||e|| = 0$
3483 @end tex
3484 @ifnottex
3485 @math{||e||=0}
3486 @end ifnottex
3487 then an exception is raised.
3488
3489 @cindex @code{remove_dirac_ONE()}
3490 If a Clifford number happens to be a factor of
3491 @code{dirac_ONE()} then we can convert it to a ``real'' (non-Clifford)
3492 expression by the function
3493
3494 @example
3495     ex remove_dirac_ONE(const ex & e);
3496 @end example
3497
3498 @cindex @code{canonicalize_clifford()}
3499 The function @code{canonicalize_clifford()} works for a
3500 generic Clifford algebra in a similar way as for Dirac gammas.
3501
3502 The next provided function is
3503
3504 @cindex @code{clifford_moebius_map()}
3505 @example
3506     ex clifford_moebius_map(const ex & a, const ex & b, const ex & c,
3507                             const ex & d, const ex & v, const ex & G,
3508                             unsigned char rl = 0, bool anticommuting = false);
3509     ex clifford_moebius_map(const ex & M, const ex & v, const ex & G,
3510                             unsigned char rl = 0, bool anticommuting = false);
3511 @end example 
3512
3513 It takes a list or vector @code{v} and makes the Moebius (conformal or
3514 linear-fractional) transformation @samp{v -> (av+b)/(cv+d)} defined by
3515 the matrix @samp{M = [[a, b], [c, d]]}. The parameter @code{G} defines
3516 the metric of the surrounding (pseudo-)Euclidean space. This can be an
3517 indexed object, tensormetric, matrix or a Clifford unit, in the later
3518 case the optional parameters @code{rl} and @code{anticommuting} are ignored
3519 even if supplied.  The returned value of this function is a list of
3520 components of the resulting vector.
3521
3522 @cindex @code{clifford_max_label()}
3523 Finally the function
3524
3525 @example
3526 char clifford_max_label(const ex & e, bool ignore_ONE = false);
3527 @end example
3528
3529 can detect a presence of Clifford objects in the expression @code{e}: if
3530 such objects are found it returns the maximal
3531 @code{representation_label} of them, otherwise @code{-1}. The optional
3532 parameter @code{ignore_ONE} indicates if @code{dirac_ONE} objects should
3533 be ignored during the search.
3534  
3535 LaTeX output for Clifford units looks like
3536 @code{\clifford[1]@{e@}^@{@{\nu@}@}}, where @code{1} is the
3537 @code{representation_label} and @code{\nu} is the index of the
3538 corresponding unit. This provides a flexible typesetting with a suitable
3539 defintion of the @code{\clifford} command. For example, the definition
3540 @example
3541     \newcommand@{\clifford@}[1][]@{@}
3542 @end example
3543 typesets all Clifford units identically, while the alternative definition
3544 @example
3545     \newcommand@{\clifford@}[2][]@{\ifcase #1 #2\or \tilde@{#2@} \or \breve@{#2@} \fi@}
3546 @end example
3547 prints units with @code{representation_label=0} as 
3548 @tex
3549 $e$,
3550 @end tex
3551 @ifnottex
3552 @code{e},
3553 @end ifnottex
3554 with @code{representation_label=1} as 
3555 @tex
3556 $\tilde{e}$
3557 @end tex
3558 @ifnottex
3559 @code{\tilde@{e@}}
3560 @end ifnottex
3561  and with @code{representation_label=2} as 
3562 @tex
3563 $\breve{e}$.
3564 @end tex
3565 @ifnottex
3566 @code{\breve@{e@}}.
3567 @end ifnottex
3568
3569 @cindex @code{color} (class)
3570 @subsection Color algebra
3571
3572 @cindex @code{color_T()}
3573 For computations in quantum chromodynamics, GiNaC implements the base elements
3574 and structure constants of the su(3) Lie algebra (color algebra). The base
3575 elements @math{T_a} are constructed by the function
3576
3577 @example
3578 ex color_T(const ex & a, unsigned char rl = 0);
3579 @end example
3580
3581 which takes two arguments: the index and a @dfn{representation label} in the
3582 range 0 to 255 which is used to distinguish elements of different color
3583 algebras. Objects with different labels commutate with each other. The
3584 dimension of the index must be exactly 8 and it should be of class @code{idx},
3585 not @code{varidx}.
3586
3587 @cindex @code{color_ONE()}
3588 The unity element of a color algebra is constructed by
3589
3590 @example
3591 ex color_ONE(unsigned char rl = 0);
3592 @end example
3593
3594 @strong{Please notice:} You must always use @code{color_ONE()} when referring to
3595 multiples of the unity element, even though it's customary to omit it.
3596 E.g. instead of @code{color_T(a)*(color_T(b)*indexed(X,b)+1)} you have to
3597 write @code{color_T(a)*(color_T(b)*indexed(X,b)+color_ONE())}. Otherwise,
3598 GiNaC may produce incorrect results.
3599
3600 @cindex @code{color_d()}
3601 @cindex @code{color_f()}
3602 The functions
3603
3604 @example
3605 ex color_d(const ex & a, const ex & b, const ex & c);
3606 ex color_f(const ex & a, const ex & b, const ex & c);
3607 @end example
3608
3609 create the symmetric and antisymmetric structure constants @math{d_abc} and
3610 @math{f_abc} which satisfy @math{@{T_a, T_b@} = 1/3 delta_ab + d_abc T_c}
3611 and @math{[T_a, T_b] = i f_abc T_c}.
3612
3613 These functions evaluate to their numerical values,
3614 if you supply numeric indices to them. The index values should be in
3615 the range from 1 to 8, not from 0 to 7. This departure from usual conventions
3616 goes along better with the notations used in physical literature.
3617
3618 @cindex @code{color_h()}
3619 There's an additional function
3620
3621 @example
3622 ex color_h(const ex & a, const ex & b, const ex & c);
3623 @end example
3624
3625 which returns the linear combination @samp{color_d(a, b, c)+I*color_f(a, b, c)}.
3626
3627 The function @code{simplify_indexed()} performs some simplifications on
3628 expressions containing color objects:
3629
3630 @example
3631 @{
3632     ...
3633     idx a(symbol("a"), 8), b(symbol("b"), 8), c(symbol("c"), 8),
3634         k(symbol("k"), 8), l(symbol("l"), 8);
3635
3636     e = color_d(a, b, l) * color_f(a, b, k);
3637     cout << e.simplify_indexed() << endl;
3638      // -> 0
3639
3640     e = color_d(a, b, l) * color_d(a, b, k);
3641     cout << e.simplify_indexed() << endl;
3642      // -> 5/3*delta.k.l
3643
3644     e = color_f(l, a, b) * color_f(a, b, k);
3645     cout << e.simplify_indexed() << endl;
3646      // -> 3*delta.k.l
3647
3648     e = color_h(a, b, c) * color_h(a, b, c);
3649     cout << e.simplify_indexed() << endl;
3650      // -> -32/3
3651
3652     e = color_h(a, b, c) * color_T(b) * color_T(c);
3653     cout << e.simplify_indexed() << endl;
3654      // -> -2/3*T.a
3655
3656     e = color_h(a, b, c) * color_T(a) * color_T(b) * color_T(c);
3657     cout << e.simplify_indexed() << endl;
3658      // -> -8/9*ONE
3659
3660     e = color_T(k) * color_T(a) * color_T(b) * color_T(k);
3661     cout << e.simplify_indexed() << endl;
3662      // -> 1/4*delta.b.a*ONE-1/6*T.a*T.b
3663     ...
3664 @end example
3665
3666 @cindex @code{color_trace()}
3667 To calculate the trace of an expression containing color objects you use one
3668 of the functions
3669
3670 @example
3671 ex color_trace(const ex & e, const std::set<unsigned char> & rls);
3672 ex color_trace(const ex & e, const lst & rll);
3673 ex color_trace(const ex & e, unsigned char rl = 0);
3674 @end example
3675
3676 These functions take the trace over all color @samp{T} objects in the
3677 specified set @code{rls} or list @code{rll} of representation labels, or the
3678 single label @code{rl}; @samp{T}s with other labels are left standing. For
3679 example:
3680
3681 @example
3682     ...
3683     e = color_trace(4 * color_T(a) * color_T(b) * color_T(c));
3684     cout << e << endl;
3685      // -> -I*f.a.c.b+d.a.c.b
3686 @}
3687 @end example
3688
3689
3690 @node Hash Maps, Methods and Functions, Non-commutative objects, Basic Concepts
3691 @c    node-name, next, previous, up
3692 @section Hash Maps
3693 @cindex hash maps
3694 @cindex @code{exhashmap} (class)
3695
3696 For your convenience, GiNaC offers the container template @code{exhashmap<T>}
3697 that can be used as a drop-in replacement for the STL
3698 @code{std::map<ex, T, ex_is_less>}, using hash tables to provide faster,
3699 typically constant-time, element look-up than @code{map<>}.
3700
3701 @code{exhashmap<>} supports all @code{map<>} members and operations, with the
3702 following differences:
3703
3704 @itemize @bullet
3705 @item
3706 no @code{lower_bound()} and @code{upper_bound()} methods
3707 @item
3708 no reverse iterators, no @code{rbegin()}/@code{rend()}
3709 @item 
3710 no @code{operator<(exhashmap, exhashmap)}
3711 @item
3712 the comparison function object @code{key_compare} is hardcoded to
3713 @code{ex_is_less}
3714 @item
3715 the constructor @code{exhashmap(size_t n)} allows specifying the minimum
3716 initial hash table size (the actual table size after construction may be
3717 larger than the specified value)
3718 @item
3719 the method @code{size_t bucket_count()} returns the current size of the hash
3720 table
3721 @item 
3722 @code{insert()} and @code{erase()} operations invalidate all iterators
3723 @end itemize
3724
3725
3726 @node Methods and Functions, Information About Expressions, Hash Maps, Top
3727 @c    node-name, next, previous, up
3728 @chapter Methods and Functions
3729 @cindex polynomial
3730
3731 In this chapter the most important algorithms provided by GiNaC will be
3732 described.  Some of them are implemented as functions on expressions,
3733 others are implemented as methods provided by expression objects.  If
3734 they are methods, there exists a wrapper function around it, so you can
3735 alternatively call it in a functional way as shown in the simple
3736 example:
3737
3738 @example
3739     ...
3740     cout << "As method:   " << sin(1).evalf() << endl;
3741     cout << "As function: " << evalf(sin(1)) << endl;
3742     ...
3743 @end example
3744
3745 @cindex @code{subs()}
3746 The general rule is that wherever