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