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