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