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