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