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