- documented numeric::to_int()/to_long()/to_double()/to_cl_N()
[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-2003 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
52
53 @page
54 @vskip 0pt plus 1filll
55 Copyright @copyright{} 1999-2003 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-2003 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 @end menu
689
690
691 @node Expressions, Automatic evaluation, Basic Concepts, Basic Concepts
692 @c    node-name, next, previous, up
693 @section Expressions
694 @cindex expression (class @code{ex})
695 @cindex @code{has()}
696
697 The most common class of objects a user deals with is the expression
698 @code{ex}, representing a mathematical object like a variable, number,
699 function, sum, product, etc@dots{}  Expressions may be put together to form
700 new expressions, passed as arguments to functions, and so on.  Here is a
701 little collection of valid expressions:
702
703 @example
704 ex MyEx1 = 5;                       // simple number
705 ex MyEx2 = x + 2*y;                 // polynomial in x and y
706 ex MyEx3 = (x + 1)/(x - 1);         // rational expression
707 ex MyEx4 = sin(x + 2*y) + 3*z + 41; // containing a function
708 ex MyEx5 = MyEx4 + 1;               // similar to above
709 @end example
710
711 Expressions are handles to other more fundamental objects, that often
712 contain other expressions thus creating a tree of expressions
713 (@xref{Internal Structures}, for particular examples).  Most methods on
714 @code{ex} therefore run top-down through such an expression tree.  For
715 example, the method @code{has()} scans recursively for occurrences of
716 something inside an expression.  Thus, if you have declared @code{MyEx4}
717 as in the example above @code{MyEx4.has(y)} will find @code{y} inside
718 the argument of @code{sin} and hence return @code{true}.
719
720 The next sections will outline the general picture of GiNaC's class
721 hierarchy and describe the classes of objects that are handled by
722 @code{ex}.
723
724
725 @node Automatic evaluation, Error handling, Expressions, Basic Concepts
726 @c    node-name, next, previous, up
727 @section Automatic evaluation and canonicalization of expressions
728 @cindex evaluation
729
730 GiNaC performs some automatic transformations on expressions, to simplify
731 them and put them into a canonical form. Some examples:
732
733 @example
734 ex MyEx1 = 2*x - 1 + x;  // 3*x-1
735 ex MyEx2 = x - x;        // 0
736 ex MyEx3 = cos(2*Pi);    // 1
737 ex MyEx4 = x*y/x;        // y
738 @end example
739
740 This behavior is usually referred to as @dfn{automatic} or @dfn{anonymous
741 evaluation}. GiNaC only performs transformations that are
742
743 @itemize @bullet
744 @item
745 at most of complexity @math{O(n log n)}
746 @item
747 algebraically correct, possibly except for a set of measure zero (e.g.
748 @math{x/x} is transformed to @math{1} although this is incorrect for @math{x=0})
749 @end itemize
750
751 There are two types of automatic transformations in GiNaC that may not
752 behave in an entirely obvious way at first glance:
753
754 @itemize
755 @item
756 The terms of sums and products (and some other things like the arguments of
757 symmetric functions, the indices of symmetric tensors etc.) are re-ordered
758 into a canonical form that is deterministic, but not lexicographical or in
759 any other way easily guessable (it almost always depends on the number and
760 order of the symbols you define). However, constructing the same expression
761 twice, either implicitly or explicitly, will always result in the same
762 canonical form.
763 @item
764 Expressions of the form 'number times sum' are automatically expanded (this
765 has to do with GiNaC's internal representation of sums and products). For
766 example
767 @example
768 ex MyEx5 = 2*(x + y);   // 2*x+2*y
769 ex MyEx6 = z*(x + y);   // z*(x+y)
770 @end example
771 @end itemize
772
773 The general rule is that when you construct expressions, GiNaC automatically
774 creates them in canonical form, which might differ from the form you typed in
775 your program. This may create some awkward looking output (@samp{-y+x} instead
776 of @samp{x-y}) but allows for more efficient operation and usually yields
777 some immediate simplifications.
778
779 @cindex @code{eval()}
780 Internally, the anonymous evaluator in GiNaC is implemented by the methods
781
782 @example
783 ex ex::eval(int level = 0) const;
784 ex basic::eval(int level = 0) const;
785 @end example
786
787 but unless you are extending GiNaC with your own classes or functions, there
788 should never be any reason to call them explicitly. All GiNaC methods that
789 transform expressions, like @code{subs()} or @code{normal()}, automatically
790 re-evaluate their results.
791
792
793 @node Error handling, The Class Hierarchy, Automatic evaluation, Basic Concepts
794 @c    node-name, next, previous, up
795 @section Error handling
796 @cindex exceptions
797 @cindex @code{pole_error} (class)
798
799 GiNaC reports run-time errors by throwing C++ exceptions. All exceptions
800 generated by GiNaC are subclassed from the standard @code{exception} class
801 defined in the @file{<stdexcept>} header. In addition to the predefined
802 @code{logic_error}, @code{domain_error}, @code{out_of_range},
803 @code{invalid_argument}, @code{runtime_error}, @code{range_error} and
804 @code{overflow_error} types, GiNaC also defines a @code{pole_error}
805 exception that gets thrown when trying to evaluate a mathematical function
806 at a singularity.
807
808 The @code{pole_error} class has a member function
809
810 @example
811 int pole_error::degree() const;
812 @end example
813
814 that returns the order of the singularity (or 0 when the pole is
815 logarithmic or the order is undefined).
816
817 When using GiNaC it is useful to arrange for exceptions to be catched in
818 the main program even if you don't want to do any special error handling.
819 Otherwise whenever an error occurs in GiNaC, it will be delegated to the
820 default exception handler of your C++ compiler's run-time system which
821 usually only aborts the program without giving any information what went
822 wrong.
823
824 Here is an example for a @code{main()} function that catches and prints
825 exceptions generated by GiNaC:
826
827 @example
828 #include <iostream>
829 #include <stdexcept>
830 #include <ginac/ginac.h>
831 using namespace std;
832 using namespace GiNaC;
833
834 int main()
835 @{
836     try @{
837         ...
838         // code using GiNaC
839         ...
840     @} catch (exception &p) @{
841         cerr << p.what() << endl;
842         return 1;
843     @}
844     return 0;
845 @}
846 @end example
847
848
849 @node The Class Hierarchy, Symbols, Error handling, Basic Concepts
850 @c    node-name, next, previous, up
851 @section The Class Hierarchy
852
853 GiNaC's class hierarchy consists of several classes representing
854 mathematical objects, all of which (except for @code{ex} and some
855 helpers) are internally derived from one abstract base class called
856 @code{basic}.  You do not have to deal with objects of class
857 @code{basic}, instead you'll be dealing with symbols, numbers,
858 containers of expressions and so on.
859
860 @cindex container
861 @cindex atom
862 To get an idea about what kinds of symbolic composites may be built we
863 have a look at the most important classes in the class hierarchy and
864 some of the relations among the classes:
865
866 @image{classhierarchy}
867
868 The abstract classes shown here (the ones without drop-shadow) are of no
869 interest for the user.  They are used internally in order to avoid code
870 duplication if two or more classes derived from them share certain
871 features.  An example is @code{expairseq}, a container for a sequence of
872 pairs each consisting of one expression and a number (@code{numeric}).
873 What @emph{is} visible to the user are the derived classes @code{add}
874 and @code{mul}, representing sums and products.  @xref{Internal
875 Structures}, where these two classes are described in more detail.  The
876 following table shortly summarizes what kinds of mathematical objects
877 are stored in the different classes:
878
879 @cartouche
880 @multitable @columnfractions .22 .78
881 @item @code{symbol} @tab Algebraic symbols @math{a}, @math{x}, @math{y}@dots{}
882 @item @code{constant} @tab Constants like 
883 @tex
884 $\pi$
885 @end tex
886 @ifnottex
887 @math{Pi}
888 @end ifnottex
889 @item @code{numeric} @tab All kinds of numbers, @math{42}, @math{7/3*I}, @math{3.14159}@dots{}
890 @item @code{add} @tab Sums like @math{x+y} or @math{a-(2*b)+3}
891 @item @code{mul} @tab Products like @math{x*y} or @math{2*a^2*(x+y+z)/b}
892 @item @code{ncmul} @tab Products of non-commutative objects
893 @item @code{power} @tab Exponentials such as @math{x^2}, @math{a^b}, 
894 @tex
895 $\sqrt{2}$
896 @end tex
897 @ifnottex
898 @code{sqrt(}@math{2}@code{)}
899 @end ifnottex
900 @dots{}
901 @item @code{pseries} @tab Power Series, e.g. @math{x-1/6*x^3+1/120*x^5+O(x^7)}
902 @item @code{function} @tab A symbolic function like @math{sin(2*x)}
903 @item @code{lst} @tab Lists of expressions @{@math{x}, @math{2*y}, @math{3+z}@}
904 @item @code{matrix} @tab @math{m}x@math{n} matrices of expressions
905 @item @code{relational} @tab A relation like the identity @math{x}@code{==}@math{y}
906 @item @code{indexed} @tab Indexed object like @math{A_ij}
907 @item @code{tensor} @tab Special tensor like the delta and metric tensors
908 @item @code{idx} @tab Index of an indexed object
909 @item @code{varidx} @tab Index with variance
910 @item @code{spinidx} @tab Index with variance and dot (used in Weyl-van-der-Waerden spinor formalism)
911 @item @code{wildcard} @tab Wildcard for pattern matching
912 @item @code{structure} @tab Template for user-defined classes
913 @end multitable
914 @end cartouche
915
916
917 @node Symbols, Numbers, The Class Hierarchy, Basic Concepts
918 @c    node-name, next, previous, up
919 @section Symbols
920 @cindex @code{symbol} (class)
921 @cindex hierarchy of classes
922
923 @cindex atom
924 Symbols are for symbolic manipulation what atoms are for chemistry.  You
925 can declare objects of class @code{symbol} as any other object simply by
926 saying @code{symbol x,y;}.  There is, however, a catch in here having to
927 do with the fact that C++ is a compiled language.  The information about
928 the symbol's name is thrown away by the compiler but at a later stage
929 you may want to print expressions holding your symbols.  In order to
930 avoid confusion GiNaC's symbols are able to know their own name.  This
931 is accomplished by declaring its name for output at construction time in
932 the fashion @code{symbol x("x");}.  If you declare a symbol using the
933 default constructor (i.e. without string argument) the system will deal
934 out a unique name.  That name may not be suitable for printing but for
935 internal routines when no output is desired it is often enough.  We'll
936 come across examples of such symbols later in this tutorial.
937
938 This implies that the strings passed to symbols at construction time may
939 not be used for comparing two of them.  It is perfectly legitimate to
940 write @code{symbol x("x"),y("x");} but it is likely to lead into
941 trouble.  Here, @code{x} and @code{y} are different symbols and
942 statements like @code{x-y} will not be simplified to zero although the
943 output @code{x-x} looks funny.  Such output may also occur when there
944 are two different symbols in two scopes, for instance when you call a
945 function that declares a symbol with a name already existent in a symbol
946 in the calling function.  Again, comparing them (using @code{operator==}
947 for instance) will always reveal their difference.  Watch out, please.
948
949 @cindex @code{subs()}
950 Although symbols can be assigned expressions for internal reasons, you
951 should not do it (and we are not going to tell you how it is done).  If
952 you want to replace a symbol with something else in an expression, you
953 can use the expression's @code{.subs()} method (@pxref{Substituting Expressions}).
954
955
956 @node Numbers, Constants, Symbols, Basic Concepts
957 @c    node-name, next, previous, up
958 @section Numbers
959 @cindex @code{numeric} (class)
960
961 @cindex GMP
962 @cindex CLN
963 @cindex rational
964 @cindex fraction
965 For storing numerical things, GiNaC uses Bruno Haible's library CLN.
966 The classes therein serve as foundation classes for GiNaC.  CLN stands
967 for Class Library for Numbers or alternatively for Common Lisp Numbers.
968 In order to find out more about CLN's internals, the reader is referred to
969 the documentation of that library.  @inforef{Introduction, , cln}, for
970 more information. Suffice to say that it is by itself build on top of
971 another library, the GNU Multiple Precision library GMP, which is an
972 extremely fast library for arbitrary long integers and rationals as well
973 as arbitrary precision floating point numbers.  It is very commonly used
974 by several popular cryptographic applications.  CLN extends GMP by
975 several useful things: First, it introduces the complex number field
976 over either reals (i.e. floating point numbers with arbitrary precision)
977 or rationals.  Second, it automatically converts rationals to integers
978 if the denominator is unity and complex numbers to real numbers if the
979 imaginary part vanishes and also correctly treats algebraic functions.
980 Third it provides good implementations of state-of-the-art algorithms
981 for all trigonometric and hyperbolic functions as well as for
982 calculation of some useful constants.
983
984 The user can construct an object of class @code{numeric} in several
985 ways.  The following example shows the four most important constructors.
986 It uses construction from C-integer, construction of fractions from two
987 integers, construction from C-float and construction from a string:
988
989 @example
990 #include <iostream>
991 #include <ginac/ginac.h>
992 using namespace GiNaC;
993
994 int main()
995 @{
996     numeric two = 2;                      // exact integer 2
997     numeric r(2,3);                       // exact fraction 2/3
998     numeric e(2.71828);                   // floating point number
999     numeric p = "3.14159265358979323846"; // constructor from string
1000     // Trott's constant in scientific notation:
1001     numeric trott("1.0841015122311136151E-2");
1002     
1003     std::cout << two*p << std::endl;  // floating point 6.283...
1004     ...
1005 @end example
1006
1007 @cindex @code{I}
1008 @cindex complex numbers
1009 The imaginary unit in GiNaC is a predefined @code{numeric} object with the
1010 name @code{I}:
1011
1012 @example
1013     ...
1014     numeric z1 = 2-3*I;                    // exact complex number 2-3i
1015     numeric z2 = 5.9+1.6*I;                // complex floating point number
1016 @}
1017 @end example
1018
1019 It may be tempting to construct fractions by writing @code{numeric r(3/2)}.
1020 This would, however, call C's built-in operator @code{/} for integers
1021 first and result in a numeric holding a plain integer 1.  @strong{Never
1022 use the operator @code{/} on integers} unless you know exactly what you
1023 are doing!  Use the constructor from two integers instead, as shown in
1024 the example above.  Writing @code{numeric(1)/2} may look funny but works
1025 also.
1026
1027 @cindex @code{Digits}
1028 @cindex accuracy
1029 We have seen now the distinction between exact numbers and floating
1030 point numbers.  Clearly, the user should never have to worry about
1031 dynamically created exact numbers, since their `exactness' always
1032 determines how they ought to be handled, i.e. how `long' they are.  The
1033 situation is different for floating point numbers.  Their accuracy is
1034 controlled by one @emph{global} variable, called @code{Digits}.  (For
1035 those readers who know about Maple: it behaves very much like Maple's
1036 @code{Digits}).  All objects of class numeric that are constructed from
1037 then on will be stored with a precision matching that number of decimal
1038 digits:
1039
1040 @example
1041 #include <iostream>
1042 #include <ginac/ginac.h>
1043 using namespace std;
1044 using namespace GiNaC;
1045
1046 void foo()
1047 @{
1048     numeric three(3.0), one(1.0);
1049     numeric x = one/three;
1050
1051     cout << "in " << Digits << " digits:" << endl;
1052     cout << x << endl;
1053     cout << Pi.evalf() << endl;
1054 @}
1055
1056 int main()
1057 @{
1058     foo();
1059     Digits = 60;
1060     foo();
1061     return 0;
1062 @}
1063 @end example
1064
1065 The above example prints the following output to screen:
1066
1067 @example
1068 in 17 digits:
1069 0.33333333333333333334
1070 3.1415926535897932385
1071 in 60 digits:
1072 0.33333333333333333333333333333333333333333333333333333333333333333334
1073 3.1415926535897932384626433832795028841971693993751058209749445923078
1074 @end example
1075
1076 @cindex rounding
1077 Note that the last number is not necessarily rounded as you would
1078 naively expect it to be rounded in the decimal system.  But note also,
1079 that in both cases you got a couple of extra digits.  This is because
1080 numbers are internally stored by CLN as chunks of binary digits in order
1081 to match your machine's word size and to not waste precision.  Thus, on
1082 architectures with different word size, the above output might even
1083 differ with regard to actually computed digits.
1084
1085 It should be clear that objects of class @code{numeric} should be used
1086 for constructing numbers or for doing arithmetic with them.  The objects
1087 one deals with most of the time are the polymorphic expressions @code{ex}.
1088
1089 @subsection Tests on numbers
1090
1091 Once you have declared some numbers, assigned them to expressions and
1092 done some arithmetic with them it is frequently desired to retrieve some
1093 kind of information from them like asking whether that number is
1094 integer, rational, real or complex.  For those cases GiNaC provides
1095 several useful methods.  (Internally, they fall back to invocations of
1096 certain CLN functions.)
1097
1098 As an example, let's construct some rational number, multiply it with
1099 some multiple of its denominator and test what comes out:
1100
1101 @example
1102 #include <iostream>
1103 #include <ginac/ginac.h>
1104 using namespace std;
1105 using namespace GiNaC;
1106
1107 // some very important constants:
1108 const numeric twentyone(21);
1109 const numeric ten(10);
1110 const numeric five(5);
1111
1112 int main()
1113 @{
1114     numeric answer = twentyone;
1115
1116     answer /= five;
1117     cout << answer.is_integer() << endl;  // false, it's 21/5
1118     answer *= ten;
1119     cout << answer.is_integer() << endl;  // true, it's 42 now!
1120 @}
1121 @end example
1122
1123 Note that the variable @code{answer} is constructed here as an integer
1124 by @code{numeric}'s copy constructor but in an intermediate step it
1125 holds a rational number represented as integer numerator and integer
1126 denominator.  When multiplied by 10, the denominator becomes unity and
1127 the result is automatically converted to a pure integer again.
1128 Internally, the underlying CLN is responsible for this behavior and we
1129 refer the reader to CLN's documentation.  Suffice to say that
1130 the same behavior applies to complex numbers as well as return values of
1131 certain functions.  Complex numbers are automatically converted to real
1132 numbers if the imaginary part becomes zero.  The full set of tests that
1133 can be applied is listed in the following table.
1134
1135 @cartouche
1136 @multitable @columnfractions .30 .70
1137 @item @strong{Method} @tab @strong{Returns true if the object is@dots{}}
1138 @item @code{.is_zero()}
1139 @tab @dots{}equal to zero
1140 @item @code{.is_positive()}
1141 @tab @dots{}not complex and greater than 0
1142 @item @code{.is_integer()}
1143 @tab @dots{}a (non-complex) integer
1144 @item @code{.is_pos_integer()}
1145 @tab @dots{}an integer and greater than 0
1146 @item @code{.is_nonneg_integer()}
1147 @tab @dots{}an integer and greater equal 0
1148 @item @code{.is_even()}
1149 @tab @dots{}an even integer
1150 @item @code{.is_odd()}
1151 @tab @dots{}an odd integer
1152 @item @code{.is_prime()}
1153 @tab @dots{}a prime integer (probabilistic primality test)
1154 @item @code{.is_rational()}
1155 @tab @dots{}an exact rational number (integers are rational, too)
1156 @item @code{.is_real()}
1157 @tab @dots{}a real integer, rational or float (i.e. is not complex)
1158 @item @code{.is_cinteger()}
1159 @tab @dots{}a (complex) integer (such as @math{2-3*I})
1160 @item @code{.is_crational()}
1161 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
1162 @end multitable
1163 @end cartouche
1164
1165 @subsection Converting numbers
1166
1167 Sometimes it is desirable to convert a @code{numeric} object back to a
1168 built-in arithmetic type (@code{int}, @code{double}, etc.). The @code{numeric}
1169 class provides a couple of methods for this purpose:
1170
1171 @cindex @code{to_int()}
1172 @cindex @code{to_long()}
1173 @cindex @code{to_double()}
1174 @cindex @code{to_cl_N()}
1175 @example
1176 int numeric::to_int() const;
1177 long numeric::to_long() const;
1178 double numeric::to_double() const;
1179 cln::cl_N numeric::to_cl_N() const;
1180 @end example
1181
1182 @code{to_int()} and @code{to_long()} only work when the number they are
1183 applied on is an exact integer. Otherwise the program will halt with a
1184 message like @samp{Not a 32-bit integer}. @code{to_double()} applied on a
1185 rational number will return a floating-point approximation. Both
1186 @code{to_int()/to_long()} and @code{to_double()} discard the imaginary
1187 part of complex numbers.
1188
1189
1190 @node Constants, Fundamental containers, Numbers, Basic Concepts
1191 @c    node-name, next, previous, up
1192 @section Constants
1193 @cindex @code{constant} (class)
1194
1195 @cindex @code{Pi}
1196 @cindex @code{Catalan}
1197 @cindex @code{Euler}
1198 @cindex @code{evalf()}
1199 Constants behave pretty much like symbols except that they return some
1200 specific number when the method @code{.evalf()} is called.
1201
1202 The predefined known constants are:
1203
1204 @cartouche
1205 @multitable @columnfractions .14 .30 .56
1206 @item @strong{Name} @tab @strong{Common Name} @tab @strong{Numerical Value (to 35 digits)}
1207 @item @code{Pi}
1208 @tab Archimedes' constant
1209 @tab 3.14159265358979323846264338327950288
1210 @item @code{Catalan}
1211 @tab Catalan's constant
1212 @tab 0.91596559417721901505460351493238411
1213 @item @code{Euler}
1214 @tab Euler's (or Euler-Mascheroni) constant
1215 @tab 0.57721566490153286060651209008240243
1216 @end multitable
1217 @end cartouche
1218
1219
1220 @node Fundamental containers, Lists, Constants, Basic Concepts
1221 @c    node-name, next, previous, up
1222 @section Sums, products and powers
1223 @cindex polynomial
1224 @cindex @code{add}
1225 @cindex @code{mul}
1226 @cindex @code{power}
1227
1228 Simple rational expressions are written down in GiNaC pretty much like
1229 in other CAS or like expressions involving numerical variables in C.
1230 The necessary operators @code{+}, @code{-}, @code{*} and @code{/} have
1231 been overloaded to achieve this goal.  When you run the following
1232 code snippet, the constructor for an object of type @code{mul} is
1233 automatically called to hold the product of @code{a} and @code{b} and
1234 then the constructor for an object of type @code{add} is called to hold
1235 the sum of that @code{mul} object and the number one:
1236
1237 @example
1238     ...
1239     symbol a("a"), b("b");
1240     ex MyTerm = 1+a*b;
1241     ...
1242 @end example
1243
1244 @cindex @code{pow()}
1245 For exponentiation, you have already seen the somewhat clumsy (though C-ish)
1246 statement @code{pow(x,2);} to represent @code{x} squared.  This direct
1247 construction is necessary since we cannot safely overload the constructor
1248 @code{^} in C++ to construct a @code{power} object.  If we did, it would
1249 have several counterintuitive and undesired effects:
1250
1251 @itemize @bullet
1252 @item
1253 Due to C's operator precedence, @code{2*x^2} would be parsed as @code{(2*x)^2}.
1254 @item
1255 Due to the binding of the operator @code{^}, @code{x^a^b} would result in
1256 @code{(x^a)^b}. This would be confusing since most (though not all) other CAS
1257 interpret this as @code{x^(a^b)}.
1258 @item
1259 Also, expressions involving integer exponents are very frequently used,
1260 which makes it even more dangerous to overload @code{^} since it is then
1261 hard to distinguish between the semantics as exponentiation and the one
1262 for exclusive or.  (It would be embarrassing to return @code{1} where one
1263 has requested @code{2^3}.)
1264 @end itemize
1265
1266 @cindex @command{ginsh}
1267 All effects are contrary to mathematical notation and differ from the
1268 way most other CAS handle exponentiation, therefore overloading @code{^}
1269 is ruled out for GiNaC's C++ part.  The situation is different in
1270 @command{ginsh}, there the exponentiation-@code{^} exists.  (Also note
1271 that the other frequently used exponentiation operator @code{**} does
1272 not exist at all in C++).
1273
1274 To be somewhat more precise, objects of the three classes described
1275 here, are all containers for other expressions.  An object of class
1276 @code{power} is best viewed as a container with two slots, one for the
1277 basis, one for the exponent.  All valid GiNaC expressions can be
1278 inserted.  However, basic transformations like simplifying
1279 @code{pow(pow(x,2),3)} to @code{x^6} automatically are only performed
1280 when this is mathematically possible.  If we replace the outer exponent
1281 three in the example by some symbols @code{a}, the simplification is not
1282 safe and will not be performed, since @code{a} might be @code{1/2} and
1283 @code{x} negative.
1284
1285 Objects of type @code{add} and @code{mul} are containers with an
1286 arbitrary number of slots for expressions to be inserted.  Again, simple
1287 and safe simplifications are carried out like transforming
1288 @code{3*x+4-x} to @code{2*x+4}.
1289
1290
1291 @node Lists, Mathematical functions, Fundamental containers, Basic Concepts
1292 @c    node-name, next, previous, up
1293 @section Lists of expressions
1294 @cindex @code{lst} (class)
1295 @cindex lists
1296 @cindex @code{nops()}
1297 @cindex @code{op()}
1298 @cindex @code{append()}
1299 @cindex @code{prepend()}
1300 @cindex @code{remove_first()}
1301 @cindex @code{remove_last()}
1302 @cindex @code{remove_all()}
1303
1304 The GiNaC class @code{lst} serves for holding a @dfn{list} of arbitrary
1305 expressions. They are not as ubiquitous as in many other computer algebra
1306 packages, but are sometimes used to supply a variable number of arguments of
1307 the same type to GiNaC methods such as @code{subs()} and @code{to_rational()},
1308 so you should have a basic understanding of them.
1309
1310 Lists of up to 16 expressions can be directly constructed from single
1311 expressions:
1312
1313 @example
1314 @{
1315     symbol x("x"), y("y");
1316     lst l(x, 2, y, x+y);
1317     // now, l is a list holding the expressions 'x', '2', 'y', and 'x+y'
1318     ...
1319 @end example
1320
1321 Use the @code{nops()} method to determine the size (number of expressions) of
1322 a list and the @code{op()} method or the @code{[]} operator to access
1323 individual elements:
1324
1325 @example
1326     ...
1327     cout << l.nops() << endl;                // prints '4'
1328     cout << l.op(2) << " " << l[0] << endl;  // prints 'y x'
1329     ...
1330 @end example
1331
1332 As with the standard @code{list<T>} container, accessing random elements of a
1333 @code{lst} is generally an operation of order @math{O(N)}. Faster read-only
1334 sequential access to the elements of a list is possible with the
1335 iterator types provided by the @code{lst} class:
1336
1337 @example
1338 typedef ... lst::const_iterator;
1339 typedef ... lst::const_reverse_iterator;
1340 lst::const_iterator lst::begin() const;
1341 lst::const_iterator lst::end() const;
1342 lst::const_reverse_iterator lst::rbegin() const;
1343 lst::const_reverse_iterator lst::rend() const;
1344 @end example
1345
1346 For example, to print the elements of a list individually you can use:
1347
1348 @example
1349     ...
1350     // O(N)
1351     for (lst::const_iterator i = l.begin(); i != l.end(); ++i)
1352         cout << *i << endl;
1353     ...
1354 @end example
1355
1356 which is one order faster than
1357
1358 @example
1359     ...
1360     // O(N^2)
1361     for (size_t i = 0; i < l.nops(); ++i)
1362         cout << l.op(i) << endl;
1363     ...
1364 @end example
1365
1366 These iterators also allow you to use some of the algorithms provided by
1367 the C++ standard library:
1368
1369 @example
1370     ...
1371     // print the elements of the list (requires #include <iterator>)
1372     copy(l.begin(), l.end(), ostream_iterator<ex>(cout, "\n"));
1373
1374     // sum up the elements of the list (requires #include <numeric>)
1375     ex sum = accumulate(l.begin(), l.end(), ex(0));
1376     cout << sum << endl;  // prints '2+2*x+2*y'
1377     ...
1378 @end example
1379
1380 @code{lst} is one of the few GiNaC classes that allow in-place modifications
1381 (the only other one is @code{matrix}). You can modify single elements:
1382
1383 @example
1384     ...
1385     l[1] = 42;       // l is now @{x, 42, y, x+y@}
1386     l.let_op(1) = 7; // l is now @{x, 7, y, x+y@}
1387     ...
1388 @end example
1389
1390 You can append or prepend an expression to a list with the @code{append()}
1391 and @code{prepend()} methods:
1392
1393 @example
1394     ...
1395     l.append(4*x);   // l is now @{x, 7, y, x+y, 4*x@}
1396     l.prepend(0);    // l is now @{0, x, 7, y, x+y, 4*x@}
1397     ...
1398 @end example
1399
1400 You can remove the first or last element of a list with @code{remove_first()}
1401 and @code{remove_last()}:
1402
1403 @example
1404     ...
1405     l.remove_first();   // l is now @{x, 7, y, x+y, 4*x@}
1406     l.remove_last();    // l is now @{x, 7, y, x+y@}
1407     ...
1408 @end example
1409
1410 You can remove all the elements of a list with @code{remove_all()}:
1411
1412 @example
1413     ...
1414     l.remove_all();     // l is now empty
1415     ...
1416 @end example
1417
1418 You can bring the elements of a list into a canonical order with @code{sort()}:
1419
1420 @example
1421     ...
1422     lst l1(x, 2, y, x+y);
1423     lst l2(2, x+y, x, y);
1424     l1.sort();
1425     l2.sort();
1426     // l1 and l2 are now equal
1427     ...
1428 @end example
1429
1430 Finally, you can remove all but the first element of consecutive groups of
1431 elements with @code{unique()}:
1432
1433 @example
1434     ...
1435     lst l3(x, 2, 2, 2, y, x+y, y+x);
1436     l3.unique();        // l3 is now @{x, 2, y, x+y@}
1437 @}
1438 @end example
1439
1440
1441 @node Mathematical functions, Relations, Lists, Basic Concepts
1442 @c    node-name, next, previous, up
1443 @section Mathematical functions
1444 @cindex @code{function} (class)
1445 @cindex trigonometric function
1446 @cindex hyperbolic function
1447
1448 There are quite a number of useful functions hard-wired into GiNaC.  For
1449 instance, all trigonometric and hyperbolic functions are implemented
1450 (@xref{Built-in Functions}, for a complete list).
1451
1452 These functions (better called @emph{pseudofunctions}) are all objects
1453 of class @code{function}.  They accept one or more expressions as
1454 arguments and return one expression.  If the arguments are not
1455 numerical, the evaluation of the function may be halted, as it does in
1456 the next example, showing how a function returns itself twice and
1457 finally an expression that may be really useful:
1458
1459 @cindex Gamma function
1460 @cindex @code{subs()}
1461 @example
1462     ...
1463     symbol x("x"), y("y");    
1464     ex foo = x+y/2;
1465     cout << tgamma(foo) << endl;
1466      // -> tgamma(x+(1/2)*y)
1467     ex bar = foo.subs(y==1);
1468     cout << tgamma(bar) << endl;
1469      // -> tgamma(x+1/2)
1470     ex foobar = bar.subs(x==7);
1471     cout << tgamma(foobar) << endl;
1472      // -> (135135/128)*Pi^(1/2)
1473     ...
1474 @end example
1475
1476 Besides evaluation most of these functions allow differentiation, series
1477 expansion and so on.  Read the next chapter in order to learn more about
1478 this.
1479
1480 It must be noted that these pseudofunctions are created by inline
1481 functions, where the argument list is templated.  This means that
1482 whenever you call @code{GiNaC::sin(1)} it is equivalent to
1483 @code{sin(ex(1))} and will therefore not result in a floating point
1484 number.  Unless of course the function prototype is explicitly
1485 overridden -- which is the case for arguments of type @code{numeric}
1486 (not wrapped inside an @code{ex}).  Hence, in order to obtain a floating
1487 point number of class @code{numeric} you should call
1488 @code{sin(numeric(1))}.  This is almost the same as calling
1489 @code{sin(1).evalf()} except that the latter will return a numeric
1490 wrapped inside an @code{ex}.
1491
1492
1493 @node Relations, Matrices, Mathematical functions, Basic Concepts
1494 @c    node-name, next, previous, up
1495 @section Relations
1496 @cindex @code{relational} (class)
1497
1498 Sometimes, a relation holding between two expressions must be stored
1499 somehow.  The class @code{relational} is a convenient container for such
1500 purposes.  A relation is by definition a container for two @code{ex} and
1501 a relation between them that signals equality, inequality and so on.
1502 They are created by simply using the C++ operators @code{==}, @code{!=},
1503 @code{<}, @code{<=}, @code{>} and @code{>=} between two expressions.
1504
1505 @xref{Mathematical functions}, for examples where various applications
1506 of the @code{.subs()} method show how objects of class relational are
1507 used as arguments.  There they provide an intuitive syntax for
1508 substitutions.  They are also used as arguments to the @code{ex::series}
1509 method, where the left hand side of the relation specifies the variable
1510 to expand in and the right hand side the expansion point.  They can also
1511 be used for creating systems of equations that are to be solved for
1512 unknown variables.  But the most common usage of objects of this class
1513 is rather inconspicuous in statements of the form @code{if
1514 (expand(pow(a+b,2))==a*a+2*a*b+b*b) @{...@}}.  Here, an implicit
1515 conversion from @code{relational} to @code{bool} takes place.  Note,
1516 however, that @code{==} here does not perform any simplifications, hence
1517 @code{expand()} must be called explicitly.
1518
1519
1520 @node Matrices, Indexed objects, Relations, Basic Concepts
1521 @c    node-name, next, previous, up
1522 @section Matrices
1523 @cindex @code{matrix} (class)
1524
1525 A @dfn{matrix} is a two-dimensional array of expressions. The elements of a
1526 matrix with @math{m} rows and @math{n} columns are accessed with two
1527 @code{unsigned} indices, the first one in the range 0@dots{}@math{m-1}, the
1528 second one in the range 0@dots{}@math{n-1}.
1529
1530 There are a couple of ways to construct matrices, with or without preset
1531 elements:
1532
1533 @cindex @code{lst_to_matrix()}
1534 @cindex @code{diag_matrix()}
1535 @cindex @code{unit_matrix()}
1536 @cindex @code{symbolic_matrix()}
1537 @example
1538 matrix::matrix(unsigned r, unsigned c);
1539 matrix::matrix(unsigned r, unsigned c, const lst & l);
1540 ex lst_to_matrix(const lst & l);
1541 ex diag_matrix(const lst & l);
1542 ex unit_matrix(unsigned x);
1543 ex unit_matrix(unsigned r, unsigned c);
1544 ex symbolic_matrix(unsigned r, unsigned c, const string & base_name);
1545 ex symbolic_matrix(unsigned r, unsigned c, const string & base_name, const string & tex_base_name);
1546 @end example
1547
1548 The first two functions are @code{matrix} constructors which create a matrix
1549 with @samp{r} rows and @samp{c} columns. The matrix elements can be
1550 initialized from a (flat) list of expressions @samp{l}. Otherwise they are
1551 all set to zero. The @code{lst_to_matrix()} function constructs a matrix
1552 from a list of lists, each list representing a matrix row. @code{diag_matrix()}
1553 constructs a diagonal matrix given the list of diagonal elements.
1554 @code{unit_matrix()} creates an @samp{x} by @samp{x} (or @samp{r} by @samp{c})
1555 unit matrix. And finally, @code{symbolic_matrix} constructs a matrix filled
1556 with newly generated symbols made of the specified base name and the
1557 position of each element in the matrix.
1558
1559 Matrix elements can be accessed and set using the parenthesis (function call)
1560 operator:
1561
1562 @example
1563 const ex & matrix::operator()(unsigned r, unsigned c) const;
1564 ex & matrix::operator()(unsigned r, unsigned c);
1565 @end example
1566
1567 It is also possible to access the matrix elements in a linear fashion with
1568 the @code{op()} method. But C++-style subscripting with square brackets
1569 @samp{[]} is not available.
1570
1571 Here are a couple of examples of constructing matrices:
1572
1573 @example
1574 @{
1575     symbol a("a"), b("b");
1576
1577     matrix M(2, 2);
1578     M(0, 0) = a;
1579     M(1, 1) = b;
1580     cout << M << endl;
1581      // -> [[a,0],[0,b]]
1582
1583     cout << matrix(2, 2, lst(a, 0, 0, b)) << endl;
1584      // -> [[a,0],[0,b]]
1585
1586     cout << lst_to_matrix(lst(lst(a, 0), lst(0, b))) << endl;
1587      // -> [[a,0],[0,b]]
1588
1589     cout << diag_matrix(lst(a, b)) << endl;
1590      // -> [[a,0],[0,b]]
1591
1592     cout << unit_matrix(3) << endl;
1593      // -> [[1,0,0],[0,1,0],[0,0,1]]
1594
1595     cout << symbolic_matrix(2, 3, "x") << endl;
1596      // -> [[x00,x01,x02],[x10,x11,x12]]
1597 @}
1598 @end example
1599
1600 @cindex @code{transpose()}
1601 There are three ways to do arithmetic with matrices. The first (and most
1602 direct one) is to use the methods provided by the @code{matrix} class:
1603
1604 @example
1605 matrix matrix::add(const matrix & other) const;
1606 matrix matrix::sub(const matrix & other) const;
1607 matrix matrix::mul(const matrix & other) const;
1608 matrix matrix::mul_scalar(const ex & other) const;
1609 matrix matrix::pow(const ex & expn) const;
1610 matrix matrix::transpose() const;
1611 @end example
1612
1613 All of these methods return the result as a new matrix object. Here is an
1614 example that calculates @math{A*B-2*C} for three matrices @math{A}, @math{B}
1615 and @math{C}:
1616
1617 @example
1618 @{
1619     matrix A(2, 2, lst(1, 2, 3, 4));
1620     matrix B(2, 2, lst(-1, 0, 2, 1));
1621     matrix C(2, 2, lst(8, 4, 2, 1));
1622
1623     matrix result = A.mul(B).sub(C.mul_scalar(2));
1624     cout << result << endl;
1625      // -> [[-13,-6],[1,2]]
1626     ...
1627 @}
1628 @end example
1629
1630 @cindex @code{evalm()}
1631 The second (and probably the most natural) way is to construct an expression
1632 containing matrices with the usual arithmetic operators and @code{pow()}.
1633 For efficiency reasons, expressions with sums, products and powers of
1634 matrices are not automatically evaluated in GiNaC. You have to call the
1635 method
1636
1637 @example
1638 ex ex::evalm() const;
1639 @end example
1640
1641 to obtain the result:
1642
1643 @example
1644 @{
1645     ...
1646     ex e = A*B - 2*C;
1647     cout << e << endl;
1648      // -> [[1,2],[3,4]]*[[-1,0],[2,1]]-2*[[8,4],[2,1]]
1649     cout << e.evalm() << endl;
1650      // -> [[-13,-6],[1,2]]
1651     ...
1652 @}
1653 @end example
1654
1655 The non-commutativity of the product @code{A*B} in this example is
1656 automatically recognized by GiNaC. There is no need to use a special
1657 operator here. @xref{Non-commutative objects}, for more information about
1658 dealing with non-commutative expressions.
1659
1660 Finally, you can work with indexed matrices and call @code{simplify_indexed()}
1661 to perform the arithmetic:
1662
1663 @example
1664 @{
1665     ...
1666     idx i(symbol("i"), 2), j(symbol("j"), 2), k(symbol("k"), 2);
1667     e = indexed(A, i, k) * indexed(B, k, j) - 2 * indexed(C, i, j);
1668     cout << e << endl;
1669      // -> -2*[[8,4],[2,1]].i.j+[[-1,0],[2,1]].k.j*[[1,2],[3,4]].i.k
1670     cout << e.simplify_indexed() << endl;
1671      // -> [[-13,-6],[1,2]].i.j
1672 @}
1673 @end example
1674
1675 Using indices is most useful when working with rectangular matrices and
1676 one-dimensional vectors because you don't have to worry about having to
1677 transpose matrices before multiplying them. @xref{Indexed objects}, for
1678 more information about using matrices with indices, and about indices in
1679 general.
1680
1681 The @code{matrix} class provides a couple of additional methods for
1682 computing determinants, traces, and characteristic polynomials:
1683
1684 @cindex @code{determinant()}
1685 @cindex @code{trace()}
1686 @cindex @code{charpoly()}
1687 @example
1688 ex matrix::determinant(unsigned algo=determinant_algo::automatic) const;
1689 ex matrix::trace() const;
1690 ex matrix::charpoly(const ex & lambda) const;
1691 @end example
1692
1693 The @samp{algo} argument of @code{determinant()} allows to select
1694 between different algorithms for calculating the determinant.  The
1695 asymptotic speed (as parametrized by the matrix size) can greatly differ
1696 between those algorithms, depending on the nature of the matrix'
1697 entries.  The possible values are defined in the @file{flags.h} header
1698 file.  By default, GiNaC uses a heuristic to automatically select an
1699 algorithm that is likely (but not guaranteed) to give the result most
1700 quickly.
1701
1702 @cindex @code{inverse()}
1703 @cindex @code{solve()}
1704 Matrices may also be inverted using the @code{ex matrix::inverse()}
1705 method and linear systems may be solved with:
1706
1707 @example
1708 matrix matrix::solve(const matrix & vars, const matrix & rhs, unsigned algo=solve_algo::automatic) const;
1709 @end example
1710
1711 Assuming the matrix object this method is applied on is an @code{m}
1712 times @code{n} matrix, then @code{vars} must be a @code{n} times
1713 @code{p} matrix of symbolic indeterminates and @code{rhs} a @code{m}
1714 times @code{p} matrix.  The returned matrix then has dimension @code{n}
1715 times @code{p} and in the case of an underdetermined system will still
1716 contain some of the indeterminates from @code{vars}.  If the system is
1717 overdetermined, an exception is thrown.
1718
1719
1720 @node Indexed objects, Non-commutative objects, Matrices, Basic Concepts
1721 @c    node-name, next, previous, up
1722 @section Indexed objects
1723
1724 GiNaC allows you to handle expressions containing general indexed objects in
1725 arbitrary spaces. It is also able to canonicalize and simplify such
1726 expressions and perform symbolic dummy index summations. There are a number
1727 of predefined indexed objects provided, like delta and metric tensors.
1728
1729 There are few restrictions placed on indexed objects and their indices and
1730 it is easy to construct nonsense expressions, but our intention is to
1731 provide a general framework that allows you to implement algorithms with
1732 indexed quantities, getting in the way as little as possible.
1733
1734 @cindex @code{idx} (class)
1735 @cindex @code{indexed} (class)
1736 @subsection Indexed quantities and their indices
1737
1738 Indexed expressions in GiNaC are constructed of two special types of objects,
1739 @dfn{index objects} and @dfn{indexed objects}.
1740
1741 @itemize @bullet
1742
1743 @cindex contravariant
1744 @cindex covariant
1745 @cindex variance
1746 @item Index objects are of class @code{idx} or a subclass. Every index has
1747 a @dfn{value} and a @dfn{dimension} (which is the dimension of the space
1748 the index lives in) which can both be arbitrary expressions but are usually
1749 a number or a simple symbol. In addition, indices of class @code{varidx} have
1750 a @dfn{variance} (they can be co- or contravariant), and indices of class
1751 @code{spinidx} have a variance and can be @dfn{dotted} or @dfn{undotted}.
1752
1753 @item Indexed objects are of class @code{indexed} or a subclass. They
1754 contain a @dfn{base expression} (which is the expression being indexed), and
1755 one or more indices.
1756
1757 @end itemize
1758
1759 @strong{Note:} when printing expressions, covariant indices and indices
1760 without variance are denoted @samp{.i} while contravariant indices are
1761 denoted @samp{~i}. Dotted indices have a @samp{*} in front of the index
1762 value. In the following, we are going to use that notation in the text so
1763 instead of @math{A^i_jk} we will write @samp{A~i.j.k}. Index dimensions are
1764 not visible in the output.
1765
1766 A simple example shall illustrate the concepts:
1767
1768 @example
1769 #include <iostream>
1770 #include <ginac/ginac.h>
1771 using namespace std;
1772 using namespace GiNaC;
1773
1774 int main()
1775 @{
1776     symbol i_sym("i"), j_sym("j");
1777     idx i(i_sym, 3), j(j_sym, 3);
1778
1779     symbol A("A");
1780     cout << indexed(A, i, j) << endl;
1781      // -> A.i.j
1782     cout << index_dimensions << indexed(A, i, j) << endl;
1783      // -> A.i[3].j[3]
1784     cout << dflt; // reset cout to default output format (dimensions hidden)
1785     ...
1786 @end example
1787
1788 The @code{idx} constructor takes two arguments, the index value and the
1789 index dimension. First we define two index objects, @code{i} and @code{j},
1790 both with the numeric dimension 3. The value of the index @code{i} is the
1791 symbol @code{i_sym} (which prints as @samp{i}) and the value of the index
1792 @code{j} is the symbol @code{j_sym} (which prints as @samp{j}). Next we
1793 construct an expression containing one indexed object, @samp{A.i.j}. It has
1794 the symbol @code{A} as its base expression and the two indices @code{i} and
1795 @code{j}.
1796
1797 The dimensions of indices are normally not visible in the output, but one
1798 can request them to be printed with the @code{index_dimensions} manipulator,
1799 as shown above.
1800
1801 Note the difference between the indices @code{i} and @code{j} which are of
1802 class @code{idx}, and the index values which are the symbols @code{i_sym}
1803 and @code{j_sym}. The indices of indexed objects cannot directly be symbols
1804 or numbers but must be index objects. For example, the following is not
1805 correct and will raise an exception:
1806
1807 @example
1808 symbol i("i"), j("j");
1809 e = indexed(A, i, j); // ERROR: indices must be of type idx
1810 @end example
1811
1812 You can have multiple indexed objects in an expression, index values can
1813 be numeric, and index dimensions symbolic:
1814
1815 @example
1816     ...
1817     symbol B("B"), dim("dim");
1818     cout << 4 * indexed(A, i)
1819           + indexed(B, idx(j_sym, 4), idx(2, 3), idx(i_sym, dim)) << endl;
1820      // -> B.j.2.i+4*A.i
1821     ...
1822 @end example
1823
1824 @code{B} has a 4-dimensional symbolic index @samp{k}, a 3-dimensional numeric
1825 index of value 2, and a symbolic index @samp{i} with the symbolic dimension
1826 @samp{dim}. Note that GiNaC doesn't automatically notify you that the free
1827 indices of @samp{A} and @samp{B} in the sum don't match (you have to call
1828 @code{simplify_indexed()} for that, see below).
1829
1830 In fact, base expressions, index values and index dimensions can be
1831 arbitrary expressions:
1832
1833 @example
1834     ...
1835     cout << indexed(A+B, idx(2*i_sym+1, dim/2)) << endl;
1836      // -> (B+A).(1+2*i)
1837     ...
1838 @end example
1839
1840 It's also possible to construct nonsense like @samp{Pi.sin(x)}. You will not
1841 get an error message from this but you will probably not be able to do
1842 anything useful with it.
1843
1844 @cindex @code{get_value()}
1845 @cindex @code{get_dimension()}
1846 The methods
1847
1848 @example
1849 ex idx::get_value();
1850 ex idx::get_dimension();
1851 @end example
1852
1853 return the value and dimension of an @code{idx} object. If you have an index
1854 in an expression, such as returned by calling @code{.op()} on an indexed
1855 object, you can get a reference to the @code{idx} object with the function
1856 @code{ex_to<idx>()} on the expression.
1857
1858 There are also the methods
1859
1860 @example
1861 bool idx::is_numeric();
1862 bool idx::is_symbolic();
1863 bool idx::is_dim_numeric();
1864 bool idx::is_dim_symbolic();
1865 @end example
1866
1867 for checking whether the value and dimension are numeric or symbolic
1868 (non-numeric). Using the @code{info()} method of an index (see @ref{Information
1869 About Expressions}) returns information about the index value.
1870
1871 @cindex @code{varidx} (class)
1872 If you need co- and contravariant indices, use the @code{varidx} class:
1873
1874 @example
1875     ...
1876     symbol mu_sym("mu"), nu_sym("nu");
1877     varidx mu(mu_sym, 4), nu(nu_sym, 4); // default is contravariant ~mu, ~nu
1878     varidx mu_co(mu_sym, 4, true);       // covariant index .mu
1879
1880     cout << indexed(A, mu, nu) << endl;
1881      // -> A~mu~nu
1882     cout << indexed(A, mu_co, nu) << endl;
1883      // -> A.mu~nu
1884     cout << indexed(A, mu.toggle_variance(), nu) << endl;
1885      // -> A.mu~nu
1886     ...
1887 @end example
1888
1889 A @code{varidx} is an @code{idx} with an additional flag that marks it as
1890 co- or contravariant. The default is a contravariant (upper) index, but
1891 this can be overridden by supplying a third argument to the @code{varidx}
1892 constructor. The two methods
1893
1894 @example
1895 bool varidx::is_covariant();
1896 bool varidx::is_contravariant();
1897 @end example
1898
1899 allow you to check the variance of a @code{varidx} object (use @code{ex_to<varidx>()}
1900 to get the object reference from an expression). There's also the very useful
1901 method
1902
1903 @example
1904 ex varidx::toggle_variance();
1905 @end example
1906
1907 which makes a new index with the same value and dimension but the opposite
1908 variance. By using it you only have to define the index once.
1909
1910 @cindex @code{spinidx} (class)
1911 The @code{spinidx} class provides dotted and undotted variant indices, as
1912 used in the Weyl-van-der-Waerden spinor formalism:
1913
1914 @example
1915     ...
1916     symbol K("K"), C_sym("C"), D_sym("D");
1917     spinidx C(C_sym, 2), D(D_sym);          // default is 2-dimensional,
1918                                             // contravariant, undotted
1919     spinidx C_co(C_sym, 2, true);           // covariant index
1920     spinidx D_dot(D_sym, 2, false, true);   // contravariant, dotted
1921     spinidx D_co_dot(D_sym, 2, true, true); // covariant, dotted
1922
1923     cout << indexed(K, C, D) << endl;
1924      // -> K~C~D
1925     cout << indexed(K, C_co, D_dot) << endl;
1926      // -> K.C~*D
1927     cout << indexed(K, D_co_dot, D) << endl;
1928      // -> K.*D~D
1929     ...
1930 @end example
1931
1932 A @code{spinidx} is a @code{varidx} with an additional flag that marks it as
1933 dotted or undotted. The default is undotted but this can be overridden by
1934 supplying a fourth argument to the @code{spinidx} constructor. The two
1935 methods
1936
1937 @example
1938 bool spinidx::is_dotted();
1939 bool spinidx::is_undotted();
1940 @end example
1941
1942 allow you to check whether or not a @code{spinidx} object is dotted (use
1943 @code{ex_to<spinidx>()} to get the object reference from an expression).
1944 Finally, the two methods
1945
1946 @example
1947 ex spinidx::toggle_dot();
1948 ex spinidx::toggle_variance_dot();
1949 @end example
1950
1951 create a new index with the same value and dimension but opposite dottedness
1952 and the same or opposite variance.
1953
1954 @subsection Substituting indices
1955
1956 @cindex @code{subs()}
1957 Sometimes you will want to substitute one symbolic index with another
1958 symbolic or numeric index, for example when calculating one specific element
1959 of a tensor expression. This is done with the @code{.subs()} method, as it
1960 is done for symbols (see @ref{Substituting Expressions}).
1961
1962 You have two possibilities here. You can either substitute the whole index
1963 by another index or expression:
1964
1965 @example
1966     ...
1967     ex e = indexed(A, mu_co);
1968     cout << e << " becomes " << e.subs(mu_co == nu) << endl;
1969      // -> A.mu becomes A~nu
1970     cout << e << " becomes " << e.subs(mu_co == varidx(0, 4)) << endl;
1971      // -> A.mu becomes A~0
1972     cout << e << " becomes " << e.subs(mu_co == 0) << endl;
1973      // -> A.mu becomes A.0
1974     ...
1975 @end example
1976
1977 The third example shows that trying to replace an index with something that
1978 is not an index will substitute the index value instead.
1979
1980 Alternatively, you can substitute the @emph{symbol} of a symbolic index by
1981 another expression:
1982
1983 @example
1984     ...
1985     ex e = indexed(A, mu_co);
1986     cout << e << " becomes " << e.subs(mu_sym == nu_sym) << endl;
1987      // -> A.mu becomes A.nu
1988     cout << e << " becomes " << e.subs(mu_sym == 0) << endl;
1989      // -> A.mu becomes A.0
1990     ...
1991 @end example
1992
1993 As you see, with the second method only the value of the index will get
1994 substituted. Its other properties, including its dimension, remain unchanged.
1995 If you want to change the dimension of an index you have to substitute the
1996 whole index by another one with the new dimension.
1997
1998 Finally, substituting the base expression of an indexed object works as
1999 expected:
2000
2001 @example
2002     ...
2003     ex e = indexed(A, mu_co);
2004     cout << e << " becomes " << e.subs(A == A+B) << endl;
2005      // -> A.mu becomes (B+A).mu
2006     ...
2007 @end example
2008
2009 @subsection Symmetries
2010 @cindex @code{symmetry} (class)
2011 @cindex @code{sy_none()}
2012 @cindex @code{sy_symm()}
2013 @cindex @code{sy_anti()}
2014 @cindex @code{sy_cycl()}
2015
2016 Indexed objects can have certain symmetry properties with respect to their
2017 indices. Symmetries are specified as a tree of objects of class @code{symmetry}
2018 that is constructed with the helper functions
2019
2020 @example
2021 symmetry sy_none(...);
2022 symmetry sy_symm(...);
2023 symmetry sy_anti(...);
2024 symmetry sy_cycl(...);
2025 @end example
2026
2027 @code{sy_none()} stands for no symmetry, @code{sy_symm()} and @code{sy_anti()}
2028 specify fully symmetric or antisymmetric, respectively, and @code{sy_cycl()}
2029 represents a cyclic symmetry. Each of these functions accepts up to four
2030 arguments which can be either symmetry objects themselves or unsigned integer
2031 numbers that represent an index position (counting from 0). A symmetry
2032 specification that consists of only a single @code{sy_symm()}, @code{sy_anti()}
2033 or @code{sy_cycl()} with no arguments specifies the respective symmetry for
2034 all indices.
2035
2036 Here are some examples of symmetry definitions:
2037
2038 @example
2039     ...
2040     // No symmetry:
2041     e = indexed(A, i, j);
2042     e = indexed(A, sy_none(), i, j);     // equivalent
2043     e = indexed(A, sy_none(0, 1), i, j); // equivalent
2044
2045     // Symmetric in all three indices:
2046     e = indexed(A, sy_symm(), i, j, k);
2047     e = indexed(A, sy_symm(0, 1, 2), i, j, k); // equivalent
2048     e = indexed(A, sy_symm(2, 0, 1), i, j, k); // same symmetry, but yields a
2049                                                // different canonical order
2050
2051     // Symmetric in the first two indices only:
2052     e = indexed(A, sy_symm(0, 1), i, j, k);
2053     e = indexed(A, sy_none(sy_symm(0, 1), 2), i, j, k); // equivalent
2054
2055     // Antisymmetric in the first and last index only (index ranges need not
2056     // be contiguous):
2057     e = indexed(A, sy_anti(0, 2), i, j, k);
2058     e = indexed(A, sy_none(sy_anti(0, 2), 1), i, j, k); // equivalent
2059
2060     // An example of a mixed symmetry: antisymmetric in the first two and
2061     // last two indices, symmetric when swapping the first and last index
2062     // pairs (like the Riemann curvature tensor):
2063     e = indexed(A, sy_symm(sy_anti(0, 1), sy_anti(2, 3)), i, j, k, l);
2064
2065     // Cyclic symmetry in all three indices:
2066     e = indexed(A, sy_cycl(), i, j, k);
2067     e = indexed(A, sy_cycl(0, 1, 2), i, j, k); // equivalent
2068
2069     // The following examples are invalid constructions that will throw
2070     // an exception at run time.
2071
2072     // An index may not appear multiple times:
2073     e = indexed(A, sy_symm(0, 0, 1), i, j, k); // ERROR
2074     e = indexed(A, sy_none(sy_symm(0, 1), sy_anti(0, 2)), i, j, k); // ERROR
2075
2076     // Every child of sy_symm(), sy_anti() and sy_cycl() must refer to the
2077     // same number of indices:
2078     e = indexed(A, sy_symm(sy_anti(0, 1), 2), i, j, k); // ERROR
2079
2080     // And of course, you cannot specify indices which are not there:
2081     e = indexed(A, sy_symm(0, 1, 2, 3), i, j, k); // ERROR
2082     ...
2083 @end example
2084
2085 If you need to specify more than four indices, you have to use the
2086 @code{.add()} method of the @code{symmetry} class. For example, to specify
2087 full symmetry in the first six indices you would write
2088 @code{sy_symm(0, 1, 2, 3).add(4).add(5)}.
2089
2090 If an indexed object has a symmetry, GiNaC will automatically bring the
2091 indices into a canonical order which allows for some immediate simplifications:
2092
2093 @example
2094     ...
2095     cout << indexed(A, sy_symm(), i, j)
2096           + indexed(A, sy_symm(), j, i) << endl;
2097      // -> 2*A.j.i
2098     cout << indexed(B, sy_anti(), i, j)
2099           + indexed(B, sy_anti(), j, i) << endl;
2100      // -> 0
2101     cout << indexed(B, sy_anti(), i, j, k)
2102           - indexed(B, sy_anti(), j, k, i) << endl;
2103      // -> 0
2104     ...
2105 @end example
2106
2107 @cindex @code{get_free_indices()}
2108 @cindex dummy index
2109 @subsection Dummy indices
2110
2111 GiNaC treats certain symbolic index pairs as @dfn{dummy indices} meaning
2112 that a summation over the index range is implied. Symbolic indices which are
2113 not dummy indices are called @dfn{free indices}. Numeric indices are neither
2114 dummy nor free indices.
2115
2116 To be recognized as a dummy index pair, the two indices must be of the same
2117 class and their value must be the same single symbol (an index like
2118 @samp{2*n+1} is never a dummy index). If the indices are of class
2119 @code{varidx} they must also be of opposite variance; if they are of class
2120 @code{spinidx} they must be both dotted or both undotted.
2121
2122 The method @code{.get_free_indices()} returns a vector containing the free
2123 indices of an expression. It also checks that the free indices of the terms
2124 of a sum are consistent:
2125
2126 @example
2127 @{
2128     symbol A("A"), B("B"), C("C");
2129
2130     symbol i_sym("i"), j_sym("j"), k_sym("k"), l_sym("l");
2131     idx i(i_sym, 3), j(j_sym, 3), k(k_sym, 3), l(l_sym, 3);
2132
2133     ex e = indexed(A, i, j) * indexed(B, j, k) + indexed(C, k, l, i, l);
2134     cout << exprseq(e.get_free_indices()) << endl;
2135      // -> (.i,.k)
2136      // 'j' and 'l' are dummy indices
2137
2138     symbol mu_sym("mu"), nu_sym("nu"), rho_sym("rho"), sigma_sym("sigma");
2139     varidx mu(mu_sym, 4), nu(nu_sym, 4), rho(rho_sym, 4), sigma(sigma_sym, 4);
2140
2141     e = indexed(A, mu, nu) * indexed(B, nu.toggle_variance(), rho)
2142       + indexed(C, mu, sigma, rho, sigma.toggle_variance());
2143     cout << exprseq(e.get_free_indices()) << endl;
2144      // -> (~mu,~rho)
2145      // 'nu' is a dummy index, but 'sigma' is not
2146
2147     e = indexed(A, mu, mu);
2148     cout << exprseq(e.get_free_indices()) << endl;
2149      // -> (~mu)
2150      // 'mu' is not a dummy index because it appears twice with the same
2151      // variance
2152
2153     e = indexed(A, mu, nu) + 42;
2154     cout << exprseq(e.get_free_indices()) << endl; // ERROR
2155      // this will throw an exception:
2156      // "add::get_free_indices: inconsistent indices in sum"
2157 @}
2158 @end example
2159
2160 @cindex @code{simplify_indexed()}
2161 @subsection Simplifying indexed expressions
2162
2163 In addition to the few automatic simplifications that GiNaC performs on
2164 indexed expressions (such as re-ordering the indices of symmetric tensors
2165 and calculating traces and convolutions of matrices and predefined tensors)
2166 there is the method
2167
2168 @example
2169 ex ex::simplify_indexed();
2170 ex ex::simplify_indexed(const scalar_products & sp);
2171 @end example
2172
2173 that performs some more expensive operations:
2174
2175 @itemize
2176 @item it checks the consistency of free indices in sums in the same way
2177   @code{get_free_indices()} does
2178 @item it tries to give dummy indices that appear in different terms of a sum
2179   the same name to allow simplifications like @math{a_i*b_i-a_j*b_j=0}
2180 @item it (symbolically) calculates all possible dummy index summations/contractions
2181   with the predefined tensors (this will be explained in more detail in the
2182   next section)
2183 @item it detects contractions that vanish for symmetry reasons, for example
2184   the contraction of a symmetric and a totally antisymmetric tensor
2185 @item as a special case of dummy index summation, it can replace scalar products
2186   of two tensors with a user-defined value
2187 @end itemize
2188
2189 The last point is done with the help of the @code{scalar_products} class
2190 which is used to store scalar products with known values (this is not an
2191 arithmetic class, you just pass it to @code{simplify_indexed()}):
2192
2193 @example
2194 @{
2195     symbol A("A"), B("B"), C("C"), i_sym("i");
2196     idx i(i_sym, 3);
2197
2198     scalar_products sp;
2199     sp.add(A, B, 0); // A and B are orthogonal
2200     sp.add(A, C, 0); // A and C are orthogonal
2201     sp.add(A, A, 4); // A^2 = 4 (A has length 2)
2202
2203     e = indexed(A + B, i) * indexed(A + C, i);
2204     cout << e << endl;
2205      // -> (B+A).i*(A+C).i
2206
2207     cout << e.expand(expand_options::expand_indexed).simplify_indexed(sp)
2208          << endl;
2209      // -> 4+C.i*B.i
2210 @}
2211 @end example
2212
2213 The @code{scalar_products} object @code{sp} acts as a storage for the
2214 scalar products added to it with the @code{.add()} method. This method
2215 takes three arguments: the two expressions of which the scalar product is
2216 taken, and the expression to replace it with. After @code{sp.add(A, B, 0)},
2217 @code{simplify_indexed()} will replace all scalar products of indexed
2218 objects that have the symbols @code{A} and @code{B} as base expressions
2219 with the single value 0. The number, type and dimension of the indices
2220 don't matter; @samp{A~mu~nu*B.mu.nu} would also be replaced by 0.
2221
2222 @cindex @code{expand()}
2223 The example above also illustrates a feature of the @code{expand()} method:
2224 if passed the @code{expand_indexed} option it will distribute indices
2225 over sums, so @samp{(A+B).i} becomes @samp{A.i+B.i}.
2226
2227 @cindex @code{tensor} (class)
2228 @subsection Predefined tensors
2229
2230 Some frequently used special tensors such as the delta, epsilon and metric
2231 tensors are predefined in GiNaC. They have special properties when
2232 contracted with other tensor expressions and some of them have constant
2233 matrix representations (they will evaluate to a number when numeric
2234 indices are specified).
2235
2236 @cindex @code{delta_tensor()}
2237 @subsubsection Delta tensor
2238
2239 The delta tensor takes two indices, is symmetric and has the matrix
2240 representation @code{diag(1, 1, 1, ...)}. It is constructed by the function
2241 @code{delta_tensor()}:
2242
2243 @example
2244 @{
2245     symbol A("A"), B("B");
2246
2247     idx i(symbol("i"), 3), j(symbol("j"), 3),
2248         k(symbol("k"), 3), l(symbol("l"), 3);
2249
2250     ex e = indexed(A, i, j) * indexed(B, k, l)
2251          * delta_tensor(i, k) * delta_tensor(j, l) << endl;
2252     cout << e.simplify_indexed() << endl;
2253      // -> B.i.j*A.i.j
2254
2255     cout << delta_tensor(i, i) << endl;
2256      // -> 3
2257 @}
2258 @end example
2259
2260 @cindex @code{metric_tensor()}
2261 @subsubsection General metric tensor
2262
2263 The function @code{metric_tensor()} creates a general symmetric metric
2264 tensor with two indices that can be used to raise/lower tensor indices. The
2265 metric tensor is denoted as @samp{g} in the output and if its indices are of
2266 mixed variance it is automatically replaced by a delta tensor:
2267
2268 @example
2269 @{
2270     symbol A("A");
2271
2272     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
2273
2274     ex e = metric_tensor(mu, nu) * indexed(A, nu.toggle_variance(), rho);
2275     cout << e.simplify_indexed() << endl;
2276      // -> A~mu~rho
2277
2278     e = delta_tensor(mu, nu.toggle_variance()) * metric_tensor(nu, rho);
2279     cout << e.simplify_indexed() << endl;
2280      // -> g~mu~rho
2281
2282     e = metric_tensor(mu.toggle_variance(), nu.toggle_variance())
2283       * metric_tensor(nu, rho);
2284     cout << e.simplify_indexed() << endl;
2285      // -> delta.mu~rho
2286
2287     e = metric_tensor(nu.toggle_variance(), rho.toggle_variance())
2288       * metric_tensor(mu, nu) * (delta_tensor(mu.toggle_variance(), rho)
2289         + indexed(A, mu.toggle_variance(), rho));
2290     cout << e.simplify_indexed() << endl;
2291      // -> 4+A.rho~rho
2292 @}
2293 @end example
2294
2295 @cindex @code{lorentz_g()}
2296 @subsubsection Minkowski metric tensor
2297
2298 The Minkowski metric tensor is a special metric tensor with a constant
2299 matrix representation which is either @code{diag(1, -1, -1, ...)} (negative
2300 signature, the default) or @code{diag(-1, 1, 1, ...)} (positive signature).
2301 It is created with the function @code{lorentz_g()} (although it is output as
2302 @samp{eta}):
2303
2304 @example
2305 @{
2306     varidx mu(symbol("mu"), 4);
2307
2308     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
2309       * lorentz_g(mu, varidx(0, 4));       // negative signature
2310     cout << e.simplify_indexed() << endl;
2311      // -> 1
2312
2313     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
2314       * lorentz_g(mu, varidx(0, 4), true); // positive signature
2315     cout << e.simplify_indexed() << endl;
2316      // -> -1
2317 @}
2318 @end example
2319
2320 @cindex @code{spinor_metric()}
2321 @subsubsection Spinor metric tensor
2322
2323 The function @code{spinor_metric()} creates an antisymmetric tensor with
2324 two indices that is used to raise/lower indices of 2-component spinors.
2325 It is output as @samp{eps}:
2326
2327 @example
2328 @{
2329     symbol psi("psi");
2330
2331     spinidx A(symbol("A")), B(symbol("B")), C(symbol("C"));
2332     ex A_co = A.toggle_variance(), B_co = B.toggle_variance();
2333
2334     e = spinor_metric(A, B) * indexed(psi, B_co);
2335     cout << e.simplify_indexed() << endl;
2336      // -> psi~A
2337
2338     e = spinor_metric(A, B) * indexed(psi, A_co);
2339     cout << e.simplify_indexed() << endl;
2340      // -> -psi~B
2341
2342     e = spinor_metric(A_co, B_co) * indexed(psi, B);
2343     cout << e.simplify_indexed() << endl;
2344      // -> -psi.A
2345
2346     e = spinor_metric(A_co, B_co) * indexed(psi, A);
2347     cout << e.simplify_indexed() << endl;
2348      // -> psi.B
2349
2350     e = spinor_metric(A_co, B_co) * spinor_metric(A, B);
2351     cout << e.simplify_indexed() << endl;
2352      // -> 2
2353
2354     e = spinor_metric(A_co, B_co) * spinor_metric(B, C);
2355     cout << e.simplify_indexed() << endl;
2356      // -> -delta.A~C
2357 @}
2358 @end example
2359
2360 The matrix representation of the spinor metric is @code{[[0, 1], [-1, 0]]}.
2361
2362 @cindex @code{epsilon_tensor()}
2363 @cindex @code{lorentz_eps()}
2364 @subsubsection Epsilon tensor
2365
2366 The epsilon tensor is totally antisymmetric, its number of indices is equal
2367 to the dimension of the index space (the indices must all be of the same
2368 numeric dimension), and @samp{eps.1.2.3...} (resp. @samp{eps~0~1~2...}) is
2369 defined to be 1. Its behavior with indices that have a variance also
2370 depends on the signature of the metric. Epsilon tensors are output as
2371 @samp{eps}.
2372
2373 There are three functions defined to create epsilon tensors in 2, 3 and 4
2374 dimensions:
2375
2376 @example
2377 ex epsilon_tensor(const ex & i1, const ex & i2);
2378 ex epsilon_tensor(const ex & i1, const ex & i2, const ex & i3);
2379 ex lorentz_eps(const ex & i1, const ex & i2, const ex & i3, const ex & i4, bool pos_sig = false);
2380 @end example
2381
2382 The first two functions create an epsilon tensor in 2 or 3 Euclidean
2383 dimensions, the last function creates an epsilon tensor in a 4-dimensional
2384 Minkowski space (the last @code{bool} argument specifies whether the metric
2385 has negative or positive signature, as in the case of the Minkowski metric
2386 tensor):
2387
2388 @example
2389 @{
2390     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4),
2391            sig(symbol("sig"), 4), lam(symbol("lam"), 4), bet(symbol("bet"), 4);
2392     e = lorentz_eps(mu, nu, rho, sig) *
2393         lorentz_eps(mu.toggle_variance(), nu.toggle_variance(), lam, bet);
2394     cout << simplify_indexed(e) << endl;
2395      // -> 2*eta~bet~rho*eta~sig~lam-2*eta~sig~bet*eta~rho~lam
2396
2397     idx i(symbol("i"), 3), j(symbol("j"), 3), k(symbol("k"), 3);
2398     symbol A("A"), B("B");
2399     e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(B, k);
2400     cout << simplify_indexed(e) << endl;
2401      // -> -B.k*A.j*eps.i.k.j
2402     e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(A, k);
2403     cout << simplify_indexed(e) << endl;
2404      // -> 0
2405 @}
2406 @end example
2407
2408 @subsection Linear algebra
2409
2410 The @code{matrix} class can be used with indices to do some simple linear
2411 algebra (linear combinations and products of vectors and matrices, traces
2412 and scalar products):
2413
2414 @example
2415 @{
2416     idx i(symbol("i"), 2), j(symbol("j"), 2);
2417     symbol x("x"), y("y");
2418
2419     // A is a 2x2 matrix, X is a 2x1 vector
2420     matrix A(2, 2, lst(1, 2, 3, 4)), X(2, 1, lst(x, y));
2421
2422     cout << indexed(A, i, i) << endl;
2423      // -> 5
2424
2425     ex e = indexed(A, i, j) * indexed(X, j);
2426     cout << e.simplify_indexed() << endl;
2427      // -> [[2*y+x],[4*y+3*x]].i
2428
2429     e = indexed(A, i, j) * indexed(X, i) + indexed(X, j) * 2;
2430     cout << e.simplify_indexed() << endl;
2431      // -> [[3*y+3*x,6*y+2*x]].j
2432 @}
2433 @end example
2434
2435 You can of course obtain the same results with the @code{matrix::add()},
2436 @code{matrix::mul()} and @code{matrix::trace()} methods (@pxref{Matrices})
2437 but with indices you don't have to worry about transposing matrices.
2438
2439 Matrix indices always start at 0 and their dimension must match the number
2440 of rows/columns of the matrix. Matrices with one row or one column are
2441 vectors and can have one or two indices (it doesn't matter whether it's a
2442 row or a column vector). Other matrices must have two indices.
2443
2444 You should be careful when using indices with variance on matrices. GiNaC
2445 doesn't look at the variance and doesn't know that @samp{F~mu~nu} and
2446 @samp{F.mu.nu} are different matrices. In this case you should use only
2447 one form for @samp{F} and explicitly multiply it with a matrix representation
2448 of the metric tensor.
2449
2450
2451 @node Non-commutative objects, Methods and Functions, Indexed objects, Basic Concepts
2452 @c    node-name, next, previous, up
2453 @section Non-commutative objects
2454
2455 GiNaC is equipped to handle certain non-commutative algebras. Three classes of
2456 non-commutative objects are built-in which are mostly of use in high energy
2457 physics:
2458
2459 @itemize
2460 @item Clifford (Dirac) algebra (class @code{clifford})
2461 @item su(3) Lie algebra (class @code{color})
2462 @item Matrices (unindexed) (class @code{matrix})
2463 @end itemize
2464
2465 The @code{clifford} and @code{color} classes are subclasses of
2466 @code{indexed} because the elements of these algebras usually carry
2467 indices. The @code{matrix} class is described in more detail in
2468 @ref{Matrices}.
2469
2470 Unlike most computer algebra systems, GiNaC does not primarily provide an
2471 operator (often denoted @samp{&*}) for representing inert products of
2472 arbitrary objects. Rather, non-commutativity in GiNaC is a property of the
2473 classes of objects involved, and non-commutative products are formed with
2474 the usual @samp{*} operator, as are ordinary products. GiNaC is capable of
2475 figuring out by itself which objects commute and will group the factors
2476 by their class. Consider this example:
2477
2478 @example
2479     ...
2480     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
2481     idx a(symbol("a"), 8), b(symbol("b"), 8);
2482     ex e = -dirac_gamma(mu) * (2*color_T(a)) * 8 * color_T(b) * dirac_gamma(nu);
2483     cout << e << endl;
2484      // -> -16*(gamma~mu*gamma~nu)*(T.a*T.b)
2485     ...
2486 @end example
2487
2488 As can be seen, GiNaC pulls out the overall commutative factor @samp{-16} and
2489 groups the non-commutative factors (the gammas and the su(3) generators)
2490 together while preserving the order of factors within each class (because
2491 Clifford objects commute with color objects). The resulting expression is a
2492 @emph{commutative} product with two factors that are themselves non-commutative
2493 products (@samp{gamma~mu*gamma~nu} and @samp{T.a*T.b}). For clarification,
2494 parentheses are placed around the non-commutative products in the output.
2495
2496 @cindex @code{ncmul} (class)
2497 Non-commutative products are internally represented by objects of the class
2498 @code{ncmul}, as opposed to commutative products which are handled by the
2499 @code{mul} class. You will normally not have to worry about this distinction,
2500 though.
2501
2502 The advantage of this approach is that you never have to worry about using
2503 (or forgetting to use) a special operator when constructing non-commutative
2504 expressions. Also, non-commutative products in GiNaC are more intelligent
2505 than in other computer algebra systems; they can, for example, automatically
2506 canonicalize themselves according to rules specified in the implementation
2507 of the non-commutative classes. The drawback is that to work with other than
2508 the built-in algebras you have to implement new classes yourself. Symbols
2509 always commute and it's not possible to construct non-commutative products
2510 using symbols to represent the algebra elements or generators. User-defined
2511 functions can, however, be specified as being non-commutative.
2512
2513 @cindex @code{return_type()}
2514 @cindex @code{return_type_tinfo()}
2515 Information about the commutativity of an object or expression can be
2516 obtained with the two member functions
2517
2518 @example
2519 unsigned ex::return_type() const;
2520 unsigned ex::return_type_tinfo() const;
2521 @end example
2522
2523 The @code{return_type()} function returns one of three values (defined in
2524 the header file @file{flags.h}), corresponding to three categories of
2525 expressions in GiNaC:
2526
2527 @itemize
2528 @item @code{return_types::commutative}: Commutes with everything. Most GiNaC
2529   classes are of this kind.
2530 @item @code{return_types::noncommutative}: Non-commutative, belonging to a
2531   certain class of non-commutative objects which can be determined with the
2532   @code{return_type_tinfo()} method. Expressions of this category commute
2533   with everything except @code{noncommutative} expressions of the same
2534   class.
2535 @item @code{return_types::noncommutative_composite}: Non-commutative, composed
2536   of non-commutative objects of different classes. Expressions of this
2537   category don't commute with any other @code{noncommutative} or
2538   @code{noncommutative_composite} expressions.
2539 @end itemize
2540
2541 The value returned by the @code{return_type_tinfo()} method is valid only
2542 when the return type of the expression is @code{noncommutative}. It is a
2543 value that is unique to the class of the object and usually one of the
2544 constants in @file{tinfos.h}, or derived therefrom.
2545
2546 Here are a couple of examples:
2547
2548 @cartouche
2549 @multitable @columnfractions 0.33 0.33 0.34
2550 @item @strong{Expression} @tab @strong{@code{return_type()}} @tab @strong{@code{return_type_tinfo()}}
2551 @item @code{42} @tab @code{commutative} @tab -
2552 @item @code{2*x-y} @tab @code{commutative} @tab -
2553 @item @code{dirac_ONE()} @tab @code{noncommutative} @tab @code{TINFO_clifford}
2554 @item @code{dirac_gamma(mu)*dirac_gamma(nu)} @tab @code{noncommutative} @tab @code{TINFO_clifford}
2555 @item @code{2*color_T(a)} @tab @code{noncommutative} @tab @code{TINFO_color}
2556 @item @code{dirac_ONE()*color_T(a)} @tab @code{noncommutative_composite} @tab -
2557 @end multitable
2558 @end cartouche
2559
2560 Note: the @code{return_type_tinfo()} of Clifford objects is only equal to
2561 @code{TINFO_clifford} for objects with a representation label of zero.
2562 Other representation labels yield a different @code{return_type_tinfo()},
2563 but it's the same for any two objects with the same label. This is also true
2564 for color objects.
2565
2566 A last note: With the exception of matrices, positive integer powers of
2567 non-commutative objects are automatically expanded in GiNaC. For example,
2568 @code{pow(a*b, 2)} becomes @samp{a*b*a*b} if @samp{a} and @samp{b} are
2569 non-commutative expressions).
2570
2571
2572 @cindex @code{clifford} (class)
2573 @subsection Clifford algebra
2574
2575 @cindex @code{dirac_gamma()}
2576 Clifford algebra elements (also called Dirac gamma matrices, although GiNaC
2577 doesn't treat them as matrices) are designated as @samp{gamma~mu} and satisfy
2578 @samp{gamma~mu*gamma~nu + gamma~nu*gamma~mu = 2*eta~mu~nu} where @samp{eta~mu~nu}
2579 is the Minkowski metric tensor. Dirac gammas are constructed by the function
2580
2581 @example
2582 ex dirac_gamma(const ex & mu, unsigned char rl = 0);
2583 @end example
2584
2585 which takes two arguments: the index and a @dfn{representation label} in the
2586 range 0 to 255 which is used to distinguish elements of different Clifford
2587 algebras (this is also called a @dfn{spin line index}). Gammas with different
2588 labels commute with each other. The dimension of the index can be 4 or (in
2589 the framework of dimensional regularization) any symbolic value. Spinor
2590 indices on Dirac gammas are not supported in GiNaC.
2591
2592 @cindex @code{dirac_ONE()}
2593 The unity element of a Clifford algebra is constructed by
2594
2595 @example
2596 ex dirac_ONE(unsigned char rl = 0);
2597 @end example
2598
2599 @strong{Note:} You must always use @code{dirac_ONE()} when referring to
2600 multiples of the unity element, even though it's customary to omit it.
2601 E.g. instead of @code{dirac_gamma(mu)*(dirac_slash(q,4)+m)} you have to
2602 write @code{dirac_gamma(mu)*(dirac_slash(q,4)+m*dirac_ONE())}. Otherwise,
2603 GiNaC will complain and/or produce incorrect results.
2604
2605 @cindex @code{dirac_gamma5()}
2606 There is a special element @samp{gamma5} that commutes with all other
2607 gammas, has a unit square, and in 4 dimensions equals
2608 @samp{gamma~0 gamma~1 gamma~2 gamma~3}, provided by
2609
2610 @example
2611 ex dirac_gamma5(unsigned char rl = 0);
2612 @end example
2613
2614 @cindex @code{dirac_gammaL()}
2615 @cindex @code{dirac_gammaR()}
2616 The chiral projectors @samp{(1+/-gamma5)/2} are also available as proper
2617 objects, constructed by
2618
2619 @example
2620 ex dirac_gammaL(unsigned char rl = 0);
2621 ex dirac_gammaR(unsigned char rl = 0);
2622 @end example
2623
2624 They observe the relations @samp{gammaL^2 = gammaL}, @samp{gammaR^2 = gammaR},
2625 and @samp{gammaL gammaR = gammaR gammaL = 0}.
2626
2627 @cindex @code{dirac_slash()}
2628 Finally, the function
2629
2630 @example
2631 ex dirac_slash(const ex & e, const ex & dim, unsigned char rl = 0);
2632 @end example
2633
2634 creates a term that represents a contraction of @samp{e} with the Dirac
2635 Lorentz vector (it behaves like a term of the form @samp{e.mu gamma~mu}
2636 with a unique index whose dimension is given by the @code{dim} argument).
2637 Such slashed expressions are printed with a trailing backslash, e.g. @samp{e\}.
2638
2639 In products of dirac gammas, superfluous unity elements are automatically
2640 removed, squares are replaced by their values, and @samp{gamma5}, @samp{gammaL}
2641 and @samp{gammaR} are moved to the front.
2642
2643 The @code{simplify_indexed()} function performs contractions in gamma strings,
2644 for example
2645
2646 @example
2647 @{
2648     ...
2649     symbol a("a"), b("b"), D("D");
2650     varidx mu(symbol("mu"), D);
2651     ex e = dirac_gamma(mu) * dirac_slash(a, D)
2652          * dirac_gamma(mu.toggle_variance());
2653     cout << e << endl;
2654      // -> gamma~mu*a\*gamma.mu
2655     e = e.simplify_indexed();
2656     cout << e << endl;
2657      // -> -D*a\+2*a\
2658     cout << e.subs(D == 4) << endl;
2659      // -> -2*a\
2660     ...
2661 @}
2662 @end example
2663
2664 @cindex @code{dirac_trace()}
2665 To calculate the trace of an expression containing strings of Dirac gammas
2666 you use the function
2667
2668 @example
2669 ex dirac_trace(const ex & e, unsigned char rl = 0, const ex & trONE = 4);
2670 @end example
2671
2672 This function takes the trace of all gammas with the specified representation
2673 label; gammas with other labels are left standing. The last argument to
2674 @code{dirac_trace()} is the value to be returned for the trace of the unity
2675 element, which defaults to 4. The @code{dirac_trace()} function is a linear
2676 functional that is equal to the usual trace only in @math{D = 4} dimensions.
2677 In particular, the functional is not cyclic in @math{D != 4} dimensions when
2678 acting on expressions containing @samp{gamma5}, so it's not a proper trace.
2679 This @samp{gamma5} scheme is described in greater detail in
2680 @cite{The Role of gamma5 in Dimensional Regularization}.
2681
2682 The value of the trace itself is also usually different in 4 and in
2683 @math{D != 4} dimensions:
2684
2685 @example
2686 @{
2687     // 4 dimensions
2688     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
2689     ex e = dirac_gamma(mu) * dirac_gamma(nu) *
2690            dirac_gamma(mu.toggle_variance()) * dirac_gamma(rho);
2691     cout << dirac_trace(e).simplify_indexed() << endl;
2692      // -> -8*eta~rho~nu
2693 @}
2694 ...
2695 @{
2696     // D dimensions
2697     symbol D("D");
2698     varidx mu(symbol("mu"), D), nu(symbol("nu"), D), rho(symbol("rho"), D);
2699     ex e = dirac_gamma(mu) * dirac_gamma(nu) *
2700            dirac_gamma(mu.toggle_variance()) * dirac_gamma(rho);
2701     cout << dirac_trace(e).simplify_indexed() << endl;
2702      // -> 8*eta~rho~nu-4*eta~rho~nu*D
2703 @}
2704 @end example
2705
2706 Here is an example for using @code{dirac_trace()} to compute a value that
2707 appears in the calculation of the one-loop vacuum polarization amplitude in
2708 QED:
2709
2710 @example
2711 @{
2712     symbol q("q"), l("l"), m("m"), ldotq("ldotq"), D("D");
2713     varidx mu(symbol("mu"), D), nu(symbol("nu"), D);
2714
2715     scalar_products sp;
2716     sp.add(l, l, pow(l, 2));
2717     sp.add(l, q, ldotq);
2718
2719     ex e = dirac_gamma(mu) *
2720            (dirac_slash(l, D) + dirac_slash(q, D) + m * dirac_ONE()) *    
2721            dirac_gamma(mu.toggle_variance()) *
2722            (dirac_slash(l, D) + m * dirac_ONE());   
2723     e = dirac_trace(e).simplify_indexed(sp);
2724     e = e.collect(lst(l, ldotq, m));
2725     cout << e << endl;
2726      // -> (8-4*D)*l^2+(8-4*D)*ldotq+4*D*m^2
2727 @}
2728 @end example
2729
2730 The @code{canonicalize_clifford()} function reorders all gamma products that
2731 appear in an expression to a canonical (but not necessarily simple) form.
2732 You can use this to compare two expressions or for further simplifications:
2733
2734 @example
2735 @{
2736     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
2737     ex e = dirac_gamma(mu) * dirac_gamma(nu) + dirac_gamma(nu) * dirac_gamma(mu);
2738     cout << e << endl;
2739      // -> gamma~mu*gamma~nu+gamma~nu*gamma~mu
2740
2741     e = canonicalize_clifford(e);
2742     cout << e << endl;
2743      // -> 2*eta~mu~nu
2744 @}
2745 @end example
2746
2747
2748 @cindex @code{color} (class)
2749 @subsection Color algebra
2750
2751 @cindex @code{color_T()}
2752 For computations in quantum chromodynamics, GiNaC implements the base elements
2753 and structure constants of the su(3) Lie algebra (color algebra). The base
2754 elements @math{T_a} are constructed by the function
2755
2756 @example
2757 ex color_T(const ex & a, unsigned char rl = 0);
2758 @end example
2759
2760 which takes two arguments: the index and a @dfn{representation label} in the
2761 range 0 to 255 which is used to distinguish elements of different color
2762 algebras. Objects with different labels commute with each other. The
2763 dimension of the index must be exactly 8 and it should be of class @code{idx},
2764 not @code{varidx}.
2765
2766 @cindex @code{color_ONE()}
2767 The unity element of a color algebra is constructed by
2768
2769 @example
2770 ex color_ONE(unsigned char rl = 0);
2771 @end example
2772
2773 @strong{Note:} You must always use @code{color_ONE()} when referring to
2774 multiples of the unity element, even though it's customary to omit it.
2775 E.g. instead of @code{color_T(a)*(color_T(b)*indexed(X,b)+1)} you have to
2776 write @code{color_T(a)*(color_T(b)*indexed(X,b)+color_ONE())}. Otherwise,
2777 GiNaC may produce incorrect results.
2778
2779 @cindex @code{color_d()}
2780 @cindex @code{color_f()}
2781 The functions
2782
2783 @example
2784 ex color_d(const ex & a, const ex & b, const ex & c);
2785 ex color_f(const ex & a, const ex & b, const ex & c);
2786 @end example
2787
2788 create the symmetric and antisymmetric structure constants @math{d_abc} and
2789 @math{f_abc} which satisfy @math{@{T_a, T_b@} = 1/3 delta_ab + d_abc T_c}
2790 and @math{[T_a, T_b] = i f_abc T_c}.
2791
2792 @cindex @code{color_h()}
2793 There's an additional function
2794
2795 @example
2796 ex color_h(const ex & a, const ex & b, const ex & c);
2797 @end example
2798
2799 which returns the linear combination @samp{color_d(a, b, c)+I*color_f(a, b, c)}.
2800
2801 The function @code{simplify_indexed()} performs some simplifications on
2802 expressions containing color objects:
2803
2804 @example
2805 @{
2806     ...
2807     idx a(symbol("a"), 8), b(symbol("b"), 8), c(symbol("c"), 8),
2808         k(symbol("k"), 8), l(symbol("l"), 8);
2809
2810     e = color_d(a, b, l) * color_f(a, b, k);
2811     cout << e.simplify_indexed() << endl;
2812      // -> 0
2813
2814     e = color_d(a, b, l) * color_d(a, b, k);
2815     cout << e.simplify_indexed() << endl;
2816      // -> 5/3*delta.k.l
2817
2818     e = color_f(l, a, b) * color_f(a, b, k);
2819     cout << e.simplify_indexed() << endl;
2820      // -> 3*delta.k.l
2821
2822     e = color_h(a, b, c) * color_h(a, b, c);
2823     cout << e.simplify_indexed() << endl;
2824      // -> -32/3
2825
2826     e = color_h(a, b, c) * color_T(b) * color_T(c);
2827     cout << e.simplify_indexed() << endl;
2828      // -> -2/3*T.a
2829
2830     e = color_h(a, b, c) * color_T(a) * color_T(b) * color_T(c);
2831     cout << e.simplify_indexed() << endl;
2832      // -> -8/9*ONE
2833
2834     e = color_T(k) * color_T(a) * color_T(b) * color_T(k);
2835     cout << e.simplify_indexed() << endl;
2836      // -> 1/4*delta.b.a*ONE-1/6*T.a*T.b
2837     ...
2838 @end example
2839
2840 @cindex @code{color_trace()}
2841 To calculate the trace of an expression containing color objects you use the
2842 function
2843
2844 @example
2845 ex color_trace(const ex & e, unsigned char rl = 0);
2846 @end example
2847
2848 This function takes the trace of all color @samp{T} objects with the
2849 specified representation label; @samp{T}s with other labels are left
2850 standing. For example:
2851
2852 @example
2853     ...
2854     e = color_trace(4 * color_T(a) * color_T(b) * color_T(c));
2855     cout << e << endl;
2856      // -> -I*f.a.c.b+d.a.c.b
2857 @}
2858 @end example
2859
2860
2861 @node Methods and Functions, Information About Expressions, Non-commutative objects, Top
2862 @c    node-name, next, previous, up
2863 @chapter Methods and Functions
2864 @cindex polynomial
2865
2866 In this chapter the most important algorithms provided by GiNaC will be
2867 described.  Some of them are implemented as functions on expressions,
2868 others are implemented as methods provided by expression objects.  If
2869 they are methods, there exists a wrapper function around it, so you can
2870 alternatively call it in a functional way as shown in the simple
2871 example:
2872
2873 @example
2874     ...
2875     cout << "As method:   " << sin(1).evalf() << endl;
2876     cout << "As function: " << evalf(sin(1)) << endl;
2877     ...
2878 @end example
2879
2880 @cindex @code{subs()}
2881 The general rule is that wherever methods accept one or more parameters
2882 (@var{arg1}, @var{arg2}, @dots{}) the order of arguments the function
2883 wrapper accepts is the same but preceded by the object to act on
2884 (@var{object}, @var{arg1}, @var{arg2}, @dots{}).  This approach is the
2885 most natural one in an OO model but it may lead to confusion for MapleV
2886 users because where they would type @code{A:=x+1; subs(x=2,A);} GiNaC
2887 would require @code{A=x+1; subs(A,x==2);} (after proper declaration of
2888 @code{A} and @code{x}).  On the other hand, since MapleV returns 3 on
2889 @code{A:=x^2+3; coeff(A,x,0);} (GiNaC: @code{A=pow(x,2)+3;
2890 coeff(A,x,0);}) it is clear that MapleV is not trying to be consistent
2891 here.  Also, users of MuPAD will in most cases feel more comfortable
2892 with GiNaC's convention.  All function wrappers are implemented
2893 as simple inline functions which just call the corresponding method and
2894 are only provided for users uncomfortable with OO who are dead set to
2895 avoid method invocations.  Generally, nested function wrappers are much
2896 harder to read than a sequence of methods and should therefore be
2897 avoided if possible.  On the other hand, not everything in GiNaC is a
2898 method on class @code{ex} and sometimes calling a function cannot be
2899 avoided.
2900
2901 @menu
2902 * Information About Expressions::
2903 * Numerical Evaluation::
2904 * Substituting Expressions::
2905 * Pattern Matching and Advanced Substitutions::
2906 * Applying a Function on Subexpressions::
2907 * Visitors and Tree Traversal::
2908 * Polynomial Arithmetic::           Working with polynomials.
2909 * Rational Expressions::            Working with rational functions.
2910 * Symbolic Differentiation::
2911 * Series Expansion::                Taylor and Laurent expansion.
2912 * Symmetrization::
2913 * Built-in Functions::              List of predefined mathematical functions.
2914 * Solving Linear Systems of Equations::
2915 * Input/Output::                    Input and output of expressions.
2916 @end menu
2917
2918
2919 @node Information About Expressions, Numerical Evaluation, Methods and Functions, Methods and Functions
2920 @c    node-name, next, previous, up
2921 @section Getting information about expressions
2922
2923 @subsection Checking expression types
2924 @cindex @code{is_a<@dots{}>()}
2925 @cindex @code{is_exactly_a<@dots{}>()}
2926 @cindex @code{ex_to<@dots{}>()}
2927 @cindex Converting @code{ex} to other classes
2928 @cindex @code{info()}
2929 @cindex @code{return_type()}
2930 @cindex @code{return_type_tinfo()}
2931
2932 Sometimes it's useful to check whether a given expression is a plain number,
2933 a sum, a polynomial with integer coefficients, or of some other specific type.
2934 GiNaC provides a couple of functions for this:
2935
2936 @example
2937 bool is_a<T>(const ex & e);
2938 bool is_exactly_a<T>(const ex & e);
2939 bool ex::info(unsigned flag);
2940 unsigned ex::return_type() const;
2941 unsigned ex::return_type_tinfo() const;
2942 @end example
2943
2944 When the test made by @code{is_a<T>()} returns true, it is safe to call
2945 one of the functions @code{ex_to<T>()}, where @code{T} is one of the
2946 class names (@xref{The Class Hierarchy}, for a list of all classes). For
2947 example, assuming @code{e} is an @code{ex}:
2948
2949 @example
2950 @{
2951     @dots{}
2952     if (is_a<numeric>(e))
2953         numeric n = ex_to<numeric>(e);
2954     @dots{}
2955 @}
2956 @end example
2957
2958 @code{is_a<T>(e)} allows you to check whether the top-level object of
2959 an expression @samp{e} is an instance of the GiNaC class @samp{T}
2960 (@xref{The Class Hierarchy}, for a list of all classes). This is most useful,
2961 e.g., for checking whether an expression is a number, a sum, or a product:
2962
2963 @example
2964 @{
2965     symbol x("x");
2966     ex e1 = 42;
2967     ex e2 = 4*x - 3;
2968     is_a<numeric>(e1);  // true
2969     is_a<numeric>(e2);  // false
2970     is_a<add>(e1);      // false
2971     is_a<add>(e2);      // true
2972     is_a<mul>(e1);      // false
2973     is_a<mul>(e2);      // false
2974 @}
2975 @end example
2976
2977 In contrast, @code{is_exactly_a<T>(e)} allows you to check whether the
2978 top-level object of an expression @samp{e} is an instance of the GiNaC
2979 class @samp{T}, not including parent classes.
2980
2981 The @code{info()} method is used for checking certain attributes of
2982 expressions. The possible values for the @code{flag} argument are defined
2983 in @file{ginac/flags.h}, the most important being explained in the following
2984 table:
2985
2986 @cartouche
2987 @multitable @columnfractions .30 .70
2988 @item @strong{Flag} @tab @strong{Returns true if the object is@dots{}}
2989 @item @code{numeric}
2990 @tab @dots{}a number (same as @code{is_<numeric>(...)})
2991 @item @code{real}
2992 @tab @dots{}a real integer, rational or float (i.e. is not complex)
2993 @item @code{rational}
2994 @tab @dots{}an exact rational number (integers are rational, too)
2995 @item @code{integer}
2996 @tab @dots{}a (non-complex) integer
2997 @item @code{crational}
2998 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
2999 @item @code{cinteger}
3000 @tab @dots{}a (complex) integer (such as @math{2-3*I})
3001 @item @code{positive}
3002 @tab @dots{}not complex and greater than 0
3003 @item @code{negative}
3004 @tab @dots{}not complex and less than 0
3005 @item @code{nonnegative}
3006 @tab @dots{}not complex and greater than or equal to 0
3007 @item @code{posint}
3008 @tab @dots{}an integer greater than 0
3009 @item @code{negint}
3010 @tab @dots{}an integer less than 0
3011 @item @code{nonnegint}
3012 @tab @dots{}an integer greater than or equal to 0
3013 @item @code{even}
3014 @tab @dots{}an even integer
3015 @item @code{odd}
3016 @tab @dots{}an odd integer
3017 @item @code{prime}
3018 @tab @dots{}a prime integer (probabilistic primality test)
3019 @item @code{relation}
3020 @tab @dots{}a relation (same as @code{is_a<relational>(...)})
3021 @item @code{relation_equal}
3022 @tab @dots{}a @code{==} relation
3023 @item @code{relation_not_equal}
3024 @tab @dots{}a @code{!=} relation
3025 @item @code{relation_less}
3026 @tab @dots{}a @code{<} relation
3027 @item @code{relation_less_or_equal}
3028 @tab @dots{}a @code{<=} relation
3029 @item @code{relation_greater}
3030 @tab @dots{}a @code{>} relation
3031 @item @code{relation_greater_or_equal}
3032 @tab @dots{}a @code{>=} relation
3033 @item @code{symbol}
3034 @tab @dots{}a symbol (same as @code{is_a<symbol>(...)})
3035 @item @code{list}
3036 @tab @dots{}a list (same as @code{is_a<lst>(...)})
3037 @item @code{polynomial}
3038 @tab @dots{}a polynomial (i.e. only consists of sums and products of numbers and symbols with positive integer powers)
3039 @item @code{integer_polynomial}
3040 @tab @dots{}a polynomial with (non-complex) integer coefficients
3041 @item @code{cinteger_polynomial}
3042 @tab @dots{}a polynomial with (possibly complex) integer coefficients (such as @math{2-3*I})
3043 @item @code{rational_polynomial}
3044 @tab @dots{}a polynomial with (non-complex) rational coefficients
3045 @item @code{crational_polynomial}
3046 @tab @dots{}a polynomial with (possibly complex) rational coefficients (such as @math{2/3+7/2*I})
3047 @item @code{rational_function}
3048 @tab @dots{}a rational function (@math{x+y}, @math{z/(x+y)})
3049 @item @code{algebraic}
3050 @tab @dots{}an algebraic object (@math{sqrt(2)}, @math{sqrt(x)-1})
3051 @end multitable
3052 @end cartouche
3053
3054 To determine whether an expression is commutative or non-commutative and if
3055 so, with which other expressions it would commute, you use the methods
3056 @code{return_type()} and @code{return_type_tinfo()}. @xref{Non-commutative objects},
3057 for an explanation of these.
3058
3059
3060 @subsection Accessing subexpressions
3061 @cindex @code{nops()}
3062 @cindex @code{op()}
3063 @cindex container
3064 @cindex @code{relational} (class)
3065
3066 GiNaC provides the two methods
3067
3068 @example
3069 size_t ex::nops();
3070 ex ex::op(size_t i);
3071 @end example
3072
3073 for accessing the subexpressions in the container-like GiNaC classes like
3074 @code{add}, @code{mul}, @code{lst}, and @code{function}. @code{nops()}
3075 determines the number of subexpressions (@samp{operands}) contained, while
3076 @code{op()} returns the @code{i}-th (0..@code{nops()-1}) subexpression.
3077 In the case of a @code{power} object, @code{op(0)} will return the basis
3078 and @code{op(1)} the exponent. For @code{indexed} objects, @code{op(0)}
3079 is the base expression and @code{op(i)}, @math{i>0} are the indices.
3080
3081 The left-hand and right-hand side expressions of objects of class
3082 @code{relational} (and only of these) can also be accessed with the methods
3083
3084 @example
3085 ex ex::lhs();
3086 ex ex::rhs();
3087 @end example
3088
3089
3090 @subsection Comparing expressions
3091 @cindex @code{is_equal()}
3092 @cindex @code{is_zero()}
3093
3094 Expressions can be compared with the usual C++ relational operators like
3095 @code{==}, @code{>}, and @code{<} but if the expressions contain symbols,
3096 the result is usually not determinable and the result will be @code{false},
3097 except in the case of the @code{!=} operator. You should also be aware that
3098 GiNaC will only do the most trivial test for equality (subtracting both
3099 expressions), so something like @code{(pow(x,2)+x)/x==x+1} will return
3100 @code{false}.
3101
3102 Actually, if you construct an expression like @code{a == b}, this will be
3103 represented by an object of the @code{relational} class (@pxref{Relations})
3104 which is not evaluated until (explicitly or implicitly) cast to a @code{bool}.
3105
3106 There are also two methods
3107
3108 @example
3109 bool ex::is_equal(const ex & other);
3110 bool ex::is_zero();
3111 @end example
3112
3113 for checking whether one expression is equal to another, or equal to zero,
3114 respectively.
3115
3116
3117 @subsection Ordering expressions
3118 @cindex @code{ex_is_less} (class)
3119 @cindex @code{ex_is_equal} (class)
3120 @cindex @code{compare()}
3121
3122 Sometimes it is necessary to establish a mathematically well-defined ordering
3123 on a set of arbitrary expressions, for example to use expressions as keys
3124 in a @code{std::map<>} container, or to bring a vector of expressions into
3125 a canonical order (which is done internally by GiNaC for sums and products).
3126
3127 The operators @code{<}, @code{>} etc. described in the last section cannot
3128 be used for this, as they don't implement an ordering relation in the
3129 mathematical sense. In particular, they are not guaranteed to be
3130 antisymmetric: if @samp{a} and @samp{b} are different expressions, and
3131 @code{a < b} yields @code{false}, then @code{b < a} doesn't necessarily
3132 yield @code{true}.
3133
3134 By default, STL classes and algorithms use the @code{<} and @code{==}
3135 operators to compare objects, which are unsuitable for expressions, but GiNaC
3136 provides two functors that can be supplied as proper binary comparison
3137 predicates to the STL:
3138
3139 @example
3140 class ex_is_less : public std::binary_function<ex, ex, bool> @{
3141 public:
3142     bool operator()(const ex &lh, const ex &rh) const;
3143 @};
3144
3145 class ex_is_equal : public std::binary_function<ex, ex, bool> @{
3146 public:
3147     bool operator()(const ex &lh, const ex &rh) const;
3148 @};
3149 @end example
3150
3151 For example, to define a @code{map} that maps expressions to strings you
3152 have to use
3153
3154 @example
3155 std::map<ex, std::string, ex_is_less> myMap;
3156 @end example
3157
3158 Omitting the @code{ex_is_less} template parameter will introduce spurious
3159 bugs because the map operates improperly.
3160
3161 Other examples for the use of the functors:
3162
3163 @example
3164 std::vector<ex> v;
3165 // fill vector
3166 ...
3167
3168 // sort vector
3169 std::sort(v.begin(), v.end(), ex_is_less());
3170
3171 // count the number of expressions equal to '1'
3172 unsigned num_ones = std::count_if(v.begin(), v.end(),
3173                                   std::bind2nd(ex_is_equal(), 1));
3174 @end example
3175
3176 The implementation of @code{ex_is_less} uses the member function
3177
3178 @example
3179 int ex::compare(const ex & other) const;
3180 @end example
3181
3182 which returns @math{0} if @code{*this} and @code{other} are equal, @math{-1}
3183 if @code{*this} sorts before @code{other}, and @math{1} if @code{*this} sorts
3184 after @code{other}.
3185
3186
3187 @node Numerical Evaluation, Substituting Expressions, Information About Expressions, Methods and Functions
3188 @c    node-name, next, previous, up
3189 @section Numercial Evaluation
3190 @cindex @code{evalf()}
3191
3192 GiNaC keeps algebraic expressions, numbers and constants in their exact form.
3193 To evaluate them using floating-point arithmetic you need to call
3194
3195 @example
3196 ex ex::evalf(int level = 0) const;
3197 @end example
3198
3199 @cindex @code{Digits}
3200 The accuracy of the evaluation is controlled by the global object @code{Digits}
3201 which can be assigned an integer value. The default value of @code{Digits}
3202 is 17. @xref{Numbers}, for more information and examples.
3203
3204 To evaluate an expression to a @code{double} floating-point number you can
3205 call @code{evalf()} followed by @code{numeric::to_double()}, like this:
3206
3207 @example
3208 @{
3209     // Approximate sin(x/Pi)
3210     symbol x("x");
3211     ex e = series(sin(x/Pi), x == 0, 6);
3212
3213     // Evaluate numerically at x=0.1
3214     ex f = evalf(e.subs(x == 0.1));
3215
3216     // ex_to<numeric> is an unsafe cast, so check the type first
3217     if (is_a<numeric>(f)) @{
3218         double d = ex_to<numeric>(f).to_double();
3219         cout << d << endl;
3220          // -> 0.0318256
3221     @} else
3222         // error
3223 @}
3224 @end example
3225
3226
3227 @node Substituting Expressions, Pattern Matching and Advanced Substitutions, Numerical Evaluation, Methods and Functions
3228 @c    node-name, next, previous, up
3229 @section Substituting expressions
3230 @cindex @code{subs()}
3231
3232 Algebraic objects inside expressions can be replaced with arbitrary
3233 expressions via the @code{.subs()} method:
3234
3235 @example
3236 ex ex::subs(const ex & e, unsigned options = 0);
3237 ex ex::subs(const lst & syms, const lst & repls, unsigned options = 0);
3238 @end example
3239
3240 In the first form, @code{subs()} accepts a relational of the form
3241 @samp{object == expression} or a @code{lst} of such relationals:
3242
3243 @example
3244 @{
3245     symbol x("x"), y("y");
3246
3247     ex e1 = 2*x^2-4*x+3;
3248     cout << "e1(7) = " << e1.subs(x == 7) << endl;
3249      // -> 73
3250
3251     ex e2 = x*y + x;
3252     cout << "e2(-2, 4) = " << e2.subs(lst(x == -2, y == 4)) << endl;
3253      // -> -10
3254 @}
3255 @end example
3256
3257 If you specify multiple substitutions, they are performed in parallel, so e.g.
3258 @code{subs(lst(x == y, y == x))} exchanges @samp{x} and @samp{y}.
3259
3260 The second form of @code{subs()} takes two lists, one for the objects to be
3261 replaced and one for the expressions to be substituted (both lists must
3262 contain the same number of elements). Using this form, you would write
3263 @code{subs(lst(x, y), lst(y, x))} to exchange @samp{x} and @samp{y}.
3264
3265 The optional last argument to @code{subs()} is a combination of
3266 @code{subs_options} flags. There are two options available:
3267 @code{subs_options::no_pattern} disables pattern matching, which makes
3268 large @code{subs()} operations significantly faster if you are not using
3269 patterns. The second option, @code{subs_options::algebraic} enables
3270 algebraic substitutions in products and powers.
3271 @ref{Pattern Matching and Advanced Substitutions}, for more information
3272 about patterns and algebraic substitutions.
3273
3274 @code{subs()} performs syntactic substitution of any complete algebraic
3275 object; it does not try to match sub-expressions as is demonstrated by the
3276 following example:
3277
3278 @example
3279 @{
3280     symbol x("x"), y("y"), z("z");
3281
3282     ex e1 = pow(x+y, 2);
3283     cout << e1.subs(x+y == 4) << endl;
3284      // -> 16
3285
3286     ex e2 = sin(x)*sin(y)*cos(x);
3287     cout << e2.subs(sin(x) == cos(x)) << endl;
3288      // -> cos(x)^2*sin(y)
3289
3290     ex e3 = x+y+z;
3291     cout << e3.subs(x+y == 4) << endl;
3292      // -> x+y+z
3293      // (and not 4+z as one might expect)
3294 @}
3295 @end example
3296
3297 A more powerful form of substitution using wildcards is described in the
3298 next section.
3299
3300
3301 @node Pattern Matching and Advanced Substitutions, Applying a Function on Subexpressions, Substituting Expressions, Methods and Functions
3302 @c    node-name, next, previous, up
3303 @section Pattern matching and advanced substitutions
3304 @cindex @code{wildcard} (class)
3305 @cindex Pattern matching
3306
3307 GiNaC allows the use of patterns for checking whether an expression is of a
3308 certain form or contains subexpressions of a certain form, and for
3309 substituting expressions in a more general way.
3310
3311 A @dfn{pattern} is an algebraic expression that optionally contains wildcards.
3312 A @dfn{wildcard} is a special kind of object (of class @code{wildcard}) that
3313 represents an arbitrary expression. Every wildcard has a @dfn{label} which is
3314 an unsigned integer number to allow having multiple different wildcards in a
3315 pattern. Wildcards are printed as @samp{$label} (this is also the way they
3316 are specified in @command{ginsh}). In C++ code, wildcard objects are created
3317 with the call
3318
3319 @example
3320 ex wild(unsigned label = 0);
3321 @end example
3322
3323 which is simply a wrapper for the @code{wildcard()} constructor with a shorter
3324 name.
3325
3326 Some examples for patterns:
3327
3328 @multitable @columnfractions .5 .5
3329 @item @strong{Constructed as} @tab @strong{Output as}
3330 @item @code{wild()} @tab @samp{$0}
3331 @item @code{pow(x,wild())} @tab @samp{x^$0}
3332 @item @code{atan2(wild(1),wild(2))} @tab @samp{atan2($1,$2)}
3333 @item @code{indexed(A,idx(wild(),3))} @tab @samp{A.$0}
3334 @end multitable
3335
3336 Notes:
3337
3338 @itemize
3339 @item Wildcards behave like symbols and are subject to the same algebraic
3340   rules. E.g., @samp{$0+2*$0} is automatically transformed to @samp{3*$0}.
3341 @item As shown in the last example, to use wildcards for indices you have to
3342   use them as the value of an @code{idx} object. This is because indices must
3343   always be of class @code{idx} (or a subclass).
3344 @item Wildcards only represent expressions or subexpressions. It is not
3345   possible to use them as placeholders for other properties like index
3346   dimension or variance, representation labels, symmetry of indexed objects
3347   etc.
3348 @item Because wildcards are commutative, it is not possible to use wildcards
3349   as part of noncommutative products.
3350 @item A pattern does not have to contain wildcards. @samp{x} and @samp{x+y}
3351   are also valid patterns.
3352 @end itemize
3353
3354 @subsection Matching expressions
3355 @cindex @code{match()}
3356 The most basic application of patterns is to check whether an expression
3357 matches a given pattern. This is done by the function
3358
3359 @example
3360 bool ex::match(const ex & pattern);
3361 bool ex::match(const ex & pattern, lst & repls);
3362 @end example
3363
3364 This function returns @code{true} when the expression matches the pattern
3365 and @code{false} if it doesn't. If used in the second form, the actual
3366 subexpressions matched by the wildcards get returned in the @code{repls}
3367 object as a list of relations of the form @samp{wildcard == expression}.
3368 If @code{match()} returns false, the state of @code{repls} is undefined.
3369 For reproducible results, the list should be empty when passed to
3370 @code{match()}, but it is also possible to find similarities in multiple
3371 expressions by passing in the result of a previous match.
3372
3373 The matching algorithm works as follows:
3374
3375 @itemize
3376 @item A single wildcard matches any expression. If one wildcard appears
3377   multiple times in a pattern, it must match the same expression in all
3378   places (e.g. @samp{$0} matches anything, and @samp{$0*($0+1)} matches
3379   @samp{x*(x+1)} but not @samp{x*(y+1)}).
3380 @item If the expression is not of the same class as the pattern, the match
3381   fails (i.e. a sum only matches a sum, a function only matches a function,
3382   etc.).
3383 @item If the pattern is a function, it only matches the same function
3384   (i.e. @samp{sin($0)} matches @samp{sin(x)} but doesn't match @samp{exp(x)}).
3385 @item Except for sums and products, the match fails if the number of
3386   subexpressions (@code{nops()}) is not equal to the number of subexpressions
3387   of the pattern.
3388 @item If there are no subexpressions, the expressions and the pattern must
3389   be equal (in the sense of @code{is_equal()}).
3390 @item Except for sums and products, each subexpression (@code{op()}) must
3391   match the corresponding subexpression of the pattern.
3392 @end itemize
3393
3394 Sums (@code{add}) and products (@code{mul}) are treated in a special way to
3395 account for their commutativity and associativity:
3396
3397 @itemize
3398 @item If the pattern contains a term or factor that is a single wildcard,
3399   this one is used as the @dfn{global wildcard}. If there is more than one
3400   such wildcard, one of them is chosen as the global wildcard in a random
3401   way.
3402 @item Every term/factor of the pattern, except the global wildcard, is
3403   matched against every term of the expression in sequence. If no match is
3404   found, the whole match fails. Terms that did match are not considered in
3405   further matches.
3406 @item If there are no unmatched terms left, the match succeeds. Otherwise
3407   the match fails unless there is a global wildcard in the pattern, in
3408   which case this wildcard matches the remaining terms.
3409 @end itemize
3410
3411 In general, having more than one single wildcard as a term of a sum or a
3412 factor of a product (such as @samp{a+$0+$1}) will lead to unpredictable or
3413 ambiguous results.
3414
3415 Here are some examples in @command{ginsh} to demonstrate how it works (the
3416 @code{match()} function in @command{ginsh} returns @samp{FAIL} if the
3417 match fails, and the list of wildcard replacements otherwise):
3418
3419 @example
3420 > match((x+y)^a,(x+y)^a);
3421 @{@}
3422 > match((x+y)^a,(x+y)^b);
3423 FAIL
3424 > match((x+y)^a,$1^$2);
3425 @{$1==x+y,$2==a@}
3426 > match((x+y)^a,$1^$1);
3427 FAIL
3428 > match((x+y)^(x+y),$1^$1);
3429 @{$1==x+y@}
3430 > match((x+y)^(x+y),$1^$2);
3431 @{$1==x+y,$2==x+y@}
3432 > match((a+b)*(a+c),($1+b)*($1+c));
3433 @{$1==a@}
3434 > match((a+b)*(a+c),(a+$1)*(a+$2));
3435 @{$1==c,$2==b@}
3436   (Unpredictable. The result might also be [$1==c,$2==b].)
3437 > match((a+b)*(a+c),($1+$2)*($1+$3));
3438   (The result is undefined. Due to the sequential nature of the algorithm
3439    and the re-ordering of terms in GiNaC, the match for the first factor
3440    may be @{$1==a,$2==b@} in which case the match for the second factor
3441    succeeds, or it may be @{$1==b,$2==a@} which causes the second match to
3442    fail.)
3443 > match(a*(x+y)+a*z+b,a*$1+$2);
3444   (This is also ambiguous and may return either @{$1==z,$2==a*(x+y)+b@} or
3445    @{$1=x+y,$2=a*z+b@}.)
3446 > match(a+b+c+d+e+f,c);
3447 FAIL
3448 > match(a+b+c+d+e+f,c+$0);
3449 @{$0==a+e+b+f+d@}
3450 > match(a+b+c+d+e+f,c+e+$0);
3451 @{$0==a+b+f+d@}
3452 > match(a+b,a+b+$0);
3453 @{$0==0@}
3454 > match(a*b^2,a^$1*b^$2);
3455 FAIL
3456   (The matching is syntactic, not algebraic, and "a" doesn't match "a^$1"
3457    even though a==a^1.)
3458 > match(x*atan2(x,x^2),$0*atan2($0,$0^2));
3459 @{$0==x@}
3460 > match(atan2(y,x^2),atan2(y,$0));
3461 @{$0==x^2@}
3462 @end example
3463
3464 @subsection Matching parts of expressions
3465 @cindex @code{has()}
3466 A more general way to look for patterns in expressions is provided by the
3467 member function
3468
3469 @example
3470 bool ex::has(const ex & pattern);
3471 @end example
3472
3473 This function checks whether a pattern is matched by an expression itself or
3474 by any of its subexpressions.
3475
3476 Again some examples in @command{ginsh} for illustration (in @command{ginsh},
3477 @code{has()} returns @samp{1} for @code{true} and @samp{0} for @code{false}):
3478
3479 @example
3480 > has(x*sin(x+y+2*a),y);
3481 1
3482 > has(x*sin(x+y+2*a),x+y);
3483 0
3484   (This is because in GiNaC, "x+y" is not a subexpression of "x+y+2*a" (which
3485    has the subexpressions "x", "y" and "2*a".)
3486 > has(x*sin(x+y+2*a),x+y+$1);
3487 1
3488   (But this is possible.)
3489 > has(x*sin(2*(x+y)+2*a),x+y);
3490 0
3491   (This fails because "2*(x+y)" automatically gets converted to "2*x+2*y" of
3492    which "x+y" is not a subexpression.)
3493 > has(x+1,x^$1);
3494 0
3495   (Although x^1==x and x^0==1, neither "x" nor "1" are actually of the form
3496    "x^something".)
3497 > has(4*x^2-x+3,$1*x);
3498 1
3499 > has(4*x^2+x+3,$1*x);
3500 0
3501   (Another possible pitfall. The first expression matches because the term
3502    "-x" has the form "(-1)*x" in GiNaC. To check whether a polynomial
3503    contains a linear term you should use the coeff() function instead.)
3504 @end example
3505
3506 @cindex @code{find()}
3507 The method
3508
3509 @example
3510 bool ex::find(const ex & pattern, lst & found);
3511 @end example
3512
3513 works a bit like @code{has()} but it doesn't stop upon finding the first
3514 match. Instead, it appends all found matches to the specified list. If there
3515 are multiple occurrences of the same expression, it is entered only once to
3516 the list. @code{find()} returns false if no matches were found (in
3517 @command{ginsh}, it returns an empty list):
3518
3519 @example
3520 > find(1+x+x^2+x^3,x);
3521 @{x@}
3522 > find(1+x+x^2+x^3,y);
3523 @{@}
3524 > find(1+x+x^2+x^3,x^$1);
3525 @{x^3,x^2@}
3526   (Note the absence of "x".)
3527 > expand((sin(x)+sin(y))*(a+b));
3528 sin(y)*a+sin(x)*b+sin(x)*a+sin(y)*b
3529 > find(%,sin($1));
3530 @{sin(y),sin(x)@}
3531 @end example
3532
3533 @subsection Substituting expressions
3534 @cindex @code{subs()}
3535 Probably the most useful application of patterns is to use them for
3536 substituting expressions with the @code{subs()} method. Wildcards can be
3537 used in the search patterns as well as in the replacement expressions, where
3538 they get replaced by the expressions matched by them. @code{subs()} doesn't
3539 know anything about algebra; it performs purely syntactic substitutions.
3540
3541 Some examples:
3542
3543 @example
3544 > subs(a^2+b^2+(x+y)^2,$1^2==$1^3);
3545 b^3+a^3+(x+y)^3
3546 > subs(a^4+b^4+(x+y)^4,$1^2==$1^3);
3547 b^4+a^4+(x+y)^4
3548 > subs((a+b+c)^2,a+b==x);
3549 (a+b+c)^2
3550 > subs((a+b+c)^2,a+b+$1==x+$1);
3551 (x+c)^2
3552 > subs(a+2*b,a+b==x);
3553 a+2*b
3554 > subs(4*x^3-2*x^2+5*x-1,x==a);
3555 -1+5*a-2*a^2+4*a^3
3556 > subs(4*x^3-2*x^2+5*x-1,x^$0==a^$0);
3557 -1+5*x-2*a^2+4*a^3
3558 > subs(sin(1+sin(x)),sin($1)==cos($1));
3559 cos(1+cos(x))
3560 > expand(subs(a*sin(x+y)^2+a*cos(x+y)^2+b,cos($1)^2==1-sin($1)^2));
3561 a+b
3562 @end example
3563
3564 The last example would be written in C++ in this way:
3565
3566 @example
3567 @{
3568     symbol a("a"), b("b"), x("x"), y("y");
3569     e = a*pow(sin(x+y), 2) + a*pow(cos(x+y), 2) + b;
3570     e = e.subs(pow(cos(wild()), 2) == 1-pow(sin(wild()), 2));
3571     cout << e.expand() << endl;
3572      // -> a+b
3573 @}
3574 @end example
3575
3576 @subsection Algebraic substitutions
3577 Supplying the @code{subs_options::algebraic} option to @code{subs()}
3578 enables smarter, algebraic substitutions in products and powers. If you want
3579 to substitute some factors of a product, you only need to list these factors
3580 in your pattern. Furthermore, if an (integer) power of some expression occurs
3581 in your pattern and in the expression that you want the substitution to occur
3582 in, it can be substituted as many times as possible, without getting negative
3583 powers.
3584
3585 An example clarifies it all (hopefully):
3586
3587 @example
3588 cout << (a*a*a*a+b*b*b*b+pow(x+y,4)).subs(wild()*wild()==pow(wild(),3),
3589                                         subs_options::algebraic) << endl;
3590 // --> (y+x)^6+b^6+a^6
3591
3592 cout << ((a+b+c)*(a+b+c)).subs(a+b==x,subs_options::algebraic) << endl;
3593 // --> (c+b+a)^2
3594 // Powers and products are smart, but addition is just the same.
3595
3596 cout << ((a+b+c)*(a+b+c)).subs(a+b+wild()==x+wild(), subs_options::algebraic)
3597                                                                       << endl;
3598 // --> (x+c)^2
3599 // As I said: addition is just the same.
3600
3601 cout << (pow(a,5)*pow(b,7)+2*b).subs(b*b*a==x,subs_options::algebraic) << endl;
3602 // --> x^3*b*a^2+2*b
3603
3604 cout << (pow(a,-5)*pow(b,-7)+2*b).subs(1/(b*b*a)==x,subs_options::algebraic)
3605                                                                        << endl;
3606 // --> 2*b+x^3*b^(-1)*a^(-2)
3607
3608 cout << (4*x*x*x-2*x*x+5*x-1).subs(x==a,subs_options::algebraic) << endl;
3609 // --> -1-2*a^2+4*a^3+5*a
3610
3611 cout << (4*x*x*x-2*x*x+5*x-1).subs(pow(x,wild())==pow(a,wild()),
3612                                 subs_options::algebraic) << endl;
3613 // --> -1+5*x+4*x^3-2*x^2
3614 // You should not really need this kind of patterns very often now.
3615 // But perhaps this it's-not-a-bug-it's-a-feature (c/sh)ould still change.
3616
3617 cout << ex(sin(1+sin(x))).subs(sin(wild())==cos(wild()),
3618                                 subs_options::algebraic) << endl;
3619 // --> cos(1+cos(x))
3620
3621 cout << expand((a*sin(x+y)*sin(x+y)+a*cos(x+y)*cos(x+y)+b)
3622         .subs((pow(cos(wild()),2)==1-pow(sin(wild()),2)),
3623                                 subs_options::algebraic)) << endl;
3624 // --> b+a
3625 @end example
3626
3627
3628 @node Applying a Function on Subexpressions, Visitors and Tree Traversal, Pattern Matching and Advanced Substitutions, Methods and Functions
3629 @c    node-name, next, previous, up
3630 @section Applying a Function on Subexpressions
3631 @cindex tree traversal
3632 @cindex @code{map()}
3633
3634 Sometimes you may want to perform an operation on specific parts of an
3635 expression while leaving the general structure of it intact. An example
3636 of this would be a matrix trace operation: the trace of a sum is the sum
3637 of the traces of the individual terms. That is, the trace should @dfn{map}
3638 on the sum, by applying itself to each of the sum's operands. It is possible
3639 to do this manually which usually results in code like this:
3640
3641 @example
3642 ex calc_trace(ex e)
3643 @{
3644     if (is_a<matrix>(e))
3645         return ex_to<matrix>(e).trace();
3646     else if (is_a<add>(e)) @{
3647         ex sum = 0;
3648         for (size_t i=0; i<e.nops(); i++)
3649             sum += calc_trace(e.op(i));
3650         return sum;
3651     @} else if (is_a<mul>)(e)) @{
3652         ...
3653     @} else @{
3654         ...
3655     @}
3656 @}
3657 @end example
3658
3659 This is, however, slightly inefficient (if the sum is very large it can take
3660 a long time to add the terms one-by-one), and its applicability is limited to
3661 a rather small class of expressions. If @code{calc_trace()} is called with
3662 a relation or a list as its argument, you will probably want the trace to
3663 be taken on both sides of the relation or of all elements of the list.
3664
3665 GiNaC offers the @code{map()} method to aid in the implementation of such
3666 operations:
3667
3668 @example
3669 ex ex::map(map_function & f) const;
3670 ex ex::map(ex (*f)(const ex & e)) const;
3671 @end example
3672
3673 In the first (preferred) form, @code{map()} takes a function object that
3674 is subclassed from the @code{map_function} class. In the second form, it
3675 takes a pointer to a function that accepts and returns an expression.
3676 @code{map()} constructs a new expression of the same type, applying the
3677 specified function on all subexpressions (in the sense of @code{op()}),
3678 non-recursively.
3679
3680 The use of a function object makes it possible to supply more arguments to
3681 the function that is being mapped, or to keep local state information.
3682 The @code{map_function} class declares a virtual function call operator
3683 that you can overload. Here is a sample implementation of @code{calc_trace()}
3684 that uses @code{map()} in a recursive fashion:
3685
3686 @example
3687 struct calc_trace : public map_function @{
3688     ex operator()(const ex &e)
3689     @{
3690         if (is_a<matrix>(e))
3691             return ex_to<matrix>(e).trace();
3692         else if (is_a<mul>(e)) @{
3693             ...
3694         @} else
3695             return e.map(*this);
3696     @}
3697 @};
3698 @end example
3699
3700 This function object could then be used like this:
3701
3702 @example
3703 @{
3704     ex M = ... // expression with matrices
3705     calc_trace do_trace;
3706     ex tr = do_trace(M);
3707 @}
3708 @end example
3709
3710 Here is another example for you to meditate over.  It removes quadratic
3711 terms in a variable from an expanded polynomial:
3712
3713 @example
3714 struct map_rem_quad : public map_function @{
3715     ex var;
3716     map_rem_quad(const ex & var_) : var