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