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