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