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