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