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