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