02d9e508a34b5b94d33f39162e4eaa1f6d45bf97
[ginac.git] / doc / tutorial / ginac.texi
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename ginac.info
4 @settitle GiNaC, an open framework for symbolic computation within the C++ programming language
5 @setchapternewpage on
6 @afourpaper
7 @c For `info' only.
8 @paragraphindent 0
9 @c For TeX only.
10 @iftex
11 @c I hate putting "@noindent" in front of every paragraph.
12 @parindent=0pt
13 @end iftex
14 @c %**end of header
15
16 @include version.texi
17
18 @direntry
19 * ginac: (ginac).                   C++ library for symbolic computation.
20 @end direntry
21
22 @ifinfo
23 This is a tutorial that documents GiNaC @value{VERSION}, an open
24 framework for symbolic computation within the C++ programming language.
25
26 Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
27
28 Permission is granted to make and distribute verbatim copies of
29 this manual provided the copyright notice and this permission notice
30 are preserved on all copies.
31
32 @ignore
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission
35 notice identical to this one except for the removal of this paragraph
36
37 @end ignore
38 Permission is granted to copy and distribute modified versions of this
39 manual under the conditions for verbatim copying, provided that the entire
40 resulting derived work is distributed under the terms of a permission
41 notice identical to this one.
42 @end ifinfo
43
44 @finalout
45 @c finalout prevents ugly black rectangles on overfull hbox lines
46 @titlepage
47 @title GiNaC @value{VERSION}
48 @subtitle An open framework for symbolic computation within the C++ programming language
49 @subtitle @value{UPDATED}
50 @author The GiNaC Group:
51 @author Christian Bauer, Alexander Frink, Richard Kreckel, Jens Vollinga
52
53 @page
54 @vskip 0pt plus 1filll
55 Copyright @copyright{} 1999-2005 Johannes Gutenberg University Mainz, Germany
56 @sp 2
57 Permission is granted to make and distribute verbatim copies of
58 this manual provided the copyright notice and this permission notice
59 are preserved on all copies.
60
61 Permission is granted to copy and distribute modified versions of this
62 manual under the conditions for verbatim copying, provided that the entire
63 resulting derived work is distributed under the terms of a permission
64 notice identical to this one.
65 @end titlepage
66
67 @page
68 @contents
69
70 @page
71
72
73 @node Top, Introduction, (dir), (dir)
74 @c    node-name, next, previous, up
75 @top GiNaC
76
77 This is a tutorial that documents GiNaC @value{VERSION}, an open
78 framework for symbolic computation within the C++ programming language.
79
80 @menu
81 * Introduction::                 GiNaC's purpose.
82 * A Tour of GiNaC::              A quick tour of the library.
83 * Installation::                 How to install the package.
84 * Basic Concepts::               Description of fundamental classes.
85 * Methods and Functions::        Algorithms for symbolic manipulations.
86 * Extending GiNaC::              How to extend the library.
87 * A Comparison With Other CAS::  Compares GiNaC to traditional CAS.
88 * Internal Structures::          Description of some internal structures.
89 * Package Tools::                Configuring packages to work with GiNaC.
90 * Bibliography::
91 * Concept Index::
92 @end menu
93
94
95 @node Introduction, A Tour of GiNaC, Top, Top
96 @c    node-name, next, previous, up
97 @chapter Introduction
98 @cindex history of GiNaC
99
100 The motivation behind GiNaC derives from the observation that most
101 present day computer algebra systems (CAS) are linguistically and
102 semantically impoverished.  Although they are quite powerful tools for
103 learning math and solving particular problems they lack modern
104 linguistic structures that allow for the creation of large-scale
105 projects.  GiNaC is an attempt to overcome this situation by extending a
106 well established and standardized computer language (C++) by some
107 fundamental symbolic capabilities, thus allowing for integrated systems
108 that embed symbolic manipulations together with more established areas
109 of computer science (like computation-intense numeric applications,
110 graphical interfaces, etc.) under one roof.
111
112 The particular problem that led to the writing of the GiNaC framework is
113 still a very active field of research, namely the calculation of higher
114 order corrections to elementary particle interactions.  There,
115 theoretical physicists are interested in matching present day theories
116 against experiments taking place at particle accelerators.  The
117 computations involved are so complex they call for a combined symbolical
118 and numerical approach.  This turned out to be quite difficult to
119 accomplish with the present day CAS we have worked with so far and so we
120 tried to fill the gap by writing GiNaC.  But of course its applications
121 are in no way restricted to theoretical physics.
122
123 This tutorial is intended for the novice user who is new to GiNaC but
124 already has some background in C++ programming.  However, since a
125 hand-made documentation like this one is difficult to keep in sync with
126 the development, the actual documentation is inside the sources in the
127 form of comments.  That documentation may be parsed by one of the many
128 Javadoc-like documentation systems.  If you fail at generating it you
129 may access it from @uref{http://www.ginac.de/reference/, the GiNaC home
130 page}.  It is an invaluable resource not only for the advanced user who
131 wishes to extend the system (or chase bugs) but for everybody who wants
132 to comprehend the inner workings of GiNaC.  This little tutorial on the
133 other hand only covers the basic things that are unlikely to change in
134 the near future.
135
136 @section License
137 The GiNaC framework for symbolic computation within the C++ programming
138 language is Copyright @copyright{} 1999-2005 Johannes Gutenberg
139 University Mainz, Germany.
140
141 This program is free software; you can redistribute it and/or
142 modify it under the terms of the GNU General Public License as
143 published by the Free Software Foundation; either version 2 of the
144 License, or (at your option) any later version.
145
146 This program is distributed in the hope that it will be useful, but
147 WITHOUT ANY WARRANTY; without even the implied warranty of
148 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
149 General Public License for more details.
150
151 You should have received a copy of the GNU General Public License
152 along with this program; see the file COPYING.  If not, write to the
153 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
154 MA 02110-1301, USA.
155
156
157 @node A Tour of GiNaC, How to use it from within C++, Introduction, Top
158 @c    node-name, next, previous, up
159 @chapter A Tour of GiNaC
160
161 This quick tour of GiNaC wants to arise your interest in the
162 subsequent chapters by showing off a bit.  Please excuse us if it
163 leaves many open questions.
164
165 @menu
166 * How to use it from within C++::  Two simple examples.
167 * What it can do for you::         A Tour of GiNaC's features.
168 @end menu
169
170
171 @node How to use it from within C++, What it can do for you, A Tour of GiNaC, A Tour of GiNaC
172 @c    node-name, next, previous, up
173 @section How to use it from within C++
174
175 The GiNaC open framework for symbolic computation within the C++ programming
176 language does not try to define a language of its own as conventional
177 CAS do.  Instead, it extends the capabilities of C++ by symbolic
178 manipulations.  Here is how to generate and print a simple (and rather
179 pointless) bivariate polynomial with some large coefficients:
180
181 @example
182 #include <iostream>
183 #include <ginac/ginac.h>
184 using namespace std;
185 using namespace GiNaC;
186
187 int main()
188 @{
189     symbol x("x"), y("y");
190     ex poly;
191
192     for (int i=0; i<3; ++i)
193         poly += factorial(i+16)*pow(x,i)*pow(y,2-i);
194
195     cout << poly << endl;
196     return 0;
197 @}
198 @end example
199
200 Assuming the file is called @file{hello.cc}, on our system we can compile
201 and run it like this:
202
203 @example
204 $ c++ hello.cc -o hello -lcln -lginac
205 $ ./hello
206 355687428096000*x*y+20922789888000*y^2+6402373705728000*x^2
207 @end example
208
209 (@xref{Package Tools}, for tools that help you when creating a software
210 package that uses GiNaC.)
211
212 @cindex Hermite polynomial
213 Next, there is a more meaningful C++ program that calls a function which
214 generates Hermite polynomials in a specified free variable.
215
216 @example
217 #include <iostream>
218 #include <ginac/ginac.h>
219 using namespace std;
220 using namespace GiNaC;
221
222 ex HermitePoly(const symbol & x, int n)
223 @{
224     ex HKer=exp(-pow(x, 2));
225     // uses the identity H_n(x) == (-1)^n exp(x^2) (d/dx)^n exp(-x^2)
226     return normal(pow(-1, n) * diff(HKer, x, n) / HKer);
227 @}
228
229 int main()
230 @{
231     symbol z("z");
232
233     for (int i=0; i<6; ++i)
234         cout << "H_" << i << "(z) == " << HermitePoly(z,i) << endl;
235
236     return 0;
237 @}
238 @end example
239
240 When run, this will type out
241
242 @example
243 H_0(z) == 1
244 H_1(z) == 2*z
245 H_2(z) == 4*z^2-2
246 H_3(z) == -12*z+8*z^3
247 H_4(z) == -48*z^2+16*z^4+12
248 H_5(z) == 120*z-160*z^3+32*z^5
249 @end example
250
251 This method of generating the coefficients is of course far from optimal
252 for production purposes.
253
254 In order to show some more examples of what GiNaC can do we will now use
255 the @command{ginsh}, a simple GiNaC interactive shell that provides a
256 convenient window into GiNaC's capabilities.
257
258
259 @node What it can do for you, Installation, How to use it from within C++, A Tour of GiNaC
260 @c    node-name, next, previous, up
261 @section What it can do for you
262
263 @cindex @command{ginsh}
264 After invoking @command{ginsh} one can test and experiment with GiNaC's
265 features much like in other Computer Algebra Systems except that it does
266 not provide programming constructs like loops or conditionals.  For a
267 concise description of the @command{ginsh} syntax we refer to its
268 accompanied man page. Suffice to say that assignments and comparisons in
269 @command{ginsh} are written as they are in C, i.e. @code{=} assigns and
270 @code{==} compares.
271
272 It can manipulate arbitrary precision integers in a very fast way.
273 Rational numbers are automatically converted to fractions of coprime
274 integers:
275
276 @example
277 > x=3^150;
278 369988485035126972924700782451696644186473100389722973815184405301748249
279 > y=3^149;
280 123329495011708990974900260817232214728824366796574324605061468433916083
281 > x/y;
282 3
283 > y/x;
284 1/3
285 @end example
286
287 Exact numbers are always retained as exact numbers and only evaluated as
288 floating point numbers if requested.  For instance, with numeric
289 radicals is dealt pretty much as with symbols.  Products of sums of them
290 can be expanded:
291
292 @example
293 > expand((1+a^(1/5)-a^(2/5))^3);
294 1+3*a+3*a^(1/5)-5*a^(3/5)-a^(6/5)
295 > expand((1+3^(1/5)-3^(2/5))^3);
296 10-5*3^(3/5)
297 > evalf((1+3^(1/5)-3^(2/5))^3);
298 0.33408977534118624228
299 @end example
300
301 The function @code{evalf} that was used above converts any number in
302 GiNaC's expressions into floating point numbers.  This can be done to
303 arbitrary predefined accuracy:
304
305 @example
306 > evalf(1/7);
307 0.14285714285714285714
308 > Digits=150;
309 150
310 > evalf(1/7);
311 0.1428571428571428571428571428571428571428571428571428571428571428571428
312 5714285714285714285714285714285714285
313 @end example
314
315 Exact numbers other than rationals that can be manipulated in GiNaC
316 include predefined constants like Archimedes' @code{Pi}.  They can both
317 be used in symbolic manipulations (as an exact number) as well as in
318 numeric expressions (as an inexact number):
319
320 @example
321 > a=Pi^2+x;
322 x+Pi^2
323 > evalf(a);
324 9.869604401089358619+x
325 > x=2;
326 2
327 > evalf(a);
328 11.869604401089358619
329 @end example
330
331 Built-in functions evaluate immediately to exact numbers if
332 this is possible.  Conversions that can be safely performed are done
333 immediately; conversions that are not generally valid are not done:
334
335 @example
336 > cos(42*Pi);
337 1
338 > cos(acos(x));
339 x
340 > acos(cos(x));
341 acos(cos(x))
342 @end example
343
344 (Note that converting the last input to @code{x} would allow one to
345 conclude that @code{42*Pi} is equal to @code{0}.)
346
347 Linear equation systems can be solved along with basic linear
348 algebra manipulations over symbolic expressions.  In C++ GiNaC offers
349 a matrix class for this purpose but we can see what it can do using
350 @command{ginsh}'s bracket notation to type them in:
351
352 @example
353 > lsolve(a+x*y==z,x);
354 y^(-1)*(z-a);
355 > lsolve(@{3*x+5*y == 7, -2*x+10*y == -5@}, @{x, y@});
356 @{x==19/8,y==-1/40@}
357 > M = [ [1, 3], [-3, 2] ];
358 [[1,3],[-3,2]]
359 > determinant(M);
360 11
361 > charpoly(M,lambda);
362 lambda^2-3*lambda+11
363 > A = [ [1, 1], [2, -1] ];
364 [[1,1],[2,-1]]
365 > A+2*M;
366 [[1,1],[2,-1]]+2*[[1,3],[-3,2]]
367 > evalm(%);
368 [[3,7],[-4,3]]
369 > B = [ [0, 0, a], [b, 1, -b], [-1/a, 0, 0] ];
370 > evalm(B^(2^12345));
371 [[1,0,0],[0,1,0],[0,0,1]]
372 @end example
373
374 Multivariate polynomials and rational functions may be expanded,
375 collected and normalized (i.e. converted to a ratio of two coprime 
376 polynomials):
377
378 @example
379 > a = x^4 + 2*x^2*y^2 + 4*x^3*y + 12*x*y^3 - 3*y^4;
380 12*x*y^3+2*x^2*y^2+4*x^3*y-3*y^4+x^4
381 > b = x^2 + 4*x*y - y^2;
382 4*x*y-y^2+x^2
383 > expand(a*b);
384 8*x^5*y+17*x^4*y^2+43*x^2*y^4-24*x*y^5+16*x^3*y^3+3*y^6+x^6
385 > collect(a+b,x);
386 4*x^3*y-y^2-3*y^4+(12*y^3+4*y)*x+x^4+x^2*(1+2*y^2)
387 > collect(a+b,y);
388 12*x*y^3-3*y^4+(-1+2*x^2)*y^2+(4*x+4*x^3)*y+x^2+x^4
389 > normal(a/b);
390 3*y^2+x^2
391 @end example
392
393 You can differentiate functions and expand them as Taylor or Laurent
394 series in a very natural syntax (the second argument of @code{series} is
395 a relation defining the evaluation point, the third specifies the
396 order):
397
398 @cindex Zeta function
399 @example
400 > diff(tan(x),x);
401 tan(x)^2+1
402 > series(sin(x),x==0,4);
403 x-1/6*x^3+Order(x^4)
404 > series(1/tan(x),x==0,4);
405 x^(-1)-1/3*x+Order(x^2)
406 > series(tgamma(x),x==0,3);
407 x^(-1)-Euler+(1/12*Pi^2+1/2*Euler^2)*x+
408 (-1/3*zeta(3)-1/12*Pi^2*Euler-1/6*Euler^3)*x^2+Order(x^3)
409 > evalf(%);
410 x^(-1)-0.5772156649015328606+(0.9890559953279725555)*x
411 -(0.90747907608088628905)*x^2+Order(x^3)
412 > series(tgamma(2*sin(x)-2),x==Pi/2,6);
413 -(x-1/2*Pi)^(-2)+(-1/12*Pi^2-1/2*Euler^2-1/240)*(x-1/2*Pi)^2
414 -Euler-1/12+Order((x-1/2*Pi)^3)
415 @end example
416
417 Here we have made use of the @command{ginsh}-command @code{%} to pop the
418 previously evaluated element from @command{ginsh}'s internal stack.
419
420 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,
1947                    const string & tex_base_name);
1948 @end example
1949
1950 @code{diag_matrix()} constructs a diagonal matrix given the list of diagonal
1951 elements. @code{unit_matrix()} creates an @samp{x} by @samp{x} (or @samp{r}
1952 by @samp{c}) unit matrix. And finally, @code{symbolic_matrix} constructs a
1953 matrix filled with newly generated symbols made of the specified base name
1954 and the position of each element in the matrix.
1955
1956 Matrix elements can be accessed and set using the parenthesis (function call)
1957 operator:
1958
1959 @example
1960 const ex & matrix::operator()(unsigned r, unsigned c) const;
1961 ex & matrix::operator()(unsigned r, unsigned c);
1962 @end example
1963
1964 It is also possible to access the matrix elements in a linear fashion with
1965 the @code{op()} method. But C++-style subscripting with square brackets
1966 @samp{[]} is not available.
1967
1968 Here are a couple of examples for constructing matrices:
1969
1970 @example
1971 @{
1972     symbol a("a"), b("b");
1973
1974     matrix M(2, 2);
1975     M = a, 0,
1976         0, b;
1977     cout << M << endl;
1978      // -> [[a,0],[0,b]]
1979
1980     matrix M2(2, 2);
1981     M2(0, 0) = a;
1982     M2(1, 1) = b;
1983     cout << M2 << endl;
1984      // -> [[a,0],[0,b]]
1985
1986     cout << matrix(2, 2, lst(a, 0, 0, b)) << endl;
1987      // -> [[a,0],[0,b]]
1988
1989     cout << lst_to_matrix(lst(lst(a, 0), lst(0, b))) << endl;
1990      // -> [[a,0],[0,b]]
1991
1992     cout << diag_matrix(lst(a, b)) << endl;
1993      // -> [[a,0],[0,b]]
1994
1995     cout << unit_matrix(3) << endl;
1996      // -> [[1,0,0],[0,1,0],[0,0,1]]
1997
1998     cout << symbolic_matrix(2, 3, "x") << endl;
1999      // -> [[x00,x01,x02],[x10,x11,x12]]
2000 @}
2001 @end example
2002
2003 @cindex @code{transpose()}
2004 There are three ways to do arithmetic with matrices. The first (and most
2005 direct one) is to use the methods provided by the @code{matrix} class:
2006
2007 @example
2008 matrix matrix::add(const matrix & other) const;
2009 matrix matrix::sub(const matrix & other) const;
2010 matrix matrix::mul(const matrix & other) const;
2011 matrix matrix::mul_scalar(const ex & other) const;
2012 matrix matrix::pow(const ex & expn) const;
2013 matrix matrix::transpose() const;
2014 @end example
2015
2016 All of these methods return the result as a new matrix object. Here is an
2017 example that calculates @math{A*B-2*C} for three matrices @math{A}, @math{B}
2018 and @math{C}:
2019
2020 @example
2021 @{
2022     matrix A(2, 2), B(2, 2), C(2, 2);
2023     A =  1, 2,
2024          3, 4;
2025     B = -1, 0,
2026          2, 1;
2027     C =  8, 4,
2028          2, 1;
2029
2030     matrix result = A.mul(B).sub(C.mul_scalar(2));
2031     cout << result << endl;
2032      // -> [[-13,-6],[1,2]]
2033     ...
2034 @}
2035 @end example
2036
2037 @cindex @code{evalm()}
2038 The second (and probably the most natural) way is to construct an expression
2039 containing matrices with the usual arithmetic operators and @code{pow()}.
2040 For efficiency reasons, expressions with sums, products and powers of
2041 matrices are not automatically evaluated in GiNaC. You have to call the
2042 method
2043
2044 @example
2045 ex ex::evalm() const;
2046 @end example
2047
2048 to obtain the result:
2049
2050 @example
2051 @{
2052     ...
2053     ex e = A*B - 2*C;
2054     cout << e << endl;
2055      // -> [[1,2],[3,4]]*[[-1,0],[2,1]]-2*[[8,4],[2,1]]
2056     cout << e.evalm() << endl;
2057      // -> [[-13,-6],[1,2]]
2058     ...
2059 @}
2060 @end example
2061
2062 The non-commutativity of the product @code{A*B} in this example is
2063 automatically recognized by GiNaC. There is no need to use a special
2064 operator here. @xref{Non-commutative objects}, for more information about
2065 dealing with non-commutative expressions.
2066
2067 Finally, you can work with indexed matrices and call @code{simplify_indexed()}
2068 to perform the arithmetic:
2069
2070 @example
2071 @{
2072     ...
2073     idx i(symbol("i"), 2), j(symbol("j"), 2), k(symbol("k"), 2);
2074     e = indexed(A, i, k) * indexed(B, k, j) - 2 * indexed(C, i, j);
2075     cout << e << endl;
2076      // -> -2*[[8,4],[2,1]].i.j+[[-1,0],[2,1]].k.j*[[1,2],[3,4]].i.k
2077     cout << e.simplify_indexed() << endl;
2078      // -> [[-13,-6],[1,2]].i.j
2079 @}
2080 @end example
2081
2082 Using indices is most useful when working with rectangular matrices and
2083 one-dimensional vectors because you don't have to worry about having to
2084 transpose matrices before multiplying them. @xref{Indexed objects}, for
2085 more information about using matrices with indices, and about indices in
2086 general.
2087
2088 The @code{matrix} class provides a couple of additional methods for
2089 computing determinants, traces, characteristic polynomials and ranks:
2090
2091 @cindex @code{determinant()}
2092 @cindex @code{trace()}
2093 @cindex @code{charpoly()}
2094 @cindex @code{rank()}
2095 @example
2096 ex matrix::determinant(unsigned algo=determinant_algo::automatic) const;
2097 ex matrix::trace() const;
2098 ex matrix::charpoly(const ex & lambda) const;
2099 unsigned matrix::rank() const;
2100 @end example
2101
2102 The @samp{algo} argument of @code{determinant()} allows to select
2103 between different algorithms for calculating the determinant.  The
2104 asymptotic speed (as parametrized by the matrix size) can greatly differ
2105 between those algorithms, depending on the nature of the matrix'
2106 entries.  The possible values are defined in the @file{flags.h} header
2107 file.  By default, GiNaC uses a heuristic to automatically select an
2108 algorithm that is likely (but not guaranteed) to give the result most
2109 quickly.
2110
2111 @cindex @code{inverse()} (matrix)
2112 @cindex @code{solve()}
2113 Matrices may also be inverted using the @code{ex matrix::inverse()}
2114 method and linear systems may be solved with:
2115
2116 @example
2117 matrix matrix::solve(const matrix & vars, const matrix & rhs,
2118                      unsigned algo=solve_algo::automatic) const;
2119 @end example
2120
2121 Assuming the matrix object this method is applied on is an @code{m}
2122 times @code{n} matrix, then @code{vars} must be a @code{n} times
2123 @code{p} matrix of symbolic indeterminates and @code{rhs} a @code{m}
2124 times @code{p} matrix.  The returned matrix then has dimension @code{n}
2125 times @code{p} and in the case of an underdetermined system will still
2126 contain some of the indeterminates from @code{vars}.  If the system is
2127 overdetermined, an exception is thrown.
2128
2129
2130 @node Indexed objects, Non-commutative objects, Matrices, Basic Concepts
2131 @c    node-name, next, previous, up
2132 @section Indexed objects
2133
2134 GiNaC allows you to handle expressions containing general indexed objects in
2135 arbitrary spaces. It is also able to canonicalize and simplify such
2136 expressions and perform symbolic dummy index summations. There are a number
2137 of predefined indexed objects provided, like delta and metric tensors.
2138
2139 There are few restrictions placed on indexed objects and their indices and
2140 it is easy to construct nonsense expressions, but our intention is to
2141 provide a general framework that allows you to implement algorithms with
2142 indexed quantities, getting in the way as little as possible.
2143
2144 @cindex @code{idx} (class)
2145 @cindex @code{indexed} (class)
2146 @subsection Indexed quantities and their indices
2147
2148 Indexed expressions in GiNaC are constructed of two special types of objects,
2149 @dfn{index objects} and @dfn{indexed objects}.
2150
2151 @itemize @bullet
2152
2153 @cindex contravariant
2154 @cindex covariant
2155 @cindex variance
2156 @item Index objects are of class @code{idx} or a subclass. Every index has
2157 a @dfn{value} and a @dfn{dimension} (which is the dimension of the space
2158 the index lives in) which can both be arbitrary expressions but are usually
2159 a number or a simple symbol. In addition, indices of class @code{varidx} have
2160 a @dfn{variance} (they can be co- or contravariant), and indices of class
2161 @code{spinidx} have a variance and can be @dfn{dotted} or @dfn{undotted}.
2162
2163 @item Indexed objects are of class @code{indexed} or a subclass. They
2164 contain a @dfn{base expression} (which is the expression being indexed), and
2165 one or more indices.
2166
2167 @end itemize
2168
2169 @strong{Please notice:} when printing expressions, covariant indices and indices
2170 without variance are denoted @samp{.i} while contravariant indices are
2171 denoted @samp{~i}. Dotted indices have a @samp{*} in front of the index
2172 value. In the following, we are going to use that notation in the text so
2173 instead of @math{A^i_jk} we will write @samp{A~i.j.k}. Index dimensions are
2174 not visible in the output.
2175
2176 A simple example shall illustrate the concepts:
2177
2178 @example
2179 #include <iostream>
2180 #include <ginac/ginac.h>
2181 using namespace std;
2182 using namespace GiNaC;
2183
2184 int main()
2185 @{
2186     symbol i_sym("i"), j_sym("j");
2187     idx i(i_sym, 3), j(j_sym, 3);
2188
2189     symbol A("A");
2190     cout << indexed(A, i, j) << endl;
2191      // -> A.i.j
2192     cout << index_dimensions << indexed(A, i, j) << endl;
2193      // -> A.i[3].j[3]
2194     cout << dflt; // reset cout to default output format (dimensions hidden)
2195     ...
2196 @end example
2197
2198 The @code{idx} constructor takes two arguments, the index value and the
2199 index dimension. First we define two index objects, @code{i} and @code{j},
2200 both with the numeric dimension 3. The value of the index @code{i} is the
2201 symbol @code{i_sym} (which prints as @samp{i}) and the value of the index
2202 @code{j} is the symbol @code{j_sym} (which prints as @samp{j}). Next we
2203 construct an expression containing one indexed object, @samp{A.i.j}. It has
2204 the symbol @code{A} as its base expression and the two indices @code{i} and
2205 @code{j}.
2206
2207 The dimensions of indices are normally not visible in the output, but one
2208 can request them to be printed with the @code{index_dimensions} manipulator,
2209 as shown above.
2210
2211 Note the difference between the indices @code{i} and @code{j} which are of
2212 class @code{idx}, and the index values which are the symbols @code{i_sym}
2213 and @code{j_sym}. The indices of indexed objects cannot directly be symbols
2214 or numbers but must be index objects. For example, the following is not
2215 correct and will raise an exception:
2216
2217 @example
2218 symbol i("i"), j("j");
2219 e = indexed(A, i, j); // ERROR: indices must be of type idx
2220 @end example
2221
2222 You can have multiple indexed objects in an expression, index values can
2223 be numeric, and index dimensions symbolic:
2224
2225 @example
2226     ...
2227     symbol B("B"), dim("dim");
2228     cout << 4 * indexed(A, i)
2229           + indexed(B, idx(j_sym, 4), idx(2, 3), idx(i_sym, dim)) << endl;
2230      // -> B.j.2.i+4*A.i
2231     ...
2232 @end example
2233
2234 @code{B} has a 4-dimensional symbolic index @samp{k}, a 3-dimensional numeric
2235 index of value 2, and a symbolic index @samp{i} with the symbolic dimension
2236 @samp{dim}. Note that GiNaC doesn't automatically notify you that the free
2237 indices of @samp{A} and @samp{B} in the sum don't match (you have to call
2238 @code{simplify_indexed()} for that, see below).
2239
2240 In fact, base expressions, index values and index dimensions can be
2241 arbitrary expressions:
2242
2243 @example
2244     ...
2245     cout << indexed(A+B, idx(2*i_sym+1, dim/2)) << endl;
2246      // -> (B+A).(1+2*i)
2247     ...
2248 @end example
2249
2250 It's also possible to construct nonsense like @samp{Pi.sin(x)}. You will not
2251 get an error message from this but you will probably not be able to do
2252 anything useful with it.
2253
2254 @cindex @code{get_value()}
2255 @cindex @code{get_dimension()}
2256 The methods
2257
2258 @example
2259 ex idx::get_value();
2260 ex idx::get_dimension();
2261 @end example
2262
2263 return the value and dimension of an @code{idx} object. If you have an index
2264 in an expression, such as returned by calling @code{.op()} on an indexed
2265 object, you can get a reference to the @code{idx} object with the function
2266 @code{ex_to<idx>()} on the expression.
2267
2268 There are also the methods
2269
2270 @example
2271 bool idx::is_numeric();
2272 bool idx::is_symbolic();
2273 bool idx::is_dim_numeric();
2274 bool idx::is_dim_symbolic();
2275 @end example
2276
2277 for checking whether the value and dimension are numeric or symbolic
2278 (non-numeric). Using the @code{info()} method of an index (see @ref{Information
2279 About Expressions}) returns information about the index value.
2280
2281 @cindex @code{varidx} (class)
2282 If you need co- and contravariant indices, use the @code{varidx} class:
2283
2284 @example
2285     ...
2286     symbol mu_sym("mu"), nu_sym("nu");
2287     varidx mu(mu_sym, 4), nu(nu_sym, 4); // default is contravariant ~mu, ~nu
2288     varidx mu_co(mu_sym, 4, true);       // covariant index .mu
2289
2290     cout << indexed(A, mu, nu) << endl;
2291      // -> A~mu~nu
2292     cout << indexed(A, mu_co, nu) << endl;
2293      // -> A.mu~nu
2294     cout << indexed(A, mu.toggle_variance(), nu) << endl;
2295      // -> A.mu~nu
2296     ...
2297 @end example
2298
2299 A @code{varidx} is an @code{idx} with an additional flag that marks it as
2300 co- or contravariant. The default is a contravariant (upper) index, but
2301 this can be overridden by supplying a third argument to the @code{varidx}
2302 constructor. The two methods
2303
2304 @example
2305 bool varidx::is_covariant();
2306 bool varidx::is_contravariant();
2307 @end example
2308
2309 allow you to check the variance of a @code{varidx} object (use @code{ex_to<varidx>()}
2310 to get the object reference from an expression). There's also the very useful
2311 method
2312
2313 @example
2314 ex varidx::toggle_variance();
2315 @end example
2316
2317 which makes a new index with the same value and dimension but the opposite
2318 variance. By using it you only have to define the index once.
2319
2320 @cindex @code{spinidx} (class)
2321 The @code{spinidx} class provides dotted and undotted variant indices, as
2322 used in the Weyl-van-der-Waerden spinor formalism:
2323
2324 @example
2325     ...
2326     symbol K("K"), C_sym("C"), D_sym("D");
2327     spinidx C(C_sym, 2), D(D_sym);          // default is 2-dimensional,
2328                                             // contravariant, undotted
2329     spinidx C_co(C_sym, 2, true);           // covariant index
2330     spinidx D_dot(D_sym, 2, false, true);   // contravariant, dotted
2331     spinidx D_co_dot(D_sym, 2, true, true); // covariant, dotted
2332
2333     cout << indexed(K, C, D) << endl;
2334      // -> K~C~D
2335     cout << indexed(K, C_co, D_dot) << endl;
2336      // -> K.C~*D
2337     cout << indexed(K, D_co_dot, D) << endl;
2338      // -> K.*D~D
2339     ...
2340 @end example
2341
2342 A @code{spinidx} is a @code{varidx} with an additional flag that marks it as
2343 dotted or undotted. The default is undotted but this can be overridden by
2344 supplying a fourth argument to the @code{spinidx} constructor. The two
2345 methods
2346
2347 @example
2348 bool spinidx::is_dotted();
2349 bool spinidx::is_undotted();
2350 @end example
2351
2352 allow you to check whether or not a @code{spinidx} object is dotted (use
2353 @code{ex_to<spinidx>()} to get the object reference from an expression).
2354 Finally, the two methods
2355
2356 @example
2357 ex spinidx::toggle_dot();
2358 ex spinidx::toggle_variance_dot();
2359 @end example
2360
2361 create a new index with the same value and dimension but opposite dottedness
2362 and the same or opposite variance.
2363
2364 @subsection Substituting indices
2365
2366 @cindex @code{subs()}
2367 Sometimes you will want to substitute one symbolic index with another
2368 symbolic or numeric index, for example when calculating one specific element
2369 of a tensor expression. This is done with the @code{.subs()} method, as it
2370 is done for symbols (see @ref{Substituting Expressions}).
2371
2372 You have two possibilities here. You can either substitute the whole index
2373 by another index or expression:
2374
2375 @example
2376     ...
2377     ex e = indexed(A, mu_co);
2378     cout << e << " becomes " << e.subs(mu_co == nu) << endl;
2379      // -> A.mu becomes A~nu
2380     cout << e << " becomes " << e.subs(mu_co == varidx(0, 4)) << endl;
2381      // -> A.mu becomes A~0
2382     cout << e << " becomes " << e.subs(mu_co == 0) << endl;
2383      // -> A.mu becomes A.0
2384     ...
2385 @end example
2386
2387 The third example shows that trying to replace an index with something that
2388 is not an index will substitute the index value instead.
2389
2390 Alternatively, you can substitute the @emph{symbol} of a symbolic index by
2391 another expression:
2392
2393 @example
2394     ...
2395     ex e = indexed(A, mu_co);
2396     cout << e << " becomes " << e.subs(mu_sym == nu_sym) << endl;
2397      // -> A.mu becomes A.nu
2398     cout << e << " becomes " << e.subs(mu_sym == 0) << endl;
2399      // -> A.mu becomes A.0
2400     ...
2401 @end example
2402
2403 As you see, with the second method only the value of the index will get
2404 substituted. Its other properties, including its dimension, remain unchanged.
2405 If you want to change the dimension of an index you have to substitute the
2406 whole index by another one with the new dimension.
2407
2408 Finally, substituting the base expression of an indexed object works as
2409 expected:
2410
2411 @example
2412     ...
2413     ex e = indexed(A, mu_co);
2414     cout << e << " becomes " << e.subs(A == A+B) << endl;
2415      // -> A.mu becomes (B+A).mu
2416     ...
2417 @end example
2418
2419 @subsection Symmetries
2420 @cindex @code{symmetry} (class)
2421 @cindex @code{sy_none()}
2422 @cindex @code{sy_symm()}
2423 @cindex @code{sy_anti()}
2424 @cindex @code{sy_cycl()}
2425
2426 Indexed objects can have certain symmetry properties with respect to their
2427 indices. Symmetries are specified as a tree of objects of class @code{symmetry}
2428 that is constructed with the helper functions
2429
2430 @example
2431 symmetry sy_none(...);
2432 symmetry sy_symm(...);
2433 symmetry sy_anti(...);
2434 symmetry sy_cycl(...);
2435 @end example
2436
2437 @code{sy_none()} stands for no symmetry, @code{sy_symm()} and @code{sy_anti()}
2438 specify fully symmetric or antisymmetric, respectively, and @code{sy_cycl()}
2439 represents a cyclic symmetry. Each of these functions accepts up to four
2440 arguments which can be either symmetry objects themselves or unsigned integer
2441 numbers that represent an index position (counting from 0). A symmetry
2442 specification that consists of only a single @code{sy_symm()}, @code{sy_anti()}
2443 or @code{sy_cycl()} with no arguments specifies the respective symmetry for
2444 all indices.
2445
2446 Here are some examples of symmetry definitions:
2447
2448 @example
2449     ...
2450     // No symmetry:
2451     e = indexed(A, i, j);
2452     e = indexed(A, sy_none(), i, j);     // equivalent
2453     e = indexed(A, sy_none(0, 1), i, j); // equivalent
2454
2455     // Symmetric in all three indices:
2456     e = indexed(A, sy_symm(), i, j, k);
2457     e = indexed(A, sy_symm(0, 1, 2), i, j, k); // equivalent
2458     e = indexed(A, sy_symm(2, 0, 1), i, j, k); // same symmetry, but yields a
2459                                                // different canonical order
2460
2461     // Symmetric in the first two indices only:
2462     e = indexed(A, sy_symm(0, 1), i, j, k);
2463     e = indexed(A, sy_none(sy_symm(0, 1), 2), i, j, k); // equivalent
2464
2465     // Antisymmetric in the first and last index only (index ranges need not
2466     // be contiguous):
2467     e = indexed(A, sy_anti(0, 2), i, j, k);
2468     e = indexed(A, sy_none(sy_anti(0, 2), 1), i, j, k); // equivalent
2469
2470     // An example of a mixed symmetry: antisymmetric in the first two and
2471     // last two indices, symmetric when swapping the first and last index
2472     // pairs (like the Riemann curvature tensor):
2473     e = indexed(A, sy_symm(sy_anti(0, 1), sy_anti(2, 3)), i, j, k, l);
2474
2475     // Cyclic symmetry in all three indices:
2476     e = indexed(A, sy_cycl(), i, j, k);
2477     e = indexed(A, sy_cycl(0, 1, 2), i, j, k); // equivalent
2478
2479     // The following examples are invalid constructions that will throw
2480     // an exception at run time.
2481
2482     // An index may not appear multiple times:
2483     e = indexed(A, sy_symm(0, 0, 1), i, j, k); // ERROR
2484     e = indexed(A, sy_none(sy_symm(0, 1), sy_anti(0, 2)), i, j, k); // ERROR
2485
2486     // Every child of sy_symm(), sy_anti() and sy_cycl() must refer to the
2487     // same number of indices:
2488     e = indexed(A, sy_symm(sy_anti(0, 1), 2), i, j, k); // ERROR
2489
2490     // And of course, you cannot specify indices which are not there:
2491     e = indexed(A, sy_symm(0, 1, 2, 3), i, j, k); // ERROR
2492     ...
2493 @end example
2494
2495 If you need to specify more than four indices, you have to use the
2496 @code{.add()} method of the @code{symmetry} class. For example, to specify
2497 full symmetry in the first six indices you would write
2498 @code{sy_symm(0, 1, 2, 3).add(4).add(5)}.
2499
2500 If an indexed object has a symmetry, GiNaC will automatically bring the
2501 indices into a canonical order which allows for some immediate simplifications:
2502
2503 @example
2504     ...
2505     cout << indexed(A, sy_symm(), i, j)
2506           + indexed(A, sy_symm(), j, i) << endl;
2507      // -> 2*A.j.i
2508     cout << indexed(B, sy_anti(), i, j)
2509           + indexed(B, sy_anti(), j, i) << endl;
2510      // -> 0
2511     cout << indexed(B, sy_anti(), i, j, k)
2512           - indexed(B, sy_anti(), j, k, i) << endl;
2513      // -> 0
2514     ...
2515 @end example
2516
2517 @cindex @code{get_free_indices()}
2518 @cindex dummy index
2519 @subsection Dummy indices
2520
2521 GiNaC treats certain symbolic index pairs as @dfn{dummy indices} meaning
2522 that a summation over the index range is implied. Symbolic indices which are
2523 not dummy indices are called @dfn{free indices}. Numeric indices are neither
2524 dummy nor free indices.
2525
2526 To be recognized as a dummy index pair, the two indices must be of the same
2527 class and their value must be the same single symbol (an index like
2528 @samp{2*n+1} is never a dummy index). If the indices are of class
2529 @code{varidx} they must also be of opposite variance; if they are of class
2530 @code{spinidx} they must be both dotted or both undotted.
2531
2532 The method @code{.get_free_indices()} returns a vector containing the free
2533 indices of an expression. It also checks that the free indices of the terms
2534 of a sum are consistent:
2535
2536 @example
2537 @{
2538     symbol A("A"), B("B"), C("C");
2539
2540     symbol i_sym("i"), j_sym("j"), k_sym("k"), l_sym("l");
2541     idx i(i_sym, 3), j(j_sym, 3), k(k_sym, 3), l(l_sym, 3);
2542
2543     ex e = indexed(A, i, j) * indexed(B, j, k) + indexed(C, k, l, i, l);
2544     cout << exprseq(e.get_free_indices()) << endl;
2545      // -> (.i,.k)
2546      // 'j' and 'l' are dummy indices
2547
2548     symbol mu_sym("mu"), nu_sym("nu"), rho_sym("rho"), sigma_sym("sigma");
2549     varidx mu(mu_sym, 4), nu(nu_sym, 4), rho(rho_sym, 4), sigma(sigma_sym, 4);
2550
2551     e = indexed(A, mu, nu) * indexed(B, nu.toggle_variance(), rho)
2552       + indexed(C, mu, sigma, rho, sigma.toggle_variance());
2553     cout << exprseq(e.get_free_indices()) << endl;
2554      // -> (~mu,~rho)
2555      // 'nu' is a dummy index, but 'sigma' is not
2556
2557     e = indexed(A, mu, mu);
2558     cout << exprseq(e.get_free_indices()) << endl;
2559      // -> (~mu)
2560      // 'mu' is not a dummy index because it appears twice with the same
2561      // variance
2562
2563     e = indexed(A, mu, nu) + 42;
2564     cout << exprseq(e.get_free_indices()) << endl; // ERROR
2565      // this will throw an exception:
2566      // "add::get_free_indices: inconsistent indices in sum"
2567 @}
2568 @end example
2569
2570 @cindex @code{expand_dummy_sum()}
2571 A dummy index summation like 
2572 @tex
2573 $ a_i b^i$
2574 @end tex
2575 @ifnottex
2576 a.i b~i
2577 @end ifnottex
2578 can be expanded for indices with numeric
2579 dimensions (e.g. 3)  into the explicit sum like
2580 @tex
2581 $a_1b^1+a_2b^2+a_3b^3 $.
2582 @end tex
2583 @ifnottex
2584 a.1 b~1 + a.2 b~2 + a.3 b~3.
2585 @end ifnottex
2586 This is performed by the function
2587
2588 @example
2589     ex expand_dummy_sum(const ex & e, bool subs_idx = false);
2590 @end example
2591
2592 which takes an expression @code{e} and returns the expanded sum for all
2593 dummy indices with numeric dimensions. If the parameter @code{subs_idx}
2594 is set to @code{true} then all substitutions are made by @code{idx} class
2595 indices, i.e. without variance. In this case the above sum 
2596 @tex
2597 $ a_i b^i$
2598 @end tex
2599 @ifnottex
2600 a.i b~i
2601 @end ifnottex
2602 will be expanded to
2603 @tex
2604 $a_1b_1+a_2b_2+a_3b_3 $.
2605 @end tex
2606 @ifnottex
2607 a.1 b.1 + a.2 b.2 + a.3 b.3.
2608 @end ifnottex
2609
2610
2611 @cindex @code{simplify_indexed()}
2612 @subsection Simplifying indexed expressions
2613
2614 In addition to the few automatic simplifications that GiNaC performs on
2615 indexed expressions (such as re-ordering the indices of symmetric tensors
2616 and calculating traces and convolutions of matrices and predefined tensors)
2617 there is the method
2618
2619 @example
2620 ex ex::simplify_indexed();
2621 ex ex::simplify_indexed(const scalar_products & sp);
2622 @end example
2623
2624 that performs some more expensive operations:
2625
2626 @itemize
2627 @item it checks the consistency of free indices in sums in the same way
2628   @code{get_free_indices()} does
2629 @item it tries to give dummy indices that appear in different terms of a sum
2630   the same name to allow simplifications like @math{a_i*b_i-a_j*b_j=0}
2631 @item it (symbolically) calculates all possible dummy index summations/contractions
2632   with the predefined tensors (this will be explained in more detail in the
2633   next section)
2634 @item it detects contractions that vanish for symmetry reasons, for example
2635   the contraction of a symmetric and a totally antisymmetric tensor
2636 @item as a special case of dummy index summation, it can replace scalar products
2637   of two tensors with a user-defined value
2638 @end itemize
2639
2640 The last point is done with the help of the @code{scalar_products} class
2641 which is used to store scalar products with known values (this is not an
2642 arithmetic class, you just pass it to @code{simplify_indexed()}):
2643
2644 @example
2645 @{
2646     symbol A("A"), B("B"), C("C"), i_sym("i");
2647     idx i(i_sym, 3);
2648
2649     scalar_products sp;
2650     sp.add(A, B, 0); // A and B are orthogonal
2651     sp.add(A, C, 0); // A and C are orthogonal
2652     sp.add(A, A, 4); // A^2 = 4 (A has length 2)
2653
2654     e = indexed(A + B, i) * indexed(A + C, i);
2655     cout << e << endl;
2656      // -> (B+A).i*(A+C).i
2657
2658     cout << e.expand(expand_options::expand_indexed).simplify_indexed(sp)
2659          << endl;
2660      // -> 4+C.i*B.i
2661 @}
2662 @end example
2663
2664 The @code{scalar_products} object @code{sp} acts as a storage for the
2665 scalar products added to it with the @code{.add()} method. This method
2666 takes three arguments: the two expressions of which the scalar product is
2667 taken, and the expression to replace it with. After @code{sp.add(A, B, 0)},
2668 @code{simplify_indexed()} will replace all scalar products of indexed
2669 objects that have the symbols @code{A} and @code{B} as base expressions
2670 with the single value 0. The number, type and dimension of the indices
2671 don't matter; @samp{A~mu~nu*B.mu.nu} would also be replaced by 0.
2672
2673 @cindex @code{expand()}
2674 The example above also illustrates a feature of the @code{expand()} method:
2675 if passed the @code{expand_indexed} option it will distribute indices
2676 over sums, so @samp{(A+B).i} becomes @samp{A.i+B.i}.
2677
2678 @cindex @code{tensor} (class)
2679 @subsection Predefined tensors
2680
2681 Some frequently used special tensors such as the delta, epsilon and metric
2682 tensors are predefined in GiNaC. They have special properties when
2683 contracted with other tensor expressions and some of them have constant
2684 matrix representations (they will evaluate to a number when numeric
2685 indices are specified).
2686
2687 @cindex @code{delta_tensor()}
2688 @subsubsection Delta tensor
2689
2690 The delta tensor takes two indices, is symmetric and has the matrix
2691 representation @code{diag(1, 1, 1, ...)}. It is constructed by the function
2692 @code{delta_tensor()}:
2693
2694 @example
2695 @{
2696     symbol A("A"), B("B");
2697
2698     idx i(symbol("i"), 3), j(symbol("j"), 3),
2699         k(symbol("k"), 3), l(symbol("l"), 3);
2700
2701     ex e = indexed(A, i, j) * indexed(B, k, l)
2702          * delta_tensor(i, k) * delta_tensor(j, l);
2703     cout << e.simplify_indexed() << endl;
2704      // -> B.i.j*A.i.j
2705
2706     cout << delta_tensor(i, i) << endl;
2707      // -> 3
2708 @}
2709 @end example
2710
2711 @cindex @code{metric_tensor()}
2712 @subsubsection General metric tensor
2713
2714 The function @code{metric_tensor()} creates a general symmetric metric
2715 tensor with two indices that can be used to raise/lower tensor indices. The
2716 metric tensor is denoted as @samp{g} in the output and if its indices are of
2717 mixed variance it is automatically replaced by a delta tensor:
2718
2719 @example
2720 @{
2721     symbol A("A");
2722
2723     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
2724
2725     ex e = metric_tensor(mu, nu) * indexed(A, nu.toggle_variance(), rho);
2726     cout << e.simplify_indexed() << endl;
2727      // -> A~mu~rho
2728
2729     e = delta_tensor(mu, nu.toggle_variance()) * metric_tensor(nu, rho);
2730     cout << e.simplify_indexed() << endl;
2731      // -> g~mu~rho
2732
2733     e = metric_tensor(mu.toggle_variance(), nu.toggle_variance())
2734       * metric_tensor(nu, rho);
2735     cout << e.simplify_indexed() << endl;
2736      // -> delta.mu~rho
2737
2738     e = metric_tensor(nu.toggle_variance(), rho.toggle_variance())
2739       * metric_tensor(mu, nu) * (delta_tensor(mu.toggle_variance(), rho)
2740         + indexed(A, mu.toggle_variance(), rho));
2741     cout << e.simplify_indexed() << endl;
2742      // -> 4+A.rho~rho
2743 @}
2744 @end example
2745
2746 @cindex @code{lorentz_g()}
2747 @subsubsection Minkowski metric tensor
2748
2749 The Minkowski metric tensor is a special metric tensor with a constant
2750 matrix representation which is either @code{diag(1, -1, -1, ...)} (negative
2751 signature, the default) or @code{diag(-1, 1, 1, ...)} (positive signature).
2752 It is created with the function @code{lorentz_g()} (although it is output as
2753 @samp{eta}):
2754
2755 @example
2756 @{
2757     varidx mu(symbol("mu"), 4);
2758
2759     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
2760       * lorentz_g(mu, varidx(0, 4));       // negative signature
2761     cout << e.simplify_indexed() << endl;
2762      // -> 1
2763
2764     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
2765       * lorentz_g(mu, varidx(0, 4), true); // positive signature
2766     cout << e.simplify_indexed() << endl;
2767      // -> -1
2768 @}
2769 @end example
2770
2771 @cindex @code{spinor_metric()}
2772 @subsubsection Spinor metric tensor
2773
2774 The function @code{spinor_metric()} creates an antisymmetric tensor with
2775 two indices that is used to raise/lower indices of 2-component spinors.
2776 It is output as @samp{eps}:
2777
2778 @example
2779 @{
2780     symbol psi("psi");
2781
2782     spinidx A(symbol("A")), B(symbol("B")), C(symbol("C"));
2783     ex A_co = A.toggle_variance(), B_co = B.toggle_variance();
2784
2785     e = spinor_metric(A, B) * indexed(psi, B_co);
2786     cout << e.simplify_indexed() << endl;
2787      // -> psi~A
2788
2789     e = spinor_metric(A, B) * indexed(psi, A_co);
2790     cout << e.simplify_indexed() << endl;
2791      // -> -psi~B
2792
2793     e = spinor_metric(A_co, B_co) * indexed(psi, B);
2794     cout << e.simplify_indexed() << endl;
2795      // -> -psi.A
2796
2797     e = spinor_metric(A_co, B_co) * indexed(psi, A);
2798     cout << e.simplify_indexed() << endl;
2799      // -> psi.B
2800
2801     e = spinor_metric(A_co, B_co) * spinor_metric(A, B);
2802     cout << e.simplify_indexed() << endl;
2803      // -> 2
2804
2805     e = spinor_metric(A_co, B_co) * spinor_metric(B, C);
2806     cout << e.simplify_indexed() << endl;
2807      // -> -delta.A~C
2808 @}
2809 @end example
2810
2811 The matrix representation of the spinor metric is @code{[[0, 1], [-1, 0]]}.
2812
2813 @cindex @code{epsilon_tensor()}
2814 @cindex @code{lorentz_eps()}
2815 @subsubsection Epsilon tensor
2816
2817 The epsilon tensor is totally antisymmetric, its number of indices is equal
2818 to the dimension of the index space (the indices must all be of the same
2819 numeric dimension), and @samp{eps.1.2.3...} (resp. @samp{eps~0~1~2...}) is
2820 defined to be 1. Its behavior with indices that have a variance also
2821 depends on the signature of the metric. Epsilon tensors are output as
2822 @samp{eps}.
2823
2824 There are three functions defined to create epsilon tensors in 2, 3 and 4
2825 dimensions:
2826
2827 @example
2828 ex epsilon_tensor(const ex & i1, const ex & i2);
2829 ex epsilon_tensor(const ex & i1, const ex & i2, const ex & i3);
2830 ex lorentz_eps(const ex & i1, const ex & i2, const ex & i3, const ex & i4,
2831                bool pos_sig = false);
2832 @end example
2833
2834 The first two functions create an epsilon tensor in 2 or 3 Euclidean
2835 dimensions, the last function creates an epsilon tensor in a 4-dimensional
2836 Minkowski space (the last @code{bool} argument specifies whether the metric
2837 has negative or positive signature, as in the case of the Minkowski metric
2838 tensor):
2839
2840 @example
2841 @{
2842     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4),
2843            sig(symbol("sig"), 4), lam(symbol("lam"), 4), bet(symbol("bet"), 4);
2844     e = lorentz_eps(mu, nu, rho, sig) *
2845         lorentz_eps(mu.toggle_variance(), nu.toggle_variance(), lam, bet);
2846     cout << simplify_indexed(e) << endl;
2847      // -> 2*eta~bet~rho*eta~sig~lam-2*eta~sig~bet*eta~rho~lam
2848
2849     idx i(symbol("i"), 3), j(symbol("j"), 3), k(symbol("k"), 3);
2850     symbol A("A"), B("B");
2851     e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(B, k);
2852     cout << simplify_indexed(e) << endl;
2853      // -> -B.k*A.j*eps.i.k.j
2854     e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(A, k);
2855     cout << simplify_indexed(e) << endl;
2856      // -> 0
2857 @}
2858 @end example
2859
2860 @subsection Linear algebra
2861
2862 The @code{matrix} class can be used with indices to do some simple linear
2863 algebra (linear combinations and products of vectors and matrices, traces
2864 and scalar products):
2865
2866 @example
2867 @{
2868     idx i(symbol("i"), 2), j(symbol("j"), 2);
2869     symbol x("x"), y("y");
2870
2871     // A is a 2x2 matrix, X is a 2x1 vector
2872     matrix A(2, 2), X(2, 1);
2873     A = 1, 2,
2874         3, 4;
2875     X = x, y;
2876
2877     cout << indexed(A, i, i) << endl;
2878      // -> 5
2879
2880     ex e = indexed(A, i, j) * indexed(X, j);
2881     cout << e.simplify_indexed() << endl;
2882      // -> [[2*y+x],[4*y+3*x]].i
2883
2884     e = indexed(A, i, j) * indexed(X, i) + indexed(X, j) * 2;
2885     cout << e.simplify_indexed() << endl;
2886      // -> [[3*y+3*x,6*y+2*x]].j
2887 @}
2888 @end example
2889
2890 You can of course obtain the same results with the @code{matrix::add()},
2891 @code{matrix::mul()} and @code{matrix::trace()} methods (@pxref{Matrices})
2892 but with indices you don't have to worry about transposing matrices.
2893
2894 Matrix indices always start at 0 and their dimension must match the number
2895 of rows/columns of the matrix. Matrices with one row or one column are
2896 vectors and can have one or two indices (it doesn't matter whether it's a
2897 row or a column vector). Other matrices must have two indices.
2898
2899 You should be careful when using indices with variance on matrices. GiNaC
2900 doesn't look at the variance and doesn't know that @samp{F~mu~nu} and
2901 @samp{F.mu.nu} are different matrices. In this case you should use only
2902 one form for @samp{F} and explicitly multiply it with a matrix representation
2903 of the metric tensor.
2904
2905
2906 @node Non-commutative objects, Hash Maps, Indexed objects, Basic Concepts
2907 @c    node-name, next, previous, up
2908 @section Non-commutative objects
2909
2910 GiNaC is equipped to handle certain non-commutative algebras. Three classes of
2911 non-commutative objects are built-in which are mostly of use in high energy
2912 physics:
2913
2914 @itemize
2915 @item Clifford (Dirac) algebra (class @code{clifford})
2916 @item su(3) Lie algebra (class @code{color})
2917 @item Matrices (unindexed) (class @code{matrix})
2918 @end itemize
2919
2920 The @code{clifford} and @code{color} classes are subclasses of
2921 @code{indexed} because the elements of these algebras usually carry
2922 indices. The @code{matrix} class is described in more detail in
2923 @ref{Matrices}.
2924
2925 Unlike most computer algebra systems, GiNaC does not primarily provide an
2926 operator (often denoted @samp{&*}) for representing inert products of
2927 arbitrary objects. Rather, non-commutativity in GiNaC is a property of the
2928 classes of objects involved, and non-commutative products are formed with
2929 the usual @samp{*} operator, as are ordinary products. GiNaC is capable of
2930 figuring out by itself which objects commutate and will group the factors
2931 by their class. Consider this example:
2932
2933 @example
2934     ...
2935     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
2936     idx a(symbol("a"), 8), b(symbol("b"), 8);
2937     ex e = -dirac_gamma(mu) * (2*color_T(a)) * 8 * color_T(b) * dirac_gamma(nu);
2938     cout << e << endl;
2939      // -> -16*(gamma~mu*gamma~nu)*(T.a*T.b)
2940     ...
2941 @end example
2942
2943 As can be seen, GiNaC pulls out the overall commutative factor @samp{-16} and
2944 groups the non-commutative factors (the gammas and the su(3) generators)
2945 together while preserving the order of factors within each class (because
2946 Clifford objects commutate with color objects). The resulting expression is a
2947 @emph{commutative} product with two factors that are themselves non-commutative
2948 products (@samp{gamma~mu*gamma~nu} and @samp{T.a*T.b}). For clarification,
2949 parentheses are placed around the non-commutative products in the output.
2950
2951 @cindex @code{ncmul} (class)
2952 Non-commutative products are internally represented by objects of the class
2953 @code{ncmul}, as opposed to commutative products which are handled by the
2954 @code{mul} class. You will normally not have to worry about this distinction,
2955 though.
2956
2957 The advantage of this approach is that you never have to worry about using
2958 (or forgetting to use) a special operator when constructing non-commutative
2959 expressions. Also, non-commutative products in GiNaC are more intelligent
2960 than in other computer algebra systems; they can, for example, automatically
2961 canonicalize themselves according to rules specified in the implementation
2962 of the non-commutative classes. The drawback is that to work with other than
2963 the built-in algebras you have to implement new classes yourself. Symbols
2964 always commutate and it's not possible to construct non-commutative products
2965 using symbols to represent the algebra elements or generators. User-defined
2966 functions can, however, be specified as being non-commutative.
2967
2968 @cindex @code{return_type()}
2969 @cindex @code{return_type_tinfo()}
2970 Information about the commutativity of an object or expression can be
2971 obtained with the two member functions
2972
2973 @example
2974 unsigned ex::return_type() const;
2975 unsigned ex::return_type_tinfo() const;
2976 @end example
2977
2978 The @code{return_type()} function returns one of three values (defined in
2979 the header file @file{flags.h}), corresponding to three categories of
2980 expressions in GiNaC:
2981
2982 @itemize
2983 @item @code{return_types::commutative}: Commutates with everything. Most GiNaC
2984   classes are of this kind.
2985 @item @code{return_types::noncommutative}: Non-commutative, belonging to a
2986   certain class of non-commutative objects which can be determined with the
2987   @code{return_type_tinfo()} method. Expressions of this category commutate
2988   with everything except @code{noncommutative} expressions of the same
2989   class.
2990 @item @code{return_types::noncommutative_composite}: Non-commutative, composed
2991   of non-commutative objects of different classes. Expressions of this
2992   category don't commutate with any other @code{noncommutative} or
2993   @code{noncommutative_composite} expressions.
2994 @end itemize
2995
2996 The value returned by the @code{return_type_tinfo()} method is valid only
2997 when the return type of the expression is @code{noncommutative}. It is a
2998 value that is unique to the class of the object and usually one of the
2999 constants in @file{tinfos.h}, or derived therefrom.
3000
3001 Here are a couple of examples:
3002
3003 @cartouche
3004 @multitable @columnfractions 0.33 0.33 0.34
3005 @item @strong{Expression} @tab @strong{@code{return_type()}} @tab @strong{@code{return_type_tinfo()}}
3006 @item @code{42} @tab @code{commutative} @tab -
3007 @item @code{2*x-y} @tab @code{commutative} @tab -
3008 @item @code{dirac_ONE()} @tab @code{noncommutative} @tab @code{TINFO_clifford}
3009 @item @code{dirac_gamma(mu)*dirac_gamma(nu)} @tab @code{noncommutative} @tab @code{TINFO_clifford}
3010 @item @code{2*color_T(a)} @tab @code{noncommutative} @tab @code{TINFO_color}
3011 @item @code{dirac_ONE()*color_T(a)} @tab @code{noncommutative_composite} @tab -
3012 @end multitable
3013 @end cartouche
3014
3015 Note: the @code{return_type_tinfo()} of Clifford objects is only equal to
3016 @code{TINFO_clifford} for objects with a representation label of zero.
3017 Other representation labels yield a different @code{return_type_tinfo()},
3018 but it's the same for any two objects with the same label. This is also true
3019 for color objects.
3020
3021 A last note: With the exception of matrices, positive integer powers of
3022 non-commutative objects are automatically expanded in GiNaC. For example,
3023 @code{pow(a*b, 2)} becomes @samp{a*b*a*b} if @samp{a} and @samp{b} are
3024 non-commutative expressions).
3025
3026
3027 @cindex @code{clifford} (class)
3028 @subsection Clifford algebra
3029
3030
3031 Clifford algebras are supported in two flavours: Dirac gamma
3032 matrices (more physical) and generic Clifford algebras (more
3033 mathematical). 
3034
3035 @cindex @code{dirac_gamma()}
3036 @subsubsection Dirac gamma matrices
3037 Dirac gamma matrices (note that GiNaC doesn't treat them
3038 as matrices) are designated as @samp{gamma~mu} and satisfy
3039 @samp{gamma~mu*gamma~nu + gamma~nu*gamma~mu = 2*eta~mu~nu} where
3040 @samp{eta~mu~nu} is the Minkowski metric tensor. Dirac gammas are
3041 constructed by the function
3042
3043 @example
3044 ex dirac_gamma(const ex & mu, unsigned char rl = 0);
3045 @end example
3046
3047 which takes two arguments: the index and a @dfn{representation label} in the
3048 range 0 to 255 which is used to distinguish elements of different Clifford
3049 algebras (this is also called a @dfn{spin line index}). Gammas with different
3050 labels commutate with each other. The dimension of the index can be 4 or (in
3051 the framework of dimensional regularization) any symbolic value. Spinor
3052 indices on Dirac gammas are not supported in GiNaC.
3053
3054 @cindex @code{dirac_ONE()}
3055 The unity element of a Clifford algebra is constructed by
3056
3057 @example
3058 ex dirac_ONE(unsigned char rl = 0);
3059 @end example
3060
3061 @strong{Please notice:} You must always use @code{dirac_ONE()} when referring to
3062 multiples of the unity element, even though it's customary to omit it.
3063 E.g. instead of @code{dirac_gamma(mu)*(dirac_slash(q,4)+m)} you have to
3064 write @code{dirac_gamma(mu)*(dirac_slash(q,4)+m*dirac_ONE())}. Otherwise,
3065 GiNaC will complain and/or produce incorrect results.
3066
3067 @cindex @code{dirac_gamma5()}
3068 There is a special element @samp{gamma5} that commutates with all other
3069 gammas, has a unit square, and in 4 dimensions equals
3070 @samp{gamma~0 gamma~1 gamma~2 gamma~3}, provided by
3071
3072 @example
3073 ex dirac_gamma5(unsigned char rl = 0);
3074 @end example
3075
3076 @cindex @code{dirac_gammaL()}
3077 @cindex @code{dirac_gammaR()}
3078 The chiral projectors @samp{(1+/-gamma5)/2} are also available as proper
3079 objects, constructed by
3080
3081 @example
3082 ex dirac_gammaL(unsigned char rl = 0);
3083 ex dirac_gammaR(unsigned char rl = 0);
3084 @end example
3085
3086 They observe the relations @samp{gammaL^2 = gammaL}, @samp{gammaR^2 = gammaR},
3087 and @samp{gammaL gammaR = gammaR gammaL = 0}.
3088
3089 @cindex @code{dirac_slash()}
3090 Finally, the function
3091
3092 @example
3093 ex dirac_slash(const ex & e, const ex & dim, unsigned char rl = 0);
3094 @end example
3095
3096 creates a term that represents a contraction of @samp{e} with the Dirac
3097 Lorentz vector (it behaves like a term of the form @samp{e.mu gamma~mu}
3098 with a unique index whose dimension is given by the @code{dim} argument).
3099 Such slashed expressions are printed with a trailing backslash, e.g. @samp{e\}.
3100
3101 In products of dirac gammas, superfluous unity elements are automatically
3102 removed, squares are replaced by their values, and @samp{gamma5}, @samp{gammaL}
3103 and @samp{gammaR} are moved to the front.
3104
3105 The @code{simplify_indexed()} function performs contractions in gamma strings,
3106 for example
3107
3108 @example
3109 @{
3110     ...
3111     symbol a("a"), b("b"), D("D");
3112     varidx mu(symbol("mu"), D);
3113     ex e = dirac_gamma(mu) * dirac_slash(a, D)
3114          * dirac_gamma(mu.toggle_variance());
3115     cout << e << endl;
3116      // -> gamma~mu*a\*gamma.mu
3117     e = e.simplify_indexed();
3118     cout << e << endl;
3119      // -> -D*a\+2*a\
3120     cout << e.subs(D == 4) << endl;
3121      // -> -2*a\
3122     ...
3123 @}
3124 @end example
3125
3126 @cindex @code{dirac_trace()}
3127 To calculate the trace of an expression containing strings of Dirac gammas
3128 you use one of the functions
3129
3130 @example
3131 ex dirac_trace(const ex & e, const std::set<unsigned char> & rls,
3132                const ex & trONE = 4);
3133 ex dirac_trace(const ex & e, const lst & rll, const ex & trONE = 4);
3134 ex dirac_trace(const ex & e, unsigned char rl = 0, const ex & trONE = 4);
3135 @end example
3136
3137 These functions take the trace over all gammas in the specified set @code{rls}
3138 or list @code{rll} of representation labels, or the single label @code{rl};
3139 gammas with other labels are left standing. The last argument to
3140 @code{dirac_trace()} is the value to be returned for the trace of the unity
3141 element, which defaults to 4.
3142
3143 The @code{dirac_trace()} function is a linear functional that is equal to the
3144 ordinary matrix trace only in @math{D = 4} dimensions. In particular, the
3145 functional is not cyclic in
3146 @tex $D \ne 4$
3147 @end tex
3148 dimensions when acting on
3149 expressions containing @samp{gamma5}, so it's not a proper trace. This
3150 @samp{gamma5} scheme is described in greater detail in
3151 @cite{The Role of gamma5 in Dimensional Regularization}.
3152
3153 The value of the trace itself is also usually different in 4 and in
3154 @tex $D \ne 4$
3155 @end tex
3156 dimensions:
3157
3158 @example
3159 @{
3160     // 4 dimensions
3161     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
3162     ex e = dirac_gamma(mu) * dirac_gamma(nu) *
3163            dirac_gamma(mu.toggle_variance()) * dirac_gamma(rho);
3164     cout << dirac_trace(e).simplify_indexed() << endl;
3165      // -> -8*eta~rho~nu
3166 @}
3167 ...
3168 @{
3169     // D dimensions
3170     symbol D("D");
3171     varidx mu(symbol("mu"), D), nu(symbol("nu"), D), rho(symbol("rho"), D);
3172     ex e = dirac_gamma(mu) * dirac_gamma(nu) *
3173            dirac_gamma(mu.toggle_variance()) * dirac_gamma(rho);
3174     cout << dirac_trace(e).simplify_indexed() << endl;
3175      // -> 8*eta~rho~nu-4*eta~rho~nu*D
3176 @}
3177 @end example
3178
3179 Here is an example for using @code{dirac_trace()} to compute a value that
3180 appears in the calculation of the one-loop vacuum polarization amplitude in
3181 QED:
3182
3183 @example
3184 @{
3185     symbol q("q"), l("l"), m("m"), ldotq("ldotq"), D("D");
3186     varidx mu(symbol("mu"), D), nu(symbol("nu"), D);
3187
3188     scalar_products sp;
3189     sp.add(l, l, pow(l, 2));
3190     sp.add(l, q, ldotq);
3191
3192     ex e = dirac_gamma(mu) *
3193            (dirac_slash(l, D) + dirac_slash(q, D) + m * dirac_ONE()) *    
3194            dirac_gamma(mu.toggle_variance()) *
3195            (dirac_slash(l, D) + m * dirac_ONE());   
3196     e = dirac_trace(e).simplify_indexed(sp);
3197     e = e.collect(lst(l, ldotq, m));
3198     cout << e << endl;
3199      // -> (8-4*D)*l^2+(8-4*D)*ldotq+4*D*m^2
3200 @}
3201 @end example
3202
3203 The @code{canonicalize_clifford()} function reorders all gamma products that
3204 appear in an expression to a canonical (but not necessarily simple) form.
3205 You can use this to compare two expressions or for further simplifications:
3206
3207 @example
3208 @{
3209     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
3210     ex e = dirac_gamma(mu) * dirac_gamma(nu) + dirac_gamma(nu) * dirac_gamma(mu);
3211     cout << e << endl;
3212      // -> gamma~mu*gamma~nu+gamma~nu*gamma~mu
3213
3214     e = canonicalize_clifford(e);
3215     cout << e << endl;
3216      // -> 2*ONE*eta~mu~nu
3217 @}
3218 @end example
3219
3220 @cindex @code{clifford_unit()}
3221 @subsubsection A generic Clifford algebra
3222
3223 A generic Clifford algebra, i.e. a
3224 @tex
3225 $2^n$
3226 @end tex
3227 dimensional algebra with
3228 generators 
3229 @tex $e_k$
3230 @end tex 
3231 satisfying the identities 
3232 @tex
3233 $e_i e_j + e_j e_i = M(i, j) + M(j, i) $
3234 @end tex
3235 @ifnottex
3236 e~i e~j + e~j e~i = M(i, j) + M(j, i) 
3237 @end ifnottex
3238 for some bilinear form (@code{metric})
3239 @math{M(i, j)}, which may be non-symmetric (see arXiv:math.QA/9911180) 
3240 and contain symbolic entries. Such generators are created by the
3241 function 
3242
3243 @example
3244     ex clifford_unit(const ex & mu, const ex & metr, unsigned char rl = 0, 
3245                                 bool anticommuting = false);    
3246 @end example
3247
3248 where @code{mu} should be a @code{varidx} class object indexing the
3249 generators, an index @code{mu} with a numeric value may be of type
3250 @code{idx} as well.
3251 Parameter @code{metr} defines the metric @math{M(i, j)} and can be
3252 represented by a square @code{matrix}, @code{tensormetric} or @code{indexed} class
3253 object. Optional parameter @code{rl} allows to distinguish different
3254 Clifford algebras, which will commute with each other. The last
3255 optional parameter @code{anticommuting} defines if the anticommuting
3256 assumption (i.e.
3257 @tex
3258 $e_i e_j + e_j e_i = 0$)
3259 @end tex
3260 @ifnottex
3261 e~i e~j + e~j e~i = 0)
3262 @end ifnottex
3263 will be used for contraction of Clifford units. If the @code{metric} is
3264 supplied by a @code{matrix} object, then the value of
3265 @code{anticommuting} is calculated automatically and the supplied one
3266 will be ignored. One can overcome this by giving @code{metric} through
3267 matrix wrapped into an @code{indexed} object.
3268
3269 Note that the call @code{clifford_unit(mu, minkmetric())} creates
3270 something very close to @code{dirac_gamma(mu)}, although
3271 @code{dirac_gamma} have more efficient simplification mechanism. 
3272 @cindex @code{clifford::get_metric()}
3273 The method @code{clifford::get_metric()} returns a metric defining this
3274 Clifford number.
3275 @cindex @code{clifford::is_anticommuting()}
3276 The method @code{clifford::is_anticommuting()} returns the
3277 @code{anticommuting} property of a unit.
3278
3279 If the matrix @math{M(i, j)} is in fact symmetric you may prefer to create
3280 the Clifford algebra units with a call like that
3281
3282 @example
3283     ex e = clifford_unit(mu, indexed(M, sy_symm(), i, j));
3284 @end example
3285
3286 since this may yield some further automatic simplifications. Again, for a
3287 metric defined through a @code{matrix} such a symmetry is detected
3288 automatically. 
3289
3290 Individual generators of a Clifford algebra can be accessed in several
3291 ways. For example 
3292
3293 @example
3294 @{
3295     ... 
3296     varidx nu(symbol("nu"), 4);
3297     realsymbol s("s");
3298     ex M = diag_matrix(lst(1, -1, 0, s));
3299     ex e = clifford_unit(nu, M);
3300     ex e0 = e.subs(nu == 0);
3301     ex e1 = e.subs(nu == 1);
3302     ex e2 = e.subs(nu == 2);
3303     ex e3 = e.subs(nu == 3);
3304     ...
3305 @}
3306 @end example
3307
3308 will produce four anti-commuting generators of a Clifford algebra with properties
3309 @tex
3310 $e_0^2=1 $, $e_1^2=-1$,  $e_2^2=0$ and $e_3^2=s$.
3311 @end tex
3312 @ifnottex
3313 @code{pow(e0, 2) = 1}, @code{pow(e1, 2) = -1}, @code{pow(e2, 2) = 0} and
3314 @code{pow(e3, 2) = s}.
3315 @end ifnottex
3316
3317 @cindex @code{lst_to_clifford()}
3318 A similar effect can be achieved from the function
3319
3320 @example
3321     ex lst_to_clifford(const ex & v, const ex & mu,  const ex & metr,
3322                        unsigned char rl = 0, bool anticommuting = false);
3323     ex lst_to_clifford(const ex & v, const ex & e);
3324 @end example
3325
3326 which converts a list or vector 
3327 @tex
3328 $v = (v^0, v^1, ..., v^n)$
3329 @end tex
3330 @ifnottex
3331 @samp{v = (v~0, v~1, ..., v~n)} 
3332 @end ifnottex
3333 into the
3334 Clifford number 
3335 @tex
3336 $v^0 e_0 + v^1 e_1 + ... + v^n e_n$
3337 @end tex
3338 @ifnottex
3339 @samp{v~0 e.0 + v~1 e.1 + ... + v~n e.n}
3340 @end ifnottex
3341 with @samp{e.k}
3342 directly supplied in the second form of the procedure. In the first form
3343 the Clifford unit @samp{e.k} is generated by the call of
3344 @code{clifford_unit(mu, metr, rl, anticommuting)}. The previous code may be rewritten
3345 with the help of @code{lst_to_clifford()} as follows
3346
3347 @example
3348 @{
3349     ...
3350     varidx nu(symbol("nu"), 4);
3351     realsymbol s("s");
3352     ex M = diag_matrix(lst(1, -1, 0, s));
3353     ex e0 = lst_to_clifford(lst(1, 0, 0, 0), nu, M);
3354     ex e1 = lst_to_clifford(lst(0, 1, 0, 0), nu, M);
3355     ex e2 = lst_to_clifford(lst(0, 0, 1, 0), nu, M);
3356     ex e3 = lst_to_clifford(lst(0, 0, 0, 1), nu, M);
3357   ...
3358 @}
3359 @end example
3360
3361 @cindex @code{clifford_to_lst()}
3362 There is the inverse function 
3363
3364 @example
3365     lst clifford_to_lst(const ex & e, const ex & c, bool algebraic = true);
3366 @end example
3367
3368 which takes an expression @code{e} and tries to find a list
3369 @tex
3370 $v = (v^0, v^1, ..., v^n)$
3371 @end tex
3372 @ifnottex
3373 @samp{v = (v~0, v~1, ..., v~n)} 
3374 @end ifnottex
3375 such that 
3376 @tex
3377 $e = v^0 c_0 + v^1 c_1 + ... + v^n c_n$
3378 @end tex
3379 @ifnottex
3380 @samp{e = v~0 c.0 + v~1 c.1 + ... + v~n c.n}
3381 @end ifnottex
3382 with respect to the given Clifford units @code{c} and with none of the
3383 @samp{v~k} containing Clifford units @code{c} (of course, this
3384 may be impossible). This function can use an @code{algebraic} method
3385 (default) or a symbolic one. With the @code{algebraic} method the @samp{v~k} are calculated as
3386 @tex
3387 $(e c_k + c_k e)/c_k^2$. If $c_k^2$
3388 @end tex
3389 @ifnottex
3390 @samp{(e c.k + c.k e)/pow(c.k, 2)}.   If @samp{pow(c.k, 2)} 
3391 @end ifnottex
3392 is zero or is not @code{numeric} for some @samp{k}
3393 then the method will be automatically changed to symbolic. The same effect
3394 is obtained by the assignment (@code{algebraic = false}) in the procedure call.
3395
3396 @cindex @code{clifford_prime()}
3397 @cindex @code{clifford_star()}
3398 @cindex @code{clifford_bar()}
3399 There are several functions for (anti-)automorphisms of Clifford algebras:
3400
3401 @example
3402     ex clifford_prime(const ex & e)
3403     inline ex clifford_star(const ex & e) @{ return e.conjugate(); @}
3404     inline ex clifford_bar(const ex & e) @{ return clifford_prime(e.conjugate()); @}
3405 @end example
3406
3407 The automorphism of a Clifford algebra @code{clifford_prime()} simply
3408 changes signs of all Clifford units in the expression. The reversion
3409 of a Clifford algebra @code{clifford_star()} coincides with the
3410 @code{conjugate()} method and effectively reverses the order of Clifford
3411 units in any product. Finally the main anti-automorphism
3412 of a Clifford algebra @code{clifford_bar()} is the composition of the
3413 previous two, i.e. it makes the reversion and changes signs of all Clifford units
3414 in a product. These functions correspond to the notations
3415 @math{e'},
3416 @tex
3417 $e^*$
3418 @end tex
3419 @ifnottex
3420 e*
3421 @end ifnottex
3422 and
3423 @tex
3424 $\overline{e}$
3425 @end tex
3426 @ifnottex
3427 @code{\bar@{e@}}
3428 @end ifnottex
3429 used in Clifford algebra textbooks.
3430
3431 @cindex @code{clifford_norm()}
3432 The function
3433
3434 @example
3435     ex clifford_norm(const ex & e);
3436 @end example
3437
3438 @cindex @code{clifford_inverse()}
3439 calculates the norm of a Clifford number from the expression
3440 @tex
3441 $||e||^2 = e\overline{e}$.
3442 @end tex
3443 @ifnottex
3444 @code{||e||^2 = e \bar@{e@}}
3445 @end ifnottex
3446  The inverse of a Clifford expression is returned by the function
3447
3448 @example
3449     ex clifford_inverse(const ex & e);
3450 @end example
3451
3452 which calculates it as 
3453 @tex
3454 $e^{-1} = \overline{e}/||e||^2$.
3455 @end tex
3456 @ifnottex
3457 @math{e^@{-1@} = \bar@{e@}/||e||^2}
3458 @end ifnottex
3459  If
3460 @tex
3461 $||e|| = 0$
3462 @end tex
3463 @ifnottex
3464 @math{||e||=0}
3465 @end ifnottex
3466 then an exception is raised.
3467
3468 @cindex @code{remove_dirac_ONE()}
3469 If a Clifford number happens to be a factor of
3470 @code{dirac_ONE()} then we can convert it to a ``real'' (non-Clifford)
3471 expression by the function
3472
3473 @example
3474     ex remove_dirac_ONE(const ex & e);
3475 @end example
3476
3477 @cindex @code{canonicalize_clifford()}
3478 The function @code{canonicalize_clifford()} works for a
3479 generic Clifford algebra in a similar way as for Dirac gammas.
3480
3481 The next provided function is
3482
3483 @cindex @code{clifford_moebius_map()}
3484 @example
3485     ex clifford_moebius_map(const ex & a, const ex & b, const ex & c,
3486                             const ex & d, const ex & v, const ex & G,
3487                             unsigned char rl = 0, bool anticommuting = false);
3488     ex clifford_moebius_map(const ex & M, const ex & v, const ex & G,
3489                             unsigned char rl = 0, bool anticommuting = false);
3490 @end example 
3491
3492 It takes a list or vector @code{v} and makes the Moebius (conformal or
3493 linear-fractional) transformation @samp{v -> (av+b)/(cv+d)} defined by
3494 the matrix @samp{M = [[a, b], [c, d]]}. The parameter @code{G} defines
3495 the metric of the surrounding (pseudo-)Euclidean space. This can be an
3496 indexed object, tensormetric, matrix or a Clifford unit, in the later
3497 case the optional parameters @code{rl} and @code{anticommuting} are ignored
3498 even if supplied.  The returned value of this function is a list of
3499 components of the resulting vector.
3500
3501 @cindex @code{clifford_max_label()}
3502 Finally the function
3503
3504 @example
3505 char clifford_max_label(const ex & e, bool ignore_ONE = false);
3506 @end example
3507
3508 can detect a presence of Clifford objects in the expression @code{e}: if
3509 such objects are found it returns the maximal
3510 @code{representation_label} of them, otherwise @code{-1}. The optional
3511 parameter @code{ignore_ONE} indicates if @code{dirac_ONE} objects should
3512 be ignored during the search.
3513  
3514 LaTeX output for Clifford units looks like
3515 @code{\clifford[1]@{e@}^@{@{\nu@}@}}, where @code{1} is the
3516 @code{representation_label} and @code{\nu} is the index of the
3517 corresponding unit. This provides a flexible typesetting with a suitable
3518 defintion of the @code{\clifford} command. For example, the definition
3519 @example
3520     \newcommand@{\clifford@}[1][]@{@}
3521 @end example
3522 typesets all Clifford units identically, while the alternative definition
3523 @example
3524     \newcommand@{\clifford@}[2][]@{\ifcase #1 #2\or \tilde@{#2@} \or \breve@{#2@} \fi@}
3525 @end example
3526 prints units with @code{representation_label=0} as 
3527 @tex
3528 $e$,
3529 @end tex
3530 @ifnottex
3531 @code{e},
3532 @end ifnottex
3533 with @code{representation_label=1} as 
3534 @tex
3535 $\tilde{e}$
3536 @end tex
3537 @ifnottex
3538 @code{\tilde@{e@}}
3539 @end ifnottex
3540  and with @code{representation_label=2} as 
3541 @tex
3542 $\breve{e}$.
3543 @end tex
3544 @ifnottex
3545 @code{\breve@{e@}}.
3546 @end ifnottex
3547
3548 @cindex @code{color} (class)
3549 @subsection Color algebra
3550
3551 @cindex @code{color_T()}
3552 For computations in quantum chromodynamics, GiNaC implements the base elements
3553 and structure constants of the su(3) Lie algebra (color algebra). The base
3554 elements @math{T_a} are constructed by the function
3555
3556 @example
3557 ex color_T(const ex & a, unsigned char rl = 0);
3558 @end example
3559
3560 which takes two arguments: the index and a @dfn{representation label} in the
3561 range 0 to 255 which is used to distinguish elements of different color
3562 algebras. Objects with different labels commutate with each other. The
3563 dimension of the index must be exactly 8 and it should be of class @code{idx},
3564 not @code{varidx}.
3565
3566 @cindex @code{color_ONE()}
3567 The unity element of a color algebra is constructed by
3568
3569 @example
3570 ex color_ONE(unsigned char rl = 0);
3571 @end example
3572
3573 @strong{Please notice:} You must always use @code{color_ONE()} when referring to
3574 multiples of the unity element, even though it's customary to omit it.
3575 E.g. instead of @code{color_T(a)*(color_T(b)*indexed(X,b)+1)} you have to
3576 write @code{color_T(a)*(color_T(b)*indexed(X,b)+color_ONE())}. Otherwise,
3577 GiNaC may produce incorrect results.
3578
3579 @cindex @code{color_d()}
3580 @cindex @code{color_f()}
3581 The functions
3582
3583 @example
3584 ex color_d(const ex & a, const ex & b, const ex & c);
3585 ex color_f(const ex & a, const ex & b, const ex & c);
3586 @end example
3587
3588 create the symmetric and antisymmetric structure constants @math{d_abc} and
3589 @math{f_abc} which satisfy @math{@{T_a, T_b@} = 1/3 delta_ab + d_abc T_c}
3590 and @math{[T_a, T_b] = i f_abc T_c}.
3591
3592 These functions evaluate to their numerical values,
3593 if you supply numeric indices to them. The index values should be in
3594 the range from 1 to 8, not from 0 to 7. This departure from usual conventions
3595 goes along better with the notations used in physical literature.
3596
3597 @cindex @code{color_h()}
3598 There's an additional function
3599
3600 @example
3601 ex color_h(const ex & a, const ex & b, const ex & c);
3602 @end example
3603
3604 which returns the linear combination @samp{color_d(a, b, c)+I*color_f(a, b, c)}.
3605
3606 The function @code{simplify_indexed()} performs some simplifications on
3607 expressions containing color objects:
3608
3609 @example
3610 @{
3611     ...
3612     idx a(symbol("a"), 8), b(symbol("b"), 8), c(symbol("c"), 8),
3613         k(symbol("k"), 8), l(symbol("l"), 8);
3614
3615     e = color_d(a, b, l) * color_f(a, b, k);
3616     cout << e.simplify_indexed() << endl;
3617      // -> 0
3618
3619     e = color_d(a, b, l) * color_d(a, b, k);
3620     cout << e.simplify_indexed() << endl;
3621      // -> 5/3*delta.k.l
3622
3623     e = color_f(l, a, b) * color_f(a, b, k);
3624     cout << e.simplify_indexed() << endl;
3625      // -> 3*delta.k.l
3626
3627     e = color_h(a, b, c) * color_h(a, b, c);
3628     cout << e.simplify_indexed() << endl;
3629      // -> -32/3
3630
3631     e = color_h(a, b, c) * color_T(b) * color_T(c);
3632     cout << e.simplify_indexed() << endl;
3633      // -> -2/3*T.a
3634
3635     e = color_h(a, b, c) * color_T(a) * color_T(b) * color_T(c);
3636     cout << e.simplify_indexed() << endl;
3637      // -> -8/9*ONE
3638
3639     e = color_T(k) * color_T(a) * color_T(b) * color_T(k);
3640     cout << e.simplify_indexed() << endl;
3641      // -> 1/4*delta.b.a*ONE-1/6*T.a*T.b
3642     ...
3643 @end example
3644
3645 @cindex @code{color_trace()}
3646 To calculate the trace of an expression containing color objects you use one
3647 of the functions
3648
3649 @example
3650 ex color_trace(const ex & e, const std::set<unsigned char> & rls);
3651 ex color_trace(const ex & e, const lst & rll);
3652 ex color_trace(const ex & e, unsigned char rl = 0);
3653 @end example
3654
3655 These functions take the trace over all color @samp{T} objects in the
3656 specified set @code{rls} or list @code{rll} of representation labels, or the
3657 single label @code{rl}; @samp{T}s with other labels are left standing. For
3658 example:
3659
3660 @example
3661     ...
3662     e = color_trace(4 * color_T(a) * color_T(b) * color_T(c));
3663     cout << e << endl;
3664      // -> -I*f.a.c.b+d.a.c.b
3665 @}
3666 @end example
3667
3668
3669 @node Hash Maps, Methods and Functions, Non-commutative objects, Basic Concepts
3670 @c    node-name, next, previous, up
3671 @section Hash Maps
3672 @cindex hash maps
3673 @cindex @code{exhashmap} (class)
3674
3675 For your convenience, GiNaC offers the container template @code{exhashmap<T>}
3676 that can be used as a drop-in replacement for the STL
3677 @code{std::map<ex, T, ex_is_less>}, using hash tables to provide faster,
3678 typically constant-time, element look-up than @code{map<>}.
3679
3680 @code{exhashmap<>} supports all @code{map<>} members and operations, with the
3681 following differences:
3682
3683 @itemize @bullet
3684 @item
3685 no @code{lower_bound()} and @code{upper_bound()} methods
3686 @item
3687 no reverse iterators, no @code{rbegin()}/@code{rend()}
3688 @item 
3689 no @code{operator<(exhashmap, exhashmap)}
3690 @item
3691 the comparison function object @code{key_compare} is hardcoded to
3692 @code{ex_is_less}
3693 @item
3694 the constructor @code{exhashmap(size_t n)} allows specifying the minimum
3695 initial hash table size (the actual table size after construction may be
3696 larger than the specified value)
3697 @item
3698 the method @code{size_t bucket_count()} returns the current size of the hash
3699 table
3700 @item 
3701 @code{insert()} and @code{erase()} operations invalidate all iterators
3702 @end itemize
3703
3704
3705 @node Methods and Functions, Information About Expressions, Hash Maps, Top
3706 @c    node-name, next, previous, up
3707 @chapter Methods and Functions
3708 @cindex polynomial
3709
3710 In this chapter the most important algorithms provided by GiNaC will be
3711 described.  Some of them are implemented as functions on expressions,
3712 others are implemented as methods provided by expression objects.  If
3713 they are methods, there exists a wrapper function around it, so you can
3714 alternatively call it in a functional way as shown in the simple
3715 example:
3716
3717 @example
3718     ...
3719     cout << "As method:   " << sin(1).evalf() << endl;
3720     cout << "As function: " << evalf(sin(1)) << endl;
3721     ...
3722 @end example
3723
3724 @cindex @code{subs()}
3725 The general rule is that wherever methods accept one or more parameters
3726 (@var{arg1}, @var{arg2}, @dots{}) the order of arguments the function
3727 wrapper accepts is the same but preceded by the object to act on
3728 (@var{object}, @var{arg1}, @var{arg2}, @dots{}).  This approach is the
3729 most natural one in an OO model but it may lead to confusion for MapleV
3730 users because where they would type @code{A:=x+1; subs(x=2,A);} GiNaC
3731 would require @code{A=x+1; subs(A,x==2);} (after proper declaration of
3732 @code{A} and @code{x}).  On the other hand, since MapleV returns 3 on
3733 @code{A:=x^2+3; coeff(A,x,0);} (GiNaC: @code{A=pow(x,2)+3;
3734 coeff(A,x,0);}) it is clear that MapleV is not trying to be consistent
3735 here.  Also, users of MuPAD will in most cases feel more comfortable
3736 with GiNaC's convention.  All function wrappers are implemented
3737 as simple inline functions which just call the corresponding method and
3738 are only provided for users uncomfortable with OO who are dead set to
3739 avoid method invocations.  Generally, nested function wrappers are much
3740 harder to read than a sequence of methods and should therefore be
3741 avoided if possible.  On the other hand, not everything in GiNaC is a
3742 method on class @code{ex} and sometimes calling a function cannot be
3743 avoided.
3744
3745 @menu
3746 * Information About Expressions::
3747 * Numerical Evaluation::
3748 * Substituting Expressions::
3749 * Pattern Matching and Advanced Substitutions::
3750 * Applying a Function on Subexpressions::
3751 * Visitors and Tree Traversal::
3752 * Polynomial Arithmetic::           Working with polynomials.
3753 * Rational Expressions::            Working with rational functions.
3754 * Symbolic Differentiation::
3755 * Series Expansion::                Taylor and Laurent expansion.
3756 * Symmetrization::
3757 * Built-in Functions::              List of predefined mathematical functions.
3758 * Multiple polylogarithms::
3759 * Complex Conjugation::
3760 * Built-in Functions::              List of predefined mathematical functions.
3761 * Solving Linear Systems of Equations::
3762 * Input/Output::                    Input and output of expressions.
3763 @end menu
3764
3765
3766 @node Information About Expressions, Numerical Evaluation, Methods and Functions, Methods and Functions
3767 @c    node-name, next, previous, up
3768 @section Getting information about expressions
3769
3770 @subsection Checking expression types
3771 @cindex @code{is_a<@dots{}>()}
3772 @cindex @code{is_exactly_a<@dots{}>()}
3773 @cindex @code{ex_to<@dots{}>()}
3774 @cindex Converting @code{ex} to other classes
3775 @cindex @code{info()}
3776 @cindex @code{return_type()}
3777 @cindex @code{return_type_tinfo()}
3778
3779 Sometimes it's useful to check whether a given expression is a plain number,
3780 a sum, a polynomial with integer coefficients, or of some other specific type.
3781 GiNaC provides a couple of functions for this:
3782
3783 @example
3784 bool is_a<T>(const ex & e);
3785 bool is_exactly_a<T>(const ex & e);
3786 bool ex::info(unsigned flag);
3787 unsigned ex::return_type() const;
3788 unsigned ex::return_type_tinfo() const;
3789 @end example
3790
3791 When the test made by @code{is_a<T>()} returns true, it is safe to call
3792 one of the functions @code{ex_to<T>()}, where @code{T} is one of the
3793 class names (@xref{The Class Hierarchy}, for a list of all classes). For
3794 example, assuming @code{e} is an @code{ex}:
3795
3796 @example
3797 @{
3798     @dots{}
3799     if (is_a<numeric>(e))
3800         numeric n = ex_to<numeric>(e);
3801     @dots{}
3802 @}
3803 @end example
3804
3805 @code{is_a<T>(e)} allows you to check whether the top-level object of
3806 an expression @samp{e} is an instance of the GiNaC class @samp{T}
3807 (@xref{The Class Hierarchy}, for a list of all classes). This is most useful,
3808 e.g., for checking whether an expression is a number, a sum, or a product:
3809
3810 @example
3811 @{
3812     symbol x("x");
3813     ex e1 = 42;
3814     ex e2 = 4*x - 3;
3815     is_a<numeric>(e1);  // true
3816     is_a<numeric>(e2);  // false
3817     is_a<add>(e1);      // false
3818     is_a<add>(e2);      // true
3819     is_a<mul>(e1);      // false
3820     is_a<mul>(e2);      // false
3821 @}
3822 @end example
3823
3824 In contrast, @code{is_exactly_a<T>(e)} allows you to check whether the
3825 top-level object of an expression @samp{e} is an instance of the GiNaC
3826 class @samp{T}, not including parent classes.
3827
3828 The @code{info()} method is used for checking certain attributes of
3829 expressions. The possible values for the @code{flag} argument are defined
3830 in @file{ginac/flags.h}, the most important being explained in the following
3831 table:
3832
3833 @cartouche
3834 @multitable @columnfractions .30 .70
3835 @item @strong{Flag} @tab @strong{Returns true if the object is@dots{}}
3836 @item @code{numeric}
3837 @tab @dots{}a number (same as @code{is_a<numeric>(...)})
3838 @item @code{real}
3839 @tab @dots{}a real integer, rational or float (i.e. is not complex)
3840 @item @code{rational}
3841 @tab @dots{}an exact rational number (integers are rational, too)
3842 @item @code{integer}
3843 @tab @dots{}a (non-complex) integer
3844 @item @code{crational}
3845 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
3846 @item @code{cinteger}
3847 @tab @dots{}a (complex) integer (such as @math{2-3*I})
3848 @item @code{positive}
3849 @tab @dots{}not complex and greater than 0
3850 @item @code{negative}
3851 @tab @dots{}not complex and less than 0
3852 @item @code{nonnegative}
3853 @tab @dots{}not complex and greater than or equal to 0
3854 @item @code{posint}
3855 @tab @dots{}an integer greater than 0
3856 @item @code{negint}
3857 @tab @dots{}an integer less than 0
3858 @item @code{nonnegint}
3859 @tab @dots{}an integer greater than or equal to 0
3860 @item @code{even}
3861 @tab @dots{}an even integer
3862 @item @code{odd}
3863 @tab @dots{}an odd integer
3864 @item @code{prime}
3865 @tab @dots{}a prime integer (probabilistic primality test)
3866 @item @code{relation}
3867 @tab @dots{}a relation (same as @code{is_a<relational>(...)})
3868 @item @code{relation_equal}
3869 @tab @dots{}a @code{==} relation
3870 @item @code{relation_not_equal}
3871 @tab @dots{}a @code{!=} relation
3872 @item @code{relation_less}
3873 @tab @dots{}a @code{<} relation
3874 @item @code{relation_less_or_equal}
3875 @tab @dots{}a @code{<=} relation
3876 @item @code{relation_greater}
3877 @tab @dots{}a @code{>} relation
3878 @item @code{relation_greater_or_equal}
3879 @tab @dots{}a @code{>=} relation
3880 @item @code{symbol}
3881 @tab @dots{}a symbol (same as @code{is_a<symbol>(...)})
3882 @item @code{list}
3883 @tab @dots{}a list (same as @code{is_a<lst>(...)})
3884 @item @code{polynomial}
3885 @tab @dots{}a polynomial (i.e. only consists of sums and products of numbers and symbols with positive integer powers)
3886 @item @code{integer_polynomial}
3887 @tab @dots{}a polynomial with (non-complex) integer coefficients
3888 @item @code{cinteger_polynomial}
3889 @tab @dots{}a polynomial with (possibly complex) integer coefficients (such as @math{2-3*I})
3890 @item @code{rational_polynomial}
3891 @tab @dots{}a polynomial with (non-complex) rational coefficients
3892 @item @code{crational_polynomial}
3893 @tab @dots{}a polynomial with (possibly complex) rational coefficients (such as @math{2/3+7/2*I})
3894 @item @code{rational_function}
3895 @tab @dots{}a rational function (@math{x+y}, @math{z/(x+y)})
3896 @item @code{algebraic}
3897 @tab @dots{}an algebraic object (@math{sqrt(2)}, @math{sqrt(x)-1})
3898 @end multitable
3899 @end cartouche
3900
3901 To determine whether an expression is commutative or non-commutative and if
3902 so, with which other expressions it would commutate, you use the methods
3903 @code{return_type()} and @code{return_type_tinfo()}. @xref{Non-commutative objects},
3904 for an explanation of these.
3905
3906
3907 @subsection Accessing subexpressions
3908 @cindex container
3909
3910 Many GiNaC classes, like @code{add}, @code{mul}, @code{lst}, and
3911 @code{function}, act as containers for subexpressions. For example, the
3912 subexpressions of a sum (an @code{add} object) are the individual terms,
3913 and the subexpressions of a @code{function} are the function's arguments.
3914
3915 @cindex @code{nops()}
3916 @cindex @code{op()}
3917 GiNaC provides several ways of accessing subexpressions. The first way is to
3918 use the two methods
3919
3920 @example
3921 size_t ex::nops();
3922 ex ex::op(size_t i);
3923 @end example
3924
3925 @code{nops()} determines the number of subexpressions (operands) contained
3926 in the expression, while @code{op(i)} returns the @code{i}-th
3927 (0..@code{nops()-1}) subexpression. In the case of a @code{power} object,
3928 @code{op(0)} will return the basis and @code{op(1)} the exponent. For
3929 @code{indexed} objects, @code{op(0)} is the base expression and @code{op(i)},
3930 @math{i>0} are the indices.
3931
3932 @cindex iterators
3933 @cindex @code{const_iterator}
3934 The second way to access subexpressions is via the STL-style random-access
3935 iterator class @code{const_iterator} and the methods
3936
3937 @example
3938 const_iterator ex::begin();
3939 const_iterator ex::end();
3940 @end example
3941
3942 @code{begin()} returns an iterator referring to the first subexpression;
3943 @code{end()} returns an iterator which is one-past the last subexpression.
3944 If the expression has no subexpressions, then @code{begin() == end()}. These
3945 iterators can also be used in conjunction with non-modifying STL algorithms.
3946
3947 Here is an example that (non-recursively) prints the subexpressions of a
3948 given expression in three different ways:
3949
3950 @example
3951 @{
3952     ex e = ...
3953
3954     // with nops()/op()
3955     for (size_t i = 0; i != e.nops(); ++i)
3956         cout << e.op(i) << endl;
3957
3958     // with iterators
3959     for (const_iterator i = e.begin(); i != e.end(); ++i)
3960         cout << *i << endl;
3961
3962     // with iterators and STL copy()
3963     std::copy(e.begin(), e.end(), std::ostream_iterator<ex>(cout, "\n"));
3964 @}
3965 @end example
3966
3967 @cindex @code{const_preorder_iterator}
3968 @cindex @code{const_postorder_iterator}
3969 @code{op()}/@code{nops()} and @code{const_iterator} only access an
3970 expression's immediate children. GiNaC provides two additional iterator
3971 classes, @code{const_preorder_iterator} and @code{const_postorder_iterator},
3972 that iterate over all objects in an expression tree, in preorder or postorder,
3973 respectively. They are STL-style forward iterators, and are created with the
3974 methods
3975
3976 @example
3977 const_preorder_iterator ex::preorder_begin();
3978 const_preorder_iterator ex::preorder_end();
3979 const_postorder_iterator ex::postorder_begin();
3980 const_postorder_iterator ex::postorder_end();
3981 @end example
3982
3983 The following example illustrates the differences between
3984 @code{const_iterator}, @code{const_preorder_iterator}, and
3985 @code{const_postorder_iterator}:
3986
3987 @example
3988 @{
3989     symbol A("A"), B("B"), C("C");
3990     ex e = lst(lst(A, B), C);
3991
3992     std::copy(e.begin(), e.end(),
3993               std::ostream_iterator<ex>(cout, "\n"));
3994     // @{A,B@}
3995     // C
3996
3997     std::copy(e.preorder_begin(), e.preorder_end(),
3998               std::ostream_iterator<ex>(cout, "\n"));
3999     // @{@{A,B@},C@}
4000     // @{A,B@}
4001     // A
4002     // B
4003     // C
4004
4005     std::copy(e.postorder_begin(), e.postorder_end(),
4006               std::ostream_iterator<ex>(cout, "\n"));
4007     // A
4008     // B
4009     // @{A,B@}
4010     // C
4011     // @{@{A,B@},C@}
4012 @}
4013 @end example
4014
4015 @cindex @code{relational} (class)
4016 Finally, the left-hand side and right-hand side expressions of objects of
4017 class @code{relational} (and only of these) can also be accessed with the
4018 methods
4019
4020 @example
4021 ex ex::lhs();
4022 ex ex::rhs();
4023 @end example
4024
4025
4026 @subsection Comparing expressions
4027 @cindex @code{is_equal()}
4028 @cindex @code{is_zero()}
4029
4030 Expressions can be compared with the usual C++ relational operators like
4031 @code{==}, @code{>}, and @code{<} but if the expressions contain symbols,
4032 the result is usually not determinable and the result will be @code{false},
4033 except in the case of the @code{!=} operator. You should also be aware that
4034 GiNaC will only do the most trivial test for equality (subtracting both
4035 expressions), so something like @code{(pow(x,2)+x)/x==x+1} will return
4036 @code{false}.
4037
4038 Actually, if you construct an expression like @code{a == b}, this will be
4039 represented by an object of the @code{relational} class (@pxref{Relations})
4040 which is not evaluated until (explicitly or implicitly) cast to a @code{bool}.
4041
4042 There are also two methods
4043
4044 @example
4045 bool ex::is_equal(const ex & other);
4046 bool ex::is_zero();
4047 @end example
4048
4049 for checking whether one expression is equal to another, or equal to zero,
4050 respectively.
4051
4052
4053 @subsection Ordering expressions
4054 @cindex @code{ex_is_less} (class)
4055 @cindex @code{ex_is_equal} (class)
4056 @cindex @code{compare()}
4057
4058 Sometimes it is necessary to establish a mathematically well-defined ordering
4059 on a set of arbitrary expressions, for example to use expressions as keys
4060 in a @code{std::map<>} container, or to bring a vector of expressions into
4061 a canonical order (which is done internally by GiNaC for sums and products).
4062
4063 The operators @code{<}, @code{>} etc. described in the last section cannot
4064 be used for this, as they don't implement an ordering relation in the
4065 mathematical sense. In particular, they are not guaranteed to be
4066 antisymmetric: if @samp{a} and @samp{b} are different expressions, and
4067 @code{a < b} yields @code{false}, then @code{b < a} doesn't necessarily
4068 yield @code{true}.
4069
4070 By default, STL classes and algorithms use the @code{<} and @code{==}
4071 operators to compare objects, which are unsuitable for expressions, but GiNaC
4072 provides two functors that can be supplied as proper binary comparison
4073 predicates to the STL:
4074
4075 @example
4076 class ex_is_less : public std::binary_function<ex, ex, bool> @{
4077 public:
4078     bool operator()(const ex &lh, const ex &rh) const;
4079 @};
4080
4081 class ex_is_equal : public std::binary_function<ex, ex, bool> @{
4082 public:
4083     bool operator()(const ex &lh, const ex &rh) const;
4084 @};
4085 @end example
4086
4087 For example, to define a @code{map} that maps expressions to strings you
4088 have to use
4089
4090 @example
4091 std::map<ex, std::string, ex_is_less> myMap;
4092 @end example
4093
4094 Omitting the @code{ex_is_less} template parameter will introduce spurious
4095 bugs because the map operates improperly.
4096
4097 Other examples for the use of the functors:
4098
4099 @example
4100 std::vector<ex> v;
4101 // fill vector
4102 ...
4103
4104 // sort vector
4105 std::sort(v.begin(), v.end(), ex_is_less());
4106
4107 // count the number of expressions equal to '1'
4108 unsigned num_ones = std::count_if(v.begin(), v.end(),
4109                                   std::bind2nd(ex_is_equal(), 1));
4110 @end example
4111
4112 The implementation of @code{ex_is_less} uses the member function
4113
4114 @example
4115 int ex::compare(const ex & other) const;
4116 @end example
4117
4118 which returns @math{0} if @code{*this} and @code{other} are equal, @math{-1}
4119 if @code{*this} sorts before @code{other}, and @math{1} if @code{*this} sorts
4120 after @code{other}.
4121
4122
4123 @node Numerical Evaluation, Substituting Expressions, Information About Expressions, Methods and Functions
4124 @c    node-name, next, previous, up
4125 @section Numerical Evaluation
4126 @cindex @code{evalf()}
4127
4128 GiNaC keeps algebraic expressions, numbers and constants in their exact form.
4129 To evaluate them using floating-point arithmetic you need to call
4130
4131 @example
4132 ex ex::evalf(int level = 0) const;
4133 @end example
4134
4135 @cindex @code{Digits}
4136 The accuracy of the evaluation is controlled by the global object @code{Digits}
4137 which can be assigned an integer value. The default value of @code{Digits}
4138 is 17. @xref{Numbers}, for more information and examples.
4139
4140 To evaluate an expression to a @code{double} floating-point number you can
4141 call @code{evalf()} followed by @code{numeric::to_double()}, like this:
4142
4143 @example
4144 @{
4145     // Approximate sin(x/Pi)
4146     symbol x("x");
4147     ex e = series(sin(x/Pi), x == 0, 6);
4148
4149     // Evaluate numerically at x=0.1
4150     ex f = evalf(e.subs(x == 0.1));
4151
4152     // ex_to<numeric> is an unsafe cast, so check the type first
4153     if (is_a<numeric>(f)) @{
4154         double d = ex_to<numeric>(f).to_double();
4155         cout << d << endl;
4156          // -> 0.0318256
4157     @} else
4158         // error
4159 @}
4160 @end example
4161
4162
4163 @node Substituting Expressions, Pattern Matching and Advanced Substitutions, Numerical Evaluation, Methods and Functions
4164 @c    node-name, next, previous, up
4165 @section Substituting expressions
4166 @cindex @code{subs()}
4167
4168 Algebraic objects inside expressions can be replaced with arbitrary
4169 expressions via the @code{.subs()} method:
4170
4171 @example
4172 ex ex::subs(const ex & e, unsigned options = 0);
4173 ex ex::subs(const exmap & m, unsigned options = 0);
4174 ex ex::subs(const lst & syms, const lst & repls, unsigned options = 0);
4175 @end example
4176
4177 In the first form, @code{subs()} accepts a relational of the form
4178 @samp{object == expression} or a @code{lst} of such relationals:
4179
4180 @example
4181 @{
4182     symbol x("x"), y("y");
4183
4184     ex e1 = 2*x^2-4*x+3;
4185     cout << "e1(7) = " << e1.subs(x == 7) << endl;
4186      // -> 73
4187
4188     ex e2 = x*y + x;
4189     cout << "e2(-2, 4) = " << e2.subs(lst(x == -2, y == 4)) << endl;
4190      // -> -10
4191 @}
4192 @end example
4193
4194 If you specify multiple substitutions, they are performed in parallel, so e.g.
4195 @code{subs(lst(x == y, y == x))} exchanges @samp{x} and @samp{y}.
4196
4197 The second form of @code{subs()} takes an @code{exmap} object which is a
4198 pair associative container that maps expressions to expressions (currently
4199 implemented as a @code{std::map}). This is the most efficient one of the
4200 three @code{subs()} forms and should be used when the number of objects to
4201 be substituted is large or unknown.
4202
4203 Using this form, the second example from above would look like this:
4204
4205 @example
4206 @{
4207     symbol x("x"), y("y");
4208     ex e2 = x*y + x;
4209
4210     exmap m;
4211     m[x] = -2;
4212     m[y] = 4;
4213     cout << "e2(-2, 4) = " << e2.subs(m) << endl;
4214 @}
4215 @end example
4216
4217 The third form of @code{subs()} takes two lists, one for the objects to be
4218 replaced and one for the expressions to be substituted (both lists must
4219 contain the same number of elements). Using this form, you would write
4220
4221 @example
4222 @{
4223     symbol x("x"), y("y");
4224     ex e2 = x*y + x;
4225
4226     cout << "e2(-2, 4) = " << e2.subs(lst(x, y), lst(-2, 4)) << endl;
4227 @}
4228 @end example
4229
4230 The optional last argument to @code{subs()} is a combination of
4231 @code{subs_options} flags. There are two options available:
4232 @code{subs_options::no_pattern} disables pattern matching, which makes
4233 large @code{subs()} operations significantly faster if you are not using
4234 patterns. The second option, @code{subs_options::algebraic} enables
4235 algebraic substitutions in products and powers.
4236 @ref{Pattern Matching and Advanced Substitutions}, for more information
4237 about patterns and algebraic substitutions.
4238
4239 @code{subs()} performs syntactic substitution of any complete algebraic
4240 object; it does not try to match sub-expressions as is demonstrated by the
4241 following example:
4242
4243 @example
4244 @{
4245     symbol x("x"), y("y"), z("z");
4246
4247     ex e1 = pow(x+y, 2);
4248     cout << e1.subs(x+y == 4) << endl;
4249      // -> 16
4250
4251     ex e2 = sin(x)*sin(y)*cos(x);
4252     cout << e2.subs(sin(x) == cos(x)) << endl;
4253      // -> cos(x)^2*sin(y)
4254
4255     ex e3 = x+y+z;
4256     cout << e3.subs(x+y == 4) << endl;
4257      // -> x+y+z
4258      // (and not 4+z as one might expect)
4259 @}
4260 @end example
4261
4262 A more powerful form of substitution using wildcards is described in the
4263 next section.
4264
4265
4266 @node Pattern Matching and Advanced Substitutions, Applying a Function on Subexpressions, Substituting Expressions, Methods and Functions
4267 @c    node-name, next, previous, up
4268 @section Pattern matching and advanced substitutions
4269 @cindex @code{wildcard} (class)
4270 @cindex Pattern matching
4271
4272 GiNaC allows the use of patterns for checking whether an expression is of a
4273 certain form or contains subexpressions of a certain form, and for
4274 substituting expressions in a more general way.
4275
4276 A @dfn{pattern} is an algebraic expression that optionally contains wildcards.
4277 A @dfn{wildcard} is a special kind of object (of class @code{wildcard}) that
4278 represents an arbitrary expression. Every wildcard has a @dfn{label} which is
4279 an unsigned integer number to allow having multiple different wildcards in a
4280 pattern. Wildcards are printed as @samp{$label} (this is also the way they
4281 are specified in @command{ginsh}). In C++ code, wildcard objects are created
4282 with the call
4283
4284 @example
4285 ex wild(unsigned label = 0);
4286 @end example
4287
4288 which is simply a wrapper for the @code{wildcard()} constructor with a shorter
4289 name.
4290
4291 Some examples for patterns:
4292
4293 @multitable @columnfractions .5 .5
4294 @item @strong{Constructed as} @tab @strong{Output as}
4295 @item @code{wild()} @tab @samp{$0}
4296 @item @code{pow(x,wild())} @tab @samp{x^$0}
4297 @item @code{atan2(wild(1),wild(2))} @tab @samp{atan2($1,$2)}
4298 @item @code{indexed(A,idx(wild(),3))} @tab @samp{A.$0}
4299 @end multitable
4300
4301 Notes:
4302
4303 @itemize
4304 @item Wildcards behave like symbols and are subject to the same algebraic
4305   rules. E.g., @samp{$0+2*$0} is automatically transformed to @samp{3*$0}.
4306 @item As shown in the last example, to use wildcards for indices you have to
4307   use them as the value of an @code{idx} object. This is because indices must
4308   always be of class @code{idx} (or a subclass).
4309 @item Wildcards only represent expressions or subexpressions. It is not
4310   possible to use them as placeholders for other properties like index
4311   dimension or variance, representation labels, symmetry of indexed objects
4312   etc.
4313 @item Because wildcards are commutative, it is not possible to use wildcards
4314   as part of noncommutative products.
4315 @item A pattern does not have to contain wildcards. @samp{x} and @samp{x+y}
4316   are also valid patterns.
4317 @end itemize
4318
4319 @subsection Matching expressions
4320 @cindex @code{match()}
4321 The most basic application of patterns is to check whether an expression
4322 matches a given pattern. This is done by the function
4323
4324 @example
4325 bool ex::match(const ex & pattern);
4326 bool ex::match(const ex & pattern, lst & repls);
4327 @end example
4328
4329 This function returns @code{true} when the expression matches the pattern
4330 and @code{false} if it doesn't. If used in the second form, the actual
4331 subexpressions matched by the wildcards get returned in the @code{repls}
4332 object as a list of relations of the form @samp{wildcard == expression}.
4333 If @code{match()} returns false, the state of @code{repls} is undefined.
4334 For reproducible results, the list should be empty when passed to
4335 @code{match()}, but it is also possible to find similarities in multiple
4336 expressions by passing in the result of a previous match.
4337
4338 The matching algorithm works as follows:
4339
4340 @itemize
4341 @item A single wildcard matches any expression. If one wildcard appears
4342   multiple times in a pattern, it must match the same expression in all
4343   places (e.g. @samp{$0} matches anything, and @samp{$0*($0+1)} matches
4344   @samp{x*(x+1)} but not @samp{x*(y+1)}).
4345 @item If the expression is not of the same class as the pattern, the match
4346   fails (i.e. a sum only matches a sum, a function only matches a function,
4347   etc.).
4348 @item If the pattern is a function, it only matches the same function
4349   (i.e. @samp{sin($0)} matches @samp{sin(x)} but doesn't match @samp{exp(x)}).
4350 @item Except for sums and products, the match fails if the number of
4351   subexpressions (@code{nops()}) is not equal to the number of subexpressions
4352   of the pattern.
4353 @item If there are no subexpressions, the expressions and the pattern must
4354   be equal (in the sense of @code{is_equal()}).
4355 @item Except for sums and products, each subexpression (@code{op()}) must
4356   match the corresponding subexpression of the pattern.
4357 @end itemize
4358
4359 Sums (@code{add}) and products (@code{mul}) are treated in a special way to
4360 account for their commutativity and associativity:
4361
4362 @itemize
4363 @item If the pattern contains a term or factor that is a single wildcard,
4364   this one is used as the @dfn{global wildcard}. If there is more than one
4365   such wildcard, one of them is chosen as the global wildcard in a random
4366   way.
4367 @item Every term/factor of the pattern, except the global wildcard, is
4368   matched against every term of the expression in sequence. If no match is
4369   found, the whole match fails. Terms that did match are not considered in
4370   further matches.
4371 @item If there are no unmatched terms left, the match succeeds. Otherwise
4372   the match fails unless there is a global wildcard in the pattern, in
4373   which case this wildcard matches the remaining terms.
4374 @end itemize
4375
4376 In general, having more than one single wildcard as a term of a sum or a
4377 factor of a product (such as @samp{a+$0+$1}) will lead to unpredictable or
4378 ambiguous results.
4379
4380 Here are some examples in @command{ginsh} to demonstrate how it works (the
4381 @code{match()} function in @command{ginsh} returns @samp{FAIL} if the
4382 match fails, and the list of wildcard replacements otherwise):
4383
4384 @example
4385 > match((x+y)^a,(x+y)^a);
4386 @{@}
4387 > match((x+y)^a,(x+y)^b);
4388 FAIL
4389 > match((x+y)^a,$1^$2);
4390 @{$1==x+y,$2==a@}
4391 > match((x+y)^a,$1^$1);
4392 FAIL
4393 > match((x+y)^(x+y),$1^$1);
4394 @{$1==x+y@}
4395 > match((x+y)^(x+y),$1^$2);
4396 @{$1==x+y,$2==x+y@}
4397 > match((a+b)*(a+c),($1+b)*($1+c));
4398 @{$1==a@}
4399 > match((a+b)*(a+c),(a+$1)*(a+$2));
4400 @{$1==c,$2==b@}
4401   (Unpredictable. The result might also be [$1==c,$2==b].)
4402 > match((a+b)*(a+c),($1+$2)*($1+$3));
4403   (The result is undefined. Due to the sequential nature of the algorithm
4404    and the re-ordering of terms in GiNaC, the match for the first factor
4405    may be @{$1==a,$2==b@} in which case the match for the second factor
4406    succeeds, or it may be @{$1==b,$2==a@} which causes the second match to
4407    fail.)
4408 > match(a*(x+y)+a*z+b,a*$1+$2);
4409   (This is also ambiguous and may return either @{$1==z,$2==a*(x+y)+b@} or
4410    @{$1=x+y,$2=a*z+b@}.)
4411 > match(a+b+c+d+e+f,c);
4412 FAIL
4413 > match(a+b+c+d+e+f,c+$0);
4414 @{$0==a+e+b+f+d@}
4415 > match(a+b+c+d+e+f,c+e+$0);
4416 @{$0==a+b+f+d@}
4417 > match(a+b,a+b+$0);
4418 @{$0==0@}
4419 > match(a*b^2,a^$1*b^$2);
4420 FAIL
4421   (The matching is syntactic, not algebraic, and "a" doesn't match "a^$1"
4422    even though a==a^1.)
4423 > match(x*atan2(x,x^2),$0*atan2($0,$0^2));
4424 @{$0==x@}
4425 > match(atan2(y,x^2),atan2(y,$0));
4426 @{$0==x^2@}
4427 @end example
4428
4429 @subsection Matching parts of expressions
4430 @cindex @code{has()}
4431 A more general way to look for patterns in expressions is provided by the
4432 member function
4433
4434 @example
4435 bool ex::has(const ex & pattern);
4436 @end example
4437
4438 This function checks whether a pattern is matched by an expression itself or
4439 by any of its subexpressions.
4440
4441 Again some examples in @command{ginsh} for illustration (in @command{ginsh},
4442 @code{has()} returns @samp{1} for @code{true} and @samp{0} for @code{false}):
4443
4444 @example
4445 > has(x*sin(x+y+2*a),y);
4446 1
4447 > has(x*sin(x+y+2*a),x+y);
4448 0
4449   (This is because in GiNaC, "x+y" is not a subexpression of "x+y+2*a" (which
4450    has the subexpressions "x", "y" and "2*a".)
4451 > has(x*sin(x+y+2*a),x+y+$1);
4452 1
4453   (But this is possible.)
4454 > has(x*sin(2*(x+y)+2*a),x+y);
4455 0