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