]> www.ginac.de Git - ginac.git/blob - doc/tutorial/ginac.texi
c92e38dcf9b8e6112b9919d9cbab8433d4b52964
[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-2007 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 @uref{http://www.ginac.de}
51
52 @page
53 @vskip 0pt plus 1filll
54 Copyright @copyright{} 1999-2007 Johannes Gutenberg University Mainz, Germany
55 @sp 2
56 Permission is granted to make and distribute verbatim copies of
57 this manual provided the copyright notice and this permission notice
58 are preserved on all copies.
59
60 Permission is granted to copy and distribute modified versions of this
61 manual under the conditions for verbatim copying, provided that the entire
62 resulting derived work is distributed under the terms of a permission
63 notice identical to this one.
64 @end titlepage
65
66 @page
67 @contents
68
69 @page
70
71
72 @node Top, Introduction, (dir), (dir)
73 @c    node-name, next, previous, up
74 @top GiNaC
75
76 This is a tutorial that documents GiNaC @value{VERSION}, an open
77 framework for symbolic computation within the C++ programming language.
78
79 @menu
80 * Introduction::                 GiNaC's purpose.
81 * A tour of GiNaC::              A quick tour of the library.
82 * Installation::                 How to install the package.
83 * Basic concepts::               Description of fundamental classes.
84 * Methods and functions::        Algorithms for symbolic manipulations.
85 * Extending GiNaC::              How to extend the library.
86 * A comparison with other CAS::  Compares GiNaC to traditional CAS.
87 * Internal structures::          Description of some internal structures.
88 * Package tools::                Configuring packages to work with GiNaC.
89 * Bibliography::
90 * Concept index::
91 @end menu
92
93
94 @node Introduction, A tour of GiNaC, Top, Top
95 @c    node-name, next, previous, up
96 @chapter Introduction
97 @cindex history of GiNaC
98
99 The motivation behind GiNaC derives from the observation that most
100 present day computer algebra systems (CAS) are linguistically and
101 semantically impoverished.  Although they are quite powerful tools for
102 learning math and solving particular problems they lack modern
103 linguistic structures that allow for the creation of large-scale
104 projects.  GiNaC is an attempt to overcome this situation by extending a
105 well established and standardized computer language (C++) by some
106 fundamental symbolic capabilities, thus allowing for integrated systems
107 that embed symbolic manipulations together with more established areas
108 of computer science (like computation-intense numeric applications,
109 graphical interfaces, etc.) under one roof.
110
111 The particular problem that led to the writing of the GiNaC framework is
112 still a very active field of research, namely the calculation of higher
113 order corrections to elementary particle interactions.  There,
114 theoretical physicists are interested in matching present day theories
115 against experiments taking place at particle accelerators.  The
116 computations involved are so complex they call for a combined symbolical
117 and numerical approach.  This turned out to be quite difficult to
118 accomplish with the present day CAS we have worked with so far and so we
119 tried to fill the gap by writing GiNaC.  But of course its applications
120 are in no way restricted to theoretical physics.
121
122 This tutorial is intended for the novice user who is new to GiNaC but
123 already has some background in C++ programming.  However, since a
124 hand-made documentation like this one is difficult to keep in sync with
125 the development, the actual documentation is inside the sources in the
126 form of comments.  That documentation may be parsed by one of the many
127 Javadoc-like documentation systems.  If you fail at generating it you
128 may access it from @uref{http://www.ginac.de/reference/, the GiNaC home
129 page}.  It is an invaluable resource not only for the advanced user who
130 wishes to extend the system (or chase bugs) but for everybody who wants
131 to comprehend the inner workings of GiNaC.  This little tutorial on the
132 other hand only covers the basic things that are unlikely to change in
133 the near future.
134
135 @section License
136 The GiNaC framework for symbolic computation within the C++ programming
137 language is Copyright @copyright{} 1999-2007 Johannes Gutenberg
138 University Mainz, Germany.
139
140 This program is free software; you can redistribute it and/or
141 modify it under the terms of the GNU General Public License as
142 published by the Free Software Foundation; either version 2 of the
143 License, or (at your option) any later version.
144
145 This program is distributed in the hope that it will be useful, but
146 WITHOUT ANY WARRANTY; without even the implied warranty of
147 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
148 General Public License for more details.
149
150 You should have received a copy of the GNU General Public License
151 along with this program; see the file COPYING.  If not, write to the
152 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
153 MA 02110-1301, USA.
154
155
156 @node A tour of GiNaC, How to use it from within C++, Introduction, Top
157 @c    node-name, next, previous, up
158 @chapter A Tour of GiNaC
159
160 This quick tour of GiNaC wants to arise your interest in the
161 subsequent chapters by showing off a bit.  Please excuse us if it
162 leaves many open questions.
163
164 @menu
165 * How to use it from within C++::  Two simple examples.
166 * What it can do for you::         A Tour of GiNaC's features.
167 @end menu
168
169
170 @node How to use it from within C++, What it can do for you, A tour of GiNaC, A tour of GiNaC
171 @c    node-name, next, previous, up
172 @section How to use it from within C++
173
174 The GiNaC open framework for symbolic computation within the C++ programming
175 language does not try to define a language of its own as conventional
176 CAS do.  Instead, it extends the capabilities of C++ by symbolic
177 manipulations.  Here is how to generate and print a simple (and rather
178 pointless) bivariate polynomial with some large coefficients:
179
180 @example
181 #include <iostream>
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 <iostream>
217 #include <ginac/ginac.h>
218 using namespace std;
219 using namespace GiNaC;
220
221 ex HermitePoly(const symbol & x, int n)
222 @{
223     ex HKer=exp(-pow(x, 2));
224     // uses the identity H_n(x) == (-1)^n exp(x^2) (d/dx)^n exp(-x^2)
225     return normal(pow(-1, n) * diff(HKer, x, n) / HKer);
226 @}
227
228 int main()
229 @{
230     symbol z("z");
231
232     for (int i=0; i<6; ++i)
233         cout << "H_" << i << "(z) == " << HermitePoly(z,i) << endl;
234
235     return 0;
236 @}
237 @end example
238
239 When run, this will type out
240
241 @example
242 H_0(z) == 1
243 H_1(z) == 2*z
244 H_2(z) == 4*z^2-2
245 H_3(z) == -12*z+8*z^3
246 H_4(z) == -48*z^2+16*z^4+12
247 H_5(z) == 120*z-160*z^3+32*z^5
248 @end example
249
250 This method of generating the coefficients is of course far from optimal
251 for production purposes.
252
253 In order to show some more examples of what GiNaC can do we will now use
254 the @command{ginsh}, a simple GiNaC interactive shell that provides a
255 convenient window into GiNaC's capabilities.
256
257
258 @node What it can do for you, Installation, How to use it from within C++, A tour of GiNaC
259 @c    node-name, next, previous, up
260 @section What it can do for you
261
262 @cindex @command{ginsh}
263 After invoking @command{ginsh} one can test and experiment with GiNaC's
264 features much like in other Computer Algebra Systems except that it does
265 not provide programming constructs like loops or conditionals.  For a
266 concise description of the @command{ginsh} syntax we refer to its
267 accompanied man page. Suffice to say that assignments and comparisons in
268 @command{ginsh} are written as they are in C, i.e. @code{=} assigns and
269 @code{==} compares.
270
271 It can manipulate arbitrary precision integers in a very fast way.
272 Rational numbers are automatically converted to fractions of coprime
273 integers:
274
275 @example
276 > x=3^150;
277 369988485035126972924700782451696644186473100389722973815184405301748249
278 > y=3^149;
279 123329495011708990974900260817232214728824366796574324605061468433916083
280 > x/y;
281 3
282 > y/x;
283 1/3
284 @end example
285
286 Exact numbers are always retained as exact numbers and only evaluated as
287 floating point numbers if requested.  For instance, with numeric
288 radicals is dealt pretty much as with symbols.  Products of sums of them
289 can be expanded:
290
291 @example
292 > expand((1+a^(1/5)-a^(2/5))^3);
293 1+3*a+3*a^(1/5)-5*a^(3/5)-a^(6/5)
294 > expand((1+3^(1/5)-3^(2/5))^3);
295 10-5*3^(3/5)
296 > evalf((1+3^(1/5)-3^(2/5))^3);
297 0.33408977534118624228
298 @end example
299
300 The function @code{evalf} that was used above converts any number in
301 GiNaC's expressions into floating point numbers.  This can be done to
302 arbitrary predefined accuracy:
303
304 @example
305 > evalf(1/7);
306 0.14285714285714285714
307 > Digits=150;
308 150
309 > evalf(1/7);
310 0.1428571428571428571428571428571428571428571428571428571428571428571428
311 5714285714285714285714285714285714285
312 @end example
313
314 Exact numbers other than rationals that can be manipulated in GiNaC
315 include predefined constants like Archimedes' @code{Pi}.  They can both
316 be used in symbolic manipulations (as an exact number) as well as in
317 numeric expressions (as an inexact number):
318
319 @example
320 > a=Pi^2+x;
321 x+Pi^2
322 > evalf(a);
323 9.869604401089358619+x
324 > x=2;
325 2
326 > evalf(a);
327 11.869604401089358619
328 @end example
329
330 Built-in functions evaluate immediately to exact numbers if
331 this is possible.  Conversions that can be safely performed are done
332 immediately; conversions that are not generally valid are not done:
333
334 @example
335 > cos(42*Pi);
336 1
337 > cos(acos(x));
338 x
339 > acos(cos(x));
340 acos(cos(x))
341 @end example
342
343 (Note that converting the last input to @code{x} would allow one to
344 conclude that @code{42*Pi} is equal to @code{0}.)
345
346 Linear equation systems can be solved along with basic linear
347 algebra manipulations over symbolic expressions.  In C++ GiNaC offers
348 a matrix class for this purpose but we can see what it can do using
349 @command{ginsh}'s bracket notation to type them in:
350
351 @example
352 > lsolve(a+x*y==z,x);
353 y^(-1)*(z-a);
354 > lsolve(@{3*x+5*y == 7, -2*x+10*y == -5@}, @{x, y@});
355 @{x==19/8,y==-1/40@}
356 > M = [ [1, 3], [-3, 2] ];
357 [[1,3],[-3,2]]
358 > determinant(M);
359 11
360 > charpoly(M,lambda);
361 lambda^2-3*lambda+11
362 > A = [ [1, 1], [2, -1] ];
363 [[1,1],[2,-1]]
364 > A+2*M;
365 [[1,1],[2,-1]]+2*[[1,3],[-3,2]]
366 > evalm(%);
367 [[3,7],[-4,3]]
368 > B = [ [0, 0, a], [b, 1, -b], [-1/a, 0, 0] ];
369 > evalm(B^(2^12345));
370 [[1,0,0],[0,1,0],[0,0,1]]
371 @end example
372
373 Multivariate polynomials and rational functions may be expanded,
374 collected and normalized (i.e. converted to a ratio of two coprime 
375 polynomials):
376
377 @example
378 > a = x^4 + 2*x^2*y^2 + 4*x^3*y + 12*x*y^3 - 3*y^4;
379 12*x*y^3+2*x^2*y^2+4*x^3*y-3*y^4+x^4
380 > b = x^2 + 4*x*y - y^2;
381 4*x*y-y^2+x^2
382 > expand(a*b);
383 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
384 > collect(a+b,x);
385 4*x^3*y-y^2-3*y^4+(12*y^3+4*y)*x+x^4+x^2*(1+2*y^2)
386 > collect(a+b,y);
387 12*x*y^3-3*y^4+(-1+2*x^2)*y^2+(4*x+4*x^3)*y+x^2+x^4
388 > normal(a/b);
389 3*y^2+x^2
390 @end example
391
392 You can differentiate functions and expand them as Taylor or Laurent
393 series in a very natural syntax (the second argument of @code{series} is
394 a relation defining the evaluation point, the third specifies the
395 order):
396
397 @cindex Zeta function
398 @example
399 > diff(tan(x),x);
400 tan(x)^2+1
401 > series(sin(x),x==0,4);
402 x-1/6*x^3+Order(x^4)
403 > series(1/tan(x),x==0,4);
404 x^(-1)-1/3*x+Order(x^2)
405 > series(tgamma(x),x==0,3);
406 x^(-1)-Euler+(1/12*Pi^2+1/2*Euler^2)*x+
407 (-1/3*zeta(3)-1/12*Pi^2*Euler-1/6*Euler^3)*x^2+Order(x^3)
408 > evalf(%);
409 x^(-1)-0.5772156649015328606+(0.9890559953279725555)*x
410 -(0.90747907608088628905)*x^2+Order(x^3)
411 > series(tgamma(2*sin(x)-2),x==Pi/2,6);
412 -(x-1/2*Pi)^(-2)+(-1/12*Pi^2-1/2*Euler^2-1/240)*(x-1/2*Pi)^2
413 -Euler-1/12+Order((x-1/2*Pi)^3)
414 @end example
415
416 Here we have made use of the @command{ginsh}-command @code{%} to pop the
417 previously evaluated element from @command{ginsh}'s internal stack.
418
419 Often, functions don't have roots in closed form.  Nevertheless, it's
420 quite easy to compute a solution numerically, to arbitrary precision:
421
422 @cindex fsolve
423 @example
424 > Digits=50:
425 > fsolve(cos(x)==x,x,0,2);
426 0.7390851332151606416553120876738734040134117589007574649658
427 > f=exp(sin(x))-x:
428 > X=fsolve(f,x,-10,10);
429 2.2191071489137460325957851882042901681753665565320678854155
430 > subs(f,x==X);
431 -6.372367644529809108115521591070847222364418220770475144296E-58
432 @end example
433
434 Notice how the final result above differs slightly from zero by about
435 @math{6*10^(-58)}.  This is because with 50 decimal digits precision the
436 root cannot be represented more accurately than @code{X}.  Such
437 inaccuracies are to be expected when computing with finite floating
438 point values.
439
440 If you ever wanted to convert units in C or C++ and found this is
441 cumbersome, here is the solution.  Symbolic types can always be used as
442 tags for different types of objects.  Converting from wrong units to the
443 metric system is now easy:
444
445 @example
446 > in=.0254*m;
447 0.0254*m
448 > lb=.45359237*kg;
449 0.45359237*kg
450 > 200*lb/in^2;
451 140613.91592783185568*kg*m^(-2)
452 @end example
453
454
455 @node Installation, Prerequisites, What it can do for you, Top
456 @c    node-name, next, previous, up
457 @chapter Installation
458
459 @cindex CLN
460 GiNaC's installation follows the spirit of most GNU software. It is
461 easily installed on your system by three steps: configuration, build,
462 installation.
463
464 @menu
465 * Prerequisites::                Packages upon which GiNaC depends.
466 * Configuration::                How to configure GiNaC.
467 * Building GiNaC::               How to compile GiNaC.
468 * Installing GiNaC::             How to install GiNaC on your system.
469 @end menu
470
471
472 @node Prerequisites, Configuration, Installation, Installation
473 @c    node-name, next, previous, up
474 @section Prerequisites
475
476 In order to install GiNaC on your system, some prerequisites need to be
477 met.  First of all, you need to have a C++-compiler adhering to the
478 ANSI-standard @cite{ISO/IEC 14882:1998(E)}.  We used GCC for development
479 so if you have a different compiler you are on your own.  For the
480 configuration to succeed you need a Posix compliant shell installed in
481 @file{/bin/sh}, GNU @command{bash} is fine. The pkg-config utility is
482 required for the configuration, it can be downloaded from
483 @uref{http://pkg-config.freedesktop.org}.
484 Last but not least, the CLN library
485 is used extensively and needs to be installed on your system.
486 Please get it from @uref{ftp://ftpthep.physik.uni-mainz.de/pub/gnu/}
487 (it is covered by GPL) and install it prior to trying to install
488 GiNaC.  The configure script checks if it can find it and if it cannot
489 it will refuse to continue.
490
491
492 @node Configuration, Building GiNaC, Prerequisites, Installation
493 @c    node-name, next, previous, up
494 @section Configuration
495 @cindex configuration
496 @cindex Autoconf
497
498 To configure GiNaC means to prepare the source distribution for
499 building.  It is done via a shell script called @command{configure} that
500 is shipped with the sources and was originally generated by GNU
501 Autoconf.  Since a configure script generated by GNU Autoconf never
502 prompts, all customization must be done either via command line
503 parameters or environment variables.  It accepts a list of parameters,
504 the complete set of which can be listed by calling it with the
505 @option{--help} option.  The most important ones will be shortly
506 described in what follows:
507
508 @itemize @bullet
509
510 @item
511 @option{--disable-shared}: When given, this option switches off the
512 build of a shared library, i.e. a @file{.so} file.  This may be convenient
513 when developing because it considerably speeds up compilation.
514
515 @item
516 @option{--prefix=@var{PREFIX}}: The directory where the compiled library
517 and headers are installed. It defaults to @file{/usr/local} which means
518 that the library is installed in the directory @file{/usr/local/lib},
519 the header files in @file{/usr/local/include/ginac} and the documentation
520 (like this one) into @file{/usr/local/share/doc/GiNaC}.
521
522 @item
523 @option{--libdir=@var{LIBDIR}}: Use this option in case you want to have
524 the library installed in some other directory than
525 @file{@var{PREFIX}/lib/}.
526
527 @item
528 @option{--includedir=@var{INCLUDEDIR}}: Use this option in case you want
529 to have the header files installed in some other directory than
530 @file{@var{PREFIX}/include/ginac/}. For instance, if you specify
531 @option{--includedir=/usr/include} you will end up with the header files
532 sitting in the directory @file{/usr/include/ginac/}. Note that the
533 subdirectory @file{ginac} is enforced by this process in order to
534 keep the header files separated from others.  This avoids some
535 clashes and allows for an easier deinstallation of GiNaC. This ought
536 to be considered A Good Thing (tm).
537
538 @item
539 @option{--datadir=@var{DATADIR}}: This option may be given in case you
540 want to have the documentation installed in some other directory than
541 @file{@var{PREFIX}/share/doc/GiNaC/}.
542
543 @end itemize
544
545 In addition, you may specify some environment variables.  @env{CXX}
546 holds the path and the name of the C++ compiler in case you want to
547 override the default in your path.  (The @command{configure} script
548 searches your path for @command{c++}, @command{g++}, @command{gcc},
549 @command{CC}, @command{cxx} and @command{cc++} in that order.)  It may
550 be very useful to define some compiler flags with the @env{CXXFLAGS}
551 environment variable, like optimization, debugging information and
552 warning levels.  If omitted, it defaults to @option{-g
553 -O2}.@footnote{The @command{configure} script is itself generated from
554 the file @file{configure.ac}.  It is only distributed in packaged
555 releases of GiNaC.  If you got the naked sources, e.g. from CVS, you
556 must generate @command{configure} along with the various
557 @file{Makefile.in} by using the @command{autoreconf} utility.  This will
558 require a fair amount of support from your local toolchain, though.}
559
560 The whole process is illustrated in the following two
561 examples. (Substitute @command{setenv @var{VARIABLE} @var{value}} for
562 @command{export @var{VARIABLE}=@var{value}} if the Berkeley C shell is
563 your login shell.)
564
565 Here is a simple configuration for a site-wide GiNaC library assuming
566 everything is in default paths:
567
568 @example
569 $ export CXXFLAGS="-Wall -O2"
570 $ ./configure
571 @end example
572
573 And here is a configuration for a private static GiNaC library with
574 several components sitting in custom places (site-wide GCC and private
575 CLN).  The compiler is persuaded to be picky and full assertions and
576 debugging information are switched on:
577
578 @example
579 $ export CXX=/usr/local/gnu/bin/c++
580 $ export CPPFLAGS="$(CPPFLAGS) -I$(HOME)/include"
581 $ export CXXFLAGS="$(CXXFLAGS) -DDO_GINAC_ASSERT -ggdb -Wall -pedantic"
582 $ export LDFLAGS="$(LDFLAGS) -L$(HOME)/lib"
583 $ ./configure --disable-shared --prefix=$(HOME)
584 @end example
585
586
587 @node Building GiNaC, Installing GiNaC, Configuration, Installation
588 @c    node-name, next, previous, up
589 @section Building GiNaC
590 @cindex building GiNaC
591
592 After proper configuration you should just build the whole
593 library by typing
594 @example
595 $ make
596 @end example
597 at the command prompt and go for a cup of coffee.  The exact time it
598 takes to compile GiNaC depends not only on the speed of your machines
599 but also on other parameters, for instance what value for @env{CXXFLAGS}
600 you entered.  Optimization may be very time-consuming.
601
602 Just to make sure GiNaC works properly you may run a collection of
603 regression tests by typing
604
605 @example
606 $ make check
607 @end example
608
609 This will compile some sample programs, run them and check the output
610 for correctness.  The regression tests fall in three categories.  First,
611 the so called @emph{exams} are performed, simple tests where some
612 predefined input is evaluated (like a pupils' exam).  Second, the
613 @emph{checks} test the coherence of results among each other with
614 possible random input.  Third, some @emph{timings} are performed, which
615 benchmark some predefined problems with different sizes and display the
616 CPU time used in seconds.  Each individual test should return a message
617 @samp{passed}.  This is mostly intended to be a QA-check if something
618 was broken during development, not a sanity check of your system.  Some
619 of the tests in sections @emph{checks} and @emph{timings} may require
620 insane amounts of memory and CPU time.  Feel free to kill them if your
621 machine catches fire.  Another quite important intent is to allow people
622 to fiddle around with optimization.
623
624 By default, the only documentation that will be built is this tutorial
625 in @file{.info} format. To build the GiNaC tutorial and reference manual
626 in HTML, DVI, PostScript, or PDF formats, use one of
627
628 @example
629 $ make html
630 $ make dvi
631 $ make ps
632 $ make pdf
633 @end example
634
635 Generally, the top-level Makefile runs recursively to the
636 subdirectories.  It is therefore safe to go into any subdirectory
637 (@code{doc/}, @code{ginsh/}, @dots{}) and simply type @code{make}
638 @var{target} there in case something went wrong.
639
640
641 @node Installing GiNaC, Basic concepts, Building GiNaC, Installation
642 @c    node-name, next, previous, up
643 @section Installing GiNaC
644 @cindex installation
645
646 To install GiNaC on your system, simply type
647
648 @example
649 $ make install
650 @end example
651
652 As described in the section about configuration the files will be
653 installed in the following directories (the directories will be created
654 if they don't already exist):
655
656 @itemize @bullet
657
658 @item
659 @file{libginac.a} will go into @file{@var{PREFIX}/lib/} (or
660 @file{@var{LIBDIR}}) which defaults to @file{/usr/local/lib/}.
661 So will @file{libginac.so} unless the configure script was
662 given the option @option{--disable-shared}.  The proper symlinks
663 will be established as well.
664
665 @item
666 All the header files will be installed into @file{@var{PREFIX}/include/ginac/}
667 (or @file{@var{INCLUDEDIR}/ginac/}, if specified).
668
669 @item
670 All documentation (info) will be stuffed into
671 @file{@var{PREFIX}/share/doc/GiNaC/} (or
672 @file{@var{DATADIR}/doc/GiNaC/}, if @var{DATADIR} was specified).
673
674 @end itemize
675
676 For the sake of completeness we will list some other useful make
677 targets: @command{make clean} deletes all files generated by
678 @command{make}, i.e. all the object files.  In addition @command{make
679 distclean} removes all files generated by the configuration and
680 @command{make maintainer-clean} goes one step further and deletes files
681 that may require special tools to rebuild (like the @command{libtool}
682 for instance).  Finally @command{make uninstall} removes the installed
683 library, header files and documentation@footnote{Uninstallation does not
684 work after you have called @command{make distclean} since the
685 @file{Makefile} is itself generated by the configuration from
686 @file{Makefile.in} and hence deleted by @command{make distclean}.  There
687 are two obvious ways out of this dilemma.  First, you can run the
688 configuration again with the same @var{PREFIX} thus creating a
689 @file{Makefile} with a working @samp{uninstall} target.  Second, you can
690 do it by hand since you now know where all the files went during
691 installation.}.
692
693
694 @node Basic concepts, Expressions, Installing GiNaC, Top
695 @c    node-name, next, previous, up
696 @chapter Basic concepts
697
698 This chapter will describe the different fundamental objects that can be
699 handled by GiNaC.  But before doing so, it is worthwhile introducing you
700 to the more commonly used class of expressions, representing a flexible
701 meta-class for storing all mathematical objects.
702
703 @menu
704 * Expressions::                  The fundamental GiNaC class.
705 * Automatic evaluation::         Evaluation and canonicalization.
706 * Error handling::               How the library reports errors.
707 * The class hierarchy::          Overview of GiNaC's classes.
708 * Symbols::                      Symbolic objects.
709 * Numbers::                      Numerical objects.
710 * Constants::                    Pre-defined constants.
711 * Fundamental containers::       Sums, products and powers.
712 * Lists::                        Lists of expressions.
713 * Mathematical functions::       Mathematical functions.
714 * Relations::                    Equality, Inequality and all that.
715 * Integrals::                    Symbolic integrals.
716 * Matrices::                     Matrices.
717 * Indexed objects::              Handling indexed quantities.
718 * Non-commutative objects::      Algebras with non-commutative products.
719 * Hash maps::                    A faster alternative to std::map<>.
720 @end menu
721
722
723 @node Expressions, Automatic evaluation, Basic concepts, Basic concepts
724 @c    node-name, next, previous, up
725 @section Expressions
726 @cindex expression (class @code{ex})
727 @cindex @code{has()}
728
729 The most common class of objects a user deals with is the expression
730 @code{ex}, representing a mathematical object like a variable, number,
731 function, sum, product, etc@dots{}  Expressions may be put together to form
732 new expressions, passed as arguments to functions, and so on.  Here is a
733 little collection of valid expressions:
734
735 @example
736 ex MyEx1 = 5;                       // simple number
737 ex MyEx2 = x + 2*y;                 // polynomial in x and y
738 ex MyEx3 = (x + 1)/(x - 1);         // rational expression
739 ex MyEx4 = sin(x + 2*y) + 3*z + 41; // containing a function
740 ex MyEx5 = MyEx4 + 1;               // similar to above
741 @end example
742
743 Expressions are handles to other more fundamental objects, that often
744 contain other expressions thus creating a tree of expressions
745 (@xref{Internal structures}, for particular examples).  Most methods on
746 @code{ex} therefore run top-down through such an expression tree.  For
747 example, the method @code{has()} scans recursively for occurrences of
748 something inside an expression.  Thus, if you have declared @code{MyEx4}
749 as in the example above @code{MyEx4.has(y)} will find @code{y} inside
750 the argument of @code{sin} and hence return @code{true}.
751
752 The next sections will outline the general picture of GiNaC's class
753 hierarchy and describe the classes of objects that are handled by
754 @code{ex}.
755
756 @subsection Note: Expressions and STL containers
757
758 GiNaC expressions (@code{ex} objects) have value semantics (they can be
759 assigned, reassigned and copied like integral types) but the operator
760 @code{<} doesn't provide a well-defined ordering on them. In STL-speak,
761 expressions are @samp{Assignable} but not @samp{LessThanComparable}.
762
763 This implies that in order to use expressions in sorted containers such as
764 @code{std::map<>} and @code{std::set<>} you have to supply a suitable
765 comparison predicate. GiNaC provides such a predicate, called
766 @code{ex_is_less}. For example, a set of expressions should be defined
767 as @code{std::set<ex, ex_is_less>}.
768
769 Unsorted containers such as @code{std::vector<>} and @code{std::list<>}
770 don't pose a problem. A @code{std::vector<ex>} works as expected.
771
772 @xref{Information about expressions}, for more about comparing and ordering
773 expressions.
774
775
776 @node Automatic evaluation, Error handling, Expressions, Basic concepts
777 @c    node-name, next, previous, up
778 @section Automatic evaluation and canonicalization of expressions
779 @cindex evaluation
780
781 GiNaC performs some automatic transformations on expressions, to simplify
782 them and put them into a canonical form. Some examples:
783
784 @example
785 ex MyEx1 = 2*x - 1 + x;  // 3*x-1
786 ex MyEx2 = x - x;        // 0
787 ex MyEx3 = cos(2*Pi);    // 1
788 ex MyEx4 = x*y/x;        // y
789 @end example
790
791 This behavior is usually referred to as @dfn{automatic} or @dfn{anonymous
792 evaluation}. GiNaC only performs transformations that are
793
794 @itemize @bullet
795 @item
796 at most of complexity
797 @tex
798 $O(n\log n)$
799 @end tex
800 @ifnottex
801 @math{O(n log n)}
802 @end ifnottex
803 @item
804 algebraically correct, possibly except for a set of measure zero (e.g.
805 @math{x/x} is transformed to @math{1} although this is incorrect for @math{x=0})
806 @end itemize
807
808 There are two types of automatic transformations in GiNaC that may not
809 behave in an entirely obvious way at first glance:
810
811 @itemize
812 @item
813 The terms of sums and products (and some other things like the arguments of
814 symmetric functions, the indices of symmetric tensors etc.) are re-ordered
815 into a canonical form that is deterministic, but not lexicographical or in
816 any other way easy to guess (it almost always depends on the number and
817 order of the symbols you define). However, constructing the same expression
818 twice, either implicitly or explicitly, will always result in the same
819 canonical form.
820 @item
821 Expressions of the form 'number times sum' are automatically expanded (this
822 has to do with GiNaC's internal representation of sums and products). For
823 example
824 @example
825 ex MyEx5 = 2*(x + y);   // 2*x+2*y
826 ex MyEx6 = z*(x + y);   // z*(x+y)
827 @end example
828 @end itemize
829
830 The general rule is that when you construct expressions, GiNaC automatically
831 creates them in canonical form, which might differ from the form you typed in
832 your program. This may create some awkward looking output (@samp{-y+x} instead
833 of @samp{x-y}) but allows for more efficient operation and usually yields
834 some immediate simplifications.
835
836 @cindex @code{eval()}
837 Internally, the anonymous evaluator in GiNaC is implemented by the methods
838
839 @example
840 ex ex::eval(int level = 0) const;
841 ex basic::eval(int level = 0) const;
842 @end example
843
844 but unless you are extending GiNaC with your own classes or functions, there
845 should never be any reason to call them explicitly. All GiNaC methods that
846 transform expressions, like @code{subs()} or @code{normal()}, automatically
847 re-evaluate their results.
848
849
850 @node Error handling, The class hierarchy, Automatic evaluation, Basic concepts
851 @c    node-name, next, previous, up
852 @section Error handling
853 @cindex exceptions
854 @cindex @code{pole_error} (class)
855
856 GiNaC reports run-time errors by throwing C++ exceptions. All exceptions
857 generated by GiNaC are subclassed from the standard @code{exception} class
858 defined in the @file{<stdexcept>} header. In addition to the predefined
859 @code{logic_error}, @code{domain_error}, @code{out_of_range},
860 @code{invalid_argument}, @code{runtime_error}, @code{range_error} and
861 @code{overflow_error} types, GiNaC also defines a @code{pole_error}
862 exception that gets thrown when trying to evaluate a mathematical function
863 at a singularity.
864
865 The @code{pole_error} class has a member function
866
867 @example
868 int pole_error::degree() const;
869 @end example
870
871 that returns the order of the singularity (or 0 when the pole is
872 logarithmic or the order is undefined).
873
874 When using GiNaC it is useful to arrange for exceptions to be caught in
875 the main program even if you don't want to do any special error handling.
876 Otherwise whenever an error occurs in GiNaC, it will be delegated to the
877 default exception handler of your C++ compiler's run-time system which
878 usually only aborts the program without giving any information what went
879 wrong.
880
881 Here is an example for a @code{main()} function that catches and prints
882 exceptions generated by GiNaC:
883
884 @example
885 #include <iostream>
886 #include <stdexcept>
887 #include <ginac/ginac.h>
888 using namespace std;
889 using namespace GiNaC;
890
891 int main()
892 @{
893     try @{
894         ...
895         // code using GiNaC
896         ...
897     @} catch (exception &p) @{
898         cerr << p.what() << endl;
899         return 1;
900     @}
901     return 0;
902 @}
903 @end example
904
905
906 @node The class hierarchy, Symbols, Error handling, Basic concepts
907 @c    node-name, next, previous, up
908 @section The class hierarchy
909
910 GiNaC's class hierarchy consists of several classes representing
911 mathematical objects, all of which (except for @code{ex} and some
912 helpers) are internally derived from one abstract base class called
913 @code{basic}.  You do not have to deal with objects of class
914 @code{basic}, instead you'll be dealing with symbols, numbers,
915 containers of expressions and so on.
916
917 @cindex container
918 @cindex atom
919 To get an idea about what kinds of symbolic composites may be built we
920 have a look at the most important classes in the class hierarchy and
921 some of the relations among the classes:
922
923 @image{classhierarchy}
924
925 The abstract classes shown here (the ones without drop-shadow) are of no
926 interest for the user.  They are used internally in order to avoid code
927 duplication if two or more classes derived from them share certain
928 features.  An example is @code{expairseq}, a container for a sequence of
929 pairs each consisting of one expression and a number (@code{numeric}).
930 What @emph{is} visible to the user are the derived classes @code{add}
931 and @code{mul}, representing sums and products.  @xref{Internal
932 structures}, where these two classes are described in more detail.  The
933 following table shortly summarizes what kinds of mathematical objects
934 are stored in the different classes:
935
936 @cartouche
937 @multitable @columnfractions .22 .78
938 @item @code{symbol} @tab Algebraic symbols @math{a}, @math{x}, @math{y}@dots{}
939 @item @code{constant} @tab Constants like 
940 @tex
941 $\pi$
942 @end tex
943 @ifnottex
944 @math{Pi}
945 @end ifnottex
946 @item @code{numeric} @tab All kinds of numbers, @math{42}, @math{7/3*I}, @math{3.14159}@dots{}
947 @item @code{add} @tab Sums like @math{x+y} or @math{a-(2*b)+3}
948 @item @code{mul} @tab Products like @math{x*y} or @math{2*a^2*(x+y+z)/b}
949 @item @code{ncmul} @tab Products of non-commutative objects
950 @item @code{power} @tab Exponentials such as @math{x^2}, @math{a^b}, 
951 @tex
952 $\sqrt{2}$
953 @end tex
954 @ifnottex
955 @code{sqrt(}@math{2}@code{)}
956 @end ifnottex
957 @dots{}
958 @item @code{pseries} @tab Power Series, e.g. @math{x-1/6*x^3+1/120*x^5+O(x^7)}
959 @item @code{function} @tab A symbolic function like
960 @tex
961 $\sin 2x$
962 @end tex
963 @ifnottex
964 @math{sin(2*x)}
965 @end ifnottex
966 @item @code{lst} @tab Lists of expressions @{@math{x}, @math{2*y}, @math{3+z}@}
967 @item @code{matrix} @tab @math{m}x@math{n} matrices of expressions
968 @item @code{relational} @tab A relation like the identity @math{x}@code{==}@math{y}
969 @item @code{indexed} @tab Indexed object like @math{A_ij}
970 @item @code{tensor} @tab Special tensor like the delta and metric tensors
971 @item @code{idx} @tab Index of an indexed object
972 @item @code{varidx} @tab Index with variance
973 @item @code{spinidx} @tab Index with variance and dot (used in Weyl-van-der-Waerden spinor formalism)
974 @item @code{wildcard} @tab Wildcard for pattern matching
975 @item @code{structure} @tab Template for user-defined classes
976 @end multitable
977 @end cartouche
978
979
980 @node Symbols, Numbers, The class hierarchy, Basic concepts
981 @c    node-name, next, previous, up
982 @section Symbols
983 @cindex @code{symbol} (class)
984 @cindex hierarchy of classes
985
986 @cindex atom
987 Symbolic indeterminates, or @dfn{symbols} for short, are for symbolic
988 manipulation what atoms are for chemistry.
989
990 A typical symbol definition looks like this:
991 @example
992 symbol x("x");
993 @end example
994
995 This definition actually contains three very different things:
996 @itemize
997 @item a C++ variable named @code{x}
998 @item a @code{symbol} object stored in this C++ variable; this object
999   represents the symbol in a GiNaC expression
1000 @item the string @code{"x"} which is the name of the symbol, used (almost)
1001   exclusively for printing expressions holding the symbol
1002 @end itemize
1003
1004 Symbols have an explicit name, supplied as a string during construction,
1005 because in C++, variable names can't be used as values, and the C++ compiler
1006 throws them away during compilation.
1007
1008 It is possible to omit the symbol name in the definition:
1009 @example
1010 symbol x;
1011 @end example
1012
1013 In this case, GiNaC will assign the symbol an internal, unique name of the
1014 form @code{symbolNNN}. This won't affect the usability of the symbol but
1015 the output of your calculations will become more readable if you give your
1016 symbols sensible names (for intermediate expressions that are only used
1017 internally such anonymous symbols can be quite useful, however).
1018
1019 Now, here is one important property of GiNaC that differentiates it from
1020 other computer algebra programs you may have used: GiNaC does @emph{not} use
1021 the names of symbols to tell them apart, but a (hidden) serial number that
1022 is unique for each newly created @code{symbol} object. If you want to use
1023 one and the same symbol in different places in your program, you must only
1024 create one @code{symbol} object and pass that around. If you create another
1025 symbol, even if it has the same name, GiNaC will treat it as a different
1026 indeterminate.
1027
1028 Observe:
1029 @example
1030 ex f(int n)
1031 @{
1032     symbol x("x");
1033     return pow(x, n);
1034 @}
1035
1036 int main()
1037 @{
1038     symbol x("x");
1039     ex e = f(6);
1040
1041     cout << e << endl;
1042      // prints "x^6" which looks right, but...
1043
1044     cout << e.degree(x) << endl;
1045      // ...this doesn't work. The symbol "x" here is different from the one
1046      // in f() and in the expression returned by f(). Consequently, it
1047      // prints "0".
1048 @}
1049 @end example
1050
1051 One possibility to ensure that @code{f()} and @code{main()} use the same
1052 symbol is to pass the symbol as an argument to @code{f()}:
1053 @example
1054 ex f(int n, const ex & x)
1055 @{
1056     return pow(x, n);
1057 @}
1058
1059 int main()
1060 @{
1061     symbol x("x");
1062
1063     // Now, f() uses the same symbol.
1064     ex e = f(6, x);
1065
1066     cout << e.degree(x) << endl;
1067      // prints "6", as expected
1068 @}
1069 @end example
1070
1071 Another possibility would be to define a global symbol @code{x} that is used
1072 by both @code{f()} and @code{main()}. If you are using global symbols and
1073 multiple compilation units you must take special care, however. Suppose
1074 that you have a header file @file{globals.h} in your program that defines
1075 a @code{symbol x("x");}. In this case, every unit that includes
1076 @file{globals.h} would also get its own definition of @code{x} (because
1077 header files are just inlined into the source code by the C++ preprocessor),
1078 and hence you would again end up with multiple equally-named, but different,
1079 symbols. Instead, the @file{globals.h} header should only contain a
1080 @emph{declaration} like @code{extern symbol x;}, with the definition of
1081 @code{x} moved into a C++ source file such as @file{globals.cpp}.
1082
1083 A different approach to ensuring that symbols used in different parts of
1084 your program are identical is to create them with a @emph{factory} function
1085 like this one:
1086 @example
1087 const symbol & get_symbol(const string & s)
1088 @{
1089     static map<string, symbol> directory;
1090     map<string, symbol>::iterator i = directory.find(s);
1091     if (i != directory.end())
1092         return i->second;
1093     else
1094         return directory.insert(make_pair(s, symbol(s))).first->second;
1095 @}
1096 @end example
1097
1098 This function returns one newly constructed symbol for each name that is
1099 passed in, and it returns the same symbol when called multiple times with
1100 the same name. Using this symbol factory, we can rewrite our example like
1101 this:
1102 @example
1103 ex f(int n)
1104 @{
1105     return pow(get_symbol("x"), n);
1106 @}
1107
1108 int main()
1109 @{
1110     ex e = f(6);
1111
1112     // Both calls of get_symbol("x") yield the same symbol.
1113     cout << e.degree(get_symbol("x")) << endl;
1114      // prints "6"
1115 @}
1116 @end example
1117
1118 Instead of creating symbols from strings we could also have
1119 @code{get_symbol()} take, for example, an integer number as its argument.
1120 In this case, we would probably want to give the generated symbols names
1121 that include this number, which can be accomplished with the help of an
1122 @code{ostringstream}.
1123
1124 In general, if you're getting weird results from GiNaC such as an expression
1125 @samp{x-x} that is not simplified to zero, you should check your symbol
1126 definitions.
1127
1128 As we said, the names of symbols primarily serve for purposes of expression
1129 output. But there are actually two instances where GiNaC uses the names for
1130 identifying symbols: When constructing an expression from a string, and when
1131 recreating an expression from an archive (@pxref{Input/output}).
1132
1133 In addition to its name, a symbol may contain a special string that is used
1134 in LaTeX output:
1135 @example
1136 symbol x("x", "\\Box");
1137 @end example
1138
1139 This creates a symbol that is printed as "@code{x}" in normal output, but
1140 as "@code{\Box}" in LaTeX code (@xref{Input/output}, for more
1141 information about the different output formats of expressions in GiNaC).
1142 GiNaC automatically creates proper LaTeX code for symbols having names of
1143 greek letters (@samp{alpha}, @samp{mu}, etc.).
1144
1145 @cindex @code{subs()}
1146 Symbols in GiNaC can't be assigned values. If you need to store results of
1147 calculations and give them a name, use C++ variables of type @code{ex}.
1148 If you want to replace a symbol in an expression with something else, you
1149 can invoke the expression's @code{.subs()} method
1150 (@pxref{Substituting expressions}).
1151
1152 @cindex @code{realsymbol()}
1153 By default, symbols are expected to stand in for complex values, i.e. they live
1154 in the complex domain.  As a consequence, operations like complex conjugation,
1155 for example (@pxref{Complex expressions}), do @emph{not} evaluate if applied
1156 to such symbols. Likewise @code{log(exp(x))} does not evaluate to @code{x},
1157 because of the unknown imaginary part of @code{x}.
1158 On the other hand, if you are sure that your symbols will hold only real
1159 values, you would like to have such functions evaluated. Therefore GiNaC
1160 allows you to specify
1161 the domain of the symbol. Instead of @code{symbol x("x");} you can write
1162 @code{realsymbol x("x");} to tell GiNaC that @code{x} stands in for real values.
1163
1164 @cindex @code{possymbol()}
1165 Furthermore, it is also possible to declare a symbol as positive. This will,
1166 for instance, enable the automatic simplification of @code{abs(x)} into 
1167 @code{x}. This is done by declaring the symbol as @code{possymbol x("x");}.
1168
1169
1170 @node Numbers, Constants, Symbols, Basic concepts
1171 @c    node-name, next, previous, up
1172 @section Numbers
1173 @cindex @code{numeric} (class)
1174
1175 @cindex GMP
1176 @cindex CLN
1177 @cindex rational
1178 @cindex fraction
1179 For storing numerical things, GiNaC uses Bruno Haible's library CLN.
1180 The classes therein serve as foundation classes for GiNaC.  CLN stands
1181 for Class Library for Numbers or alternatively for Common Lisp Numbers.
1182 In order to find out more about CLN's internals, the reader is referred to
1183 the documentation of that library.  @inforef{Introduction, , cln}, for
1184 more information. Suffice to say that it is by itself build on top of
1185 another library, the GNU Multiple Precision library GMP, which is an
1186 extremely fast library for arbitrary long integers and rationals as well
1187 as arbitrary precision floating point numbers.  It is very commonly used
1188 by several popular cryptographic applications.  CLN extends GMP by
1189 several useful things: First, it introduces the complex number field
1190 over either reals (i.e. floating point numbers with arbitrary precision)
1191 or rationals.  Second, it automatically converts rationals to integers
1192 if the denominator is unity and complex numbers to real numbers if the
1193 imaginary part vanishes and also correctly treats algebraic functions.
1194 Third it provides good implementations of state-of-the-art algorithms
1195 for all trigonometric and hyperbolic functions as well as for
1196 calculation of some useful constants.
1197
1198 The user can construct an object of class @code{numeric} in several
1199 ways.  The following example shows the four most important constructors.
1200 It uses construction from C-integer, construction of fractions from two
1201 integers, construction from C-float and construction from a string:
1202
1203 @example
1204 #include <iostream>
1205 #include <ginac/ginac.h>
1206 using namespace GiNaC;
1207
1208 int main()
1209 @{
1210     numeric two = 2;                      // exact integer 2
1211     numeric r(2,3);                       // exact fraction 2/3
1212     numeric e(2.71828);                   // floating point number
1213     numeric p = "3.14159265358979323846"; // constructor from string
1214     // Trott's constant in scientific notation:
1215     numeric trott("1.0841015122311136151E-2");
1216     
1217     std::cout << two*p << std::endl;  // floating point 6.283...
1218     ...
1219 @end example
1220
1221 @cindex @code{I}
1222 @cindex complex numbers
1223 The imaginary unit in GiNaC is a predefined @code{numeric} object with the
1224 name @code{I}:
1225
1226 @example
1227     ...
1228     numeric z1 = 2-3*I;                    // exact complex number 2-3i
1229     numeric z2 = 5.9+1.6*I;                // complex floating point number
1230 @}
1231 @end example
1232
1233 It may be tempting to construct fractions by writing @code{numeric r(3/2)}.
1234 This would, however, call C's built-in operator @code{/} for integers
1235 first and result in a numeric holding a plain integer 1.  @strong{Never
1236 use the operator @code{/} on integers} unless you know exactly what you
1237 are doing!  Use the constructor from two integers instead, as shown in
1238 the example above.  Writing @code{numeric(1)/2} may look funny but works
1239 also.
1240
1241 @cindex @code{Digits}
1242 @cindex accuracy
1243 We have seen now the distinction between exact numbers and floating
1244 point numbers.  Clearly, the user should never have to worry about
1245 dynamically created exact numbers, since their `exactness' always
1246 determines how they ought to be handled, i.e. how `long' they are.  The
1247 situation is different for floating point numbers.  Their accuracy is
1248 controlled by one @emph{global} variable, called @code{Digits}.  (For
1249 those readers who know about Maple: it behaves very much like Maple's
1250 @code{Digits}).  All objects of class numeric that are constructed from
1251 then on will be stored with a precision matching that number of decimal
1252 digits:
1253
1254 @example
1255 #include <iostream>
1256 #include <ginac/ginac.h>
1257 using namespace std;
1258 using namespace GiNaC;
1259
1260 void foo()
1261 @{
1262     numeric three(3.0), one(1.0);
1263     numeric x = one/three;
1264
1265     cout << "in " << Digits << " digits:" << endl;
1266     cout << x << endl;
1267     cout << Pi.evalf() << endl;
1268 @}
1269
1270 int main()
1271 @{
1272     foo();
1273     Digits = 60;
1274     foo();
1275     return 0;
1276 @}
1277 @end example
1278
1279 The above example prints the following output to screen:
1280
1281 @example
1282 in 17 digits:
1283 0.33333333333333333334
1284 3.1415926535897932385
1285 in 60 digits:
1286 0.33333333333333333333333333333333333333333333333333333333333333333334
1287 3.1415926535897932384626433832795028841971693993751058209749445923078
1288 @end example
1289
1290 @cindex rounding
1291 Note that the last number is not necessarily rounded as you would
1292 naively expect it to be rounded in the decimal system.  But note also,
1293 that in both cases you got a couple of extra digits.  This is because
1294 numbers are internally stored by CLN as chunks of binary digits in order
1295 to match your machine's word size and to not waste precision.  Thus, on
1296 architectures with different word size, the above output might even
1297 differ with regard to actually computed digits.
1298
1299 It should be clear that objects of class @code{numeric} should be used
1300 for constructing numbers or for doing arithmetic with them.  The objects
1301 one deals with most of the time are the polymorphic expressions @code{ex}.
1302
1303 @subsection Tests on numbers
1304
1305 Once you have declared some numbers, assigned them to expressions and
1306 done some arithmetic with them it is frequently desired to retrieve some
1307 kind of information from them like asking whether that number is
1308 integer, rational, real or complex.  For those cases GiNaC provides
1309 several useful methods.  (Internally, they fall back to invocations of
1310 certain CLN functions.)
1311
1312 As an example, let's construct some rational number, multiply it with
1313 some multiple of its denominator and test what comes out:
1314
1315 @example
1316 #include <iostream>
1317 #include <ginac/ginac.h>
1318 using namespace std;
1319 using namespace GiNaC;
1320
1321 // some very important constants:
1322 const numeric twentyone(21);
1323 const numeric ten(10);
1324 const numeric five(5);
1325
1326 int main()
1327 @{
1328     numeric answer = twentyone;
1329
1330     answer /= five;
1331     cout << answer.is_integer() << endl;  // false, it's 21/5
1332     answer *= ten;
1333     cout << answer.is_integer() << endl;  // true, it's 42 now!
1334 @}
1335 @end example
1336
1337 Note that the variable @code{answer} is constructed here as an integer
1338 by @code{numeric}'s copy constructor, but in an intermediate step it
1339 holds a rational number represented as integer numerator and integer
1340 denominator.  When multiplied by 10, the denominator becomes unity and
1341 the result is automatically converted to a pure integer again.
1342 Internally, the underlying CLN is responsible for this behavior and we
1343 refer the reader to CLN's documentation.  Suffice to say that
1344 the same behavior applies to complex numbers as well as return values of
1345 certain functions.  Complex numbers are automatically converted to real
1346 numbers if the imaginary part becomes zero.  The full set of tests that
1347 can be applied is listed in the following table.
1348
1349 @cartouche
1350 @multitable @columnfractions .30 .70
1351 @item @strong{Method} @tab @strong{Returns true if the object is@dots{}}
1352 @item @code{.is_zero()}
1353 @tab @dots{}equal to zero
1354 @item @code{.is_positive()}
1355 @tab @dots{}not complex and greater than 0
1356 @item @code{.is_negative()}
1357 @tab @dots{}not complex and smaller than 0
1358 @item @code{.is_integer()}
1359 @tab @dots{}a (non-complex) integer
1360 @item @code{.is_pos_integer()}
1361 @tab @dots{}an integer and greater than 0
1362 @item @code{.is_nonneg_integer()}
1363 @tab @dots{}an integer and greater equal 0
1364 @item @code{.is_even()}
1365 @tab @dots{}an even integer
1366 @item @code{.is_odd()}
1367 @tab @dots{}an odd integer
1368 @item @code{.is_prime()}
1369 @tab @dots{}a prime integer (probabilistic primality test)
1370 @item @code{.is_rational()}
1371 @tab @dots{}an exact rational number (integers are rational, too)
1372 @item @code{.is_real()}
1373 @tab @dots{}a real integer, rational or float (i.e. is not complex)
1374 @item @code{.is_cinteger()}
1375 @tab @dots{}a (complex) integer (such as @math{2-3*I})
1376 @item @code{.is_crational()}
1377 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
1378 @end multitable
1379 @end cartouche
1380
1381 @page
1382
1383 @subsection Numeric functions
1384
1385 The following functions can be applied to @code{numeric} objects and will be
1386 evaluated immediately:
1387
1388 @cartouche
1389 @multitable @columnfractions .30 .70
1390 @item @strong{Name} @tab @strong{Function}
1391 @item @code{inverse(z)}
1392 @tab returns @math{1/z}
1393 @cindex @code{inverse()} (numeric)
1394 @item @code{pow(a, b)}
1395 @tab exponentiation @math{a^b}
1396 @item @code{abs(z)}
1397 @tab absolute value
1398 @item @code{real(z)}
1399 @tab real part
1400 @cindex @code{real()}
1401 @item @code{imag(z)}
1402 @tab imaginary part
1403 @cindex @code{imag()}
1404 @item @code{csgn(z)}
1405 @tab complex sign (returns an @code{int})
1406 @item @code{step(x)}
1407 @tab step function (returns an @code{numeric})
1408 @item @code{numer(z)}
1409 @tab numerator of rational or complex rational number
1410 @item @code{denom(z)}
1411 @tab denominator of rational or complex rational number
1412 @item @code{sqrt(z)}
1413 @tab square root
1414 @item @code{isqrt(n)}
1415 @tab integer square root
1416 @cindex @code{isqrt()}
1417 @item @code{sin(z)}
1418 @tab sine
1419 @item @code{cos(z)}
1420 @tab cosine
1421 @item @code{tan(z)}
1422 @tab tangent
1423 @item @code{asin(z)}
1424 @tab inverse sine
1425 @item @code{acos(z)}
1426 @tab inverse cosine
1427 @item @code{atan(z)}
1428 @tab inverse tangent
1429 @item @code{atan(y, x)}
1430 @tab inverse tangent with two arguments
1431 @item @code{sinh(z)}
1432 @tab hyperbolic sine
1433 @item @code{cosh(z)}
1434 @tab hyperbolic cosine
1435 @item @code{tanh(z)}
1436 @tab hyperbolic tangent
1437 @item @code{asinh(z)}
1438 @tab inverse hyperbolic sine
1439 @item @code{acosh(z)}
1440 @tab inverse hyperbolic cosine
1441 @item @code{atanh(z)}
1442 @tab inverse hyperbolic tangent
1443 @item @code{exp(z)}
1444 @tab exponential function
1445 @item @code{log(z)}
1446 @tab natural logarithm
1447 @item @code{Li2(z)}
1448 @tab dilogarithm
1449 @item @code{zeta(z)}
1450 @tab Riemann's zeta function
1451 @item @code{tgamma(z)}
1452 @tab gamma function
1453 @item @code{lgamma(z)}
1454 @tab logarithm of gamma function
1455 @item @code{psi(z)}
1456 @tab psi (digamma) function
1457 @item @code{psi(n, z)}
1458 @tab derivatives of psi function (polygamma functions)
1459 @item @code{factorial(n)}
1460 @tab factorial function @math{n!}
1461 @item @code{doublefactorial(n)}
1462 @tab double factorial function @math{n!!}
1463 @cindex @code{doublefactorial()}
1464 @item @code{binomial(n, k)}
1465 @tab binomial coefficients
1466 @item @code{bernoulli(n)}
1467 @tab Bernoulli numbers
1468 @cindex @code{bernoulli()}
1469 @item @code{fibonacci(n)}
1470 @tab Fibonacci numbers
1471 @cindex @code{fibonacci()}
1472 @item @code{mod(a, b)}
1473 @tab modulus in positive representation (in the range @code{[0, abs(b)-1]} with the sign of b, or zero)
1474 @cindex @code{mod()}
1475 @item @code{smod(a, b)}
1476 @tab modulus in symmetric representation (in the range @code{[-iquo(abs(b)-1, 2), iquo(abs(b), 2)]})
1477 @cindex @code{smod()}
1478 @item @code{irem(a, b)}
1479 @tab integer remainder (has the sign of @math{a}, or is zero)
1480 @cindex @code{irem()}
1481 @item @code{irem(a, b, q)}
1482 @tab integer remainder and quotient, @code{irem(a, b, q) == a-q*b}
1483 @item @code{iquo(a, b)}
1484 @tab integer quotient
1485 @cindex @code{iquo()}
1486 @item @code{iquo(a, b, r)}
1487 @tab integer quotient and remainder, @code{r == a-iquo(a, b)*b}
1488 @item @code{gcd(a, b)}
1489 @tab greatest common divisor
1490 @item @code{lcm(a, b)}
1491 @tab least common multiple
1492 @end multitable
1493 @end cartouche
1494
1495 Most of these functions are also available as symbolic functions that can be
1496 used in expressions (@pxref{Mathematical functions}) or, like @code{gcd()},
1497 as polynomial algorithms.
1498
1499 @subsection Converting numbers
1500
1501 Sometimes it is desirable to convert a @code{numeric} object back to a
1502 built-in arithmetic type (@code{int}, @code{double}, etc.). The @code{numeric}
1503 class provides a couple of methods for this purpose:
1504
1505 @cindex @code{to_int()}
1506 @cindex @code{to_long()}
1507 @cindex @code{to_double()}
1508 @cindex @code{to_cl_N()}
1509 @example
1510 int numeric::to_int() const;
1511 long numeric::to_long() const;
1512 double numeric::to_double() const;
1513 cln::cl_N numeric::to_cl_N() const;
1514 @end example
1515
1516 @code{to_int()} and @code{to_long()} only work when the number they are
1517 applied on is an exact integer. Otherwise the program will halt with a
1518 message like @samp{Not a 32-bit integer}. @code{to_double()} applied on a
1519 rational number will return a floating-point approximation. Both
1520 @code{to_int()/to_long()} and @code{to_double()} discard the imaginary
1521 part of complex numbers.
1522
1523
1524 @node Constants, Fundamental containers, Numbers, Basic concepts
1525 @c    node-name, next, previous, up
1526 @section Constants
1527 @cindex @code{constant} (class)
1528
1529 @cindex @code{Pi}
1530 @cindex @code{Catalan}
1531 @cindex @code{Euler}
1532 @cindex @code{evalf()}
1533 Constants behave pretty much like symbols except that they return some
1534 specific number when the method @code{.evalf()} is called.
1535
1536 The predefined known constants are:
1537
1538 @cartouche
1539 @multitable @columnfractions .14 .32 .54
1540 @item @strong{Name} @tab @strong{Common Name} @tab @strong{Numerical Value (to 35 digits)}
1541 @item @code{Pi}
1542 @tab Archimedes' constant
1543 @tab 3.14159265358979323846264338327950288
1544 @item @code{Catalan}
1545 @tab Catalan's constant
1546 @tab 0.91596559417721901505460351493238411
1547 @item @code{Euler}
1548 @tab Euler's (or Euler-Mascheroni) constant
1549 @tab 0.57721566490153286060651209008240243
1550 @end multitable
1551 @end cartouche
1552
1553
1554 @node Fundamental containers, Lists, Constants, Basic concepts
1555 @c    node-name, next, previous, up
1556 @section Sums, products and powers
1557 @cindex polynomial
1558 @cindex @code{add}
1559 @cindex @code{mul}
1560 @cindex @code{power}
1561
1562 Simple rational expressions are written down in GiNaC pretty much like
1563 in other CAS or like expressions involving numerical variables in C.
1564 The necessary operators @code{+}, @code{-}, @code{*} and @code{/} have
1565 been overloaded to achieve this goal.  When you run the following
1566 code snippet, the constructor for an object of type @code{mul} is
1567 automatically called to hold the product of @code{a} and @code{b} and
1568 then the constructor for an object of type @code{add} is called to hold
1569 the sum of that @code{mul} object and the number one:
1570
1571 @example
1572     ...
1573     symbol a("a"), b("b");
1574     ex MyTerm = 1+a*b;
1575     ...
1576 @end example
1577
1578 @cindex @code{pow()}
1579 For exponentiation, you have already seen the somewhat clumsy (though C-ish)
1580 statement @code{pow(x,2);} to represent @code{x} squared.  This direct
1581 construction is necessary since we cannot safely overload the constructor
1582 @code{^} in C++ to construct a @code{power} object.  If we did, it would
1583 have several counterintuitive and undesired effects:
1584
1585 @itemize @bullet
1586 @item
1587 Due to C's operator precedence, @code{2*x^2} would be parsed as @code{(2*x)^2}.
1588 @item
1589 Due to the binding of the operator @code{^}, @code{x^a^b} would result in
1590 @code{(x^a)^b}. This would be confusing since most (though not all) other CAS
1591 interpret this as @code{x^(a^b)}.
1592 @item
1593 Also, expressions involving integer exponents are very frequently used,
1594 which makes it even more dangerous to overload @code{^} since it is then
1595 hard to distinguish between the semantics as exponentiation and the one
1596 for exclusive or.  (It would be embarrassing to return @code{1} where one
1597 has requested @code{2^3}.)
1598 @end itemize
1599
1600 @cindex @command{ginsh}
1601 All effects are contrary to mathematical notation and differ from the
1602 way most other CAS handle exponentiation, therefore overloading @code{^}
1603 is ruled out for GiNaC's C++ part.  The situation is different in
1604 @command{ginsh}, there the exponentiation-@code{^} exists.  (Also note
1605 that the other frequently used exponentiation operator @code{**} does
1606 not exist at all in C++).
1607
1608 To be somewhat more precise, objects of the three classes described
1609 here, are all containers for other expressions.  An object of class
1610 @code{power} is best viewed as a container with two slots, one for the
1611 basis, one for the exponent.  All valid GiNaC expressions can be
1612 inserted.  However, basic transformations like simplifying
1613 @code{pow(pow(x,2),3)} to @code{x^6} automatically are only performed
1614 when this is mathematically possible.  If we replace the outer exponent
1615 three in the example by some symbols @code{a}, the simplification is not
1616 safe and will not be performed, since @code{a} might be @code{1/2} and
1617 @code{x} negative.
1618
1619 Objects of type @code{add} and @code{mul} are containers with an
1620 arbitrary number of slots for expressions to be inserted.  Again, simple
1621 and safe simplifications are carried out like transforming
1622 @code{3*x+4-x} to @code{2*x+4}.
1623
1624
1625 @node Lists, Mathematical functions, Fundamental containers, Basic concepts
1626 @c    node-name, next, previous, up
1627 @section Lists of expressions
1628 @cindex @code{lst} (class)
1629 @cindex lists
1630 @cindex @code{nops()}
1631 @cindex @code{op()}
1632 @cindex @code{append()}
1633 @cindex @code{prepend()}
1634 @cindex @code{remove_first()}
1635 @cindex @code{remove_last()}
1636 @cindex @code{remove_all()}
1637
1638 The GiNaC class @code{lst} serves for holding a @dfn{list} of arbitrary
1639 expressions. They are not as ubiquitous as in many other computer algebra
1640 packages, but are sometimes used to supply a variable number of arguments of
1641 the same type to GiNaC methods such as @code{subs()} and some @code{matrix}
1642 constructors, so you should have a basic understanding of them.
1643
1644 Lists can be constructed by assigning a comma-separated sequence of
1645 expressions:
1646
1647 @example
1648 @{
1649     symbol x("x"), y("y");
1650     lst l;
1651     l = x, 2, y, x+y;
1652     // now, l is a list holding the expressions 'x', '2', 'y', and 'x+y',
1653     // in that order
1654     ...
1655 @end example
1656
1657 There are also constructors that allow direct creation of lists of up to
1658 16 expressions, which is often more convenient but slightly less efficient:
1659
1660 @example
1661     ...
1662     // This produces the same list 'l' as above:
1663     // lst l(x, 2, y, x+y);
1664     // lst l = lst(x, 2, y, x+y);
1665     ...
1666 @end example
1667
1668 Use the @code{nops()} method to determine the size (number of expressions) of
1669 a list and the @code{op()} method or the @code{[]} operator to access
1670 individual elements:
1671
1672 @example
1673     ...
1674     cout << l.nops() << endl;                // prints '4'
1675     cout << l.op(2) << " " << l[0] << endl;  // prints 'y x'
1676     ...
1677 @end example
1678
1679 As with the standard @code{list<T>} container, accessing random elements of a
1680 @code{lst} is generally an operation of order @math{O(N)}. Faster read-only
1681 sequential access to the elements of a list is possible with the
1682 iterator types provided by the @code{lst} class:
1683
1684 @example
1685 typedef ... lst::const_iterator;
1686 typedef ... lst::const_reverse_iterator;
1687 lst::const_iterator lst::begin() const;
1688 lst::const_iterator lst::end() const;
1689 lst::const_reverse_iterator lst::rbegin() const;
1690 lst::const_reverse_iterator lst::rend() const;
1691 @end example
1692
1693 For example, to print the elements of a list individually you can use:
1694
1695 @example
1696     ...
1697     // O(N)
1698     for (lst::const_iterator i = l.begin(); i != l.end(); ++i)
1699         cout << *i << endl;
1700     ...
1701 @end example
1702
1703 which is one order faster than
1704
1705 @example
1706     ...
1707     // O(N^2)
1708     for (size_t i = 0; i < l.nops(); ++i)
1709         cout << l.op(i) << endl;
1710     ...
1711 @end example
1712
1713 These iterators also allow you to use some of the algorithms provided by
1714 the C++ standard library:
1715
1716 @example
1717     ...
1718     // print the elements of the list (requires #include <iterator>)
1719     std::copy(l.begin(), l.end(), ostream_iterator<ex>(cout, "\n"));
1720
1721     // sum up the elements of the list (requires #include <numeric>)
1722     ex sum = std::accumulate(l.begin(), l.end(), ex(0));
1723     cout << sum << endl;  // prints '2+2*x+2*y'
1724     ...
1725 @end example
1726
1727 @code{lst} is one of the few GiNaC classes that allow in-place modifications
1728 (the only other one is @code{matrix}). You can modify single elements:
1729
1730 @example
1731     ...
1732     l[1] = 42;       // l is now @{x, 42, y, x+y@}
1733     l.let_op(1) = 7; // l is now @{x, 7, y, x+y@}
1734     ...
1735 @end example
1736
1737 You can append or prepend an expression to a list with the @code{append()}
1738 and @code{prepend()} methods:
1739
1740 @example
1741     ...
1742     l.append(4*x);   // l is now @{x, 7, y, x+y, 4*x@}
1743     l.prepend(0);    // l is now @{0, x, 7, y, x+y, 4*x@}
1744     ...
1745 @end example
1746
1747 You can remove the first or last element of a list with @code{remove_first()}
1748 and @code{remove_last()}:
1749
1750 @example
1751     ...
1752     l.remove_first();   // l is now @{x, 7, y, x+y, 4*x@}
1753     l.remove_last();    // l is now @{x, 7, y, x+y@}
1754     ...
1755 @end example
1756
1757 You can remove all the elements of a list with @code{remove_all()}:
1758
1759 @example
1760     ...
1761     l.remove_all();     // l is now empty
1762     ...
1763 @end example
1764
1765 You can bring the elements of a list into a canonical order with @code{sort()}:
1766
1767 @example
1768     ...
1769     lst l1, l2;
1770     l1 = x, 2, y, x+y;
1771     l2 = 2, x+y, x, y;
1772     l1.sort();
1773     l2.sort();
1774     // l1 and l2 are now equal
1775     ...
1776 @end example
1777
1778 Finally, you can remove all but the first element of consecutive groups of
1779 elements with @code{unique()}:
1780
1781 @example
1782     ...
1783     lst l3;
1784     l3 = x, 2, 2, 2, y, x+y, y+x;
1785     l3.unique();        // l3 is now @{x, 2, y, x+y@}
1786 @}
1787 @end example
1788
1789
1790 @node Mathematical functions, Relations, Lists, Basic concepts
1791 @c    node-name, next, previous, up
1792 @section Mathematical functions
1793 @cindex @code{function} (class)
1794 @cindex trigonometric function
1795 @cindex hyperbolic function
1796
1797 There are quite a number of useful functions hard-wired into GiNaC.  For
1798 instance, all trigonometric and hyperbolic functions are implemented
1799 (@xref{Built-in functions}, for a complete list).
1800
1801 These functions (better called @emph{pseudofunctions}) are all objects
1802 of class @code{function}.  They accept one or more expressions as
1803 arguments and return one expression.  If the arguments are not
1804 numerical, the evaluation of the function may be halted, as it does in
1805 the next example, showing how a function returns itself twice and
1806 finally an expression that may be really useful:
1807
1808 @cindex Gamma function
1809 @cindex @code{subs()}
1810 @example
1811     ...
1812     symbol x("x"), y("y");    
1813     ex foo = x+y/2;
1814     cout << tgamma(foo) << endl;
1815      // -> tgamma(x+(1/2)*y)
1816     ex bar = foo.subs(y==1);
1817     cout << tgamma(bar) << endl;
1818      // -> tgamma(x+1/2)
1819     ex foobar = bar.subs(x==7);
1820     cout << tgamma(foobar) << endl;
1821      // -> (135135/128)*Pi^(1/2)
1822     ...
1823 @end example
1824
1825 Besides evaluation most of these functions allow differentiation, series
1826 expansion and so on.  Read the next chapter in order to learn more about
1827 this.
1828
1829 It must be noted that these pseudofunctions are created by inline
1830 functions, where the argument list is templated.  This means that
1831 whenever you call @code{GiNaC::sin(1)} it is equivalent to
1832 @code{sin(ex(1))} and will therefore not result in a floating point
1833 number.  Unless of course the function prototype is explicitly
1834 overridden -- which is the case for arguments of type @code{numeric}
1835 (not wrapped inside an @code{ex}).  Hence, in order to obtain a floating
1836 point number of class @code{numeric} you should call
1837 @code{sin(numeric(1))}.  This is almost the same as calling
1838 @code{sin(1).evalf()} except that the latter will return a numeric
1839 wrapped inside an @code{ex}.
1840
1841
1842 @node Relations, Integrals, Mathematical functions, Basic concepts
1843 @c    node-name, next, previous, up
1844 @section Relations
1845 @cindex @code{relational} (class)
1846
1847 Sometimes, a relation holding between two expressions must be stored
1848 somehow.  The class @code{relational} is a convenient container for such
1849 purposes.  A relation is by definition a container for two @code{ex} and
1850 a relation between them that signals equality, inequality and so on.
1851 They are created by simply using the C++ operators @code{==}, @code{!=},
1852 @code{<}, @code{<=}, @code{>} and @code{>=} between two expressions.
1853
1854 @xref{Mathematical functions}, for examples where various applications
1855 of the @code{.subs()} method show how objects of class relational are
1856 used as arguments.  There they provide an intuitive syntax for
1857 substitutions.  They are also used as arguments to the @code{ex::series}
1858 method, where the left hand side of the relation specifies the variable
1859 to expand in and the right hand side the expansion point.  They can also
1860 be used for creating systems of equations that are to be solved for
1861 unknown variables.  But the most common usage of objects of this class
1862 is rather inconspicuous in statements of the form @code{if
1863 (expand(pow(a+b,2))==a*a+2*a*b+b*b) @{...@}}.  Here, an implicit
1864 conversion from @code{relational} to @code{bool} takes place.  Note,
1865 however, that @code{==} here does not perform any simplifications, hence
1866 @code{expand()} must be called explicitly.
1867
1868 @node Integrals, Matrices, Relations, Basic concepts
1869 @c    node-name, next, previous, up
1870 @section Integrals
1871 @cindex @code{integral} (class)
1872
1873 An object of class @dfn{integral} can be used to hold a symbolic integral.
1874 If you want to symbolically represent the integral of @code{x*x} from 0 to
1875 1, you would write this as
1876 @example
1877 integral(x, 0, 1, x*x)
1878 @end example
1879 The first argument is the integration variable. It should be noted that
1880 GiNaC is not very good (yet?) at symbolically evaluating integrals. In
1881 fact, it can only integrate polynomials. An expression containing integrals
1882 can be evaluated symbolically by calling the
1883 @example
1884 .eval_integ()
1885 @end example
1886 method on it. Numerical evaluation is available by calling the
1887 @example
1888 .evalf()
1889 @end example
1890 method on an expression containing the integral. This will only evaluate
1891 integrals into a number if @code{subs}ing the integration variable by a
1892 number in the fourth argument of an integral and then @code{evalf}ing the
1893 result always results in a number. Of course, also the boundaries of the
1894 integration domain must @code{evalf} into numbers. It should be noted that
1895 trying to @code{evalf} a function with discontinuities in the integration
1896 domain is not recommended. The accuracy of the numeric evaluation of
1897 integrals is determined by the static member variable
1898 @example
1899 ex integral::relative_integration_error
1900 @end example
1901 of the class @code{integral}. The default value of this is 10^-8.
1902 The integration works by halving the interval of integration, until numeric
1903 stability of the answer indicates that the requested accuracy has been
1904 reached. The maximum depth of the halving can be set via the static member
1905 variable
1906 @example
1907 int integral::max_integration_level
1908 @end example
1909 The default value is 15. If this depth is exceeded, @code{evalf} will simply
1910 return the integral unevaluated. The function that performs the numerical
1911 evaluation, is also available as
1912 @example
1913 ex adaptivesimpson(const ex & x, const ex & a, const ex & b, const ex & f,
1914                    const ex & error)
1915 @end example
1916 This function will throw an exception if the maximum depth is exceeded. The
1917 last parameter of the function is optional and defaults to the
1918 @code{relative_integration_error}. To make sure that we do not do too
1919 much work if an expression contains the same integral multiple times,
1920 a lookup table is used.
1921
1922 If you know that an expression holds an integral, you can get the
1923 integration variable, the left boundary, right boundary and integrand by
1924 respectively calling @code{.op(0)}, @code{.op(1)}, @code{.op(2)}, and
1925 @code{.op(3)}. Differentiating integrals with respect to variables works
1926 as expected. Note that it makes no sense to differentiate an integral
1927 with respect to the integration variable.
1928
1929 @node Matrices, Indexed objects, Integrals, Basic concepts
1930 @c    node-name, next, previous, up
1931 @section Matrices
1932 @cindex @code{matrix} (class)
1933
1934 A @dfn{matrix} is a two-dimensional array of expressions. The elements of a
1935 matrix with @math{m} rows and @math{n} columns are accessed with two
1936 @code{unsigned} indices, the first one in the range 0@dots{}@math{m-1}, the
1937 second one in the range 0@dots{}@math{n-1}.
1938
1939 There are a couple of ways to construct matrices, with or without preset
1940 elements. The constructor
1941
1942 @example
1943 matrix::matrix(unsigned r, unsigned c);
1944 @end example
1945
1946 creates a matrix with @samp{r} rows and @samp{c} columns with all elements
1947 set to zero.
1948
1949 The fastest way to create a matrix with preinitialized elements is to assign
1950 a list of comma-separated expressions to an empty matrix (see below for an
1951 example). But you can also specify the elements as a (flat) list with
1952
1953 @example
1954 matrix::matrix(unsigned r, unsigned c, const lst & l);
1955 @end example
1956
1957 The function
1958
1959 @cindex @code{lst_to_matrix()}
1960 @example
1961 ex lst_to_matrix(const lst & l);
1962 @end example
1963
1964 constructs a matrix from a list of lists, each list representing a matrix row.
1965
1966 There is also a set of functions for creating some special types of
1967 matrices:
1968
1969 @cindex @code{diag_matrix()}
1970 @cindex @code{unit_matrix()}
1971 @cindex @code{symbolic_matrix()}
1972 @example
1973 ex diag_matrix(const lst & l);
1974 ex unit_matrix(unsigned x);
1975 ex unit_matrix(unsigned r, unsigned c);
1976 ex symbolic_matrix(unsigned r, unsigned c, const string & base_name);
1977 ex symbolic_matrix(unsigned r, unsigned c, const string & base_name,
1978                    const string & tex_base_name);
1979 @end example
1980
1981 @code{diag_matrix()} constructs a diagonal matrix given the list of diagonal
1982 elements. @code{unit_matrix()} creates an @samp{x} by @samp{x} (or @samp{r}
1983 by @samp{c}) unit matrix. And finally, @code{symbolic_matrix} constructs a
1984 matrix filled with newly generated symbols made of the specified base name
1985 and the position of each element in the matrix.
1986
1987 Matrices often arise by omitting elements of another matrix. For
1988 instance, the submatrix @code{S} of a matrix @code{M} takes a
1989 rectangular block from @code{M}. The reduced matrix @code{R} is defined
1990 by removing one row and one column from a matrix @code{M}. (The
1991 determinant of a reduced matrix is called a @emph{Minor} of @code{M} and
1992 can be used for computing the inverse using Cramer's rule.)
1993
1994 @cindex @code{sub_matrix()}
1995 @cindex @code{reduced_matrix()}
1996 @example
1997 ex sub_matrix(const matrix&m, unsigned r, unsigned nr, unsigned c, unsigned nc);
1998 ex reduced_matrix(const matrix& m, unsigned r, unsigned c);
1999 @end example
2000
2001 The function @code{sub_matrix()} takes a row offset @code{r} and a
2002 column offset @code{c} and takes a block of @code{nr} rows and @code{nc}
2003 columns. The function @code{reduced_matrix()} has two integer arguments
2004 that specify which row and column to remove:
2005
2006 @example
2007 @{
2008     matrix m(3,3);
2009     m = 11, 12, 13,
2010         21, 22, 23,
2011         31, 32, 33;
2012     cout << reduced_matrix(m, 1, 1) << endl;
2013     // -> [[11,13],[31,33]]
2014     cout << sub_matrix(m, 1, 2, 1, 2) << endl;
2015     // -> [[22,23],[32,33]]
2016 @}
2017 @end example
2018
2019 Matrix elements can be accessed and set using the parenthesis (function call)
2020 operator:
2021
2022 @example
2023 const ex & matrix::operator()(unsigned r, unsigned c) const;
2024 ex & matrix::operator()(unsigned r, unsigned c);
2025 @end example
2026
2027 It is also possible to access the matrix elements in a linear fashion with
2028 the @code{op()} method. But C++-style subscripting with square brackets
2029 @samp{[]} is not available.
2030
2031 Here are a couple of examples for constructing matrices:
2032
2033 @example
2034 @{
2035     symbol a("a"), b("b");
2036
2037     matrix M(2, 2);
2038     M = a, 0,
2039         0, b;
2040     cout << M << endl;
2041      // -> [[a,0],[0,b]]
2042
2043     matrix M2(2, 2);
2044     M2(0, 0) = a;
2045     M2(1, 1) = b;
2046     cout << M2 << endl;
2047      // -> [[a,0],[0,b]]
2048
2049     cout << matrix(2, 2, lst(a, 0, 0, b)) << endl;
2050      // -> [[a,0],[0,b]]
2051
2052     cout << lst_to_matrix(lst(lst(a, 0), lst(0, b))) << endl;
2053      // -> [[a,0],[0,b]]
2054
2055     cout << diag_matrix(lst(a, b)) << endl;
2056      // -> [[a,0],[0,b]]
2057
2058     cout << unit_matrix(3) << endl;
2059      // -> [[1,0,0],[0,1,0],[0,0,1]]
2060
2061     cout << symbolic_matrix(2, 3, "x") << endl;
2062      // -> [[x00,x01,x02],[x10,x11,x12]]
2063 @}
2064 @end example
2065
2066 @cindex @code{is_zero_matrix()} 
2067 The method @code{matrix::is_zero_matrix()} returns @code{true} only if
2068 all entries of the matrix are zeros. There is also method
2069 @code{ex::is_zero_matrix()} which returns @code{true} only if the
2070 expression is zero or a zero matrix.
2071
2072 @cindex @code{transpose()}
2073 There are three ways to do arithmetic with matrices. The first (and most
2074 direct one) is to use the methods provided by the @code{matrix} class:
2075
2076 @example
2077 matrix matrix::add(const matrix & other) const;
2078 matrix matrix::sub(const matrix & other) const;
2079 matrix matrix::mul(const matrix & other) const;
2080 matrix matrix::mul_scalar(const ex & other) const;
2081 matrix matrix::pow(const ex & expn) const;
2082 matrix matrix::transpose() const;
2083 @end example
2084
2085 All of these methods return the result as a new matrix object. Here is an
2086 example that calculates @math{A*B-2*C} for three matrices @math{A}, @math{B}
2087 and @math{C}:
2088
2089 @example
2090 @{
2091     matrix A(2, 2), B(2, 2), C(2, 2);
2092     A =  1, 2,
2093          3, 4;
2094     B = -1, 0,
2095          2, 1;
2096     C =  8, 4,
2097          2, 1;
2098
2099     matrix result = A.mul(B).sub(C.mul_scalar(2));
2100     cout << result << endl;
2101      // -> [[-13,-6],[1,2]]
2102     ...
2103 @}
2104 @end example
2105
2106 @cindex @code{evalm()}
2107 The second (and probably the most natural) way is to construct an expression
2108 containing matrices with the usual arithmetic operators and @code{pow()}.
2109 For efficiency reasons, expressions with sums, products and powers of
2110 matrices are not automatically evaluated in GiNaC. You have to call the
2111 method
2112
2113 @example
2114 ex ex::evalm() const;
2115 @end example
2116
2117 to obtain the result:
2118
2119 @example
2120 @{
2121     ...
2122     ex e = A*B - 2*C;
2123     cout << e << endl;
2124      // -> [[1,2],[3,4]]*[[-1,0],[2,1]]-2*[[8,4],[2,1]]
2125     cout << e.evalm() << endl;
2126      // -> [[-13,-6],[1,2]]
2127     ...
2128 @}
2129 @end example
2130
2131 The non-commutativity of the product @code{A*B} in this example is
2132 automatically recognized by GiNaC. There is no need to use a special
2133 operator here. @xref{Non-commutative objects}, for more information about
2134 dealing with non-commutative expressions.
2135
2136 Finally, you can work with indexed matrices and call @code{simplify_indexed()}
2137 to perform the arithmetic:
2138
2139 @example
2140 @{
2141     ...
2142     idx i(symbol("i"), 2), j(symbol("j"), 2), k(symbol("k"), 2);
2143     e = indexed(A, i, k) * indexed(B, k, j) - 2 * indexed(C, i, j);
2144     cout << e << endl;
2145      // -> -2*[[8,4],[2,1]].i.j+[[-1,0],[2,1]].k.j*[[1,2],[3,4]].i.k
2146     cout << e.simplify_indexed() << endl;
2147      // -> [[-13,-6],[1,2]].i.j
2148 @}
2149 @end example
2150
2151 Using indices is most useful when working with rectangular matrices and
2152 one-dimensional vectors because you don't have to worry about having to
2153 transpose matrices before multiplying them. @xref{Indexed objects}, for
2154 more information about using matrices with indices, and about indices in
2155 general.
2156
2157 The @code{matrix} class provides a couple of additional methods for
2158 computing determinants, traces, characteristic polynomials and ranks:
2159
2160 @cindex @code{determinant()}
2161 @cindex @code{trace()}
2162 @cindex @code{charpoly()}
2163 @cindex @code{rank()}
2164 @example
2165 ex matrix::determinant(unsigned algo=determinant_algo::automatic) const;
2166 ex matrix::trace() const;
2167 ex matrix::charpoly(const ex & lambda) const;
2168 unsigned matrix::rank() const;
2169 @end example
2170
2171 The @samp{algo} argument of @code{determinant()} allows to select
2172 between different algorithms for calculating the determinant.  The
2173 asymptotic speed (as parametrized by the matrix size) can greatly differ
2174 between those algorithms, depending on the nature of the matrix'
2175 entries.  The possible values are defined in the @file{flags.h} header
2176 file.  By default, GiNaC uses a heuristic to automatically select an
2177 algorithm that is likely (but not guaranteed) to give the result most
2178 quickly.
2179
2180 @cindex @code{inverse()} (matrix)
2181 @cindex @code{solve()}
2182 Matrices may also be inverted using the @code{ex matrix::inverse()}
2183 method and linear systems may be solved with:
2184
2185 @example
2186 matrix matrix::solve(const matrix & vars, const matrix & rhs,
2187                      unsigned algo=solve_algo::automatic) const;
2188 @end example
2189
2190 Assuming the matrix object this method is applied on is an @code{m}
2191 times @code{n} matrix, then @code{vars} must be a @code{n} times
2192 @code{p} matrix of symbolic indeterminates and @code{rhs} a @code{m}
2193 times @code{p} matrix.  The returned matrix then has dimension @code{n}
2194 times @code{p} and in the case of an underdetermined system will still
2195 contain some of the indeterminates from @code{vars}.  If the system is
2196 overdetermined, an exception is thrown.
2197
2198
2199 @node Indexed objects, Non-commutative objects, Matrices, Basic concepts
2200 @c    node-name, next, previous, up
2201 @section Indexed objects
2202
2203 GiNaC allows you to handle expressions containing general indexed objects in
2204 arbitrary spaces. It is also able to canonicalize and simplify such
2205 expressions and perform symbolic dummy index summations. There are a number
2206 of predefined indexed objects provided, like delta and metric tensors.
2207
2208 There are few restrictions placed on indexed objects and their indices and
2209 it is easy to construct nonsense expressions, but our intention is to
2210 provide a general framework that allows you to implement algorithms with
2211 indexed quantities, getting in the way as little as possible.
2212
2213 @cindex @code{idx} (class)
2214 @cindex @code{indexed} (class)
2215 @subsection Indexed quantities and their indices
2216
2217 Indexed expressions in GiNaC are constructed of two special types of objects,
2218 @dfn{index objects} and @dfn{indexed objects}.
2219
2220 @itemize @bullet
2221
2222 @cindex contravariant
2223 @cindex covariant
2224 @cindex variance
2225 @item Index objects are of class @code{idx} or a subclass. Every index has
2226 a @dfn{value} and a @dfn{dimension} (which is the dimension of the space
2227 the index lives in) which can both be arbitrary expressions but are usually
2228 a number or a simple symbol. In addition, indices of class @code{varidx} have
2229 a @dfn{variance} (they can be co- or contravariant), and indices of class
2230 @code{spinidx} have a variance and can be @dfn{dotted} or @dfn{undotted}.
2231
2232 @item Indexed objects are of class @code{indexed} or a subclass. They
2233 contain a @dfn{base expression} (which is the expression being indexed), and
2234 one or more indices.
2235
2236 @end itemize
2237
2238 @strong{Please notice:} when printing expressions, covariant indices and indices
2239 without variance are denoted @samp{.i} while contravariant indices are
2240 denoted @samp{~i}. Dotted indices have a @samp{*} in front of the index
2241 value. In the following, we are going to use that notation in the text so
2242 instead of @math{A^i_jk} we will write @samp{A~i.j.k}. Index dimensions are
2243 not visible in the output.
2244
2245 A simple example shall illustrate the concepts:
2246
2247 @example
2248 #include <iostream>
2249 #include <ginac/ginac.h>
2250 using namespace std;
2251 using namespace GiNaC;
2252
2253 int main()
2254 @{
2255     symbol i_sym("i"), j_sym("j");
2256     idx i(i_sym, 3), j(j_sym, 3);
2257
2258     symbol A("A");
2259     cout << indexed(A, i, j) << endl;
2260      // -> A.i.j
2261     cout << index_dimensions << indexed(A, i, j) << endl;
2262      // -> A.i[3].j[3]
2263     cout << dflt; // reset cout to default output format (dimensions hidden)
2264     ...
2265 @end example
2266
2267 The @code{idx} constructor takes two arguments, the index value and the
2268 index dimension. First we define two index objects, @code{i} and @code{j},
2269 both with the numeric dimension 3. The value of the index @code{i} is the
2270 symbol @code{i_sym} (which prints as @samp{i}) and the value of the index
2271 @code{j} is the symbol @code{j_sym} (which prints as @samp{j}). Next we
2272 construct an expression containing one indexed object, @samp{A.i.j}. It has
2273 the symbol @code{A} as its base expression and the two indices @code{i} and
2274 @code{j}.
2275
2276 The dimensions of indices are normally not visible in the output, but one
2277 can request them to be printed with the @code{index_dimensions} manipulator,
2278 as shown above.
2279
2280 Note the difference between the indices @code{i} and @code{j} which are of
2281 class @code{idx}, and the index values which are the symbols @code{i_sym}
2282 and @code{j_sym}. The indices of indexed objects cannot directly be symbols
2283 or numbers but must be index objects. For example, the following is not
2284 correct and will raise an exception:
2285
2286 @example
2287 symbol i("i"), j("j");
2288 e = indexed(A, i, j); // ERROR: indices must be of type idx
2289 @end example
2290
2291 You can have multiple indexed objects in an expression, index values can
2292 be numeric, and index dimensions symbolic:
2293
2294 @example
2295     ...
2296     symbol B("B"), dim("dim");
2297     cout << 4 * indexed(A, i)
2298           + indexed(B, idx(j_sym, 4), idx(2, 3), idx(i_sym, dim)) << endl;
2299      // -> B.j.2.i+4*A.i
2300     ...
2301 @end example
2302
2303 @code{B} has a 4-dimensional symbolic index @samp{k}, a 3-dimensional numeric
2304 index of value 2, and a symbolic index @samp{i} with the symbolic dimension
2305 @samp{dim}. Note that GiNaC doesn't automatically notify you that the free
2306 indices of @samp{A} and @samp{B} in the sum don't match (you have to call
2307 @code{simplify_indexed()} for that, see below).
2308
2309 In fact, base expressions, index values and index dimensions can be
2310 arbitrary expressions:
2311
2312 @example
2313     ...
2314     cout << indexed(A+B, idx(2*i_sym+1, dim/2)) << endl;
2315      // -> (B+A).(1+2*i)
2316     ...
2317 @end example
2318
2319 It's also possible to construct nonsense like @samp{Pi.sin(x)}. You will not
2320 get an error message from this but you will probably not be able to do
2321 anything useful with it.
2322
2323 @cindex @code{get_value()}
2324 @cindex @code{get_dimension()}
2325 The methods
2326
2327 @example
2328 ex idx::get_value();
2329 ex idx::get_dimension();
2330 @end example
2331
2332 return the value and dimension of an @code{idx} object. If you have an index
2333 in an expression, such as returned by calling @code{.op()} on an indexed
2334 object, you can get a reference to the @code{idx} object with the function
2335 @code{ex_to<idx>()} on the expression.
2336
2337 There are also the methods
2338
2339 @example
2340 bool idx::is_numeric();
2341 bool idx::is_symbolic();
2342 bool idx::is_dim_numeric();
2343 bool idx::is_dim_symbolic();
2344 @end example
2345
2346 for checking whether the value and dimension are numeric or symbolic
2347 (non-numeric). Using the @code{info()} method of an index (see @ref{Information
2348 about expressions}) returns information about the index value.
2349
2350 @cindex @code{varidx} (class)
2351 If you need co- and contravariant indices, use the @code{varidx} class:
2352
2353 @example
2354     ...
2355     symbol mu_sym("mu"), nu_sym("nu");
2356     varidx mu(mu_sym, 4), nu(nu_sym, 4); // default is contravariant ~mu, ~nu
2357     varidx mu_co(mu_sym, 4, true);       // covariant index .mu
2358
2359     cout << indexed(A, mu, nu) << endl;
2360      // -> A~mu~nu
2361     cout << indexed(A, mu_co, nu) << endl;
2362      // -> A.mu~nu
2363     cout << indexed(A, mu.toggle_variance(), nu) << endl;
2364      // -> A.mu~nu
2365     ...
2366 @end example
2367
2368 A @code{varidx} is an @code{idx} with an additional flag that marks it as
2369 co- or contravariant. The default is a contravariant (upper) index, but
2370 this can be overridden by supplying a third argument to the @code{varidx}
2371 constructor. The two methods
2372
2373 @example
2374 bool varidx::is_covariant();
2375 bool varidx::is_contravariant();
2376 @end example
2377
2378 allow you to check the variance of a @code{varidx} object (use @code{ex_to<varidx>()}
2379 to get the object reference from an expression). There's also the very useful
2380 method
2381
2382 @example
2383 ex varidx::toggle_variance();
2384 @end example
2385
2386 which makes a new index with the same value and dimension but the opposite
2387 variance. By using it you only have to define the index once.
2388
2389 @cindex @code{spinidx} (class)
2390 The @code{spinidx} class provides dotted and undotted variant indices, as
2391 used in the Weyl-van-der-Waerden spinor formalism:
2392
2393 @example
2394     ...
2395     symbol K("K"), C_sym("C"), D_sym("D");
2396     spinidx C(C_sym, 2), D(D_sym);          // default is 2-dimensional,
2397                                             // contravariant, undotted
2398     spinidx C_co(C_sym, 2, true);           // covariant index
2399     spinidx D_dot(D_sym, 2, false, true);   // contravariant, dotted
2400     spinidx D_co_dot(D_sym, 2, true, true); // covariant, dotted
2401
2402     cout << indexed(K, C, D) << endl;
2403      // -> K~C~D
2404     cout << indexed(K, C_co, D_dot) << endl;
2405      // -> K.C~*D
2406     cout << indexed(K, D_co_dot, D) << endl;
2407      // -> K.*D~D
2408     ...
2409 @end example
2410
2411 A @code{spinidx} is a @code{varidx} with an additional flag that marks it as
2412 dotted or undotted. The default is undotted but this can be overridden by
2413 supplying a fourth argument to the @code{spinidx} constructor. The two
2414 methods
2415
2416 @example
2417 bool spinidx::is_dotted();
2418 bool spinidx::is_undotted();
2419 @end example
2420
2421 allow you to check whether or not a @code{spinidx} object is dotted (use
2422 @code{ex_to<spinidx>()} to get the object reference from an expression).
2423 Finally, the two methods
2424
2425 @example
2426 ex spinidx::toggle_dot();
2427 ex spinidx::toggle_variance_dot();
2428 @end example
2429
2430 create a new index with the same value and dimension but opposite dottedness
2431 and the same or opposite variance.
2432
2433 @subsection Substituting indices
2434
2435 @cindex @code{subs()}
2436 Sometimes you will want to substitute one symbolic index with another
2437 symbolic or numeric index, for example when calculating one specific element
2438 of a tensor expression. This is done with the @code{.subs()} method, as it
2439 is done for symbols (see @ref{Substituting expressions}).
2440
2441 You have two possibilities here. You can either substitute the whole index
2442 by another index or expression:
2443
2444 @example
2445     ...
2446     ex e = indexed(A, mu_co);
2447     cout << e << " becomes " << e.subs(mu_co == nu) << endl;
2448      // -> A.mu becomes A~nu
2449     cout << e << " becomes " << e.subs(mu_co == varidx(0, 4)) << endl;
2450      // -> A.mu becomes A~0
2451     cout << e << " becomes " << e.subs(mu_co == 0) << endl;
2452      // -> A.mu becomes A.0
2453     ...
2454 @end example
2455
2456 The third example shows that trying to replace an index with something that
2457 is not an index will substitute the index value instead.
2458
2459 Alternatively, you can substitute the @emph{symbol} of a symbolic index by
2460 another expression:
2461
2462 @example
2463     ...
2464     ex e = indexed(A, mu_co);
2465     cout << e << " becomes " << e.subs(mu_sym == nu_sym) << endl;
2466      // -> A.mu becomes A.nu
2467     cout << e << " becomes " << e.subs(mu_sym == 0) << endl;
2468      // -> A.mu becomes A.0
2469     ...
2470 @end example
2471
2472 As you see, with the second method only the value of the index will get
2473 substituted. Its other properties, including its dimension, remain unchanged.
2474 If you want to change the dimension of an index you have to substitute the
2475 whole index by another one with the new dimension.
2476
2477 Finally, substituting the base expression of an indexed object works as
2478 expected:
2479
2480 @example
2481     ...
2482     ex e = indexed(A, mu_co);
2483     cout << e << " becomes " << e.subs(A == A+B) << endl;
2484      // -> A.mu becomes (B+A).mu
2485     ...
2486 @end example
2487
2488 @subsection Symmetries
2489 @cindex @code{symmetry} (class)
2490 @cindex @code{sy_none()}
2491 @cindex @code{sy_symm()}
2492 @cindex @code{sy_anti()}
2493 @cindex @code{sy_cycl()}
2494
2495 Indexed objects can have certain symmetry properties with respect to their
2496 indices. Symmetries are specified as a tree of objects of class @code{symmetry}
2497 that is constructed with the helper functions
2498
2499 @example
2500 symmetry sy_none(...);
2501 symmetry sy_symm(...);
2502 symmetry sy_anti(...);
2503 symmetry sy_cycl(...);
2504 @end example
2505
2506 @code{sy_none()} stands for no symmetry, @code{sy_symm()} and @code{sy_anti()}
2507 specify fully symmetric or antisymmetric, respectively, and @code{sy_cycl()}
2508 represents a cyclic symmetry. Each of these functions accepts up to four
2509 arguments which can be either symmetry objects themselves or unsigned integer
2510 numbers that represent an index position (counting from 0). A symmetry
2511 specification that consists of only a single @code{sy_symm()}, @code{sy_anti()}
2512 or @code{sy_cycl()} with no arguments specifies the respective symmetry for
2513 all indices.
2514
2515 Here are some examples of symmetry definitions:
2516
2517 @example
2518     ...
2519     // No symmetry:
2520     e = indexed(A, i, j);
2521     e = indexed(A, sy_none(), i, j);     // equivalent
2522     e = indexed(A, sy_none(0, 1), i, j); // equivalent
2523
2524     // Symmetric in all three indices:
2525     e = indexed(A, sy_symm(), i, j, k);
2526     e = indexed(A, sy_symm(0, 1, 2), i, j, k); // equivalent
2527     e = indexed(A, sy_symm(2, 0, 1), i, j, k); // same symmetry, but yields a
2528                                                // different canonical order
2529
2530     // Symmetric in the first two indices only:
2531     e = indexed(A, sy_symm(0, 1), i, j, k);
2532     e = indexed(A, sy_none(sy_symm(0, 1), 2), i, j, k); // equivalent
2533
2534     // Antisymmetric in the first and last index only (index ranges need not
2535     // be contiguous):
2536     e = indexed(A, sy_anti(0, 2), i, j, k);
2537     e = indexed(A, sy_none(sy_anti(0, 2), 1), i, j, k); // equivalent
2538
2539     // An example of a mixed symmetry: antisymmetric in the first two and
2540     // last two indices, symmetric when swapping the first and last index
2541     // pairs (like the Riemann curvature tensor):
2542     e = indexed(A, sy_symm(sy_anti(0, 1), sy_anti(2, 3)), i, j, k, l);
2543
2544     // Cyclic symmetry in all three indices:
2545     e = indexed(A, sy_cycl(), i, j, k);
2546     e = indexed(A, sy_cycl(0, 1, 2), i, j, k); // equivalent
2547
2548     // The following examples are invalid constructions that will throw
2549     // an exception at run time.
2550
2551     // An index may not appear multiple times:
2552     e = indexed(A, sy_symm(0, 0, 1), i, j, k); // ERROR
2553     e = indexed(A, sy_none(sy_symm(0, 1), sy_anti(0, 2)), i, j, k); // ERROR
2554
2555     // Every child of sy_symm(), sy_anti() and sy_cycl() must refer to the
2556     // same number of indices:
2557     e = indexed(A, sy_symm(sy_anti(0, 1), 2), i, j, k); // ERROR
2558
2559     // And of course, you cannot specify indices which are not there:
2560     e = indexed(A, sy_symm(0, 1, 2, 3), i, j, k); // ERROR
2561     ...
2562 @end example
2563
2564 If you need to specify more than four indices, you have to use the
2565 @code{.add()} method of the @code{symmetry} class. For example, to specify
2566 full symmetry in the first six indices you would write
2567 @code{sy_symm(0, 1, 2, 3).add(4).add(5)}.
2568
2569 If an indexed object has a symmetry, GiNaC will automatically bring the
2570 indices into a canonical order which allows for some immediate simplifications:
2571
2572 @example
2573     ...
2574     cout << indexed(A, sy_symm(), i, j)
2575           + indexed(A, sy_symm(), j, i) << endl;
2576      // -> 2*A.j.i
2577     cout << indexed(B, sy_anti(), i, j)
2578           + indexed(B, sy_anti(), j, i) << endl;
2579      // -> 0
2580     cout << indexed(B, sy_anti(), i, j, k)
2581           - indexed(B, sy_anti(), j, k, i) << endl;
2582      // -> 0
2583     ...
2584 @end example
2585
2586 @cindex @code{get_free_indices()}
2587 @cindex dummy index
2588 @subsection Dummy indices
2589
2590 GiNaC treats certain symbolic index pairs as @dfn{dummy indices} meaning
2591 that a summation over the index range is implied. Symbolic indices which are
2592 not dummy indices are called @dfn{free indices}. Numeric indices are neither
2593 dummy nor free indices.
2594
2595 To be recognized as a dummy index pair, the two indices must be of the same
2596 class and their value must be the same single symbol (an index like
2597 @samp{2*n+1} is never a dummy index). If the indices are of class
2598 @code{varidx} they must also be of opposite variance; if they are of class
2599 @code{spinidx} they must be both dotted or both undotted.
2600
2601 The method @code{.get_free_indices()} returns a vector containing the free
2602 indices of an expression. It also checks that the free indices of the terms
2603 of a sum are consistent:
2604
2605 @example
2606 @{
2607     symbol A("A"), B("B"), C("C");
2608
2609     symbol i_sym("i"), j_sym("j"), k_sym("k"), l_sym("l");
2610     idx i(i_sym, 3), j(j_sym, 3), k(k_sym, 3), l(l_sym, 3);
2611
2612     ex e = indexed(A, i, j) * indexed(B, j, k) + indexed(C, k, l, i, l);
2613     cout << exprseq(e.get_free_indices()) << endl;
2614      // -> (.i,.k)
2615      // 'j' and 'l' are dummy indices
2616
2617     symbol mu_sym("mu"), nu_sym("nu"), rho_sym("rho"), sigma_sym("sigma");
2618     varidx mu(mu_sym, 4), nu(nu_sym, 4), rho(rho_sym, 4), sigma(sigma_sym, 4);
2619
2620     e = indexed(A, mu, nu) * indexed(B, nu.toggle_variance(), rho)
2621       + indexed(C, mu, sigma, rho, sigma.toggle_variance());
2622     cout << exprseq(e.get_free_indices()) << endl;
2623      // -> (~mu,~rho)
2624      // 'nu' is a dummy index, but 'sigma' is not
2625
2626     e = indexed(A, mu, mu);
2627     cout << exprseq(e.get_free_indices()) << endl;
2628      // -> (~mu)
2629      // 'mu' is not a dummy index because it appears twice with the same
2630      // variance
2631
2632     e = indexed(A, mu, nu) + 42;
2633     cout << exprseq(e.get_free_indices()) << endl; // ERROR
2634      // this will throw an exception:
2635      // "add::get_free_indices: inconsistent indices in sum"
2636 @}
2637 @end example
2638
2639 @cindex @code{expand_dummy_sum()}
2640 A dummy index summation like 
2641 @tex
2642 $ a_i b^i$
2643 @end tex
2644 @ifnottex
2645 a.i b~i
2646 @end ifnottex
2647 can be expanded for indices with numeric
2648 dimensions (e.g. 3)  into the explicit sum like
2649 @tex
2650 $a_1b^1+a_2b^2+a_3b^3 $.
2651 @end tex
2652 @ifnottex
2653 a.1 b~1 + a.2 b~2 + a.3 b~3.
2654 @end ifnottex
2655 This is performed by the function
2656
2657 @example
2658     ex expand_dummy_sum(const ex & e, bool subs_idx = false);
2659 @end example
2660
2661 which takes an expression @code{e} and returns the expanded sum for all
2662 dummy indices with numeric dimensions. If the parameter @code{subs_idx}
2663 is set to @code{true} then all substitutions are made by @code{idx} class
2664 indices, i.e. without variance. In this case the above sum 
2665 @tex
2666 $ a_i b^i$
2667 @end tex
2668 @ifnottex
2669 a.i b~i
2670 @end ifnottex
2671 will be expanded to
2672 @tex
2673 $a_1b_1+a_2b_2+a_3b_3 $.
2674 @end tex
2675 @ifnottex
2676 a.1 b.1 + a.2 b.2 + a.3 b.3.
2677 @end ifnottex
2678
2679
2680 @cindex @code{simplify_indexed()}
2681 @subsection Simplifying indexed expressions
2682
2683 In addition to the few automatic simplifications that GiNaC performs on
2684 indexed expressions (such as re-ordering the indices of symmetric tensors
2685 and calculating traces and convolutions of matrices and predefined tensors)
2686 there is the method
2687
2688 @example
2689 ex ex::simplify_indexed();
2690 ex ex::simplify_indexed(const scalar_products & sp);
2691 @end example
2692
2693 that performs some more expensive operations:
2694
2695 @itemize @bullet
2696 @item it checks the consistency of free indices in sums in the same way
2697   @code{get_free_indices()} does
2698 @item it tries to give dummy indices that appear in different terms of a sum
2699   the same name to allow simplifications like @math{a_i*b_i-a_j*b_j=0}
2700 @item it (symbolically) calculates all possible dummy index summations/contractions
2701   with the predefined tensors (this will be explained in more detail in the
2702   next section)
2703 @item it detects contractions that vanish for symmetry reasons, for example
2704   the contraction of a symmetric and a totally antisymmetric tensor
2705 @item as a special case of dummy index summation, it can replace scalar products
2706   of two tensors with a user-defined value
2707 @end itemize
2708
2709 The last point is done with the help of the @code{scalar_products} class
2710 which is used to store scalar products with known values (this is not an
2711 arithmetic class, you just pass it to @code{simplify_indexed()}):
2712
2713 @example
2714 @{
2715     symbol A("A"), B("B"), C("C"), i_sym("i");
2716     idx i(i_sym, 3);
2717
2718     scalar_products sp;
2719     sp.add(A, B, 0); // A and B are orthogonal
2720     sp.add(A, C, 0); // A and C are orthogonal
2721     sp.add(A, A, 4); // A^2 = 4 (A has length 2)
2722
2723     e = indexed(A + B, i) * indexed(A + C, i);
2724     cout << e << endl;
2725      // -> (B+A).i*(A+C).i
2726
2727     cout << e.expand(expand_options::expand_indexed).simplify_indexed(sp)
2728          << endl;
2729      // -> 4+C.i*B.i
2730 @}
2731 @end example
2732
2733 The @code{scalar_products} object @code{sp} acts as a storage for the
2734 scalar products added to it with the @code{.add()} method. This method
2735 takes three arguments: the two expressions of which the scalar product is
2736 taken, and the expression to replace it with.
2737
2738 @cindex @code{expand()}
2739 The example above also illustrates a feature of the @code{expand()} method:
2740 if passed the @code{expand_indexed} option it will distribute indices
2741 over sums, so @samp{(A+B).i} becomes @samp{A.i+B.i}.
2742
2743 @cindex @code{tensor} (class)
2744 @subsection Predefined tensors
2745
2746 Some frequently used special tensors such as the delta, epsilon and metric
2747 tensors are predefined in GiNaC. They have special properties when
2748 contracted with other tensor expressions and some of them have constant
2749 matrix representations (they will evaluate to a number when numeric
2750 indices are specified).
2751
2752 @cindex @code{delta_tensor()}
2753 @subsubsection Delta tensor
2754
2755 The delta tensor takes two indices, is symmetric and has the matrix
2756 representation @code{diag(1, 1, 1, ...)}. It is constructed by the function
2757 @code{delta_tensor()}:
2758
2759 @example
2760 @{
2761     symbol A("A"), B("B");
2762
2763     idx i(symbol("i"), 3), j(symbol("j"), 3),
2764         k(symbol("k"), 3), l(symbol("l"), 3);
2765
2766     ex e = indexed(A, i, j) * indexed(B, k, l)
2767          * delta_tensor(i, k) * delta_tensor(j, l);
2768     cout << e.simplify_indexed() << endl;
2769      // -> B.i.j*A.i.j
2770
2771     cout << delta_tensor(i, i) << endl;
2772      // -> 3
2773 @}
2774 @end example
2775
2776 @cindex @code{metric_tensor()}
2777 @subsubsection General metric tensor
2778
2779 The function @code{metric_tensor()} creates a general symmetric metric
2780 tensor with two indices that can be used to raise/lower tensor indices. The
2781 metric tensor is denoted as @samp{g} in the output and if its indices are of
2782 mixed variance it is automatically replaced by a delta tensor:
2783
2784 @example
2785 @{
2786     symbol A("A");
2787
2788     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
2789
2790     ex e = metric_tensor(mu, nu) * indexed(A, nu.toggle_variance(), rho);
2791     cout << e.simplify_indexed() << endl;
2792      // -> A~mu~rho
2793
2794     e = delta_tensor(mu, nu.toggle_variance()) * metric_tensor(nu, rho);
2795     cout << e.simplify_indexed() << endl;
2796      // -> g~mu~rho
2797
2798     e = metric_tensor(mu.toggle_variance(), nu.toggle_variance())
2799       * metric_tensor(nu, rho);
2800     cout << e.simplify_indexed() << endl;
2801      // -> delta.mu~rho
2802
2803     e = metric_tensor(nu.toggle_variance(), rho.toggle_variance())
2804       * metric_tensor(mu, nu) * (delta_tensor(mu.toggle_variance(), rho)
2805         + indexed(A, mu.toggle_variance(), rho));
2806     cout << e.simplify_indexed() << endl;
2807      // -> 4+A.rho~rho
2808 @}
2809 @end example
2810
2811 @cindex @code{lorentz_g()}
2812 @subsubsection Minkowski metric tensor
2813
2814 The Minkowski metric tensor is a special metric tensor with a constant
2815 matrix representation which is either @code{diag(1, -1, -1, ...)} (negative
2816 signature, the default) or @code{diag(-1, 1, 1, ...)} (positive signature).
2817 It is created with the function @code{lorentz_g()} (although it is output as
2818 @samp{eta}):
2819
2820 @example
2821 @{
2822     varidx mu(symbol("mu"), 4);
2823
2824     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
2825       * lorentz_g(mu, varidx(0, 4));       // negative signature
2826     cout << e.simplify_indexed() << endl;
2827      // -> 1
2828
2829     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
2830       * lorentz_g(mu, varidx(0, 4), true); // positive signature
2831     cout << e.simplify_indexed() << endl;
2832      // -> -1
2833 @}
2834 @end example
2835
2836 @cindex @code{spinor_metric()}
2837 @subsubsection Spinor metric tensor
2838
2839 The function @code{spinor_metric()} creates an antisymmetric tensor with
2840 two indices that is used to raise/lower indices of 2-component spinors.
2841 It is output as @samp{eps}:
2842
2843 @example
2844 @{
2845     symbol psi("psi");
2846
2847     spinidx A(symbol("A")), B(symbol("B")), C(symbol("C"));
2848     ex A_co = A.toggle_variance(), B_co = B.toggle_variance();
2849
2850     e = spinor_metric(A, B) * indexed(psi, B_co);
2851     cout << e.simplify_indexed() << endl;
2852      // -> psi~A
2853
2854     e = spinor_metric(A, B) * indexed(psi, A_co);
2855     cout << e.simplify_indexed() << endl;
2856      // -> -psi~B
2857
2858     e = spinor_metric(A_co, B_co) * indexed(psi, B);
2859     cout << e.simplify_indexed() << endl;
2860      // -> -psi.A
2861
2862     e = spinor_metric(A_co, B_co) * indexed(psi, A);
2863     cout << e.simplify_indexed() << endl;
2864      // -> psi.B
2865
2866     e = spinor_metric(A_co, B_co) * spinor_metric(A, B);
2867     cout << e.simplify_indexed() << endl;
2868      // -> 2
2869
2870     e = spinor_metric(A_co, B_co) * spinor_metric(B, C);
2871     cout << e.simplify_indexed() << endl;
2872      // -> -delta.A~C
2873 @}
2874 @end example
2875
2876 The matrix representation of the spinor metric is @code{[[0, 1], [-1, 0]]}.
2877
2878 @cindex @code{epsilon_tensor()}
2879 @cindex @code{lorentz_eps()}
2880 @subsubsection Epsilon tensor
2881
2882 The epsilon tensor is totally antisymmetric, its number of indices is equal
2883 to the dimension of the index space (the indices must all be of the same
2884 numeric dimension), and @samp{eps.1.2.3...} (resp. @samp{eps~0~1~2...}) is
2885 defined to be 1. Its behavior with indices that have a variance also
2886 depends on the signature of the metric. Epsilon tensors are output as
2887 @samp{eps}.
2888
2889 There are three functions defined to create epsilon tensors in 2, 3 and 4
2890 dimensions:
2891
2892 @example
2893 ex epsilon_tensor(const ex & i1, const ex & i2);
2894 ex epsilon_tensor(const ex & i1, const ex & i2, const ex & i3);
2895 ex lorentz_eps(const ex & i1, const ex & i2, const ex & i3, const ex & i4,
2896                bool pos_sig = false);
2897 @end example
2898
2899 The first two functions create an epsilon tensor in 2 or 3 Euclidean
2900 dimensions, the last function creates an epsilon tensor in a 4-dimensional
2901 Minkowski space (the last @code{bool} argument specifies whether the metric
2902 has negative or positive signature, as in the case of the Minkowski metric
2903 tensor):
2904
2905 @example
2906 @{
2907     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4),
2908            sig(symbol("sig"), 4), lam(symbol("lam"), 4), bet(symbol("bet"), 4);
2909     e = lorentz_eps(mu, nu, rho, sig) *
2910         lorentz_eps(mu.toggle_variance(), nu.toggle_variance(), lam, bet);
2911     cout << simplify_indexed(e) << endl;
2912      // -> 2*eta~bet~rho*eta~sig~lam-2*eta~sig~bet*eta~rho~lam
2913
2914     idx i(symbol("i"), 3), j(symbol("j"), 3), k(symbol("k"), 3);
2915     symbol A("A"), B("B");
2916     e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(B, k);
2917     cout << simplify_indexed(e) << endl;
2918      // -> -B.k*A.j*eps.i.k.j
2919     e = epsilon_tensor(i, j, k) * indexed(A, j) * indexed(A, k);
2920     cout << simplify_indexed(e) << endl;
2921      // -> 0
2922 @}
2923 @end example
2924
2925 @subsection Linear algebra
2926
2927 The @code{matrix} class can be used with indices to do some simple linear
2928 algebra (linear combinations and products of vectors and matrices, traces
2929 and scalar products):
2930
2931 @example
2932 @{
2933     idx i(symbol("i"), 2), j(symbol("j"), 2);
2934     symbol x("x"), y("y");
2935
2936     // A is a 2x2 matrix, X is a 2x1 vector
2937     matrix A(2, 2), X(2, 1);
2938     A = 1, 2,
2939         3, 4;
2940     X = x, y;
2941
2942     cout << indexed(A, i, i) << endl;
2943      // -> 5
2944
2945     ex e = indexed(A, i, j) * indexed(X, j);
2946     cout << e.simplify_indexed() << endl;
2947      // -> [[2*y+x],[4*y+3*x]].i
2948
2949     e = indexed(A, i, j) * indexed(X, i) + indexed(X, j) * 2;
2950     cout << e.simplify_indexed() << endl;
2951      // -> [[3*y+3*x,6*y+2*x]].j
2952 @}
2953 @end example
2954
2955 You can of course obtain the same results with the @code{matrix::add()},
2956 @code{matrix::mul()} and @code{matrix::trace()} methods (@pxref{Matrices})
2957 but with indices you don't have to worry about transposing matrices.
2958
2959 Matrix indices always start at 0 and their dimension must match the number
2960 of rows/columns of the matrix. Matrices with one row or one column are
2961 vectors and can have one or two indices (it doesn't matter whether it's a
2962 row or a column vector). Other matrices must have two indices.
2963
2964 You should be careful when using indices with variance on matrices. GiNaC
2965 doesn't look at the variance and doesn't know that @samp{F~mu~nu} and
2966 @samp{F.mu.nu} are different matrices. In this case you should use only
2967 one form for @samp{F} and explicitly multiply it with a matrix representation
2968 of the metric tensor.
2969
2970
2971 @node Non-commutative objects, Hash maps, Indexed objects, Basic concepts
2972 @c    node-name, next, previous, up
2973 @section Non-commutative objects
2974
2975 GiNaC is equipped to handle certain non-commutative algebras. Three classes of
2976 non-commutative objects are built-in which are mostly of use in high energy
2977 physics:
2978
2979 @itemize
2980 @item Clifford (Dirac) algebra (class @code{clifford})
2981 @item su(3) Lie algebra (class @code{color})
2982 @item Matrices (unindexed) (class @code{matrix})
2983 @end itemize
2984
2985 The @code{clifford} and @code{color} classes are subclasses of
2986 @code{indexed} because the elements of these algebras usually carry
2987 indices. The @code{matrix} class is described in more detail in
2988 @ref{Matrices}.
2989
2990 Unlike most computer algebra systems, GiNaC does not primarily provide an
2991 operator (often denoted @samp{&*}) for representing inert products of
2992 arbitrary objects. Rather, non-commutativity in GiNaC is a property of the
2993 classes of objects involved, and non-commutative products are formed with
2994 the usual @samp{*} operator, as are ordinary products. GiNaC is capable of
2995 figuring out by itself which objects commutate and will group the factors
2996 by their class. Consider this example:
2997
2998 @example
2999     ...
3000     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
3001     idx a(symbol("a"), 8), b(symbol("b"), 8);
3002     ex e = -dirac_gamma(mu) * (2*color_T(a)) * 8 * color_T(b) * dirac_gamma(nu);
3003     cout << e << endl;
3004      // -> -16*(gamma~mu*gamma~nu)*(T.a*T.b)
3005     ...
3006 @end example
3007
3008 As can be seen, GiNaC pulls out the overall commutative factor @samp{-16} and
3009 groups the non-commutative factors (the gammas and the su(3) generators)
3010 together while preserving the order of factors within each class (because
3011 Clifford objects commutate with color objects). The resulting expression is a
3012 @emph{commutative} product with two factors that are themselves non-commutative
3013 products (@samp{gamma~mu*gamma~nu} and @samp{T.a*T.b}). For clarification,
3014 parentheses are placed around the non-commutative products in the output.
3015
3016 @cindex @code{ncmul} (class)
3017 Non-commutative products are internally represented by objects of the class
3018 @code{ncmul}, as opposed to commutative products which are handled by the
3019 @code{mul} class. You will normally not have to worry about this distinction,
3020 though.
3021
3022 The advantage of this approach is that you never have to worry about using
3023 (or forgetting to use) a special operator when constructing non-commutative
3024 expressions. Also, non-commutative products in GiNaC are more intelligent
3025 than in other computer algebra systems; they can, for example, automatically
3026 canonicalize themselves according to rules specified in the implementation
3027 of the non-commutative classes. The drawback is that to work with other than
3028 the built-in algebras you have to implement new classes yourself. Both
3029 symbols and user-defined functions can be specified as being non-commutative.
3030
3031 @cindex @code{return_type()}
3032 @cindex @code{return_type_tinfo()}
3033 Information about the commutativity of an object or expression can be
3034 obtained with the two member functions
3035
3036 @example
3037 unsigned ex::return_type() const;
3038 unsigned ex::return_type_tinfo() const;
3039 @end example
3040
3041 The @code{return_type()} function returns one of three values (defined in
3042 the header file @file{flags.h}), corresponding to three categories of
3043 expressions in GiNaC:
3044
3045 @itemize @bullet
3046 @item @code{return_types::commutative}: Commutates with everything. Most GiNaC
3047   classes are of this kind.
3048 @item @code{return_types::noncommutative}: Non-commutative, belonging to a
3049   certain class of non-commutative objects which can be determined with the
3050   @code{return_type_tinfo()} method. Expressions of this category commutate
3051   with everything except @code{noncommutative} expressions of the same
3052   class.
3053 @item @code{return_types::noncommutative_composite}: Non-commutative, composed
3054   of non-commutative objects of different classes. Expressions of this
3055   category don't commutate with any other @code{noncommutative} or
3056   @code{noncommutative_composite} expressions.
3057 @end itemize
3058
3059 The value returned by the @code{return_type_tinfo()} method is valid only
3060 when the return type of the expression is @code{noncommutative}. It is a
3061 value that is unique to the class of the object, but may vary every time a
3062 GiNaC program is being run (it is dynamically assigned on start-up).
3063
3064 Here are a couple of examples:
3065
3066 @cartouche
3067 @multitable @columnfractions 0.33 0.33 0.34
3068 @item @strong{Expression} @tab @strong{@code{return_type()}} @tab @strong{@code{return_type_tinfo()}}
3069 @item @code{42} @tab @code{commutative} @tab -
3070 @item @code{2*x-y} @tab @code{commutative} @tab -
3071 @item @code{dirac_ONE()} @tab @code{noncommutative} @tab @code{TINFO_clifford}
3072 @item @code{dirac_gamma(mu)*dirac_gamma(nu)} @tab @code{noncommutative} @tab @code{TINFO_clifford}
3073 @item @code{2*color_T(a)} @tab @code{noncommutative} @tab @code{TINFO_color}
3074 @item @code{dirac_ONE()*color_T(a)} @tab @code{noncommutative_composite} @tab -
3075 @end multitable
3076 @end cartouche
3077
3078 Note: the @code{return_type_tinfo()} of Clifford objects is only equal to
3079 @code{TINFO_clifford} for objects with a representation label of zero.
3080 Other representation labels yield a different @code{return_type_tinfo()},
3081 but it's the same for any two objects with the same label. This is also true
3082 for color objects.
3083
3084 A last note: With the exception of matrices, positive integer powers of
3085 non-commutative objects are automatically expanded in GiNaC. For example,
3086 @code{pow(a*b, 2)} becomes @samp{a*b*a*b} if @samp{a} and @samp{b} are
3087 non-commutative expressions).
3088
3089
3090 @cindex @code{clifford} (class)
3091 @subsection Clifford algebra
3092
3093
3094 Clifford algebras are supported in two flavours: Dirac gamma
3095 matrices (more physical) and generic Clifford algebras (more
3096 mathematical). 
3097
3098 @cindex @code{dirac_gamma()}
3099 @subsubsection Dirac gamma matrices
3100 Dirac gamma matrices (note that GiNaC doesn't treat them
3101 as matrices) are designated as @samp{gamma~mu} and satisfy
3102 @samp{gamma~mu*gamma~nu + gamma~nu*gamma~mu = 2*eta~mu~nu} where
3103 @samp{eta~mu~nu} is the Minkowski metric tensor. Dirac gammas are
3104 constructed by the function
3105
3106 @example
3107 ex dirac_gamma(const ex & mu, unsigned char rl = 0);
3108 @end example
3109
3110 which takes two arguments: the index and a @dfn{representation label} in the
3111 range 0 to 255 which is used to distinguish elements of different Clifford
3112 algebras (this is also called a @dfn{spin line index}). Gammas with different
3113 labels commutate with each other. The dimension of the index can be 4 or (in
3114 the framework of dimensional regularization) any symbolic value. Spinor
3115 indices on Dirac gammas are not supported in GiNaC.
3116
3117 @cindex @code{dirac_ONE()}
3118 The unity element of a Clifford algebra is constructed by
3119
3120 @example
3121 ex dirac_ONE(unsigned char rl = 0);
3122 @end example
3123
3124 @strong{Please notice:} You must always use @code{dirac_ONE()} when referring to
3125 multiples of the unity element, even though it's customary to omit it.
3126 E.g. instead of @code{dirac_gamma(mu)*(dirac_slash(q,4)+m)} you have to
3127 write @code{dirac_gamma(mu)*(dirac_slash(q,4)+m*dirac_ONE())}. Otherwise,
3128 GiNaC will complain and/or produce incorrect results.
3129
3130 @cindex @code{dirac_gamma5()}
3131 There is a special element @samp{gamma5} that commutates with all other
3132 gammas, has a unit square, and in 4 dimensions equals
3133 @samp{gamma~0 gamma~1 gamma~2 gamma~3}, provided by
3134
3135 @example
3136 ex dirac_gamma5(unsigned char rl = 0);
3137 @end example
3138
3139 @cindex @code{dirac_gammaL()}
3140 @cindex @code{dirac_gammaR()}
3141 The chiral projectors @samp{(1+/-gamma5)/2} are also available as proper
3142 objects, constructed by
3143
3144 @example
3145 ex dirac_gammaL(unsigned char rl = 0);
3146 ex dirac_gammaR(unsigned char rl = 0);
3147 @end example
3148
3149 They observe the relations @samp{gammaL^2 = gammaL}, @samp{gammaR^2 = gammaR},
3150 and @samp{gammaL gammaR = gammaR gammaL = 0}.
3151
3152 @cindex @code{dirac_slash()}
3153 Finally, the function
3154
3155 @example
3156 ex dirac_slash(const ex & e, const ex & dim, unsigned char rl = 0);
3157 @end example
3158
3159 creates a term that represents a contraction of @samp{e} with the Dirac
3160 Lorentz vector (it behaves like a term of the form @samp{e.mu gamma~mu}
3161 with a unique index whose dimension is given by the @code{dim} argument).
3162 Such slashed expressions are printed with a trailing backslash, e.g. @samp{e\}.
3163
3164 In products of dirac gammas, superfluous unity elements are automatically
3165 removed, squares are replaced by their values, and @samp{gamma5}, @samp{gammaL}
3166 and @samp{gammaR} are moved to the front.
3167
3168 The @code{simplify_indexed()} function performs contractions in gamma strings,
3169 for example
3170
3171 @example
3172 @{
3173     ...
3174     symbol a("a"), b("b"), D("D");
3175     varidx mu(symbol("mu"), D);
3176     ex e = dirac_gamma(mu) * dirac_slash(a, D)
3177          * dirac_gamma(mu.toggle_variance());
3178     cout << e << endl;
3179      // -> gamma~mu*a\*gamma.mu
3180     e = e.simplify_indexed();
3181     cout << e << endl;
3182      // -> -D*a\+2*a\
3183     cout << e.subs(D == 4) << endl;
3184      // -> -2*a\
3185     ...
3186 @}
3187 @end example
3188
3189 @cindex @code{dirac_trace()}
3190 To calculate the trace of an expression containing strings of Dirac gammas
3191 you use one of the functions
3192
3193 @example
3194 ex dirac_trace(const ex & e, const std::set<unsigned char> & rls,
3195                const ex & trONE = 4);
3196 ex dirac_trace(const ex & e, const lst & rll, const ex & trONE = 4);
3197 ex dirac_trace(const ex & e, unsigned char rl = 0, const ex & trONE = 4);
3198 @end example
3199
3200 These functions take the trace over all gammas in the specified set @code{rls}
3201 or list @code{rll} of representation labels, or the single label @code{rl};
3202 gammas with other labels are left standing. The last argument to
3203 @code{dirac_trace()} is the value to be returned for the trace of the unity
3204 element, which defaults to 4.
3205
3206 The @code{dirac_trace()} function is a linear functional that is equal to the
3207 ordinary matrix trace only in @math{D = 4} dimensions. In particular, the
3208 functional is not cyclic in
3209 @tex $D \ne 4$
3210 @end tex
3211 @ifnottex
3212 @math{D != 4}
3213 @end ifnottex
3214 dimensions when acting on
3215 expressions containing @samp{gamma5}, so it's not a proper trace. This
3216 @samp{gamma5} scheme is described in greater detail in the article
3217 @cite{The Role of gamma5 in Dimensional Regularization} (@ref{Bibliography}).
3218
3219 The value of the trace itself is also usually different in 4 and in
3220 @tex $D \ne 4$
3221 @end tex
3222 @ifnottex
3223 @math{D != 4}
3224 @end ifnottex
3225 dimensions:
3226
3227 @example
3228 @{
3229     // 4 dimensions
3230     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
3231     ex e = dirac_gamma(mu) * dirac_gamma(nu) *
3232            dirac_gamma(mu.toggle_variance()) * dirac_gamma(rho);
3233     cout << dirac_trace(e).simplify_indexed() << endl;
3234      // -> -8*eta~rho~nu
3235 @}
3236 ...
3237 @{
3238     // D dimensions
3239     symbol D("D");
3240     varidx mu(symbol("mu"), D), nu(symbol("nu"), D), rho(symbol("rho"), D);
3241     ex e = dirac_gamma(mu) * dirac_gamma(nu) *
3242            dirac_gamma(mu.toggle_variance()) * dirac_gamma(rho);
3243     cout << dirac_trace(e).simplify_indexed() << endl;
3244      // -> 8*eta~rho~nu-4*eta~rho~nu*D
3245 @}
3246 @end example
3247
3248 Here is an example for using @code{dirac_trace()} to compute a value that
3249 appears in the calculation of the one-loop vacuum polarization amplitude in
3250 QED:
3251
3252 @example
3253 @{
3254     symbol q("q"), l("l"), m("m"), ldotq("ldotq"), D("D");
3255     varidx mu(symbol("mu"), D), nu(symbol("nu"), D);
3256
3257     scalar_products sp;
3258     sp.add(l, l, pow(l, 2));
3259     sp.add(l, q, ldotq);
3260
3261     ex e = dirac_gamma(mu) *
3262            (dirac_slash(l, D) + dirac_slash(q, D) + m * dirac_ONE()) *    
3263            dirac_gamma(mu.toggle_variance()) *
3264            (dirac_slash(l, D) + m * dirac_ONE());   
3265     e = dirac_trace(e).simplify_indexed(sp);
3266     e = e.collect(lst(l, ldotq, m));
3267     cout << e << endl;
3268      // -> (8-4*D)*l^2+(8-4*D)*ldotq+4*D*m^2
3269 @}
3270 @end example
3271
3272 The @code{canonicalize_clifford()} function reorders all gamma products that
3273 appear in an expression to a canonical (but not necessarily simple) form.
3274 You can use this to compare two expressions or for further simplifications:
3275
3276 @example
3277 @{
3278     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
3279     ex e = dirac_gamma(mu) * dirac_gamma(nu) + dirac_gamma(nu) * dirac_gamma(mu);
3280     cout << e << endl;
3281      // -> gamma~mu*gamma~nu+gamma~nu*gamma~mu
3282
3283     e = canonicalize_clifford(e);
3284     cout << e << endl;
3285      // -> 2*ONE*eta~mu~nu
3286 @}
3287 @end example
3288
3289 @cindex @code{clifford_unit()}
3290 @subsubsection A generic Clifford algebra
3291
3292 A generic Clifford algebra, i.e. a
3293 @tex $2^n$
3294 @end tex
3295 @ifnottex
3296 2^n
3297 @end ifnottex
3298 dimensional algebra with
3299 generators 
3300 @tex $e_k$
3301 @end tex 
3302 @ifnottex
3303 e_k
3304 @end ifnottex
3305 satisfying the identities 
3306 @tex
3307 $e_i e_j + e_j e_i = M(i, j) + M(j, i)$
3308 @end tex
3309 @ifnottex
3310 e~i e~j + e~j e~i = M(i, j) + M(j, i) 
3311 @end ifnottex
3312 for some bilinear form (@code{metric})
3313 @math{M(i, j)}, which may be non-symmetric (see arXiv:math.QA/9911180) 
3314 and contain symbolic entries. Such generators are created by the
3315 function 
3316
3317 @example
3318     ex clifford_unit(const ex & mu, const ex & metr, unsigned char rl = 0);    
3319 @end example
3320
3321 where @code{mu} should be a @code{idx} (or descendant) class object
3322 indexing the generators.
3323 Parameter @code{metr} defines the metric @math{M(i, j)} and can be
3324 represented by a square @code{matrix}, @code{tensormetric} or @code{indexed} class
3325 object. In fact, any expression either with two free indices or without
3326 indices at all is admitted as @code{metr}. In the later case an @code{indexed}
3327 object with two newly created indices with @code{metr} as its
3328 @code{op(0)} will be used.
3329 Optional parameter @code{rl} allows to distinguish different
3330 Clifford algebras, which will commute with each other. 
3331
3332 Note that the call @code{clifford_unit(mu, minkmetric())} creates
3333 something very close to @code{dirac_gamma(mu)}, although
3334 @code{dirac_gamma} have more efficient simplification mechanism. 
3335 @cindex @code{clifford::get_metric()}
3336 The method @code{clifford::get_metric()} returns a metric defining this
3337 Clifford number.
3338
3339 If the matrix @math{M(i, j)} is in fact symmetric you may prefer to create
3340 the Clifford algebra units with a call like that
3341
3342 @example
3343     ex e = clifford_unit(mu, indexed(M, sy_symm(), i, j));
3344 @end example
3345
3346 since this may yield some further automatic simplifications. Again, for a
3347 metric defined through a @code{matrix} such a symmetry is detected
3348 automatically. 
3349
3350 Individual generators of a Clifford algebra can be accessed in several
3351 ways. For example 
3352
3353 @example
3354 @{
3355     ... 
3356     idx i(symbol("i"), 4);
3357     realsymbol s("s");
3358     ex M = diag_matrix(lst(1, -1, 0, s));
3359     ex e = clifford_unit(i, M);
3360     ex e0 = e.subs(i == 0);
3361     ex e1 = e.subs(i == 1);
3362     ex e2 = e.subs(i == 2);
3363     ex e3 = e.subs(i == 3);
3364     ...
3365 @}
3366 @end example
3367
3368 will produce four anti-commuting generators of a Clifford algebra with properties
3369 @tex
3370 $e_0^2=1 $, $e_1^2=-1$,  $e_2^2=0$ and $e_3^2=s$.
3371 @end tex
3372 @ifnottex
3373 @code{pow(e0, 2) = 1}, @code{pow(e1, 2) = -1}, @code{pow(e2, 2) = 0} and
3374 @code{pow(e3, 2) = s}.
3375 @end ifnottex
3376
3377 @cindex @code{lst_to_clifford()}
3378 A similar effect can be achieved from the function
3379
3380 @example
3381     ex lst_to_clifford(const ex & v, const ex & mu,  const ex & metr,
3382                        unsigned char rl = 0);
3383     ex lst_to_clifford(const ex & v, const ex & e);
3384 @end example
3385
3386 which converts a list or vector 
3387 @tex
3388 $v = (v^0, v^1, ..., v^n)$
3389 @end tex
3390 @ifnottex
3391 @samp{v = (v~0, v~1, ..., v~n)} 
3392 @end ifnottex
3393 into the
3394 Clifford number 
3395 @tex
3396 $v^0 e_0 + v^1 e_1 + ... + v^n e_n$
3397 @end tex
3398 @ifnottex
3399 @samp{v~0 e.0 + v~1 e.1 + ... + v~n e.n}
3400 @end ifnottex
3401 with @samp{e.k}
3402 directly supplied in the second form of the procedure. In the first form
3403 the Clifford unit @samp{e.k} is generated by the call of
3404 @code{clifford_unit(mu, metr, rl)}. 
3405 @cindex pseudo-vector
3406 If the number of components supplied
3407 by @code{v} exceeds the dimensionality of the Clifford unit @code{e} by
3408 1 then function @code{lst_to_clifford()} uses the following
3409 pseudo-vector representation: 
3410 @tex
3411 $v^0 {\bf 1} + v^1 e_0 + v^2 e_1 + ... + v^{n+1} e_n$
3412 @end tex
3413 @ifnottex
3414 @samp{v~0 ONE + v~1 e.0 + v~2 e.1 + ... + v~[n+1] e.n}
3415 @end ifnottex
3416
3417 The previous code may be rewritten with the help of @code{lst_to_clifford()} as follows
3418
3419 @example
3420 @{
3421     ...
3422     idx i(symbol("i"), 4);
3423     realsymbol s("s");
3424     ex M = diag_matrix(lst(1, -1, 0, s));
3425     ex e0 = lst_to_clifford(lst(1, 0, 0, 0), i, M);
3426     ex e1 = lst_to_clifford(lst(0, 1, 0, 0), i, M);
3427     ex e2 = lst_to_clifford(lst(0, 0, 1, 0), i, M);
3428     ex e3 = lst_to_clifford(lst(0, 0, 0, 1), i, M);
3429   ...
3430 @}
3431 @end example
3432
3433 @cindex @code{clifford_to_lst()}
3434 There is the inverse function 
3435
3436 @example
3437     lst clifford_to_lst(const ex & e, const ex & c, bool algebraic = true);
3438 @end example
3439
3440 which takes an expression @code{e} and tries to find a list
3441 @tex
3442 $v = (v^0, v^1, ..., v^n)$
3443 @end tex
3444 @ifnottex
3445 @samp{v = (v~0, v~1, ..., v~n)} 
3446 @end ifnottex
3447 such that the expression is either vector 
3448 @tex
3449 $e = v^0 c_0 + v^1 c_1 + ... + v^n c_n$
3450 @end tex
3451 @ifnottex
3452 @samp{e = v~0 c.0 + v~1 c.1 + ... + v~n c.n}
3453 @end ifnottex
3454 or pseudo-vector 
3455 @tex
3456 $v^0 {\bf 1} + v^1 e_0 + v^2 e_1 + ... + v^{n+1} e_n$
3457 @end tex
3458 @ifnottex
3459 @samp{v~0 ONE + v~1 e.0 + v~2 e.1 + ... + v~[n+1] e.n}
3460 @end ifnottex
3461 with respect to the given Clifford units @code{c}. Here none of the
3462 @samp{v~k} should contain Clifford units @code{c} (of course, this
3463 may be impossible). This function can use an @code{algebraic} method
3464 (default) or a symbolic one. With the @code{algebraic} method the
3465 @samp{v~k} are calculated as 
3466 @tex
3467 $(e c_k + c_k e)/c_k^2$. If $c_k^2$
3468 @end tex
3469 @ifnottex
3470 @samp{(e c.k + c.k e)/pow(c.k, 2)}.   If @samp{pow(c.k, 2)} 
3471 @end ifnottex
3472 is zero or is not @code{numeric} for some @samp{k}
3473 then the method will be automatically changed to symbolic. The same effect
3474 is obtained by the assignment (@code{algebraic = false}) in the procedure call.
3475
3476 @cindex @code{clifford_prime()}
3477 @cindex @code{clifford_star()}
3478 @cindex @code{clifford_bar()}
3479 There are several functions for (anti-)automorphisms of Clifford algebras:
3480
3481 @example
3482     ex clifford_prime(const ex & e)
3483     inline ex clifford_star(const ex & e) @{ return e.conjugate(); @}
3484     inline ex clifford_bar(const ex & e) @{ return clifford_prime(e.conjugate()); @}
3485 @end example
3486
3487 The automorphism of a Clifford algebra @code{clifford_prime()} simply
3488 changes signs of all Clifford units in the expression. The reversion
3489 of a Clifford algebra @code{clifford_star()} coincides with the
3490 @code{conjugate()} method and effectively reverses the order of Clifford
3491 units in any product. Finally the main anti-automorphism
3492 of a Clifford algebra @code{clifford_bar()} is the composition of the
3493 previous two, i.e. it makes the reversion and changes signs of all Clifford units
3494 in a product. These functions correspond to the notations
3495 @math{e'},
3496 @tex
3497 $e^*$
3498 @end tex
3499 @ifnottex
3500 e*
3501 @end ifnottex
3502 and
3503 @tex
3504 $\overline{e}$
3505 @end tex
3506 @ifnottex
3507 @code{\bar@{e@}}
3508 @end ifnottex
3509 used in Clifford algebra textbooks.
3510
3511 @cindex @code{clifford_norm()}
3512 The function
3513
3514 @example
3515     ex clifford_norm(const ex & e);
3516 @end example
3517
3518 @cindex @code{clifford_inverse()}
3519 calculates the norm of a Clifford number from the expression
3520 @tex
3521 $||e||^2 = e\overline{e}$.
3522 @end tex
3523 @ifnottex
3524 @code{||e||^2 = e \bar@{e@}}
3525 @end ifnottex
3526  The inverse of a Clifford expression is returned by the function
3527
3528 @example
3529     ex clifford_inverse(const ex & e);
3530 @end example
3531
3532 which calculates it as 
3533 @tex
3534 $e^{-1} = \overline{e}/||e||^2$.
3535 @end tex
3536 @ifnottex
3537 @math{e^@{-1@} = \bar@{e@}/||e||^2}
3538 @end ifnottex
3539  If
3540 @tex
3541 $||e|| = 0$
3542 @end tex
3543 @ifnottex
3544 @math{||e||=0}
3545 @end ifnottex
3546 then an exception is raised.
3547
3548 @cindex @code{remove_dirac_ONE()}
3549 If a Clifford number happens to be a factor of
3550 @code{dirac_ONE()} then we can convert it to a ``real'' (non-Clifford)
3551 expression by the function
3552
3553 @example
3554     ex remove_dirac_ONE(const ex & e);
3555 @end example
3556
3557 @cindex @code{canonicalize_clifford()}
3558 The function @code{canonicalize_clifford()} works for a
3559 generic Clifford algebra in a similar way as for Dirac gammas.
3560
3561 The next provided function is
3562
3563 @cindex @code{clifford_moebius_map()}
3564 @example
3565     ex clifford_moebius_map(const ex & a, const ex & b, const ex & c,
3566                             const ex & d, const ex & v, const ex & G,
3567                             unsigned char rl = 0);
3568     ex clifford_moebius_map(const ex & M, const ex & v, const ex & G,
3569                             unsigned char rl = 0);
3570 @end example 
3571
3572 It takes a list or vector @code{v} and makes the Moebius (conformal or
3573 linear-fractional) transformation @samp{v -> (av+b)/(cv+d)} defined by
3574 the matrix @samp{M = [[a, b], [c, d]]}. The parameter @code{G} defines
3575 the metric of the surrounding (pseudo-)Euclidean space. This can be an
3576 indexed object, tensormetric, matrix or a Clifford unit, in the later
3577 case the optional parameter @code{rl} is ignored even if supplied.
3578 Depending from the type of @code{v} the returned value of this function
3579 is either a vector or a list holding vector's components.
3580
3581 @cindex @code{clifford_max_label()}
3582 Finally the function
3583
3584 @example
3585 char clifford_max_label(const ex & e, bool ignore_ONE = false);
3586 @end example
3587
3588 can detect a presence of Clifford objects in the expression @code{e}: if
3589 such objects are found it returns the maximal
3590 @code{representation_label} of them, otherwise @code{-1}. The optional
3591 parameter @code{ignore_ONE} indicates if @code{dirac_ONE} objects should
3592 be ignored during the search.
3593  
3594 LaTeX output for Clifford units looks like
3595 @code{\clifford[1]@{e@}^@{@{\nu@}@}}, where @code{1} is the
3596 @code{representation_label} and @code{\nu} is the index of the
3597 corresponding unit. This provides a flexible typesetting with a suitable
3598 definition of the @code{\clifford} command. For example, the definition
3599 @example
3600     \newcommand@{\clifford@}[1][]@{@}
3601 @end example
3602 typesets all Clifford units identically, while the alternative definition
3603 @example
3604     \newcommand@{\clifford@}[2][]@{\ifcase #1 #2\or \tilde@{#2@} \or \breve@{#2@} \fi@}
3605 @end example
3606 prints units with @code{representation_label=0} as 
3607 @tex
3608 $e$,
3609 @end tex
3610 @ifnottex
3611 @code{e},
3612 @end ifnottex
3613 with @code{representation_label=1} as 
3614 @tex
3615 $\tilde{e}$
3616 @end tex
3617 @ifnottex
3618 @code{\tilde@{e@}}
3619 @end ifnottex
3620  and with @code{representation_label=2} as 
3621 @tex
3622 $\breve{e}$.
3623 @end tex
3624 @ifnottex
3625 @code{\breve@{e@}}.
3626 @end ifnottex
3627
3628 @cindex @code{color} (class)
3629 @subsection Color algebra
3630
3631 @cindex @code{color_T()}
3632 For computations in quantum chromodynamics, GiNaC implements the base elements
3633 and structure constants of the su(3) Lie algebra (color algebra). The base
3634 elements @math{T_a} are constructed by the function
3635
3636 @example
3637 ex color_T(const ex & a, unsigned char rl = 0);
3638 @end example
3639
3640 which takes two arguments: the index and a @dfn{representation label} in the
3641 range 0 to 255 which is used to distinguish elements of different color
3642 algebras. Objects with different labels commutate with each other. The
3643 dimension of the index must be exactly 8 and it should be of class @code{idx},
3644 not @code{varidx}.
3645
3646 @cindex @code{color_ONE()}
3647 The unity element of a color algebra is constructed by
3648
3649 @example
3650 ex color_ONE(unsigned char rl = 0);
3651 @end example
3652
3653 @strong{Please notice:} You must always use @code{color_ONE()} when referring to
3654 multiples of the unity element, even though it's customary to omit it.
3655 E.g. instead of @code{color_T(a)*(color_T(b)*indexed(X,b)+1)} you have to
3656 write @code{color_T(a)*(color_T(b)*indexed(X,b)+color_ONE())}. Otherwise,
3657 GiNaC may produce incorrect results.
3658
3659 @cindex @code{color_d()}
3660 @cindex @code{color_f()}
3661 The functions
3662
3663 @example
3664 ex color_d(const ex & a, const ex & b, const ex & c);
3665 ex color_f(const ex & a, const ex & b, const ex & c);
3666 @end example
3667
3668 create the symmetric and antisymmetric structure constants @math{d_abc} and
3669 @math{f_abc} which satisfy @math{@{T_a, T_b@} = 1/3 delta_ab + d_abc T_c}
3670 and @math{[T_a, T_b] = i f_abc T_c}.
3671
3672 These functions evaluate to their numerical values,
3673 if you supply numeric indices to them. The index values should be in
3674 the range from 1 to 8, not from 0 to 7. This departure from usual conventions
3675 goes along better with the notations used in physical literature.
3676
3677 @cindex @code{color_h()}
3678 There's an additional function
3679
3680 @example
3681 ex color_h(const ex & a, const ex & b, const ex & c);
3682 @end example
3683
3684 which returns the linear combination @samp{color_d(a, b, c)+I*color_f(a, b, c)}.
3685
3686 The function @code{simplify_indexed()} performs some simplifications on
3687 expressions containing color objects:
3688
3689 @example
3690 @{
3691     ...
3692     idx a(symbol("a"), 8), b(symbol("b"), 8), c(symbol("c"), 8),
3693         k(symbol("k"), 8), l(symbol("l"), 8);
3694
3695     e = color_d(a, b, l) * color_f(a, b, k);
3696     cout << e.simplify_indexed() << endl;
3697      // -> 0
3698
3699     e = color_d(a, b, l) * color_d(a, b, k);
3700     cout << e.simplify_indexed() << endl;
3701      // -> 5/3*delta.k.l
3702
3703     e = color_f(l, a, b) * color_f(a, b, k);
3704     cout << e.simplify_indexed() << endl;
3705      // -> 3*delta.k.l
3706
3707     e = color_h(a, b, c) * color_h(a, b, c);
3708     cout << e.simplify_indexed() << endl;
3709      // -> -32/3
3710
3711     e = color_h(a, b, c) * color_T(b) * color_T(c);
3712     cout << e.simplify_indexed() << endl;
3713      // -> -2/3*T.a
3714
3715     e = color_h(a, b, c) * color_T(a) * color_T(b) * color_T(c);
3716     cout << e.simplify_indexed() << endl;
3717      // -> -8/9*ONE
3718
3719     e = color_T(k) * color_T(a) * color_T(b) * color_T(k);
3720     cout << e.simplify_indexed() << endl;
3721      // -> 1/4*delta.b.a*ONE-1/6*T.a*T.b
3722     ...
3723 @end example
3724
3725 @cindex @code{color_trace()}
3726 To calculate the trace of an expression containing color objects you use one
3727 of the functions
3728
3729 @example
3730 ex color_trace(const ex & e, const std::set<unsigned char> & rls);
3731 ex color_trace(const ex & e, const lst & rll);
3732 ex color_trace(const ex & e, unsigned char rl = 0);
3733 @end example
3734
3735 These functions take the trace over all color @samp{T} objects in the
3736 specified set @code{rls} or list @code{rll} of representation labels, or the
3737 single label @code{rl}; @samp{T}s with other labels are left standing. For
3738 example:
3739
3740 @example
3741     ...
3742     e = color_trace(4 * color_T(a) * color_T(b) * color_T(c));
3743     cout << e << endl;
3744      // -> -I*f.a.c.b+d.a.c.b
3745 @}
3746 @end example
3747
3748
3749 @node Hash maps, Methods and functions, Non-commutative objects, Basic concepts
3750 @c    node-name, next, previous, up
3751 @section Hash Maps
3752 @cindex hash maps
3753 @cindex @code{exhashmap} (class)
3754
3755 For your convenience, GiNaC offers the container template @code{exhashmap<T>}
3756 that can be used as a drop-in replacement for the STL
3757 @code{std::map<ex, T, ex_is_less>}, using hash tables to provide faster,
3758 typically constant-time, element look-up than @code{map<>}.
3759
3760 @code{exhashmap<>} supports all @code{map<>} members and operations, with the
3761 following differences:
3762
3763 @itemize @bullet
3764 @item
3765 no @code{lower_bound()} and @code{upper_bound()} methods
3766 @item
3767 no reverse iterators, no @code{rbegin()}/@code{rend()}
3768 @item 
3769 no @code{operator<(exhashmap, exhashmap)}
3770 @item
3771 the comparison function object @code{key_compare} is hardcoded to
3772 @code{ex_is_less}
3773 @item
3774 the constructor @code{exhashmap(size_t n)} allows specifying the minimum
3775 initial hash table size (the actual table size after construction may be
3776 larger than the specified value)
3777 @item
3778 the method @code{size_t bucket_count()} returns the current size of the hash
3779 table
3780 @item 
3781 @code{insert()} and @code{erase()} operations invalidate all iterators
3782 @end itemize
3783
3784
3785 @node Methods and functions, Information about expressions, Hash maps, Top
3786 @c    node-name, next, previous, up
3787 @chapter Methods and functions
3788 @cindex polynomial
3789
3790 In this chapter the most important algorithms provided by GiNaC will be
3791 described.  Some of them are implemented as functions on expressions,
3792 others are implemented as methods provided by expression objects.  If
3793 they are methods, there exists a wrapper function around it, so you can
3794 alternatively call it in a functional way as shown in the simple
3795 example:
3796
3797 @example
3798     ...
3799     cout << "As method:   " << sin(1).evalf() << endl;
3800     cout << "As function: " << evalf(sin(1)) << endl;
3801     ...
3802 @end example
3803
3804 @cindex @code{subs()}
3805 The general rule is that wherever methods accept one or more parameters
3806 (@var{arg1}, @var{arg2}, @dots{}) the order of arguments the function
3807 wrapper accepts is the same but preceded by the object to act on
3808 (@var{object}, @var{arg1}, @var{arg2}, @dots{}).  This approach is the
3809 most natural one in an OO model but it may lead to confusion for MapleV
3810 users because where they would type @code{A:=x+1; subs(x=2,A);} GiNaC
3811 would require @code{A=x+1; subs(A,x==2);} (after proper declaration of
3812 @code{A} and @code{x}).  On the other hand, since MapleV returns 3 on
3813 @code{A:=x^2+3; coeff(A,x,0);} (GiNaC: @code{A=pow(x,2)+3;
3814 coeff(A,x,0);}) it is clear that MapleV is not trying to be consistent
3815 here.  Also, users of MuPAD will in most cases feel more comfortable
3816 with GiNaC's convention.  All function wrappers are implemented
3817 as simple inline functions which just call the corresponding method and
3818 are only provided for users uncomfortable with OO who are dead set to
3819 avoid method invocations.  Generally, nested function wrappers are much
3820 harder to read than a sequence of methods and should therefore be
3821 avoided if possible.  On the other hand, not everything in GiNaC is a
3822 method on class @code{ex} and sometimes calling a function cannot be
3823 avoided.
3824
3825 @menu
3826 * Information about expressions::
3827 * Numerical evaluation::
3828 * Substituting expressions::
3829 * Pattern matching and advanced substitutions::
3830 * Applying a function on subexpressions::
3831 * Visitors and tree traversal::
3832 * Polynomial arithmetic::           Working with polynomials.
3833 * Rational expressions::            Working with rational functions.
3834 * Symbolic differentiation::
3835 * Series expansion::                Taylor and Laurent expansion.
3836 * Symmetrization::
3837 * Built-in functions::              List of predefined mathematical functions.
3838 * Multiple polylogarithms::
3839 * Complex expressions::
3840 * Solving linear systems of equations::
3841 * Input/output::                    Input and output of expressions.
3842 @end menu
3843
3844
3845 @node Information about expressions, Numerical evaluation, Methods and functions, Methods and functions
3846 @c    node-name, next, previous, up
3847 @section Getting information about expressions
3848
3849 @subsection Checking expression types
3850 @cindex @code{is_a<@dots{}>()}
3851 @cindex @code{is_exactly_a<@dots{}>()}
3852 @cindex @code{ex_to<@dots{}>()}
3853 @cindex Converting @code{ex} to other classes
3854 @cindex @code{info()}
3855 @cindex @code{return_type()}
3856 @cindex @code{return_type_tinfo()}
3857
3858 Sometimes it's useful to check whether a given expression is a plain number,
3859 a sum, a polynomial with integer coefficients, or of some other specific type.
3860 GiNaC provides a couple of functions for this:
3861
3862 @example
3863 bool is_a<T>(const ex & e);
3864 bool is_exactly_a<T>(const ex & e);
3865 bool ex::info(unsigned flag);
3866 unsigned ex::return_type() const;
3867 unsigned ex::return_type_tinfo() const;
3868 @end example
3869
3870 When the test made by @code{is_a<T>()} returns true, it is safe to call
3871 one of the functions @code{ex_to<T>()}, where @code{T} is one of the
3872 class names (@xref{The class hierarchy}, for a list of all classes). For
3873 example, assuming @code{e} is an @code{ex}:
3874
3875 @example
3876 @{
3877     @dots{}
3878     if (is_a<numeric>(e))
3879         numeric n = ex_to<numeric>(e);
3880     @dots{}
3881 @}
3882 @end example
3883
3884 @code{is_a<T>(e)} allows you to check whether the top-level object of
3885 an expression @samp{e} is an instance of the GiNaC class @samp{T}
3886 (@xref{The class hierarchy}, for a list of all classes). This is most useful,
3887 e.g., for checking whether an expression is a number, a sum, or a product:
3888
3889 @example
3890 @{
3891     symbol x("x");
3892     ex e1 = 42;
3893     ex e2 = 4*x - 3;
3894     is_a<numeric>(e1);  // true
3895     is_a<numeric>(e2);  // false
3896     is_a<add>(e1);      // false
3897     is_a<add>(e2);      // true
3898     is_a<mul>(e1);      // false
3899     is_a<mul>(e2);      // false
3900 @}
3901 @end example
3902
3903 In contrast, @code{is_exactly_a<T>(e)} allows you to check whether the
3904 top-level object of an expression @samp{e} is an instance of the GiNaC
3905 class @samp{T}, not including parent classes.
3906
3907 The @code{info()} method is used for checking certain attributes of
3908 expressions. The possible values for the @code{flag} argument are defined
3909 in @file{ginac/flags.h}, the most important being explained in the following
3910 table:
3911
3912 @cartouche
3913 @multitable @columnfractions .30 .70
3914 @item @strong{Flag} @tab @strong{Returns true if the object is@dots{}}
3915 @item @code{numeric}
3916 @tab @dots{}a number (same as @code{is_a<numeric>(...)})
3917 @item @code{real}
3918 @tab @dots{}a real number, symbol or constant (i.e. is not complex)
3919 @item @code{rational}
3920 @tab @dots{}an exact rational number (integers are rational, too)
3921 @item @code{integer}
3922 @tab @dots{}a (non-complex) integer
3923 @item @code{crational}
3924 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
3925 @item @code{cinteger}
3926 @tab @dots{}a (complex) integer (such as @math{2-3*I})
3927 @item @code{positive}
3928 @tab @dots{}not complex and greater than 0
3929 @item @code{negative}
3930 @tab @dots{}not complex and less than 0
3931 @item @code{nonnegative}
3932 @tab @dots{}not complex and greater than or equal to 0
3933 @item @code{posint}
3934 @tab @dots{}an integer greater than 0
3935 @item @code{negint}
3936 @tab @dots{}an integer less than 0
3937 @item @code{nonnegint}
3938 @tab @dots{}an integer greater than or equal to 0
3939 @item @code{even}
3940 @tab @dots{}an even integer
3941 @item @code{odd}
3942 @tab @dots{}an odd integer
3943 @item @code{prime}
3944 @tab @dots{}a prime integer (probabilistic primality test)
3945 @item @code{relation}
3946 @tab @dots{}a relation (same as @code{is_a<relational>(...)})
3947 @item @code{relation_equal}
3948 @tab @dots{}a @code{==} relation
3949 @item @code{relation_not_equal}
3950 @tab @dots{}a @code{!=} relation
3951 @item @code{relation_less}
3952 @tab @dots{}a @code{<} relation
3953 @item @code{relation_less_or_equal}
3954 @tab @dots{}a @code{<=} relation
3955 @item @code{relation_greater}
3956 @tab @dots{}a @code{>} relation
3957 @item @code{relation_greater_or_equal}
3958 @tab @dots{}a @code{>=} relation
3959 @item @code{symbol}
3960 @tab @dots{}a symbol (same as @code{is_a<symbol>(...)})
3961 @item @code{list}
3962 @tab @dots{}a list (same as @code{is_a<lst>(...)})
3963 @item @code{polynomial}
3964 @tab @dots{}a polynomial (i.e. only consists of sums and products of numbers and symbols with positive integer powers)
3965 @item @code{integer_polynomial}
3966 @tab @dots{}a polynomial with (non-complex) integer coefficients
3967 @item @code{cinteger_polynomial}
3968 @tab @dots{}a polynomial with (possibly complex) integer coefficients (such as @math{2-3*I})
3969 @item @code{rational_polynomial}
3970 @tab @dots{}a polynomial with (non-complex) rational coefficients
3971 @item @code{crational_polynomial}
3972 @tab @dots{}a polynomial with (possibly complex) rational coefficients (such as @math{2/3+7/2*I})
3973 @item @code{rational_function}
3974 @tab @dots{}a rational function (@math{x+y}, @math{z/(x+y)})
3975 @item @code{algebraic}
3976 @tab @dots{}an algebraic object (@math{sqrt(2)}, @math{sqrt(x)-1})
3977 @end multitable
3978 @end cartouche
3979
3980 To determine whether an expression is commutative or non-commutative and if
3981 so, with which other expressions it would commutate, you use the methods
3982 @code{return_type()} and @code{return_type_tinfo()}. @xref{Non-commutative objects},
3983 for an explanation of these.
3984
3985
3986 @subsection Accessing subexpressions
3987 @cindex container
3988
3989 Many GiNaC classes, like @code{add}, @code{mul}, @code{lst}, and
3990 @code{function}, act as containers for subexpressions. For example, the
3991 subexpressions of a sum (an @code{add} object) are the individual terms,
3992 and the subexpressions of a @code{function} are the function's arguments.
3993
3994 @cindex @code{nops()}
3995 @cindex @code{op()}
3996 GiNaC provides several ways of accessing subexpressions. The first way is to
3997 use the two methods
3998
3999 @example
4000 size_t ex::nops();
4001 ex ex::op(size_t i);
4002 @end example
4003
4004 @code{nops()} determines the number of subexpressions (operands) contained
4005 in the expression, while @code{op(i)} returns the @code{i}-th
4006 (0..@code{nops()-1}) subexpression. In the case of a @code{power} object,
4007 @code{op(0)} will return the basis and @code{op(1)} the exponent. For
4008 @code{indexed} objects, @code{op(0)} is the base expression and @code{op(i)},
4009 @math{i>0} are the indices.
4010
4011 @cindex iterators
4012 @cindex @code{const_iterator}
4013 The second way to access subexpressions is via the STL-style random-access
4014 iterator class @code{const_iterator} and the methods
4015
4016 @example
4017 const_iterator ex::begin();
4018 const_iterator ex::end();
4019 @end example
4020
4021 @code{begin()} returns an iterator referring to the first subexpression;
4022 @code{end()} returns an iterator which is one-past the last subexpression.
4023 If the expression has no subexpressions, then @code{begin() == end()}. These
4024 iterators can also be used in conjunction with non-modifying STL algorithms.
4025
4026 Here is an example that (non-recursively) prints the subexpressions of a
4027 given expression in three different ways:
4028
4029 @example
4030 @{
4031     ex e = ...
4032
4033     // with nops()/op()
4034     for (size_t i = 0; i != e.nops(); ++i)
4035         cout << e.op(i) << endl;
4036
4037     // with iterators
4038     for (const_iterator i = e.begin(); i != e.end(); ++i)
4039         cout << *i << endl;
4040
4041     // with iterators and STL copy()
4042     std::copy(e.begin(), e.end(), std::ostream_iterator<ex>(cout, "\n"));
4043 @}
4044 @end example
4045
4046 @cindex @code{const_preorder_iterator}
4047 @cindex @code{const_postorder_iterator}
4048 @code{op()}/@code{nops()} and @code{const_iterator} only access an
4049 expression's immediate children. GiNaC provides two additional iterator
4050 classes, @code{const_preorder_iterator} and @code{const_postorder_iterator},
4051 that iterate over all objects in an expression tree, in preorder or postorder,
4052 respectively. They are STL-style forward iterators, and are created with the
4053 methods
4054
4055 @example
4056 const_preorder_iterator ex::preorder_begin();
4057 const_preorder_iterator ex::preorder_end();
4058 const_postorder_iterator ex::postorder_begin();
4059 const_postorder_iterator ex::postorder_end();
4060 @end example
4061
4062 The following example illustrates the differences between
4063 @code{const_iterator}, @code{const_preorder_iterator}, and
4064 @code{const_postorder_iterator}:
4065
4066 @example
4067 @{
4068     symbol A("A"), B("B"), C("C");
4069     ex e = lst(lst(A, B), C);
4070
4071     std::copy(e.begin(), e.end(),
4072               std::ostream_iterator<ex>(cout, "\n"));
4073     // @{A,B@}
4074     // C
4075
4076     std::copy(e.preorder_begin(), e.preorder_end(),
4077               std::ostream_iterator<ex>(cout, "\n"));
4078     // @{@{A,B@},C@}
4079     // @{A,B@}
4080     // A
4081     // B
4082     // C
4083
4084     std::copy(e.postorder_begin(), e.postorder_end(),
4085               std::ostream_iterator<ex>(cout, "\n"));
4086     // A
4087     // B
4088     // @{A,B@}
4089     // C
4090     // @{@{A,B@},C@}
4091 @}
4092 @end example
4093
4094 @cindex @code{relational} (class)
4095 Finally, the left-hand side and right-hand side expressions of objects of
4096 class @code{relational} (and only of these) can also be accessed with the
4097 methods
4098
4099 @example
4100 ex ex::lhs();
4101 ex ex::rhs();
4102 @end example
4103
4104
4105 @subsection Comparing expressions
4106 @cindex @code{is_equal()}
4107 @cindex @code{is_zero()}
4108
4109 Expressions can be compared with the usual C++ relational operators like
4110 @code{==}, @code{>}, and @code{<} but if the expressions contain symbols,
4111 the result is usually not determinable and the result will be @code{false},
4112 except in the case of the @code{!=} operator. You should also be aware that
4113 GiNaC will only do the most trivial test for equality (subtracting both
4114 expressions), so something like @code{(pow(x,2)+x)/x==x+1} will return
4115 @code{false}.
4116
4117 Actually, if you construct an expression like @code{a == b}, this will be
4118 represented by an object of the @code{relational} class (@pxref{Relations})
4119 which is not evaluated until (explicitly or implicitly) cast to a @code{bool}.
4120
4121 There are also two methods
4122
4123 @example
4124 bool ex::is_equal(const ex & other);
4125 bool ex::is_zero();
4126 @end example
4127
4128 for checking whether one expression is equal to another, or equal to zero,
4129 respectively. See also the method @code{ex::is_zero_matrix()}, 
4130 @pxref{Matrices}. 
4131
4132
4133 @subsection Ordering expressions
4134 @cindex @code{ex_is_less} (class)
4135 @cindex @code{ex_is_equal} (class)
4136 @cindex @code{compare()}
4137
4138 Sometimes it is necessary to establish a mathematically well-defined ordering
4139 on a set of arbitrary expressions, for example to use expressions as keys
4140 in a @code{std::map<>} container, or to bring a vector of expressions into
4141 a canonical order (which is done internally by GiNaC for sums and products).
4142
4143 The operators @code{<}, @code{>} etc. described in the last section cannot
4144 be used for this, as they don't implement an ordering relation in the
4145 mathematical sense. In particular, they are not guaranteed to be
4146 antisymmetric: if @samp{a} and @samp{b} are different expressions, and
4147 @code{a < b} yields @code{false}, then @code{b < a} doesn't necessarily
4148 yield @code{true}.
4149
4150 By default, STL classes and algorithms use the @code{<} and @code{==}
4151 operators to compare objects, which are unsuitable for expressions, but GiNaC
4152 provides two functors that can be supplied as proper binary comparison
4153 predicates to the STL:
4154
4155 @example
4156 class ex_is_less : public std::binary_function<ex, ex, bool> @{
4157 public:
4158     bool operator()(const ex &lh, const ex &rh) const;
4159 @};
4160
4161 class ex_is_equal : public std::binary_function<ex, ex, bool> @{
4162 public:
4163     bool operator()(const ex &lh, const ex &rh) const;
4164 @};
4165 @end example
4166
4167 For example, to define a @code{map} that maps expressions to strings you
4168 have to use
4169
4170 @example
4171 std::map<ex, std::string, ex_is_less> myMap;
4172 @end example
4173
4174 Omitting the @code{ex_is_less} template parameter will introduce spurious
4175 bugs because the map operates improperly.
4176
4177 Other examples for the use of the functors:
4178
4179 @example
4180 std::vector<ex> v;
4181 // fill vector
4182 ...
4183
4184 // sort vector
4185 std::sort(v.begin(), v.end(), ex_is_less());
4186
4187 // count the number of expressions equal to '1'
4188 unsigned num_ones = std::count_if(v.begin(), v.end(),
4189                                   std::bind2nd(ex_is_equal(), 1));
4190 @end example
4191
4192 The implementation of @code{ex_is_less} uses the member function
4193
4194 @example
4195 int ex::compare(const ex & other) const;
4196 @end example
4197
4198 which returns @math{0} if @code{*this} and @code{other} are equal, @math{-1}
4199 if @code{*this} sorts before @code{other}, and @math{1} if @code{*this} sorts
4200 after @code{other}.
4201
4202
4203 @node Numerical evaluation, Substituting expressions, Information about expressions, Methods and functions
4204 @c    node-name, next, previous, up
4205 @section Numerical evaluation
4206 @cindex @code{evalf()}
4207
4208 GiNaC keeps algebraic expressions, numbers and constants in their exact form.
4209 To evaluate them using floating-point arithmetic you need to call
4210
4211 @example
4212 ex ex::evalf(int level = 0) const;
4213 @end example
4214
4215 @cindex @code{Digits}
4216 The accuracy of the evaluation is controlled by the global object @code{Digits}
4217 which can be assigned an integer value. The default value of @code{Digits}
4218 is 17. @xref{Numbers}, for more information and examples.
4219
4220 To evaluate an expression to a @code{double} floating-point number you can
4221 call @code{evalf()} followed by @code{numeric::to_double()}, like this:
4222
4223 @example
4224 @{
4225     // Approximate sin(x/Pi)
4226     symbol x("x");
4227     ex e = series(sin(x/Pi), x == 0, 6);
4228
4229     // Evaluate numerically at x=0.1
4230     ex f = evalf(e.subs(x == 0.1));
4231
4232     // ex_to<numeric> is an unsafe cast, so check the type first
4233     if (is_a<numeric>(f)) @{
4234         double d = ex_to<numeric>(f).to_double();
4235         cout << d << endl;
4236          // -> 0.0318256
4237     @} else
4238         // error
4239 @}
4240 @end example
4241
4242
4243 @node Substituting expressions, Pattern matching and advanced substitutions, Numerical evaluation, Methods and functions
4244 @c    node-name, next, previous, up
4245 @section Substituting expressions
4246 @cindex @code{subs()}
4247
4248 Algebraic objects inside expressions can be replaced with arbitrary
4249 expressions via the @code{.subs()} method:
4250
4251 @example
4252 ex ex::subs(const ex & e, unsigned options = 0);
4253 ex ex::subs(const exmap & m, unsigned options = 0);
4254 ex ex::subs(const lst & syms, const lst & repls, unsigned options = 0);
4255 @end example
4256
4257 In the first form, @code{subs()} accepts a relational of the form
4258 @samp{object == expression} or a @code{lst} of such relationals:
4259
4260 @example
4261 @{
4262     symbol x("x"), y("y");
4263
4264     ex e1 = 2*x^2-4*x+3;
4265     cout << "e1(7) = " << e1.subs(x == 7) << endl;
4266      // -> 73
4267
4268     ex e2 = x*y + x;
4269     cout << "e2(-2, 4) = " << e2.subs(lst(x == -2, y == 4)) << endl;
4270      // -> -10
4271 @}
4272 @end example
4273
4274 If you specify multiple substitutions, they are performed in parallel, so e.g.
4275 @code{subs(lst(x == y, y == x))} exchanges @samp{x} and @samp{y}.
4276
4277 The second form of @code{subs()} takes an @code{exmap} object which is a
4278 pair associative container that maps expressions to expressions (currently
4279 implemented as a @code{std::map}). This is the most efficient one of the
4280 three @code{subs()} forms and should be used when the number of objects to
4281 be substituted is large or unknown.
4282
4283 Using this form, the second example from above would look like this:
4284
4285 @example
4286 @{
4287     symbol x("x"), y("y");
4288     ex e2 = x*y + x;
4289
4290     exmap m;
4291     m[x] = -2;
4292     m[y] = 4;
4293     cout << "e2(-2, 4) = " << e2.subs(m) << endl;
4294 @}
4295 @end example
4296
4297 The third form of @code{subs()} takes two lists, one for the objects to be
4298 replaced and one for the expressions to be substituted (both lists must
4299 contain the same number of elements). Using this form, you would write
4300
4301 @example
4302 @{
4303     symbol x("x"), y("y");
4304     ex e2 = x*y + x;
4305
4306     cout << "e2(-2, 4) = " << e2.subs(lst(x, y), lst(-2, 4)) << endl;
4307 @}
4308 @end example
4309
4310 The optional last argument to @code{subs()} is a combination of
4311 @code{subs_options} flags. There are three options available:
4312 @code{subs_options::no_pattern} disables pattern matching, which makes
4313 large @code{subs()} operations significantly faster if you are not using
4314 patterns. The second option, @code{subs_options::algebraic} enables
4315 algebraic substitutions in products and powers.
4316 @xref{Pattern matching and advanced substitutions}, for more information
4317 about patterns and algebraic substitutions. The third option,
4318 @code{subs_options::no_index_renaming} disables the feature that dummy
4319 indices are renamed if the substitution could give a result in which a
4320 dummy index occurs more than two times. This is sometimes necessary if
4321 you want to use @code{subs()} to rename your dummy indices.
4322
4323 @code{subs()} performs syntactic substitution of any complete algebraic
4324 object; it does not try to match sub-expressions as is demonstrated by the
4325 following example:
4326
4327 @example
4328 @{
4329     symbol x("x"), y("y"), z("z");
4330
4331     ex e1 = pow(x+y, 2);
4332     cout << e1.subs(x+y == 4) << endl;
4333      // -> 16
4334
4335     ex e2 = sin(x)*sin(y)*cos(x);
4336     cout << e2.subs(sin(x) == cos(x)) << endl;
4337      // -> cos(x)^2*sin(y)
4338
4339     ex e3 = x+y+z;
4340     cout << e3.subs(x+y == 4) << endl;
4341      // -> x+y+z
4342      // (and not 4+z as one might expect)
4343 @}
4344 @end example
4345
4346 A more powerful form of substitution using wildcards is described in the
4347 next section.
4348
4349
4350 @node Pattern matching and advanced substitutions, Applying a function on subexpressions, Substituting expressions, Methods and functions
4351 @c    node-name, next, previous, up
4352 @section Pattern matching and advanced substitutions
4353 @cindex @code{wildcard} (class)
4354 @cindex Pattern matching
4355
4356 GiNaC allows the use of patterns for checking whether an expression is of a
4357 certain form or contains subexpressions of a certain form, and for
4358 substituting expressions in a more general way.
4359
4360 A @dfn{pattern} is an algebraic expression that optionally contains wildcards.
4361 A @dfn{wildcard} is a special kind of object (of class @code{wildcard}) that
4362 represents an arbitrary expression. Every wildcard has a @dfn{label} which is
4363 an unsigned integer number to allow having multiple different wildcards in a
4364 pattern. Wildcards are printed as @samp{$label} (this is also the way they
4365 are specified in @command{ginsh}). In C++ code, wildcard objects are created
4366 with the call
4367
4368 @example
4369 ex wild(unsigned label = 0);
4370 @end example
4371
4372 which is simply a wrapper for the @code{wildcard()} constructor with a shorter
4373 name.
4374
4375 Some examples for patterns:
4376
4377 @multitable @columnfractions .5 .5
4378 @item @strong{Constructed as} @tab @strong{Output as}
4379 @item @code{wild()} @tab @samp{$0}
4380 @item @code{pow(x,wild())} @tab @samp{x^$0}
4381 @item @code{atan2(wild(1),wild(2))} @tab @samp{atan2($1,$2)}
4382 @item @code{indexed(A,idx(wild(),3))} @tab @samp{A.$0}
4383 @end multitable
4384
4385 Notes:
4386
4387 @itemize @bullet
4388 @item Wildcards behave like symbols and are subject to the same algebraic
4389   rules. E.g., @samp{$0+2*$0} is automatically transformed to @samp{3*$0}.
4390 @item As shown in the last example, to use wildcards for indices you have to
4391   use them as the value of an @code{idx} object. This is because indices must
4392   always be of class @code{idx} (or a subclass).
4393 @item Wildcards only represent expressions or subexpressions. It is not
4394   possible to use them as placeholders for other properties like index
4395   dimension or variance, representation labels, symmetry of indexed objects
4396   etc.
4397 @item Because wildcards are commutative, it is not possible to use wildcards
4398   as part of noncommutative products.
4399 @item A pattern does not have to contain wildcards. @samp{x} and @samp{x+y}
4400   are also valid patterns.
4401 @end itemize
4402
4403 @subsection Matching expressions
4404 @cindex @code{match()}
4405 The most basic application of patterns is to check whether an expression
4406 matches a given pattern. This is done by the function
4407
4408 @example
4409 bool ex::match(const ex & pattern);
4410 bool ex::match(const ex & pattern, lst & repls);
4411 @end example
4412
4413 This function returns @code{true} when the expression matches the pattern
4414 and @code{false} if it doesn't. If used in the second form, the actual
4415 subexpressions matched by the wildcards get returned in the @code{repls}
4416 object as a list of relations of the form @samp{wildcard == expression}.
4417 If @code{match()} returns false, the state of @code{repls} is undefined.
4418 For reproducible results, the list should be empty when passed to
4419 @code{match()}, but it is also possible to find similarities in multiple
4420 expressions by passing in the result of a previous match.
4421
4422 The matching algorithm works as follows:
4423
4424 @itemize
4425 @item A single wildcard matches any expression. If one wildcard appears
4426   multiple times in a pattern, it must match the same expression in all
4427   places (e.g. @samp{$0} matches anything, and @samp{$0*($0+1)} matches
4428   @samp{x*(x+1)} but not @samp{x*(y+1)}).
4429 @item If the expression is not of the same class as the pattern, the match
4430   fails (i.e. a sum only matches a sum, a function only matches a function,
4431   etc.).
4432 @item If the pattern is a function, it only matches the same function
4433   (i.e. @samp{sin($0)} matches @samp{sin(x)} but doesn't match @samp{exp(x)}).
4434 @item Except for sums and products, the match fails if the number of
4435   subexpressions (@code{nops()}) is not equal to the number of subexpressions
4436   of the pattern.
4437 @item If there are no subexpressions, the expressions and the pattern must
4438   be equal (in the sense of @code{is_equal()}).
4439 @item Except for sums and products, each subexpression (@code{op()}) must
4440   match the corresponding subexpression of the pattern.
4441 @end itemize
4442
4443 Sums (@code{add}) and products (@code{mul}) are treated in a special way to
4444 account for their commutativity and associativity:
4445
4446 @itemize
4447 @item If the pattern contains a term or factor that is a single wildcard,
4448   this one is used as the @dfn{global wildcard}. If there is more than one
4449   such wildcard, one of them is chosen as the global wildcard in a random
4450   way.
4451 @item Every term/factor of the pattern, except the global wildcard, is
4452   matched against every term of the expression in sequence. If no match is
4453   found, the whole match fails. Terms that did match are not considered in
4454   further matches.
4455 @item If there are no unmatched terms left, the match succeeds. Otherwise
4456   the match fails unless there is a global wildcard in the pattern, in
4457   which case this wildcard matches the remaining terms.
4458 @end itemize
4459
4460 In general, having more than one single wildcard as a term of a sum or a
4461 factor of a product (such as @samp{a+$0+$1}) will lead to unpredictable or
4462 ambiguous results.
4463
4464 Here are some examples in @command{ginsh} to demonstrate how it works (the
4465 @code{match()} function in @command{ginsh} returns @samp{FAIL} if the
4466 match fails, and the list of wildcard replacements otherwise):
4467
4468 @example
4469 > match((x+y)^a,(x+y)^a);
4470 @{@}
4471 > match((x+y)^a,(x+y)^b);
4472 FAIL
4473 > match((x+y)^a,$1^$2);
4474 @{$1==x+y,$2==a@}
4475 > match((x+y)^a,$1^$1);
4476 FAIL
4477 > match((x+y)^(x+y),$1^$1);
4478 @{$1==x+y@}
4479 > match((x+y)^(x+y),$1^$2);
4480 @{$1==x+y,$2==x+y@}
4481 > match((a+b)*(a+c),($1+b)*($1+c));
4482 @{$1==a@}
4483 > match((a+b)*(a+c),(a+$1)*(a+$2));
4484 @{$1==b,$2==c@}
4485   (Unpredictable. The result might also be [$1==c,$2==b].)
4486 > match((a+b)*(a+c),($1+$2)*($1+$3));
4487   (The result is undefined. Due to the sequential nature of the algorithm
4488    and the re-ordering of terms in GiNaC, the match for the first factor
4489    may be @{$1==a,$2==b@} in which case the match for the second factor
4490    succeeds, or it may be @{$1==b,$2==a@} which causes the second match to
4491    fail.)
4492 > match(a*(x+y)+a*z+b,a*$1+$2);
4493   (This is also ambiguous and may return either @{$1==z,$2==a*(x+y)+b@} or
4494    @{$1=x+y,$2=a*z+b@}.)
4495 > match(a+b+c+d+e+f,c);
4496 FAIL
4497 > match(a+b+c+d+e+f,c+$0);
4498 @{$0==a+e+b+f+d@}
4499 > match(a+b+c+d+e+f,c+e+$0);
4500 @{$0==a+b+f+d@}
4501 > match(a+b,a+b+$0);
4502 @{$0==0@}
4503 > match(a*b^2,a^$1*b^$2);
4504 FAIL
4505   (The matching is syntactic, not algebraic, and "a" doesn't match "a^$1"
4506    even though a==a^1.)
4507 > match(x*atan2(x,x^2),$0*atan2($0,$0^2));
4508 @{$0==x@}
4509 > match(atan2(y,x^2),atan2(y,$0));
4510 @{$0==x^2@}
4511 @end example
4512
4513 @subsection Matching parts of expressions
4514 @cindex @code{has()}
4515 A more general way to look for patterns in expressions is provided by the
4516 member function
4517
4518 @example
4519 bool ex::has(const ex & pattern);
4520 @end example
4521
4522 This function checks whether a pattern is matched by an expression itself or
4523 by any of its subexpressions.
4524
4525 Again some examples in @command{ginsh} for illustration (in @command{ginsh},
4526 @code{has()} returns @samp{1} for @code{true} and @samp{0} for @code{false}):
4527
4528 @example
4529 > has(x*sin(x+y+2*a),y);
4530 1
4531 > has(x*sin(x+y+2*a),x+y);
4532 0
4533   (This is because in GiNaC, "x+y" is not a subexpression of "x+y+2*a" (which
4534    has the subexpressions "x", "y" and "2*a".)
4535 > has(x*sin(x+y+2*a),x+y+$1);
4536 1
4537   (But this is possible.)
4538 > has(x*sin(2*(x+y)+2*a),x+y);
4539 0
4540   (This fails because "2*(x+y)" automatically gets converted to "2*x+2*y" of
4541    which "x+y" is not a subexpression.)
4542 > has(x+1,x^$1);
4543 0
4544   (Although x^1==x and x^0==1, neither "x" nor "1" are actually of the form
4545    "x^something".)
4546 > has(4*x^2-x+3,$1*x);
4547 1
4548 > has(4*x^2+x+3,$1*x);
4549 0
4550   (Another possible pitfall. The first expression matches because the term
4551    "-x" has the form "(-1)*x" in GiNaC. To check whether a polynomial
4552    contains a linear term you should use the coeff() function instead.)
4553 @end example
4554
4555 @cindex @code{find()}
4556 The method
4557
4558 @example
4559 bool ex::find(const ex & pattern, lst & found);
4560 @end example
4561
4562 works a bit like @code{has()} but it doesn't stop upon finding the first
4563 match. Instead, it appends all found matches to the specified list. If there
4564 are multiple occurrences of the same expression, it is entered only once to
4565 the list. @code{find()} returns false if no matches were found (in
4566 @command{ginsh}, it returns an empty list):
4567
4568 @example
4569 > find(1+x+x^2+x^3,x);
4570 @{x@}
4571 > find(1+x+x^2+x^3,y);
4572 @{@}
4573 > find(1+x+x^2+x^3,x^$1);
4574 @{x^3,x^2@}
4575   (Note the absence of "x".)
4576 > expand((sin(x)+sin(y))*(a+b));
4577 sin(y)*a+sin(x)*b+sin(x)*a+sin(y)*b
4578 > find(%,sin($1));
4579 @{sin(y),sin(x)@}
4580 @end example
4581
4582 @subsection Substituting expressions
4583 @cindex @code{subs()}
4584 Probably the most useful application of patterns is to use them for
4585 substituting expressions with the @code{subs()} method. Wildcards can be
4586 used in the search patterns as well as in the replacement expressions, where
4587 they get replaced by the expressions matched by them. @code{subs()} doesn't
4588 know anything about algebra; it performs purely syntactic substitutions.
4589
4590 Some examples:
4591
4592 @example
4593 > subs(a^2+b^2+(x+y)^2,$1^2==$1^3);
4594 b^3+a^3+(x+y)^3
4595 > subs(a^4+b^4+(x+y)^4,$1^2==$1^3);
4596 b^4+a^4+(x+y)^4
4597 > subs((a+b+c)^2,a+b==x);
4598 (a+b+c)^2
4599 > subs((a+b+c)^2,a+b+$1==x+$1);
4600 (x+c)^2
4601 > subs(a+2*b,a+b==x);
4602 a+2*b
4603 > subs(4*x^3-2*x^2+5*x-1,x==a);
4604 -1+5*a-2*a^2+4*a^3
4605 > subs(4*x^3-2*x^2+5*x-1,x^$0==a^$0);
4606 -1+5*x-2*a^2+4*a^3
4607 > subs(sin(1+sin(x)),sin($1)==cos($1));
4608 cos(1+cos(x))
4609 > expand(subs(a*sin(x+y)^2+a*cos(x+y)^2+b,cos($1)^2==1-sin($1)^2));
4610 a+b
4611 @end example
4612
4613 The last example would be written in C++ in this way:
4614
4615 @example
4616 @{
4617     symbol a("a"), b("b"), x("x"), y("y");
4618     e = a*pow(sin(x+y), 2) + a*pow(cos(x+y), 2) + b;
4619     e = e.subs(pow(cos(wild()), 2) == 1-pow(sin(wild()), 2));
4620     cout << e.expand() << endl;
4621      // -> a+b
4622 @}
4623 @end example
4624
4625 @subsection The option algebraic
4626 Both @code{has()} and @code{subs()} take an optional argument to pass them
4627 extra options. This section describes what happens if you give the former
4628 the option @code{has_options::algebraic} or the latter
4629 @code{subs_options::algebraic}. In that case the matching condition for
4630 powers and multiplications is changed in such a way that they become
4631 more intuitive. Intuition says that @code{x*y} is a part of @code{x*y*z}.
4632 If you use these options you will find that
4633 @code{(x*y*z).has(x*y, has_options::algebraic)} indeed returns true.
4634 Besides matching some of the factors of a product also powers match as
4635 often as is possible without getting negative exponents. For example
4636 @code{(x^5*y^2*z).subs(x^2*y^2==c, subs_options::algebraic)} will return
4637 @code{x*c^2*z}. This also works with negative powers:
4638 @code{(x^(-3)*y^(-2)*z).subs(1/(x*y)==c, subs_options::algebraic)} will
4639 return @code{x^(-1)*c^2*z}. 
4640
4641 @strong{Note:} this only works for multiplications
4642 and not for locating @code{x+y} within @code{x+y+z}.
4643
4644
4645 @node Applying a function on subexpressions, Visitors and tree traversal, Pattern matching and advanced substitutions, Methods and functions
4646 @c    node-name, next, previous, up
4647 @section Applying a function on subexpressions
4648 @cindex tree traversal
4649 @cindex @code{map()}
4650
4651 Sometimes you may want to perform an operation on specific parts of an
4652 expression while leaving the general structure of it intact. An example
4653 of this would be a matrix trace operation: the trace of a sum is the sum
4654 of the traces of the individual terms. That is, the trace should @dfn{map}
4655 on the sum, by applying itself to each of the sum's operands. It is possible
4656 to do this manually which usually results in code like this:
4657
4658 @example
4659 ex calc_trace(ex e)
4660 @{
4661     if (is_a<matrix>(e))
4662         return ex_to<matrix>(e).trace();
4663     else if (is_a<add>(e)) @{
4664         ex sum = 0;
4665         for (size_t i=0; i<e.nops(); i++)
4666             sum += calc_trace(e.op(i));
4667         return sum;
4668     @} else if (is_a<mul>)(e)) @{
4669         ...
4670     @} else @{
4671         ...
4672     @}
4673 @}
4674 @end example
4675
4676 This is, however, slightly inefficient (if the sum is very large it can take
4677 a long time to add the terms one-by-one), and its applicability is limited to
4678 a rather small class of expressions. If @code{calc_trace()} is called with
4679 a relation or a list as its argument, you will probably want the trace to
4680 be taken on both sides of the relation or of all elements of the list.
4681
4682 GiNaC offers the @code{map()} method to aid in the implementation of such
4683 operations:
4684
4685 @example
4686 ex ex::map(map_function & f) const;
4687 ex ex::map(ex (*f)(const ex & e)) const;
4688 @end example
4689
4690 In the first (preferred) form, @code{map()} takes a function object that
4691 is subclassed from the @code{map_function} class. In the second form, it
4692 takes a pointer to a function that accepts and returns an expression.
4693 @code{map()} constructs a new expression of the same type, applying the
4694 specified function on all subexpressions (in the sense of @code{op()}),
4695 non-recursively.
4696
4697 The use of a function object makes it possible to supply more arguments to
4698 the function that is being mapped, or to keep local state information.
4699 The @code{map_function} class declares a virtual function call operator
4700 that you can overload. Here is a sample implementation of @code{calc_trace()}
4701 that uses @code{map()} in a recursive fashion:
4702
4703 @example
4704 struct calc_trace : public map_function @{
4705     ex operator()(const ex &e)
4706     @{
4707         if (is_a<matrix>(e))
4708             return ex_to<matrix>(e).trace();
4709         else if (is_a<mul>(e)) @{
4710             ...
4711         @} else
4712             return e.map(*this);
4713     @}
4714 @};
4715 @end example
4716
4717 This function object could then be used like this:
4718
4719 @example
4720 @{
4721     ex M = ... // expression with matrices
4722     calc_trace do_trace;
4723     ex tr = do_trace(M);
4724 @}
4725 @end example
4726
4727 Here is another example for you to meditate over.  It removes quadratic
4728 terms in a variable from an expanded polynomial:
4729
4730 @example
4731 struct map_rem_quad : public map_function @{
4732     ex var;
4733     map_rem_quad(const ex & var_) : var(var_) @{@}
4734
4735     ex operator()(const ex & e)
4736     @{
4737         if (is_a<add>(e) || is_a<mul>(e))
4738             return e.map(*this);
4739         else if (is_a<power>(e) && 
4740                  e.op(0).is_equal(var) && e.op(1).info(info_flags::even))
4741             return 0;
4742         else
4743             return e;
4744     @}
4745 @};
4746
4747 ...
4748
4749 @{
4750     symbol x("x"), y("y");
4751
4752     ex e;
4753     for (int i=0; i<8; i++)
4754         e += pow(x, i) * pow(y, 8-i) * (i+1);
4755     cout << e << endl;
4756      // -> 4*y^5*x^3+5*y^4*x^4+8*y*x^7+7*y^2*x^6+2*y^7*x+6*y^3*x^5+3*y^6*x^2+y^8
4757
4758     map_rem_quad rem_quad(x);
4759     cout << rem_quad(e) << endl;
4760      // -> 4*y^5*x^3+8*y*x^7+2*y^7*x+6*y^3*x^5+y^8
4761 @}
4762 @end example
4763
4764 @command{ginsh} offers a slightly different implementation of @code{map()}
4765 that allows applying algebraic functions to operands. The second argument
4766 to @code{map()} is an expression containing the wildcard @samp{$0} which
4767 acts as the placeholder for the operands:
4768
4769 @example
4770 > map(a*b,sin($0));
4771 sin(a)*sin(b)
4772 > map(a+2*b,sin($0));
4773 sin(a)+sin(2*b)
4774 > map(@{a,b,c@},$0^2+$0);
4775 @{a^2+a,b^2+b,c^2+c@}
4776 @end example
4777
4778 Note that it is only possible to use algebraic functions in the second
4779 argument. You can not use functions like @samp{diff()}, @samp{op()},
4780 @samp{subs()} etc. because these are evaluated immediately:
4781
4782 @example
4783 > map(@{a,b,c@},diff($0,a));
4784 @{0,0,0@}
4785   This is because "diff($0,a)" evaluates to "0", so the command is equivalent
4786   to "map(@{a,b,c@},0)".
4787 @end example
4788
4789
4790 @node Visitors and tree traversal, Polynomial arithmetic, Applying a function on subexpressions, Methods and functions
4791 @c    node-name, next, previous, up
4792 @section Visitors and tree traversal
4793 @cindex tree traversal
4794 @cindex @code{visitor} (class)
4795 @cindex @code{accept()}
4796 @cindex @code{visit()}
4797 @cindex @code{traverse()}
4798 @cindex @code{traverse_preorder()}
4799 @cindex @code{traverse_postorder()}
4800
4801 Suppose that you need a function that returns a list of all indices appearing
4802 in an arbitrary expression. The indices can have any dimension, and for
4803 indices with variance you always want the covariant version returned.
4804
4805 You can't use @code{get_free_indices()} because you also want to include
4806 dummy indices in the list, and you can't use @code{find()} as it needs
4807 specific index dimensions (and it would require two passes: one for indices
4808 with variance, one for plain ones).
4809
4810 The obvious solution to this problem is a tree traversal with a type switch,
4811 such as the following:
4812
4813 @example
4814 void gather_indices_helper(const ex & e, lst & l)
4815 @{
4816     if (is_a<varidx>(e)) @{
4817         const varidx & vi = ex_to<varidx>(e);
4818         l.append(vi.is_covariant() ? vi : vi.toggle_variance());
4819     @} else if (is_a<idx>(e)) @{
4820         l.append(e);
4821     @} else @{
4822         size_t n = e.nops();
4823         for (size_t i = 0; i < n; ++i)
4824             gather_indices_helper(e.op(i), l);
4825     @}
4826 @}
4827
4828 lst gather_indices(const ex & e)
4829 @{
4830     lst l;
4831     gather_indices_helper(e, l);
4832     l.sort();
4833     l.unique();
4834     return l;
4835 @}
4836 @end example
4837
4838 This works fine but fans of object-oriented programming will feel
4839 uncomfortable with the type switch. One reason is that there is a possibility
4840 for subtle bugs regarding derived classes. If we had, for example, written
4841
4842 @example
4843     if (is_a<idx>(e)) @{
4844       ...
4845     @} else if (is_a<varidx>(e)) @{
4846       ...
4847 @end example
4848
4849 in @code{gather_indices_helper}, the code wouldn't have worked because the
4850 first line "absorbs" all classes derived from @code{idx}, including
4851 @code{varidx}, so the special case for @code{varidx} would never have been
4852 executed.
4853
4854 Also, for a large number of classes, a type switch like the above can get
4855 unwieldy and inefficient (it's a linear search, after all).
4856 @code{gather_indices_helper} only checks for two classes, but if you had to
4857 write a function that required a different implementation for nearly
4858 every GiNaC class, the result would be very hard to maintain and extend.
4859
4860 The cleanest approach to the problem would be to add a new virtual function
4861 to GiNaC's class hierarchy. In our example, there would be specializations
4862 for @code{idx} and @code{varidx} while the default implementation in
4863 @code{basic} performed the tree traversal. Unfortunately, in C++ it's
4864 impossible to add virtual member functions to existing classes without
4865 changing their source and recompiling everything. GiNaC comes with source,
4866 so you could actually do this, but for a small algorithm like the one
4867 presented this would be impractical.
4868
4869 One solution to this dilemma is the @dfn{Visitor} design pattern,
4870 which is implemented in GiNaC (actually, Robert Martin's Acyclic Visitor
4871 variation, described in detail in
4872 @uref{http://objectmentor.com/publications/acv.pdf}). Instead of adding
4873 virtual functions to the class hierarchy to implement operations, GiNaC
4874 provides a single "bouncing" method @code{accept()} that takes an instance
4875 of a special @code{visitor} class and redirects execution to the one
4876 @code{visit()} virtual function of the visitor that matches the type of
4877 object that @code{accept()} was being invoked on.
4878
4879 Visitors in GiNaC must derive from the global @code{visitor} class as well
4880 as from the class @code{T::visitor} of each class @code{T} they want to
4881 visit, and implement the member functions @code{void visit(const T &)} for
4882 each class.
4883
4884 A call of
4885
4886 @example
4887 void ex::accept(visitor & v) const;
4888 @end example
4889
4890 will then dispatch to the correct @code{visit()} member function of the
4891 specified visitor @code{v} for the type of GiNaC object at the root of the
4892 expression tree (e.g. a @code{symbol}, an @code{idx} or a @code{mul}).
4893
4894 Here is an example of a visitor:
4895
4896 @example
4897 class my_visitor
4898  : public visitor,          // this is required
4899    public add::visitor,     // visit add objects
4900    public numeric::visitor, // visit numeric objects
4901    public basic::visitor    // visit basic objects
4902 @{
4903     void visit(const add & x)
4904     @{ cout << "called with an add object" << endl; @}
4905
4906     void visit(const numeric & x)
4907     @{ cout << "called with a numeric object" << endl; @}
4908
4909     void visit(const basic & x)
4910     @{ cout << "called with a basic object" << endl; @}
4911 @};
4912 @end example
4913
4914 which can be used as follows:
4915
4916 @example
4917 ...
4918     symbol x("x");
4919     ex e1 = 42;
4920     ex e2 = 4*x-3;
4921     ex e3 = 8*x;
4922
4923     my_visitor v;
4924     e1.accept(v);
4925      // prints "called with a numeric object"
4926     e2.accept(v);
4927      // prints "called with an add object"
4928     e3.accept(v);
4929      // prints "called with a basic object"
4930 ...
4931 @end example
4932
4933 The @code{visit(const basic &)} method gets called for all objects that are
4934 not @code{numeric} or @code{add} and acts as an (optional) default.
4935
4936 From a conceptual point of view, the @code{visit()} methods of the visitor
4937 behave like a newly added virtual function of the visited hierarchy.
4938 In addition, visitors can store state in member variables, and they can
4939 be extended by deriving a new visitor from an existing one, thus building
4940 hierarchies of visitors.
4941
4942 We can now rewrite our index example from above with a visitor:
4943
4944 @example
4945 class gather_indices_visitor
4946  : public visitor, public idx::visitor, public varidx::visitor
4947 @{
4948     lst l;
4949
4950     void visit(const idx & i)
4951     @{
4952         l.append(i);
4953     @}
4954
4955     void visit(const varidx & vi)
4956     @{
4957         l.append(vi.is_covariant() ? vi : vi.toggle_variance());
4958     @}
4959
4960 public:
4961     const lst & get_result() // utility function
4962     @{
4963         l.sort();
4964         l.unique();
4965         return l;
4966     @}
4967 @};
4968 @end example
4969
4970 What's missing is the tree traversal. We could implement it in
4971 @code{visit(const basic &)}, but GiNaC has predefined methods for this:
4972
4973 @example
4974 void ex::traverse_preorder(visitor & v) const;
4975 void ex::traverse_postorder(visitor & v) const;
4976 void ex::traverse(visitor & v) const;
4977 @end example
4978
4979 @code{traverse_preorder()} visits a node @emph{before} visiting its
4980 subexpressions, while @code{traverse_postorder()} visits a node @emph{after}
4981 visiting its subexpressions. @code{traverse()} is a synonym for
4982 @code{traverse_preorder()}.
4983
4984 Here is a new implementation of @code{gather_indices()} that uses the visitor
4985 and @code{traverse()}:
4986
4987 @example
4988 lst gather_indices(const ex & e)
4989 @{
4990     gather_indices_visitor v;
4991     e.traverse(v);
4992     return v.get_result();
4993 @}
4994 @end example
4995
4996 Alternatively, you could use pre- or postorder iterators for the tree
4997 traversal:
4998
4999 @example
5000 lst gather_indices(const ex & e)
5001 @{
5002     gather_indices_visitor v;
5003     for (const_preorder_iterator i = e.preorder_begin();
5004          i != e.preorder_end(); ++i) @{
5005         i->accept(v);
5006     @}
5007     return v.get_result();
5008 @}
5009 @end example
5010
5011
5012 @node Polynomial arithmetic, Rational expressions, Visitors and tree traversal, Methods and functions
5013 @c    node-name, next, previous, up
5014 @section Polynomial arithmetic
5015
5016 @subsection Testing whether an expression is a polynomial
5017 @cindex @code{is_polynomial()}
5018
5019 Testing whether an expression is a polynomial in one or more variables
5020 can be done with the method
5021 @example
5022 bool ex::is_polynomial(const ex & vars) const;
5023 @end example
5024 In the case of more than
5025 one variable, the variables are given as a list.
5026
5027 @example
5028 (x*y*sin(y)).is_polynomial(x)         // Returns true.
5029 (x*y*sin(y)).is_polynomial(lst(x,y))  // Returns false.
5030 @end example
5031
5032 @subsection Expanding and collecting
5033 @cindex @code{expand()}
5034 @cindex @code{collect()}
5035 @cindex @code{collect_common_factors()}
5036
5037 A polynomial in one or more variables has many equivalent
5038 representations.  Some useful ones serve a specific purpose.  Consider
5039 for example the trivariate polynomial @math{4*x*y + x*z + 20*y^2 +
5040 21*y*z + 4*z^2} (written down here in output-style).  It is equivalent
5041 to the factorized polynomial @math{(x + 5*y + 4*z)*(4*y + z)}.  Other
5042 representations are the recursive ones where one collects for exponents
5043 in one of the three variable.  Since the factors are themselves
5044 polynomials in the remaining two variables the procedure can be
5045 repeated.  In our example, two possibilities would be @math{(4*y + z)*x
5046 + 20*y^2 + 21*y*z + 4*z^2} and @math{20*y^2 + (21*z + 4*x)*y + 4*z^2 +
5047 x*z}.
5048
5049 To bring an expression into expanded form, its method
5050
5051 @example
5052 ex ex::expand(unsigned options = 0);
5053 @end example
5054
5055 may be called.  In our example above, this corresponds to @math{4*x*y +
5056 x*z + 20*y^2 + 21*y*z + 4*z^2}.  Again, since the canonical form in
5057 GiNaC is not easy to guess you should be prepared to see different
5058 orderings of terms in such sums!
5059
5060 Another useful representation of multivariate polynomials is as a
5061 univariate polynomial in one of the variables with the coefficients
5062 being polynomials in the remaining variables.  The method
5063 @code{collect()} accomplishes this task:
5064
5065 @example
5066 ex ex::collect(const ex & s, bool distributed = false);
5067 @end example
5068
5069 The first argument to @code{collect()} can also be a list of objects in which
5070 case the result is either a recursively collected polynomial, or a polynomial
5071 in a distributed form with terms like @math{c*x1^e1*...*xn^en}, as specified
5072 by the @code{distributed} flag.
5073
5074 Note that the original polynomial needs to be in expanded form (for the
5075 variables concerned) in order for @code{collect()} to be able to find the
5076 coefficients properly.
5077
5078 The following @command{ginsh} transcript shows an application of @code{collect()}
5079 together with @code{find()}:
5080
5081 @example
5082 > a=expand((sin(x)+sin(y))*(1+p+q)*(1+d));
5083 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)
5084 +q*sin(x)+d*sin(y)*p+sin(x)+sin(y)*p
5085 > collect(a,@{p,q@});
5086 d*sin(x)+(d*sin(x)+sin(y)+d*sin(y)+sin(x))*p
5087 +(d*sin(x)+sin(y)+d*sin(y)+sin(x))*q+sin(y)+d*sin(y)+sin(x)
5088 > collect(a,find(a,sin($1)));
5089 (1+q+d+q*d+d*p+p)*sin(y)+(1+q+d+q*d+d*p+p)*sin(x)
5090 > collect(a,@{find(a,sin($1)),p,q@});
5091 (1+(1+d)*p+d+q*(1+d))*sin(x)+(1+(1+d)*p+d+q*(1+d))*sin(y)
5092 > collect(a,@{find(a,sin($1)),d@});
5093 (1+q+d*(1+q+p)+p)*sin(y)+(1+q+d*(1+q+p)+p)*sin(x)
5094 @end example
5095
5096 Polynomials can often be brought into a more compact form by collecting
5097 common factors from the terms of sums. This is accomplished by the function
5098
5099 @example
5100 ex collect_common_factors(const ex & e);
5101 @end example
5102
5103 This function doesn't perform a full factorization but only looks for
5104 factors which are already explicitly present:
5105
5106 @example
5107 > collect_common_factors(a*x+a*y);
5108 (x+y)*a
5109 > collect_common_factors(a*x^2+2*a*x*y+a*y^2);
5110 a*(2*x*y+y^2+x^2)
5111 > collect_common_factors(a*(b*(a+c)*x+b*((a+c)*x+(a+c)*y)*y));
5112 (c+a)*a*(x*y+y^2+x)*b
5113 @end example
5114
5115 @subsection Degree and coefficients
5116 @cindex @code{degree()}
5117 @cindex @code{ldegree()}
5118 @cindex @code{coeff()}
5119
5120 The degree and low degree of a polynomial can be obtained using the two
5121 methods
5122
5123 @example
5124 int ex::degree(const ex & s);
5125 int ex::ldegree(const ex & s);
5126 @end example
5127
5128 which also work reliably on non-expanded input polynomials (they even work
5129 on rational functions, returning the asymptotic degree). By definition, the
5130 degree of zero is zero. To extract a coefficient with a certain power from
5131 an expanded polynomial you use
5132
5133 @example
5134 ex ex::coeff(const ex & s, int n);
5135 @end example
5136
5137 You can also obtain the leading and trailing coefficients with the methods
5138
5139 @example
5140 ex ex::lcoeff(const ex & s);
5141 ex ex::tcoeff(const ex & s);
5142 @end example
5143
5144 which are equivalent to @code{coeff(s, degree(s))} and @code{coeff(s, ldegree(s))},
5145 respectively.
5146
5147 An application is illustrated in the next example, where a multivariate
5148 polynomial is analyzed:
5149
5150 @example
5151 @{
5152     symbol x("x"), y("y");
5153     ex PolyInp = 4*pow(x,3)*y + 5*x*pow(y,2) + 3*y
5154                  - pow(x+y,2) + 2*pow(y+2,2) - 8;
5155     ex Poly = PolyInp.expand();
5156     
5157     for (int i=Poly.ldegree(x); i<=Poly.degree(x); ++i) @{
5158         cout << "The x^" << i << "-coefficient is "
5159              << Poly.coeff(x,i) << endl;
5160     @}
5161     cout << "As polynomial in y: " 
5162          << Poly.collect(y) << endl;
5163 @}
5164 @end example
5165
5166 When run, it returns an output in the following fashion:
5167
5168 @example
5169 The x^0-coefficient is y^2+11*y
5170 The x^1-coefficient is 5*y^2-2*y
5171 The x^2-coefficient is -1
5172 The x^3-coefficient is 4*y
5173 As polynomial in y: -x^2+(5*x+1)*y^2+(-2*x+4*x^3+11)*y
5174 @end example
5175
5176 As always, the exact output may vary between different versions of GiNaC
5177 or even from run to run since the internal canonical ordering is not
5178 within the user's sphere of influence.
5179
5180 @code{degree()}, @code{ldegree()}, @code{coeff()}, @code{lcoeff()},
5181 @code{tcoeff()} and @code{collect()} can also be used to a certain degree
5182 with non-polynomial expressions as they not only work with symbols but with
5183 constants, functions and indexed objects as well:
5184
5185 @example
5186 @{
5187     symbol a("a"), b("b"), c("c"), x("x");
5188     idx i(symbol("i"), 3);
5189
5190     ex e = pow(sin(x) - cos(x), 4);
5191     cout << e.degree(cos(x)) << endl;
5192      // -> 4
5193     cout << e.expand().coeff(sin(x), 3) << endl;
5194      // -> -4*cos(x)
5195
5196     e = indexed(a+b, i) * indexed(b+c, i); 
5197     e = e.expand(expand_options::expand_indexed);
5198     cout << e.collect(indexed(b, i)) << endl;
5199      // -> a.i*c.i+(a.i+c.i)*b.i+b.i^2
5200 @}
5201 @end example
5202
5203
5204 @subsection Polynomial division
5205 @cindex polynomial division
5206 @cindex quotient
5207 @cindex remainder
5208 @cindex pseudo-remainder
5209 @cindex @code{quo()}
5210 @cindex @code{rem()}
5211 @cindex @code{prem()}
5212 @cindex @code{divide()}
5213
5214 The two functions
5215
5216 @example
5217 ex quo(const ex & a, const ex & b, const ex & x);
5218 ex rem(const ex & a, const ex & b, const ex & x);
5219 @end example
5220
5221 compute the quotient and remainder of univariate polynomials in the variable
5222 @samp{x}. The results satisfy @math{a = b*quo(a, b, x) + rem(a, b, x)}.
5223
5224 The additional function
5225
5226 @example
5227 ex prem(const ex & a, const ex & b, const ex & x);
5228 @end example
5229
5230 computes the pseudo-remainder of @samp{a} and @samp{b} which satisfies
5231 @math{c*a = b*q + prem(a, b, x)}, where @math{c = b.lcoeff(x) ^ (a.degree(x) - b.degree(x) + 1)}.
5232
5233 Exact division of multivariate polynomials is performed by the function
5234
5235 @example
5236 bool divide(const ex & a, const ex & b, ex & q);
5237 @end example
5238
5239 If @samp{b} divides @samp{a} over the rationals, this function returns @code{true}
5240 and returns the quotient in the variable @code{q}. Otherwise it returns @code{false}
5241 in which case the value of @code{q} is undefined.
5242
5243
5244 @subsection Unit, content and primitive part
5245 @cindex @code{unit()}
5246 @cindex @code{content()}
5247 @cindex @code{primpart()}
5248 @cindex @code{unitcontprim()}
5249
5250 The methods
5251
5252 @example
5253 ex ex::unit(const ex & x);
5254 ex ex::content(const ex & x);
5255 ex ex::primpart(const ex & x);
5256 ex ex::primpart(const ex & x, const ex & c);
5257 @end example
5258
5259 return the unit part, content part, and primitive polynomial of a multivariate
5260 polynomial with respect to the variable @samp{x} (the unit part being the sign
5261 of the leading coefficient, the content part being the GCD of the coefficients,
5262 and the primitive polynomial being the input polynomial divided by the unit and
5263 content parts). The second variant of @code{primpart()} expects the previously
5264 calculated content part of the polynomial in @code{c}, which enables it to
5265 work faster in the case where the content part has already been computed. The
5266 product of unit, content, and primitive part is the original polynomial.
5267
5268 Additionally, the method
5269
5270 @example
5271 void ex::unitcontprim(const ex & x, ex & u, ex & c, ex & p);
5272 @end example
5273
5274 computes the unit, content, and primitive parts in one go, returning them
5275 in @code{u}, @code{c}, and @code{p}, respectively.
5276
5277
5278 @subsection GCD, LCM and resultant
5279 @cindex GCD
5280 @cindex LCM
5281 @cindex @code{gcd()}
5282 @cindex @code{lcm()}
5283
5284 The functions for polynomial greatest common divisor and least common
5285 multiple have the synopsis
5286
5287 @example
5288 ex gcd(const ex & a, const ex & b);
5289 ex lcm(const ex & a, const ex & b);
5290 @end example
5291
5292 The functions @code{gcd()} and @code{lcm()} accept two expressions
5293 @code{a} and @code{b} as arguments and return a new expression, their
5294 greatest common divisor or least common multiple, respectively.  If the
5295 polynomials @code{a} and @code{b} are coprime @code{gcd(a,b)} returns 1
5296 and @code{lcm(a,b)} returns the product of @code{a} and @code{b}. Note that all
5297 the coefficients must be rationals.
5298
5299 @example
5300 #include <ginac/ginac.h>
5301 using namespace GiNaC;
5302
5303 int main()
5304 @{
5305     symbol x("x"), y("y"), z("z");
5306     ex P_a = 4*x*y + x*z + 20*pow(y, 2) + 21*y*z + 4*pow(z, 2);
5307     ex P_b = x*y + 3*x*z + 5*pow(y, 2) + 19*y*z + 12*pow(z, 2);
5308
5309     ex P_gcd = gcd(P_a, P_b);
5310     // x + 5*y + 4*z
5311     ex P_lcm = lcm(P_a, P_b);
5312     // 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
5313 @}
5314 @end example
5315
5316 @cindex resultant
5317 @cindex @code{resultant()}
5318
5319 The resultant of two expressions only makes sense with polynomials.
5320 It is always computed with respect to a specific symbol within the
5321 expressions. The function has the interface
5322
5323 @example
5324 ex resultant(const ex & a, const ex & b, const ex & s);
5325 @end example
5326
5327 Resultants are symmetric in @code{a} and @code{b}. The following example
5328 computes the resultant of two expressions with respect to @code{x} and
5329 @code{y}, respectively:
5330
5331 @example
5332 #include <ginac/ginac.h>
5333 using namespace GiNaC;
5334
5335 int main()
5336 @{
5337     symbol x("x"), y("y");
5338
5339     ex e1 = x+pow(y,2), e2 = 2*pow(x,3)-1; // x+y^2, 2*x^3-1
5340     ex r;
5341     
5342     r = resultant(e1, e2, x); 
5343     // -> 1+2*y^6
5344     r = resultant(e1, e2, y); 
5345     // -> 1-4*x^3+4*x^6
5346 @}
5347 @end example
5348
5349 @subsection Square-free decomposition
5350 @cindex square-free decomposition
5351 @cindex factorization
5352 @cindex @code{sqrfree()}
5353
5354 GiNaC still lacks proper factorization support.  Some form of
5355 factorization is, however, easily implemented by noting that factors
5356 appearing in a polynomial with power two or more also appear in the
5357 derivative and hence can easily be found by computing the GCD of the
5358 original polynomial and its derivatives.  Any decent system has an
5359 interface for this so called square-free factorization.  So we provide
5360 one, too:
5361 @example
5362 ex sqrfree(const ex & a, const lst & l = lst());
5363 @end example
5364 Here is an example that by the way illustrates how the exact form of the
5365 result may slightly depend on the order of differentiation, calling for
5366 some care with subsequent processing of the result:
5367 @example
5368     ...
5369     symbol x("x"), y("y");
5370     ex BiVarPol = expand(pow(2-2*y,3) * pow(1+x*y,2) * pow(x-2*y,2) * (x+y));
5371
5372     cout << sqrfree(BiVarPol, lst(x,y)) << endl;
5373      // -> 8*(1-y)^3*(y*x^2-2*y+x*(1-2*y^2))^2*(y+x)
5374
5375     cout << sqrfree(BiVarPol, lst(y,x)) << endl;
5376      // -> 8*(1-y)^3*(-y*x^2+2*y+x*(-1+2*y^2))^2*(y+x)
5377
5378     cout << sqrfree(BiVarPol) << endl;
5379      // -> depending on luck, any of the above
5380     ...
5381 @end example
5382 Note also, how factors with the same exponents are not fully factorized
5383 with this method.
5384
5385
5386 @node Rational expressions, Symbolic differentiation, Polynomial arithmetic, Methods and functions
5387 @c    node-name, next, previous, up
5388 @section Rational expressions
5389
5390 @subsection The @code{normal} method
5391 @cindex @code{normal()}
5392 @cindex simplification
5393 @cindex temporary replacement
5394
5395 Some basic form of simplification of expressions is called for frequently.
5396 GiNaC provides the method @code{.normal()}, which converts a rational function
5397 into an equivalent rational function of the form @samp{numerator/denominator}
5398 where numerator and denominator are coprime.  If the input expression is already
5399 a fraction, it just finds the GCD of numerator and denominator and cancels it,
5400 otherwise it performs fraction addition and multiplication.
5401
5402 @code{.normal()} can also be used on expressions which are not rational functions
5403 as it will replace all non-rational objects (like functions or non-integer
5404 powers) by temporary symbols to bring the expression to the domain of rational
5405 functions before performing the normalization, and re-substituting these
5406 symbols afterwards. This algorithm is also available as a separate method
5407 @code{.to_rational()}, described below.
5408
5409 This means that both expressions @code{t1} and @code{t2} are indeed
5410 simplified in this little code snippet:
5411
5412 @example
5413 @{
5414     symbol x("x");
5415     ex t1 = (pow(x,2) + 2*x + 1)/(x + 1);
5416     ex t2 = (pow(sin(x),2) + 2*sin(x) + 1)/(sin(x) + 1);
5417     std::cout << "t1 is " << t1.normal() << std::endl;
5418     std::cout << "t2 is " << t2.normal() << std::endl;
5419 @}
5420 @end example
5421
5422 Of course this works for multivariate polynomials too, so the ratio of
5423 the sample-polynomials from the section about GCD and LCM above would be
5424 normalized to @code{P_a/P_b} = @code{(4*y+z)/(y+3*z)}.
5425
5426
5427 @subsection Numerator and denominator
5428 @cindex numerator
5429 @cindex denominator
5430 @cindex @code{numer()}
5431 @cindex @code{denom()}
5432 @cindex @code{numer_denom()}
5433
5434 The numerator and denominator of an expression can be obtained with
5435
5436 @example
5437 ex ex::numer();
5438 ex ex::denom();
5439 ex ex::numer_denom();
5440 @end example
5441
5442 These functions will first normalize the expression as described above and
5443 then return the numerator, denominator, or both as a list, respectively.
5444 If you need both numerator and denominator, calling @code{numer_denom()} is
5445 faster than using @code{numer()} and @code{denom()} separately.
5446
5447
5448 @subsection Converting to a polynomial or rational expression
5449 @cindex @code{to_polynomial()}
5450 @cindex @code{to_rational()}
5451
5452 Some of the methods described so far only work on polynomials or rational
5453 functions. GiNaC provides a way to extend the domain of these functions to
5454 general expressions by using the temporary replacement algorithm described
5455 above. You do this by calling
5456
5457 @example
5458 ex ex::to_polynomial(exmap & m);
5459 ex ex::to_polynomial(lst & l);
5460 @end example
5461 or
5462 @example
5463 ex ex::to_rational(exmap & m);
5464 ex ex::to_rational(lst & l);
5465 @end example
5466
5467 on the expression to be converted. The supplied @code{exmap} or @code{lst}
5468 will be filled with the generated temporary symbols and their replacement
5469 expressions in a format that can be used directly for the @code{subs()}
5470 method. It can also already contain a list of replacements from an earlier
5471 application of @code{.to_polynomial()} or @code{.to_rational()}, so it's
5472 possible to use it on multiple expressions and get consistent results.
5473
5474 The difference between @code{.to_polynomial()} and @code{.to_rational()}
5475 is probably best illustrated with an example:
5476
5477 @example
5478 @{
5479     symbol x("x"), y("y");
5480     ex a = 2*x/sin(x) - y/(3*sin(x));
5481     cout << a << endl;
5482
5483     lst lp;
5484     ex p = a.to_polynomial(lp);
5485     cout << " = " << p << "\n   with " << lp << endl;
5486      // = symbol3*symbol2*y+2*symbol2*x
5487      //   with @{symbol2==sin(x)^(-1),symbol3==-1/3@}
5488
5489     lst lr;
5490     ex r = a.to_rational(lr);
5491     cout << " = " << r << "\n   with " << lr << endl;
5492      // = -1/3*symbol4^(-1)*y+2*symbol4^(-1)*x
5493      //   with @{symbol4==sin(x)@}
5494 @}
5495 @end example
5496
5497 The following more useful example will print @samp{sin(x)-cos(x)}:
5498
5499 @example
5500 @{
5501     symbol x("x");
5502     ex a = pow(sin(x), 2) - pow(cos(x), 2);
5503     ex b = sin(x) + cos(x);
5504     ex q;
5505     exmap m;
5506     divide(a.to_polynomial(m), b.to_polynomial(m), q);
5507     cout << q.subs(m) << endl;
5508 @}
5509 @end example
5510
5511
5512 @node Symbolic differentiation, Series expansion, Rational expressions, Methods and functions
5513 @c    node-name, next, previous, up
5514 @section Symbolic differentiation
5515 @cindex differentiation
5516 @cindex @code{diff()}
5517 @cindex chain rule
5518 @cindex product rule
5519
5520 GiNaC's objects know how to differentiate themselves.  Thus, a
5521 polynomial (class @code{add}) knows that its derivative is the sum of
5522 the derivatives of all the monomials:
5523
5524 @example
5525 @{
5526     symbol x("x"), y("y"), z("z");
5527     ex P = pow(x, 5) + pow(x, 2) + y;
5528
5529     cout << P.diff(x,2) << endl;
5530      // -> 20*x^3 + 2
5531     cout << P.diff(y) << endl;    // 1
5532      // -> 1
5533     cout << P.diff(z) << endl;    // 0
5534      // -> 0
5535 @}
5536 @end example
5537
5538 If a second integer parameter @var{n} is given, the @code{diff} method
5539 returns the @var{n}th derivative.
5540
5541 If @emph{every} object and every function is told what its derivative
5542 is, all derivatives of composed objects can be calculated using the
5543 chain rule and the product rule.  Consider, for instance the expression
5544 @code{1/cosh(x)}.  Since the derivative of @code{cosh(x)} is
5545 @code{sinh(x)} and the derivative of @code{pow(x,-1)} is
5546 @code{-pow(x,-2)}, GiNaC can readily compute the composition.  It turns
5547 out that the composition is the generating function for Euler Numbers,
5548 i.e. the so called @var{n}th Euler number is the coefficient of
5549 @code{x^n/n!} in the expansion of @code{1/cosh(x)}.  We may use this
5550 identity to code a function that generates Euler numbers in just three
5551 lines:
5552
5553 @cindex Euler numbers
5554 @example
5555 #include <ginac/ginac.h>
5556 using namespace GiNaC;
5557
5558 ex EulerNumber(unsigned n)
5559 @{
5560     symbol x;
5561     const ex generator = pow(cosh(x),-1);
5562     return generator.diff(x,n).subs(x==0);
5563 @}
5564
5565 int main()
5566 @{
5567     for (unsigned i=0; i<11; i+=2)
5568         std::cout << EulerNumber(i) << std::endl;
5569     return 0;
5570 @}
5571 @end example
5572
5573 When you run it, it produces the sequence @code{1}, @code{-1}, @code{5},
5574 @code{-61}, @code{1385}, @code{-50521}.  We increment the loop variable
5575 @code{i} by two since all odd Euler numbers vanish anyways.
5576
5577
5578 @node Series expansion, Symmetrization, Symbolic differentiation, Methods and functions
5579 @c    node-name, next, previous, up
5580 @section Series expansion
5581 @cindex @code{series()}
5582 @cindex Taylor expansion
5583 @cindex Laurent expansion
5584 @cindex @code{pseries} (class)
5585 @cindex @code{Order()}
5586
5587 Expressions know how to expand themselves as a Taylor series or (more
5588 generally) a Laurent series.  As in most conventional Computer Algebra
5589 Systems, no distinction is made between those two.  There is a class of
5590 its own for storing such series (@code{class pseries}) and a built-in
5591 function (called @code{Order}) for storing the order term of the series.
5592 As a consequence, if you want to work with series, i.e. multiply two
5593 series, you need to call the method @code{ex::series} again to convert
5594 it to a series object with the usual structure (expansion plus order
5595 term).  A sample application from special relativity could read:
5596
5597 @example
5598 #include <ginac/ginac.h>
5599 using namespace std;
5600 using namespace GiNaC;
5601
5602 int main()
5603 @{
5604     symbol v("v"), c("c");
5605     
5606     ex gamma = 1/sqrt(1 - pow(v/c,2));
5607     ex mass_nonrel = gamma.series(v==0, 10);
5608     
5609     cout << "the relativistic mass increase with v is " << endl
5610          << mass_nonrel << endl;
5611     
5612     cout << "the inverse square of this series is " << endl
5613          << pow(mass_nonrel,-2).series(v==0, 10) << endl;
5614 @}
5615 @end example
5616
5617 Only calling the series method makes the last output simplify to
5618 @math{1-v^2/c^2+O(v^10)}, without that call we would just have a long
5619 series raised to the power @math{-2}.
5620
5621 @cindex Machin's formula
5622 As another instructive application, let us calculate the numerical 
5623 value of Archimedes' constant
5624 @tex
5625 $\pi$
5626 @end tex
5627 @ifnottex
5628 @math{Pi}
5629 @end ifnottex
5630 (for which there already exists the built-in constant @code{Pi}) 
5631 using John Machin's amazing formula
5632 @tex
5633 $\pi=16$~atan~$\!\left(1 \over 5 \right)-4$~atan~$\!\left(1 \over 239 \right)$.
5634 @end tex
5635 @ifnottex
5636 @math{Pi==16*atan(1/5)-4*atan(1/239)}.
5637 @end ifnottex
5638 This equation (and similar ones) were used for over 200 years for
5639 computing digits of pi (see @cite{Pi Unleashed}).  We may expand the
5640 arcus tangent around @code{0} and insert the fractions @code{1/5} and
5641 @code{1/239}.  However, as we have seen, a series in GiNaC carries an
5642 order term with it and the question arises what the system is supposed
5643 to do when the fractions are plugged into that order term.  The solution
5644 is to use the function @code{series_to_poly()} to simply strip the order
5645 term off:
5646
5647 @example
5648 #include <ginac/ginac.h>
5649 using namespace GiNaC;
5650
5651 ex machin_pi(int degr)
5652 @{
5653     symbol x;
5654     ex pi_expansion = series_to_poly(atan(x).series(x,degr));
5655     ex pi_approx = 16*pi_expansion.subs(x==numeric(1,5))
5656                    -4*pi_expansion.subs(x==numeric(1,239));
5657     return pi_approx;
5658 @}
5659
5660 int main()
5661 @{
5662     using std::cout;  // just for fun, another way of...
5663     using std::endl;  // ...dealing with this namespace std.
5664     ex pi_frac;
5665     for (int i=2; i<12; i+=2) @{
5666         pi_frac = machin_pi(i);
5667         cout << i << ":\t" << pi_frac << endl
5668              << "\t" << pi_frac.evalf() << endl;
5669     @}
5670     return 0;
5671 @}
5672 @end example
5673
5674 Note how we just called @code{.series(x,degr)} instead of
5675 @code{.series(x==0,degr)}.  This is a simple shortcut for @code{ex}'s
5676 method @code{series()}: if the first argument is a symbol the expression
5677 is expanded in that symbol around point @code{0}.  When you run this
5678 program, it will type out:
5679
5680 @example
5681 2:      3804/1195
5682         3.1832635983263598326
5683 4:      5359397032/1706489875
5684         3.1405970293260603143
5685 6:      38279241713339684/12184551018734375
5686         3.141621029325034425
5687 8:      76528487109180192540976/24359780855939418203125
5688         3.141591772182177295
5689 10:     327853873402258685803048818236/104359128170408663038552734375
5690         3.1415926824043995174
5691 @end example
5692
5693
5694 @node Symmetrization, Built-in functions, Series expansion, Methods and functions
5695 @c    node-name, next, previous, up
5696 @section Symmetrization
5697 @cindex @code{symmetrize()}
5698 @cindex @code{antisymmetrize()}
5699 @cindex @code{symmetrize_cyclic()}
5700
5701 The three methods
5702
5703 @example
5704 ex ex::symmetrize(const lst & l);
5705 ex ex::antisymmetrize(const lst & l);
5706 ex ex::symmetrize_cyclic(const lst & l);
5707 @end example
5708
5709 symmetrize an expression by returning the sum over all symmetric,
5710 antisymmetric or cyclic permutations of the specified list of objects,
5711 weighted by the number of permutations.
5712
5713 The three additional methods
5714
5715 @example
5716 ex ex::symmetrize();
5717 ex ex::antisymmetrize();
5718 ex ex::symmetrize_cyclic();
5719 @end example
5720
5721 symmetrize or antisymmetrize an expression over its free indices.
5722
5723 Symmetrization is most useful with indexed expressions but can be used with
5724 almost any kind of object (anything that is @code{subs()}able):
5725
5726 @example
5727 @{
5728     idx i(symbol("i"), 3), j(symbol("j"), 3), k(symbol("k"), 3);
5729     symbol A("A"), B("B"), a("a"), b("b"), c("c");
5730                                            
5731     cout << indexed(A, i, j).symmetrize() << endl;
5732      // -> 1/2*A.j.i+1/2*A.i.j
5733     cout << indexed(A, i, j, k).antisymmetrize(lst(i, j)) << endl;
5734      // -> -1/2*A.j.i.k+1/2*A.i.j.k
5735     cout << lst(a, b, c).symmetrize_cyclic(lst(a, b, c)) << endl;
5736      // -> 1/3*@{a,b,c@}+1/3*@{b,c,a@}+1/3*@{c,a,b@}
5737 @}
5738 @end example
5739
5740 @page
5741
5742 @node Built-in functions, Multiple polylogarithms, Symmetrization, Methods and functions
5743 @c    node-name, next, previous, up
5744 @section Predefined mathematical functions
5745 @c
5746 @subsection Overview
5747
5748 GiNaC contains the following predefined mathematical functions:
5749
5750 @cartouche
5751 @multitable @columnfractions .30 .70
5752 @item @strong{Name} @tab @strong{Function}
5753 @item @code{abs(x)}
5754 @tab absolute value
5755 @cindex @code{abs()}
5756 @item @code{step(x)}
5757 @tab step function
5758 @cindex @code{step()}
5759 @item @code{csgn(x)}
5760 @tab complex sign
5761 @cindex @code{conjugate()}
5762 @item @code{conjugate(x)}
5763 @tab complex conjugation
5764 @cindex @code{real_part()}
5765 @item @code{real_part(x)}
5766 @tab real part
5767 @cindex @code{imag_part()}
5768 @item @code{imag_part(x)}
5769 @tab imaginary part
5770 @item @code{sqrt(x)}
5771 @tab square root (not a GiNaC function, rather an alias for @code{pow(x, numeric(1, 2))})
5772 @cindex @code{sqrt()}
5773 @item @code{sin(x)}
5774 @tab sine
5775 @cindex @code{sin()}
5776 @item @code{cos(x)}
5777 @tab cosine
5778 @cindex @code{cos()}
5779 @item @code{tan(x)}
5780 @tab tangent
5781 @cindex @code{tan()}
5782 @item @code{asin(x)}
5783 @tab inverse sine
5784 @cindex @code{asin()}
5785 @item @code{acos(x)}
5786 @tab inverse cosine
5787 @cindex @code{acos()}
5788 @item @code{atan(x)}
5789 @tab inverse tangent
5790 @cindex @code{atan()}
5791 @item @code{atan2(y, x)}
5792 @tab inverse tangent with two arguments
5793 @item @code{sinh(x)}
5794 @tab hyperbolic sine
5795 @cindex @code{sinh()}
5796 @item @code{cosh(x)}
5797 @tab hyperbolic cosine
5798 @cindex @code{cosh()}
5799 @item @code{tanh(x)}
5800 @tab hyperbolic tangent
5801 @cindex @code{tanh()}
5802 @item @code{asinh(x)}
5803 @tab inverse hyperbolic sine
5804 @cindex @code{asinh()}
5805 @item @code{acosh(x)}
5806 @tab inverse hyperbolic cosine
5807 @cindex @code{acosh()}
5808 @item @code{atanh(x)}
5809 @tab inverse hyperbolic tangent
5810 @cindex @code{atanh()}
5811 @item @code{exp(x)}
5812 @tab exponential function
5813 @cindex @code{exp()}
5814 @item @code{log(x)}
5815 @tab natural logarithm
5816 @cindex @code{log()}
5817 @item @code{Li2(x)}
5818 @tab dilogarithm
5819 @cindex @code{Li2()}
5820 @item @code{Li(m, x)}
5821 @tab classical polylogarithm as well as multiple polylogarithm
5822 @cindex @code{Li()}
5823 @item @code{G(a, y)}
5824 @tab multiple polylogarithm
5825 @cindex @code{G()}
5826 @item @code{G(a, s, y)}
5827 @tab multiple polylogarithm with explicit signs for the imaginary parts
5828 @cindex @code{G()}
5829 @item @code{S(n, p, x)}
5830 @tab Nielsen's generalized polylogarithm
5831 @cindex @code{S()}
5832 @item @code{H(m, x)}
5833 @tab harmonic polylogarithm
5834 @cindex @code{H()}
5835 @item @code{zeta(m)}
5836 @tab Riemann's zeta function as well as multiple zeta value
5837 @cindex @code{zeta()}
5838 @item @code{zeta(m, s)}
5839 @tab alternating Euler sum
5840 @cindex @code{zeta()}
5841 @item @code{zetaderiv(n, x)}
5842 @tab derivatives of Riemann's zeta function
5843 @item @code{tgamma(x)}
5844 @tab gamma function
5845 @cindex @code{tgamma()}
5846 @cindex gamma function
5847 @item @code{lgamma(x)}
5848 @tab logarithm of gamma function
5849 @cindex @code{lgamma()}
5850 @item @code{beta(x, y)}
5851 @tab beta function (@code{tgamma(x)*tgamma(y)/tgamma(x+y)})
5852 @cindex @code{beta()}
5853 @item @code{psi(x)}
5854 @tab psi (digamma) function
5855 @cindex @code{psi()}
5856 @item @code{psi(n, x)}
5857 @tab derivatives of psi function (polygamma functions)
5858 @item @code{factorial(n)}
5859 @tab factorial function @math{n!}
5860 @cindex @code{factorial()}
5861 @item @code{binomial(n, k)}
5862 @tab binomial coefficients
5863 @cindex @code{binomial()}
5864 @item @code{Order(x)}
5865 @tab order term function in truncated power series
5866 @cindex @code{Order()}
5867 @end multitable
5868 @end cartouche
5869
5870 @cindex branch cut
5871 For functions that have a branch cut in the complex plane GiNaC follows
5872 the conventions for C++ as defined in the ANSI standard as far as
5873 possible.  In particular: the natural logarithm (@code{log}) and the
5874 square root (@code{sqrt}) both have their branch cuts running along the
5875 negative real axis where the points on the axis itself belong to the
5876 upper part (i.e. continuous with quadrant II).  The inverse
5877 trigonometric and hyperbolic functions are not defined for complex
5878 arguments by the C++ standard, however.  In GiNaC we follow the
5879 conventions used by CLN, which in turn follow the carefully designed
5880 definitions in the Common Lisp standard.  It should be noted that this
5881 convention is identical to the one used by the C99 standard and by most
5882 serious CAS.  It is to be expected that future revisions of the C++
5883 standard incorporate these functions in the complex domain in a manner
5884 compatible with C99.
5885
5886 @node Multiple polylogarithms, Complex expressions, Built-in functions, Methods and functions
5887 @c    node-name, next, previous, up
5888 @subsection Multiple polylogarithms
5889
5890 @cindex polylogarithm
5891 @cindex Nielsen's generalized polylogarithm
5892 @cindex harmonic polylogarithm
5893 @cindex multiple zeta value
5894 @cindex alternating Euler sum
5895 @cindex multiple polylogarithm
5896
5897 The multiple polylogarithm is the most generic member of a family of functions,
5898 to which others like the harmonic polylogarithm, Nielsen's generalized
5899 polylogarithm and the multiple zeta value belong.
5900 Everyone of these functions can also be written as a multiple polylogarithm with specific
5901 parameters. This whole family of functions is therefore often referred to simply as
5902 multiple polylogarithms, containing @code{Li}, @code{G}, @code{H}, @code{S} and @code{zeta}.
5903 The multiple polylogarithm itself comes in two variants: @code{Li} and @code{G}. While
5904 @code{Li} and @code{G} in principle represent the same function, the different
5905 notations are more natural to the series representation or the integral
5906 representation, respectively.
5907
5908 To facilitate the discussion of these functions we distinguish between indices and
5909 arguments as parameters. In the table above indices are printed as @code{m}, @code{s},
5910 @code{n} or @code{p}, whereas arguments are printed as @code{x}, @code{a} and @code{y}.
5911
5912 To define a @code{Li}, @code{H} or @code{zeta} with a depth greater than one, you have to
5913 pass a GiNaC @code{lst} for the indices @code{m} and @code{s}, and in the case of @code{Li}
5914 for the argument @code{x} as well. The parameter @code{a} of @code{G} must always be a @code{lst} containing
5915 the arguments in expanded form. If @code{G} is used with a third parameter @code{s}, @code{s} must
5916 have the same length as @code{a}. It contains then the signs of the imaginary parts of the arguments. If
5917 @code{s} is not given, the signs default to +1.
5918 Note that @code{Li} and @code{zeta} are polymorphic in this respect. They can stand in for
5919 the classical polylogarithm and Riemann's zeta function (if depth is one), as well as for
5920 the multiple polylogarithm and the multiple zeta value, respectively. Note also, that
5921 GiNaC doesn't check whether the @code{lst}s for two parameters do have the same length.
5922 It is up to the user to ensure this, otherwise evaluating will result in undefined behavior.
5923
5924 The functions print in LaTeX format as
5925 @tex
5926 ${\rm Li\;\!}_{m_1,m_2,\ldots,m_k}(x_1,x_2,\ldots,x_k)$, 
5927 @end tex
5928 @tex
5929 ${\rm S}_{n,p}(x)$, 
5930 @end tex
5931 @tex
5932 ${\rm H\;\!}_{m_1,m_2,\ldots,m_k}(x)$ and 
5933 @end tex
5934 @tex
5935 $\zeta(m_1,m_2,\ldots,m_k)$.
5936 @end tex
5937 @ifnottex
5938 @command{\mbox@{Li@}_@{m_1,m_2,...,m_k@}(x_1,x_2,...,x_k)},
5939 @command{\mbox@{S@}_@{n,p@}(x)},
5940 @command{\mbox@{H@}_@{m_1,m_2,...,m_k@}(x)} and 
5941 @command{\zeta(m_1,m_2,...,m_k)} (with the dots replaced by actual parameters).
5942 @end ifnottex
5943 If @code{zeta} is an alternating zeta sum, i.e. @code{zeta(m,s)}, the indices with negative sign
5944 are printed with a line above, e.g.
5945 @tex
5946 $\zeta(5,\overline{2})$.
5947 @end tex
5948 @ifnottex
5949 @command{\zeta(5,\overline@{2@})}.
5950 @end ifnottex
5951 The order of indices and arguments in the GiNaC @code{lst}s and in the output is the same.
5952
5953 Definitions and analytical as well as numerical properties of multiple polylogarithms
5954 are too numerous to be covered here. Instead, the user is referred to the publications listed at the
5955 end of this section. The implementation in GiNaC adheres to the definitions and conventions therein,
5956 except for a few differences which will be explicitly stated in the following.
5957
5958 One difference is about the order of the indices and arguments. For GiNaC we adopt the convention
5959 that the indices and arguments are understood to be in the same order as in which they appear in
5960 the series representation. This means
5961 @tex
5962 ${\rm Li\;\!}_{m_1,m_2,m_3}(x,1,1) = {\rm H\;\!}_{m_1,m_2,m_3}(x)$ and 
5963 @end tex
5964 @tex
5965 ${\rm Li\;\!}_{2,1}(1,1) = \zeta(2,1) = \zeta(3)$, but
5966 @end tex
5967 @tex
5968 $\zeta(1,2)$ evaluates to infinity.
5969 @end tex
5970 @ifnottex
5971 @code{Li_@{m_1,m_2,m_3@}(x,1,1) = H_@{m_1,m_2,m_3@}(x)} and 
5972 @code{Li_@{2,1@}(1,1) = zeta(2,1) = zeta(3)}, but
5973 @code{zeta(1,2)} evaluates to infinity.
5974 @end ifnottex
5975 So in comparison to the older ones of the referenced publications the order of
5976 indices and arguments for @code{Li} is reversed.
5977
5978 The functions only evaluate if the indices are integers greater than zero, except for the indices
5979 @code{s} in @code{zeta} and @code{G} as well as @code{m} in @code{H}. Since @code{s}
5980 will be interpreted as the sequence of signs for the corresponding indices
5981 @code{m} or the sign of the imaginary part for the
5982 corresponding arguments @code{a}, it must contain 1 or -1, e.g.
5983 @code{zeta(lst(3,4), lst(-1,1))} means
5984 @tex
5985 $\zeta(\overline{3},4)$
5986 @end tex
5987 @ifnottex
5988 @command{zeta(\overline@{3@},4)}
5989 @end ifnottex
5990 and
5991 @code{G(lst(a,b), lst(-1,1), c)} means
5992 @tex
5993 $G(a-0\epsilon,b+0\epsilon;c)$.
5994 @end tex
5995 @ifnottex
5996 @command{G(a-0\epsilon,b+0\epsilon;c)}.
5997 @end ifnottex
5998 The definition of @code{H} allows indices to be 0, 1 or -1 (in expanded notation) or equally to
5999 be any integer (in compact notation). With GiNaC expanded and compact notation can be mixed,
6000 e.g. @code{lst(0,0,-1,0,1,0,0)}, @code{lst(0,0,-1,2,0,0)} and @code{lst(-3,2,0,0)} are equivalent as
6001 indices. The anonymous evaluator @code{eval()} tries to reduce the functions, if possible, to
6002 the least-generic multiple polylogarithm. If all arguments are unit, it returns @code{zeta}.
6003 Arguments equal to zero get considered, too. Riemann's zeta function @code{zeta} (with depth one)
6004 evaluates also for negative integers and positive even integers. For example:
6005
6006 @example
6007 > Li(@{3,1@},@{x,1@});
6008 S(2,2,x)
6009 > H(@{-3,2@},1);
6010 -zeta(@{3,2@},@{-1,-1@})
6011 > S(3,1,1);
6012 1/90*Pi^4
6013 @end example
6014
6015 It is easy to tell for a given function into which other function it can be rewritten, may
6016 it be a less-generic or a more-generic one, except for harmonic polylogarithms @code{H}
6017 with negative indices or trailing zeros (the example above gives a hint). Signs can
6018 quickly be messed up, for example. Therefore GiNaC offers a C++ function
6019 @code{convert_H_to_Li()} to deal with the upgrade of a @code{H} to a multiple polylogarithm
6020 @code{Li} (@code{eval()} already cares for the possible downgrade):
6021
6022 @example
6023 > convert_H_to_Li(@{0,-2,-1,3@},x);
6024 Li(@{3,1,3@},@{-x,1,-1@})
6025 > convert_H_to_Li(@{2,-1,0@},x);
6026 -Li(@{2,1@},@{x,-1@})*log(x)+2*Li(@{3,1@},@{x,-1@})+Li(@{2,2@},@{x,-1@})
6027 @end example
6028
6029 Every function can be numerically evaluated for
6030 arbitrary real or complex arguments. The precision is arbitrary and can be set through the
6031 global variable @code{Digits}:
6032
6033 @example
6034 > Digits=100;
6035 100
6036 > evalf(zeta(@{3,1,3,1@}));
6037 0.005229569563530960100930652283899231589890420784634635522547448972148869544...
6038 @end example
6039
6040 Note that the convention for arguments on the branch cut in GiNaC as stated above is
6041 different from the one Remiddi and Vermaseren have chosen for the harmonic polylogarithm.
6042
6043 If a function evaluates to infinity, no exceptions are raised, but the function is returned
6044 unevaluated, e.g.
6045 @tex
6046 $\zeta(1)$.
6047 @end tex
6048 @ifnottex
6049 @command{zeta(1)}.
6050 @end ifnottex
6051 In long expressions this helps a lot with debugging, because you can easily spot
6052 the divergencies. But on the other hand, you have to make sure for yourself, that no illegal
6053 cancellations of divergencies happen.
6054
6055 Useful publications:
6056
6057 @cite{Nested Sums, Expansion of Transcendental Functions and Multi-Scale Multi-Loop Integrals}, 
6058 S.Moch, P.Uwer, S.Weinzierl, hep-ph/0110083
6059
6060 @cite{Harmonic Polylogarithms}, 
6061 E.Remiddi, J.A.M.Vermaseren, Int.J.Mod.Phys. A15 (2000), pp. 725-754
6062
6063 @cite{Special Values of Multiple Polylogarithms}, 
6064 J.Borwein, D.Bradley, D.Broadhurst, P.Lisonek, Trans.Amer.Math.Soc. 353/3 (2001), pp. 907-941
6065
6066 @cite{Numerical Evaluation of Multiple Polylogarithms}, 
6067 J.Vollinga, S.Weinzierl, hep-ph/0410259
6068
6069 @node Complex expressions, Solving linear systems of equations, Multiple polylogarithms, Methods and functions
6070 @c    node-name, next, previous, up
6071 @section Complex expressions
6072 @c
6073 @cindex @code{conjugate()}
6074
6075 For dealing with complex expressions there are the methods
6076
6077 @example
6078 ex ex::conjugate();
6079 ex ex::real_part();
6080 ex ex::imag_part();
6081 @end example
6082
6083 that return respectively the complex conjugate, the real part and the
6084 imaginary part of an expression. Complex conjugation works as expected
6085 for all built-in functions and objects. Taking real and imaginary
6086 parts has not yet been implemented for all built-in functions. In cases where
6087 it is not known how to conjugate or take a real/imaginary part one
6088 of the functions @code{conjugate}, @code{real_part} or @code{imag_part}
6089 is returned. For instance, in case of a complex symbol @code{x}
6090 (symbols are complex by default), one could not simplify
6091 @code{conjugate(x)}. In the case of strings of gamma matrices,
6092 the @code{conjugate} method takes the Dirac conjugate.
6093
6094 For example,
6095 @example
6096 @{
6097     varidx a(symbol("a"), 4), b(symbol("b"), 4);
6098     symbol x("x");
6099     realsymbol y("y");
6100                                            
6101     cout << (3*I*x*y + sin(2*Pi*I*y)).conjugate() << endl;
6102      // -> -3*I*conjugate(x)*y+sin(-2*I*Pi*y)
6103     cout << (dirac_gamma(a)*dirac_gamma(b)*dirac_gamma5()).conjugate() << endl;
6104      // -> -gamma5*gamma~b*gamma~a
6105 @}
6106 @end example
6107
6108 If you declare your own GiNaC functions, then they will conjugate themselves
6109 by conjugating their arguments. This is the default strategy. If you want to
6110 change this behavior, you have to supply a specialized conjugation method
6111 for your function (see @ref{Symbolic functions} and the GiNaC source-code
6112 for @code{abs} as an example). Also, specialized methods can be provided
6113 to take real and imaginary parts of user-defined functions.
6114
6115 @node Solving linear systems of equations, Input/output, Complex expressions, Methods and functions
6116 @c    node-name, next, previous, up
6117 @section Solving linear systems of equations
6118 @cindex @code{lsolve()}
6119
6120 The function @code{lsolve()} provides a convenient wrapper around some
6121 matrix operations that comes in handy when a system of linear equations
6122 needs to be solved:
6123
6124 @example
6125 ex lsolve(const ex & eqns, const ex & symbols,
6126           unsigned options = solve_algo::automatic);
6127 @end example
6128
6129 Here, @code{eqns} is a @code{lst} of equalities (i.e. class
6130 @code{relational}) while @code{symbols} is a @code{lst} of
6131 indeterminates.  (@xref{The class hierarchy}, for an exposition of class
6132 @code{lst}).
6133
6134 It returns the @code{lst} of solutions as an expression.  As an example,
6135 let us solve the two equations @code{a*x+b*y==3} and @code{x-y==b}:
6136
6137 @example
6138 @{
6139     symbol a("a"), b("b"), x("x"), y("y");
6140     lst eqns, vars;
6141     eqns = a*x+b*y==3, x-y==b;
6142     vars = x, y;
6143     cout << lsolve(eqns, vars) << endl;
6144      // -> @{x==(3+b^2)/(b+a),y==(3-b*a)/(b+a)@}
6145 @end example
6146
6147 When the linear equations @code{eqns} are underdetermined, the solution
6148 will contain one or more tautological entries like @code{x==x},
6149 depending on the rank of the system.  When they are overdetermined, the
6150 solution will be an empty @code{lst}.  Note the third optional parameter
6151 to @code{lsolve()}: it accepts the same parameters as
6152 @code{matrix::solve()}.  This is because @code{lsolve} is just a wrapper
6153 around that method.
6154
6155
6156 @node Input/output, Extending GiNaC, Solving linear systems of equations, Methods and functions
6157 @c    node-name, next, previous, up
6158 @section Input and output of expressions
6159 @cindex I/O
6160
6161 @subsection Expression output
6162 @cindex printing
6163 @cindex output of expressions
6164
6165 Expressions can simply be written to any stream:
6166
6167 @example
6168 @{
6169     symbol x("x");
6170     ex e = 4.5*I+pow(x,2)*3/2;
6171     cout << e << endl;    // prints '4.5*I+3/2*x^2'
6172     // ...
6173 @end example
6174
6175 The default output format is identical to the @command{ginsh} input syntax and
6176 to that used by most computer algebra systems, but not directly pastable
6177 into a GiNaC C++ program (note that in the above example, @code{pow(x,2)}
6178 is printed as @samp{x^2}).
6179
6180 It is possible to print expressions in a number of different formats with
6181 a set of stream manipulators;
6182
6183 @example
6184 std::ostream & dflt(std::ostream & os);
6185 std::ostream & latex(std::ostream & os);
6186 std::ostream & tree(std::ostream & os);
6187 std::ostream & csrc(std::ostream & os);
6188 std::ostream & csrc_float(std::ostream & os);
6189 std::ostream & csrc_double(std::ostream & os);
6190 std::ostream & csrc_cl_N(std::ostream & os);
6191 std::ostream & index_dimensions(std::ostream & os);
6192 std::ostream & no_index_dimensions(std::ostream & os);
6193 @end example
6194
6195 The @code{tree}, @code{latex} and @code{csrc} formats are also available in
6196 @command{ginsh} via the @code{print()}, @code{print_latex()} and
6197 @code{print_csrc()} functions, respectively.
6198
6199 @cindex @code{dflt}
6200 All manipulators affect the stream state permanently. To reset the output
6201 format to the default, use the @code{dflt} manipulator:
6202
6203 @example
6204     // ...
6205     cout << latex;            // all output to cout will be in LaTeX format from
6206                               // now on
6207     cout << e << endl;        // prints '4.5 i+\frac@{3@}@{2@} x^@{2@}'
6208     cout << sin(x/2) << endl; // prints '\sin(\frac@{1@}@{2@} x)'
6209     cout << dflt;             // revert to default output format
6210     cout << e << endl;        // prints '4.5*I+3/2*x^2'
6211     // ...
6212 @end example
6213
6214 If you don't want to affect the format of the stream you're working with,
6215 you can output to a temporary @code{ostringstream} like this:
6216
6217 @example
6218     // ...
6219     ostringstream s;
6220     s << latex << e;         // format of cout remains unchanged
6221     cout << s.str() << endl; // prints '4.5 i+\frac@{3@}@{2@} x^@{2@}'
6222     // ...
6223 @end example
6224
6225 @anchor{csrc printing}
6226 @cindex @code{csrc}
6227 @cindex @code{csrc_float}
6228 @cindex @code{csrc_double}
6229 @cindex @code{csrc_cl_N}
6230 The @code{csrc} (an alias for @code{csrc_double}), @code{csrc_float},
6231 @code{csrc_double} and @code{csrc_cl_N} manipulators set the output to a
6232 format that can be directly used in a C or C++ program. The three possible
6233 formats select the data types used for numbers (@code{csrc_cl_N} uses the
6234 classes provided by the CLN library):
6235
6236 @example
6237     // ...
6238     cout << "f = " << csrc_float << e << ";\n";
6239     cout << "d = " << csrc_double << e << ";\n";
6240     cout << "n = " << csrc_cl_N << e << ";\n";
6241     // ...
6242 @end example
6243
6244 The above example will produce (note the @code{x^2} being converted to
6245 @code{x*x}):
6246
6247 @example
6248 f = (3.0/2.0)*(x*x)+std::complex<float>(0.0,4.5000000e+00);
6249 d = (3.0/2.0)*(x*x)+std::complex<double>(0.0,4.5000000000000000e+00);
6250 n = cln::cl_RA("3/2")*(x*x)+cln::complex(cln::cl_I("0"),cln::cl_F("4.5_17"));
6251 @end example
6252
6253 @cindex @code{tree}
6254 The @code{tree} manipulator allows dumping the internal structure of an
6255 expression for debugging purposes:
6256
6257 @example
6258     // ...
6259     cout << tree << e;
6260 @}
6261 @end example
6262
6263 produces
6264
6265 @example
6266 add, hash=0x0, flags=0x3, nops=2
6267     power, hash=0x0, flags=0x3, nops=2
6268         x (symbol), serial=0, hash=0xc8d5bcdd, flags=0xf
6269         2 (numeric), hash=0x6526b0fa, flags=0xf
6270     3/2 (numeric), hash=0xf9828fbd, flags=0xf
6271     -----
6272     overall_coeff
6273     4.5L0i (numeric), hash=0xa40a97e0, flags=0xf
6274     =====
6275 @end example
6276
6277 @cindex @code{latex}
6278 The @code{latex} output format is for LaTeX parsing in mathematical mode.
6279 It is rather similar to the default format but provides some braces needed
6280 by LaTeX for delimiting boxes and also converts some common objects to
6281 conventional LaTeX names. It is possible to give symbols a special name for
6282 LaTeX output by supplying it as a second argument to the @code{symbol}
6283 constructor.
6284
6285 For example, the code snippet
6286
6287 @example
6288 @{
6289     symbol x("x", "\\circ");
6290     ex e = lgamma(x).series(x==0,3);
6291     cout << latex << e << endl;
6292 @}
6293 @end example
6294
6295 will print
6296
6297 @example
6298     @{(-\ln(\circ))@}+@{(-\gamma_E)@} \circ+@{(\frac@{1@}@{12@} \pi^@{2@})@} \circ^@{2@}
6299     +\mathcal@{O@}(\circ^@{3@})
6300 @end example
6301
6302 @cindex @code{index_dimensions}
6303 @cindex @code{no_index_dimensions}
6304 Index dimensions are normally hidden in the output. To make them visible, use
6305 the @code{index_dimensions} manipulator. The dimensions will be written in
6306 square brackets behind each index value in the default and LaTeX output
6307 formats:
6308
6309 @example
6310 @{
6311     symbol x("x"), y("y");
6312     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
6313     ex e = indexed(x, mu) * indexed(y, nu);
6314
6315     cout << e << endl;
6316      // prints 'x~mu*y~nu'
6317     cout << index_dimensions << e << endl;
6318      // prints 'x~mu[4]*y~nu[4]'
6319     cout << no_index_dimensions << e << endl;
6320      // prints 'x~mu*y~nu'
6321 @}
6322 @end example
6323
6324
6325 @cindex Tree traversal
6326 If you need any fancy special output format, e.g. for interfacing GiNaC
6327 with other algebra systems or for producing code for different
6328 programming languages, you can always traverse the expression tree yourself:
6329
6330 @example
6331 static void my_print(const ex & e)
6332 @{
6333     if (is_a<function>(e))
6334         cout << ex_to<function>(e).get_name();
6335     else
6336         cout << ex_to<basic>(e).class_name();
6337     cout << "(";
6338     size_t n = e.nops();
6339     if (n)
6340         for (size_t i=0; i<n; i++) @{
6341             my_print(e.op(i));
6342             if (i != n-1)
6343                 cout << ",";
6344         @}
6345     else
6346         cout << e;
6347     cout << ")";
6348 @}
6349
6350 int main()
6351 @{
6352     my_print(pow(3, x) - 2 * sin(y / Pi)); cout << endl;
6353     return 0;
6354 @}
6355 @end example
6356
6357 This will produce
6358
6359 @example
6360 add(power(numeric(3),symbol(x)),mul(sin(mul(power(constant(Pi),numeric(-1)),
6361 symbol(y))),numeric(-2)))
6362 @end example
6363
6364 If you need an output format that makes it possible to accurately
6365 reconstruct an expression by feeding the output to a suitable parser or
6366 object factory, you should consider storing the expression in an
6367 @code{archive} object and reading the object properties from there.
6368 See the section on archiving for more information.
6369
6370
6371 @subsection Expression input
6372 @cindex input of expressions
6373
6374 GiNaC provides no way to directly read an expression from a stream because
6375 you will usually want the user to be able to enter something like @samp{2*x+sin(y)}
6376 and have the @samp{x} and @samp{y} correspond to the symbols @code{x} and
6377 @code{y} you defined in your program and there is no way to specify the
6378 desired symbols to the @code{>>} stream input operator.
6379
6380 Instead, GiNaC lets you construct an expression from a string, specifying the
6381 list of symbols to be used:
6382
6383 @example
6384 @{
6385     symbol x("x"), y("y");
6386     ex e("2*x+sin(y)", lst(x, y));
6387 @}
6388 @end example
6389
6390 The input syntax is the same as that used by @command{ginsh} and the stream
6391 output operator @code{<<}. The symbols in the string are matched by name to
6392 the symbols in the list and if GiNaC encounters a symbol not specified in
6393 the list it will throw an exception.
6394
6395 With this constructor, it's also easy to implement interactive GiNaC programs:
6396
6397 @example
6398 #include <iostream>
6399 #include <string>
6400 #include <stdexcept>
6401 #include <ginac/ginac.h>
6402 using namespace std;
6403 using namespace GiNaC;
6404
6405 int main()
6406 @{
6407     symbol x("x");
6408     string s;
6409
6410     cout << "Enter an expression containing 'x': ";
6411     getline(cin, s);
6412
6413     try @{
6414         ex e(s, lst(x));
6415         cout << "The derivative of " << e << " with respect to x is ";
6416         cout << e.diff(x) << ".\n";
6417     @} catch (exception &p) @{
6418         cerr << p.what() << endl;
6419     @}
6420 @}
6421 @end example
6422
6423 @subsection Compiling expressions to C function pointers
6424 @cindex compiling expressions
6425
6426 Numerical evaluation of algebraic expressions is seamlessly integrated into
6427 GiNaC by help of the CLN library. While CLN allows for very fast arbitrary
6428 precision numerics, which is more than sufficient for most users, sometimes only
6429 the speed of built-in floating point numbers is fast enough, e.g. for Monte
6430 Carlo integration. The only viable option then is the following: print the
6431 expression in C syntax format, manually add necessary C code, compile that
6432 program and run is as a separate application. This is not only cumbersome and
6433 involves a lot of manual intervention, but it also separates the algebraic and
6434 the numerical evaluation into different execution stages.
6435
6436 GiNaC offers a couple of functions that help to avoid these inconveniences and
6437 problems. The functions automatically perform the printing of a GiNaC expression
6438 and the subsequent compiling of its associated C code. The created object code
6439 is then dynamically linked to the currently running program. A function pointer
6440 to the C function that performs the numerical evaluation is returned and can be
6441 used instantly. This all happens automatically, no user intervention is needed.
6442
6443 The following example demonstrates the use of @code{compile_ex}:
6444
6445 @example
6446     // ...
6447     symbol x("x");
6448     ex myexpr = sin(x) / x;
6449
6450     FUNCP_1P fp;
6451     compile_ex(myexpr, x, fp);
6452
6453     cout << fp(3.2) << endl;
6454     // ...
6455 @end example
6456
6457 The function @code{compile_ex} is called with the expression to be compiled and
6458 its only free variable @code{x}. Upon successful completion the third parameter
6459 contains a valid function pointer to the corresponding C code module. If called
6460 like in the last line only built-in double precision numerics is involved.
6461
6462 @cindex FUNCP_1P
6463 @cindex FUNCP_2P
6464 @cindex FUNCP_CUBA
6465 The function pointer has to be defined in advance. GiNaC offers three function
6466 pointer types at the moment:
6467
6468 @example
6469     typedef double (*FUNCP_1P) (double);
6470     typedef double (*FUNCP_2P) (double, double);
6471     typedef void (*FUNCP_CUBA) (const int*, const double[], const int*, double[]);
6472 @end example
6473
6474 @cindex CUBA library
6475 @cindex Monte Carlo integration
6476 @code{FUNCP_2P} allows for two variables in the expression. @code{FUNCP_CUBA} is
6477 the correct type to be used with the CUBA library
6478 (@uref{http://www.feynarts/cuba}) for numerical integrations. The details for the
6479 parameters of @code{FUNCP_CUBA} are explained in the CUBA manual.
6480
6481 @cindex compile_ex
6482 For every function pointer type there is a matching @code{compile_ex} available:
6483
6484 @example
6485     void compile_ex(const ex& expr, const symbol& sym, FUNCP_1P& fp,
6486                     const std::string filename = "");
6487     void compile_ex(const ex& expr, const symbol& sym1, const symbol& sym2,
6488                     FUNCP_2P& fp, const std::string filename = "");
6489     void compile_ex(const lst& exprs, const lst& syms, FUNCP_CUBA& fp,
6490                     const std::string filename = "");
6491 @end example
6492
6493 When the last parameter @code{filename} is not supplied, @code{compile_ex} will
6494 choose a unique random name for the intermediate source and object files it
6495 produces. On program termination these files will be deleted. If one wishes to
6496 keep the C code and the object files, one can supply the @code{filename}
6497 parameter. The intermediate files will use that filename and will not be
6498 deleted.
6499
6500 @cindex link_ex
6501 @code{link_ex} is a function that allows to dynamically link an existing object
6502 file and to make it available via a function pointer. This is useful if you
6503 have already used @code{compile_ex} on an expression and want to avoid the
6504 compilation step to be performed over and over again when you restart your
6505 program. The precondition for this is of course, that you have chosen a
6506 filename when you did call @code{compile_ex}. For every above mentioned
6507 function pointer type there exists a corresponding @code{link_ex} function:
6508
6509 @example
6510     void link_ex(const std::string filename, FUNCP_1P& fp);
6511     void link_ex(const std::string filename, FUNCP_2P& fp);
6512     void link_ex(const std::string filename, FUNCP_CUBA& fp);
6513 @end example
6514
6515 The complete filename (including the suffix @code{.so}) of the object file has
6516 to be supplied.
6517
6518 The function
6519
6520 @cindex unlink_ex
6521 @example
6522     void unlink_ex(const std::string filename);
6523 @end example
6524
6525 is supplied for the rare cases when one wishes to close the dynamically linked
6526 object files directly and have the intermediate files (only if filename has not
6527 been given) deleted. Normally one doesn't need this function, because all the
6528 clean-up will be done automatically upon (regular) program termination.
6529
6530 All the described functions will throw an exception in case they cannot perform
6531 correctly, like for example when writing the file or starting the compiler
6532 fails. Since internally the same printing methods as described in section
6533 @ref{csrc printing} are used, only functions and objects that are available in
6534 standard C will compile successfully (that excludes polylogarithms for example
6535 at the moment). Another precondition for success is, of course, that it must be
6536 possible to evaluate the expression numerically. No free variables despite the
6537 ones supplied to @code{compile_ex} should appear in the expression.
6538
6539 @cindex ginac-excompiler
6540 @code{compile_ex} uses the shell script @code{ginac-excompiler} to start the C
6541 compiler and produce the object files. This shell script comes with GiNaC and
6542 will be installed together with GiNaC in the configured @code{$PREFIX/bin}
6543 directory.
6544
6545 @subsection Archiving
6546 @cindex @code{archive} (class)
6547 @cindex archiving
6548
6549 GiNaC allows creating @dfn{archives} of expressions which can be stored
6550 to or retrieved from files. To create an archive, you declare an object
6551 of class @code{archive} and archive expressions in it, giving each
6552 expression a unique name:
6553
6554 @example
6555 #include <fstream>
6556 using namespace std;
6557 #include <ginac/ginac.h>
6558 using namespace GiNaC;
6559
6560 int main()
6561 @{
6562     symbol x("x"), y("y"), z("z");
6563
6564     ex foo = sin(x + 2*y) + 3*z + 41;
6565     ex bar = foo + 1;
6566
6567     archive a;
6568     a.archive_ex(foo, "foo");
6569     a.archive_ex(bar, "the second one");
6570     // ...
6571 @end example
6572
6573 The archive can then be written to a file:
6574
6575 @example
6576     // ...
6577     ofstream out("foobar.gar");
6578     out << a;
6579     out.close();
6580     // ...
6581 @end example
6582
6583 The file @file{foobar.gar} contains all information that is needed to
6584 reconstruct the expressions @code{foo} and @code{bar}.
6585
6586 @cindex @command{viewgar}
6587 The tool @command{viewgar} that comes with GiNaC can be used to view
6588 the contents of GiNaC archive files:
6589
6590 @example
6591 $ viewgar foobar.gar
6592 foo = 41+sin(x+2*y)+3*z
6593 the second one = 42+sin(x+2*y)+3*z
6594 @end example
6595
6596 The point of writing archive files is of course that they can later be
6597 read in again:
6598
6599 @example
6600     // ...
6601     archive a2;
6602     ifstream in("foobar.gar");
6603     in >> a2;
6604     // ...
6605 @end example
6606
6607 And the stored expressions can be retrieved by their name:
6608
6609 @example
6610     // ...
6611     lst syms;
6612     syms = x, y;
6613
6614     ex ex1 = a2.unarchive_ex(syms, "foo");
6615     ex ex2 = a2.unarchive_ex(syms, "the second one");
6616
6617     cout << ex1 << endl;              // prints "41+sin(x+2*y)+3*z"
6618     cout << ex2 << endl;              // prints "42+sin(x+2*y)+3*z"
6619     cout << ex1.subs(x == 2) << endl; // prints "41+sin(2+2*y)+3*z"
6620 @}
6621 @end example
6622
6623 Note that you have to supply a list of the symbols which are to be inserted
6624 in the expressions. Symbols in archives are stored by their name only and
6625 if you don't specify which symbols you have, unarchiving the expression will
6626 create new symbols with that name. E.g. if you hadn't included @code{x} in
6627 the @code{syms} list above, the @code{ex1.subs(x == 2)} statement would
6628 have had no effect because the @code{x} in @code{ex1} would have been a
6629 different symbol than the @code{x} which was defined at the beginning of
6630 the program, although both would appear as @samp{x} when printed.
6631
6632 You can also use the information stored in an @code{archive} object to
6633 output expressions in a format suitable for exact reconstruction. The
6634 @code{archive} and @code{archive_node} classes have a couple of member
6635 functions that let you access the stored properties:
6636
6637 @example
6638 static void my_print2(const archive_node & n)
6639 @{
6640     string class_name;
6641     n.find_string("class", class_name);
6642     cout << class_name << "(";
6643
6644     archive_node::propinfovector p;
6645     n.get_properties(p);
6646
6647     size_t num = p.size();
6648     for (size_t i=0; i<num; i++) @{
6649         const string &name = p[i].name;
6650         if (name == "class")
6651             continue;
6652         cout << name << "=";
6653
6654         unsigned count = p[i].count;
6655         if (count > 1)
6656             cout << "@{";
6657
6658         for (unsigned j=0; j<count; j++) @{
6659             switch (p[i].type) @{
6660                 case archive_node::PTYPE_BOOL: @{
6661                     bool x;
6662                     n.find_bool(name, x, j);
6663                     cout << (x ? "true" : "false");
6664                     break;
6665                 @}
6666                 case archive_node::PTYPE_UNSIGNED: @{
6667                     unsigned x;
6668                     n.find_unsigned(name, x, j);
6669                     cout << x;
6670                     break;
6671                 @}
6672                 case archive_node::PTYPE_STRING: @{
6673                     string x;
6674                     n.find_string(name, x, j);
6675                     cout << '\"' << x << '\"';
6676                     break;
6677                 @}
6678                 case archive_node::PTYPE_NODE: @{
6679                     const archive_node &x = n.find_ex_node(name, j);
6680                     my_print2(x);
6681                     break;
6682                 @}
6683             @}
6684
6685             if (j != count-1)
6686                 cout << ",";
6687         @}
6688
6689         if (count > 1)
6690             cout << "@}";
6691
6692         if (i != num-1)
6693             cout << ",";
6694     @}
6695
6696     cout << ")";
6697 @}
6698
6699 int main()
6700 @{
6701     ex e = pow(2, x) - y;
6702     archive ar(e, "e");
6703     my_print2(ar.get_top_node(0)); cout << endl;
6704     return 0;
6705 @}
6706 @end example
6707
6708 This will produce:
6709
6710 @example
6711 add(rest=@{power(basis=numeric(number="2"),exponent=symbol(name="x")),
6712 symbol(name="y")@},coeff=@{numeric(number="1"),numeric(number="-1")@},
6713 overall_coeff=numeric(number="0"))
6714 @end example
6715
6716 Be warned, however, that the set of properties and their meaning for each
6717 class may change between GiNaC versions.
6718
6719
6720 @node Extending GiNaC, What does not belong into GiNaC, Input/output, Top
6721 @c    node-name, next, previous, up
6722 @chapter Extending GiNaC
6723
6724 By reading so far you should have gotten a fairly good understanding of
6725 GiNaC's design patterns.  From here on you should start reading the
6726 sources.  All we can do now is issue some recommendations how to tackle
6727 GiNaC's many loose ends in order to fulfill everybody's dreams.  If you
6728 develop some useful extension please don't hesitate to contact the GiNaC
6729 authors---they will happily incorporate them into future versions.
6730
6731 @menu
6732 * What does not belong into GiNaC::  What to avoid.
6733 * Symbolic functions::               Implementing symbolic functions.
6734 * Printing::                         Adding new output formats.
6735 * Structures::                       Defining new algebraic classes (the easy way).
6736 * Adding classes::                   Defining new algebraic classes (the hard way).
6737 @end menu
6738
6739
6740 @node What does not belong into GiNaC, Symbolic functions, Extending GiNaC, Extending GiNaC
6741 @c    node-name, next, previous, up
6742 @section What doesn't belong into GiNaC
6743
6744 @cindex @command{ginsh}
6745 First of all, GiNaC's name must be read literally.  It is designed to be
6746 a library for use within C++.  The tiny @command{ginsh} accompanying
6747 GiNaC makes this even more clear: it doesn't even attempt to provide a
6748 language.  There are no loops or conditional expressions in
6749 @command{ginsh}, it is merely a window into the library for the
6750 programmer to test stuff (or to show off).  Still, the design of a
6751 complete CAS with a language of its own, graphical capabilities and all
6752 this on top of GiNaC is possible and is without doubt a nice project for
6753 the future.
6754
6755 There are many built-in functions in GiNaC that do not know how to
6756 evaluate themselves numerically to a precision declared at runtime
6757 (using @code{Digits}).  Some may be evaluated at certain points, but not
6758 generally.  This ought to be fixed.  However, doing numerical
6759 computations with GiNaC's quite abstract classes is doomed to be
6760 inefficient.  For this purpose, the underlying foundation classes
6761 provided by CLN are much better suited.
6762
6763
6764 @node Symbolic functions, Printing, What does not belong into GiNaC, Extending GiNaC
6765 @c    node-name, next, previous, up
6766 @section Symbolic functions
6767
6768 The easiest and most instructive way to start extending GiNaC is probably to
6769 create your own symbolic functions. These are implemented with the help of
6770 two preprocessor macros:
6771
6772 @cindex @code{DECLARE_FUNCTION}
6773 @cindex @code{REGISTER_FUNCTION}
6774 @example
6775 DECLARE_FUNCTION_<n>P(<name>)
6776 REGISTER_FUNCTION(<name>, <options>)
6777 @end example
6778
6779 The @code{DECLARE_FUNCTION} macro will usually appear in a header file. It
6780 declares a C++ function with the given @samp{name} that takes exactly @samp{n}
6781 parameters of type @code{ex} and returns a newly constructed GiNaC
6782 @code{function} object that represents your function.
6783
6784 The @code{REGISTER_FUNCTION} macro implements the function. It must be passed
6785 the same @samp{name} as the respective @code{DECLARE_FUNCTION} macro, and a
6786 set of options that associate the symbolic function with C++ functions you
6787 provide to implement the various methods such as evaluation, derivative,
6788 series expansion etc. They also describe additional attributes the function
6789 might have, such as symmetry and commutation properties, and a name for
6790 LaTeX output. Multiple options are separated by the member access operator
6791 @samp{.} and can be given in an arbitrary order.
6792
6793 (By the way: in case you are worrying about all the macros above we can
6794 assure you that functions are GiNaC's most macro-intense classes. We have
6795 done our best to avoid macros where we can.)
6796
6797 @subsection A minimal example
6798
6799 Here is an example for the implementation of a function with two arguments
6800 that is not further evaluated:
6801
6802 @example
6803 DECLARE_FUNCTION_2P(myfcn)
6804
6805 REGISTER_FUNCTION(myfcn, dummy())
6806 @end example
6807
6808 Any code that has seen the @code{DECLARE_FUNCTION} line can use @code{myfcn()}
6809 in algebraic expressions:
6810
6811 @example
6812 @{
6813     ...
6814     symbol x("x");
6815     ex e = 2*myfcn(42, 1+3*x) - x;
6816     cout << e << endl;
6817      // prints '2*myfcn(42,1+3*x)-x'
6818     ...
6819 @}
6820 @end example
6821
6822 The @code{dummy()} option in the @code{REGISTER_FUNCTION} line signifies
6823 "no options". A function with no options specified merely acts as a kind of
6824 container for its arguments. It is a pure "dummy" function with no associated
6825 logic (which is, however, sometimes perfectly sufficient).
6826
6827 Let's now have a look at the implementation of GiNaC's cosine function for an
6828 example of how to make an "intelligent" function.
6829
6830 @subsection The cosine function
6831
6832 The GiNaC header file @file{inifcns.h} contains the line
6833
6834 @example
6835 DECLARE_FUNCTION_1P(cos)
6836 @end example
6837
6838 which declares to all programs using GiNaC that there is a function @samp{cos}
6839 that takes one @code{ex} as an argument. This is all they need to know to use
6840 this function in expressions.
6841
6842 The implementation of the cosine function is in @file{inifcns_trans.cpp}. Here
6843 is its @code{REGISTER_FUNCTION} line:
6844
6845 @example
6846 REGISTER_FUNCTION(cos, eval_func(cos_eval).
6847                        evalf_func(cos_evalf).
6848                        derivative_func(cos_deriv).
6849                        latex_name("\\cos"));
6850 @end example
6851
6852 There are four options defined for the cosine function. One of them
6853 (@code{latex_name}) gives the function a proper name for LaTeX output; the
6854 other three indicate the C++ functions in which the "brains" of the cosine
6855 function are defined.
6856
6857 @cindex @code{hold()}
6858 @cindex evaluation
6859 The @code{eval_func()} option specifies the C++ function that implements
6860 the @code{eval()} method, GiNaC's anonymous evaluator. This function takes
6861 the same number of arguments as the associated symbolic function (one in this
6862 case) and returns the (possibly transformed or in some way simplified)
6863 symbolically evaluated function (@xref{Automatic evaluation}, for a description
6864 of the automatic evaluation process). If no (further) evaluation is to take
6865 place, the @code{eval_func()} function must return the original function
6866 with @code{.hold()}, to avoid a potential infinite recursion. If your
6867 symbolic functions produce a segmentation fault or stack overflow when
6868 using them in expressions, you are probably missing a @code{.hold()}
6869 somewhere.
6870
6871 The @code{eval_func()} function for the cosine looks something like this
6872 (actually, it doesn't look like this at all, but it should give you an idea
6873 what is going on):
6874
6875 @example
6876 static ex cos_eval(const ex & x)
6877 @{
6878     if ("x is a multiple of 2*Pi")
6879         return 1;
6880     else if ("x is a multiple of Pi")
6881         return -1;
6882     else if ("x is a multiple of Pi/2")
6883         return 0;
6884     // more rules...
6885
6886     else if ("x has the form 'acos(y)'")
6887         return y;
6888     else if ("x has the form 'asin(y)'")
6889         return sqrt(1-y^2);
6890     // more rules...
6891
6892     else
6893         return cos(x).hold();
6894 @}
6895 @end example
6896
6897 This function is called every time the cosine is used in a symbolic expression:
6898
6899 @example
6900 @{
6901     ...
6902     e = cos(Pi);
6903      // this calls cos_eval(Pi), and inserts its return value into
6904      // the actual expression
6905     cout << e << endl;
6906      // prints '-1'
6907     ...
6908 @}
6909 @end example
6910
6911 In this way, @code{cos(4*Pi)} automatically becomes @math{1},
6912 @code{cos(asin(a+b))} becomes @code{sqrt(1-(a+b)^2)}, etc. If no reasonable
6913 symbolic transformation can be done, the unmodified function is returned
6914 with @code{.hold()}.
6915
6916 GiNaC doesn't automatically transform @code{cos(2)} to @samp{-0.416146...}.
6917 The user has to call @code{evalf()} for that. This is implemented in a
6918 different function:
6919
6920 @example
6921 static ex cos_evalf(const ex & x)
6922 @{
6923     if (is_a<numeric>(x))
6924         return cos(ex_to<numeric>(x));
6925     else
6926         return cos(x).hold();
6927 @}
6928 @end example
6929
6930 Since we are lazy we defer the problem of numeric evaluation to somebody else,
6931 in this case the @code{cos()} function for @code{numeric} objects, which in
6932 turn hands it over to the @code{cos()} function in CLN. The @code{.hold()}
6933 isn't really needed here, but reminds us that the corresponding @code{eval()}
6934 function would require it in this place.
6935
6936 Differentiation will surely turn up and so we need to tell @code{cos}
6937 what its first derivative is (higher derivatives, @code{.diff(x,3)} for
6938 instance, are then handled automatically by @code{basic::diff} and
6939 @code{ex::diff}):
6940
6941 @example
6942 static ex cos_deriv(const ex & x, unsigned diff_param)
6943 @{
6944     return -sin(x);
6945 @}
6946 @end example
6947
6948 @cindex product rule
6949 The second parameter is obligatory but uninteresting at this point.  It
6950 specifies which parameter to differentiate in a partial derivative in
6951 case the function has more than one parameter, and its main application
6952 is for correct handling of the chain rule.
6953
6954 An implementation of the series expansion is not needed for @code{cos()} as
6955 it doesn't have any poles and GiNaC can do Taylor expansion by itself (as
6956 long as it knows what the derivative of @code{cos()} is). @code{tan()}, on
6957 the other hand, does have poles and may need to do Laurent expansion:
6958
6959 @example
6960 static ex tan_series(const ex & x, const relational & rel,
6961                      int order, unsigned options)
6962 @{
6963     // Find the actual expansion point
6964     const ex x_pt = x.subs(rel);
6965
6966     if ("x_pt is not an odd multiple of Pi/2")
6967         throw do_taylor();  // tell function::series() to do Taylor expansion
6968
6969     // On a pole, expand sin()/cos()
6970     return (sin(x)/cos(x)).series(rel, order+2, options);
6971 @}
6972 @end example
6973
6974 The @code{series()} implementation of a function @emph{must} return a
6975 @code{pseries} object, otherwise your code will crash.
6976
6977 @subsection Function options
6978
6979 GiNaC functions understand several more options which are always
6980 specified as @code{.option(params)}. None of them are required, but you
6981 need to specify at least one option to @code{REGISTER_FUNCTION()}. There
6982 is a do-nothing option called @code{dummy()} which you can use to define
6983 functions without any special options.
6984
6985 @example
6986 eval_func(<C++ function>)
6987 evalf_func(<C++ function>)
6988 derivative_func(<C++ function>)
6989 series_func(<C++ function>)
6990 conjugate_func(<C++ function>)
6991 @end example
6992
6993 These specify the C++ functions that implement symbolic evaluation,
6994 numeric evaluation, partial derivatives, and series expansion, respectively.
6995 They correspond to the GiNaC methods @code{eval()}, @code{evalf()},
6996 @code{diff()} and @code{series()}.
6997
6998 The @code{eval_func()} function needs to use @code{.hold()} if no further
6999 automatic evaluation is desired or possible.
7000
7001 If no @code{series_func()} is given, GiNaC defaults to simple Taylor
7002 expansion, which is correct if there are no poles involved. If the function
7003 has poles in the complex plane, the @code{series_func()} needs to check
7004 whether the expansion point is on a pole and fall back to Taylor expansion
7005 if it isn't. Otherwise, the pole usually needs to be regularized by some
7006 suitable transformation.
7007
7008 @example
7009 latex_name(const string & n)
7010 @end example
7011
7012 specifies the LaTeX code that represents the name of the function in LaTeX
7013 output. The default is to put the function name in an @code{\mbox@{@}}.
7014
7015 @example
7016 do_not_evalf_params()
7017 @end example
7018
7019 This tells @code{evalf()} to not recursively evaluate the parameters of the
7020 function before calling the @code{evalf_func()}.
7021
7022 @example
7023 set_return_type(unsigned return_type, unsigned return_type_tinfo)
7024 @end example
7025
7026 This allows you to explicitly specify the commutation properties of the
7027 function (@xref{Non-commutative objects}, for an explanation of
7028 (non)commutativity in GiNaC). For example, you can use
7029 @code{set_return_type(return_types::noncommutative, TINFO_matrix)} to make
7030 GiNaC treat your function like a matrix. By default, functions inherit the
7031 commutation properties of their first argument.
7032
7033 @example
7034 set_symmetry(const symmetry & s)
7035 @end example
7036
7037 specifies the symmetry properties of the function with respect to its
7038 arguments. @xref{Indexed objects}, for an explanation of symmetry
7039 specifications. GiNaC will automatically rearrange the arguments of
7040 symmetric functions into a canonical order.
7041
7042 Sometimes you may want to have finer control over how functions are
7043 displayed in the output. For example, the @code{abs()} function prints
7044 itself as @samp{abs(x)} in the default output format, but as @samp{|x|}
7045 in LaTeX mode, and @code{fabs(x)} in C source output. This is achieved
7046 with the
7047
7048 @example
7049 print_func<C>(<C++ function>)
7050 @end example
7051
7052 option which is explained in the next section.
7053
7054 @subsection Functions with a variable number of arguments
7055
7056 The @code{DECLARE_FUNCTION} and @code{REGISTER_FUNCTION} macros define
7057 functions with a fixed number of arguments. Sometimes, though, you may need
7058 to have a function that accepts a variable number of expressions. One way to
7059 accomplish this is to pass variable-length lists as arguments. The
7060 @code{Li()} function uses this method for multiple polylogarithms.
7061
7062 It is also possible to define functions that accept a different number of
7063 parameters under the same function name, such as the @code{psi()} function
7064 which can be called either as @code{psi(z)} (the digamma function) or as
7065 @code{psi(n, z)} (polygamma functions). These are actually two different
7066 functions in GiNaC that, however, have the same name. Defining such
7067 functions is not possible with the macros but requires manually fiddling
7068 with GiNaC internals. If you are interested, please consult the GiNaC source
7069 code for the @code{psi()} function (@file{inifcns.h} and
7070 @file{inifcns_gamma.cpp}).
7071
7072
7073 @node Printing, Structures, Symbolic functions, Extending GiNaC
7074 @c    node-name, next, previous, up
7075 @section GiNaC's expression output system
7076
7077 GiNaC allows the output of expressions in a variety of different formats
7078 (@pxref{Input/output}). This section will explain how expression output
7079 is implemented internally, and how to define your own output formats or
7080 change the output format of built-in algebraic objects. You will also want
7081 to read this section if you plan to write your own algebraic classes or
7082 functions.
7083
7084 @cindex @code{print_context} (class)
7085 @cindex @code{print_dflt} (class)
7086 @cindex @code{print_latex} (class)
7087 @cindex @code{print_tree} (class)
7088 @cindex @code{print_csrc} (class)
7089 All the different output formats are represented by a hierarchy of classes
7090 rooted in the @code{print_context} class, defined in the @file{print.h}
7091 header file:
7092
7093 @table @code
7094 @item print_dflt
7095 the default output format
7096 @item print_latex
7097 output in LaTeX mathematical mode
7098 @item print_tree
7099 a dump of the internal expression structure (for debugging)
7100 @item print_csrc
7101 the base class for C source output
7102 @item print_csrc_float
7103 C source output using the @code{float} type
7104 @item print_csrc_double
7105 C source output using the @code{double} type
7106 @item print_csrc_cl_N
7107 C source output using CLN types
7108 @end table
7109
7110 The @code{print_context} base class provides two public data members:
7111
7112 @example
7113 class print_context
7114 @{
7115     ...
7116 public:
7117     std::ostream & s;
7118     unsigned options;
7119 @};
7120 @end example
7121
7122 @code{s} is a reference to the stream to output to, while @code{options}
7123 holds flags and modifiers. Currently, there is only one flag defined:
7124 @code{print_options::print_index_dimensions} instructs the @code{idx} class
7125 to print the index dimension which is normally hidden.
7126
7127 When you write something like @code{std::cout << e}, where @code{e} is
7128 an object of class @code{ex}, GiNaC will construct an appropriate
7129 @code{print_context} object (of a class depending on the selected output
7130 format), fill in the @code{s} and @code{options} members, and call
7131
7132 @cindex @code{print()}
7133 @example
7134 void ex::print(const print_context & c, unsigned level = 0) const;
7135 @end example
7136
7137 which in turn forwards the call to the @code{print()} method of the
7138 top-level algebraic object contained in the expression.
7139
7140 Unlike other methods, GiNaC classes don't usually override their
7141 @code{print()} method to implement expression output. Instead, the default
7142 implementation @code{basic::print(c, level)} performs a run-time double
7143 dispatch to a function selected by the dynamic type of the object and the
7144 passed @code{print_context}. To this end, GiNaC maintains a separate method
7145 table for each class, similar to the virtual function table used for ordinary
7146 (single) virtual function dispatch.
7147
7148 The method table contains one slot for each possible @code{print_context}
7149 type, indexed by the (internally assigned) serial number of the type. Slots
7150 may be empty, in which case GiNaC will retry the method lookup with the
7151 @code{print_context} object's parent class, possibly repeating the process
7152 until it reaches the @code{print_context} base class. If there's still no
7153 method defined, the method table of the algebraic object's parent class
7154 is consulted, and so on, until a matching method is found (eventually it
7155 will reach the combination @code{basic/print_context}, which prints the
7156 object's class name enclosed in square brackets).
7157
7158 You can think of the print methods of all the different classes and output
7159 formats as being arranged in a two-dimensional matrix with one axis listing
7160 the algebraic classes and the other axis listing the @code{print_context}
7161 classes.
7162
7163 Subclasses of @code{basic} can, of course, also overload @code{basic::print()}
7164 to implement printing, but then they won't get any of the benefits of the
7165 double dispatch mechanism (such as the ability for derived classes to
7166 inherit only certain print methods from its parent, or the replacement of
7167 methods at run-time).
7168
7169 @subsection Print methods for classes
7170
7171 The method table for a class is set up either in the definition of the class,
7172 by passing the appropriate @code{print_func<C>()} option to
7173 @code{GINAC_IMPLEMENT_REGISTERED_CLASS_OPT()} (@xref{Adding classes}, for
7174 an example), or at run-time using @code{set_print_func<T, C>()}. The latter
7175 can also be used to override existing methods dynamically.
7176
7177 The argument to @code{print_func<C>()} and @code{set_print_func<T, C>()} can
7178 be a member function of the class (or one of its parent classes), a static
7179 member function, or an ordinary (global) C++ function. The @code{C} template
7180 parameter specifies the appropriate @code{print_context} type for which the
7181 method should be invoked, while, in the case of @code{set_print_func<>()}, the
7182 @code{T} parameter specifies the algebraic class (for @code{print_func<>()},
7183 the class is the one being implemented by
7184 @code{GINAC_IMPLEMENT_REGISTERED_CLASS_OPT}).
7185
7186 For print methods that are member functions, their first argument must be of
7187 a type convertible to a @code{const C &}, and the second argument must be an
7188 @code{unsigned}.
7189
7190 For static members and global functions, the first argument must be of a type
7191 convertible to a @code{const T &}, the second argument must be of a type
7192 convertible to a @code{const C &}, and the third argument must be an
7193 @code{unsigned}. A global function will, of course, not have access to
7194 private and protected members of @code{T}.
7195
7196 The @code{unsigned} argument of the print methods (and of @code{ex::print()}
7197 and @code{basic::print()}) is used for proper parenthesizing of the output
7198 (and by @code{print_tree} for proper indentation). It can be used for similar
7199 purposes if you write your own output formats.
7200
7201 The explanations given above may seem complicated, but in practice it's
7202 really simple, as shown in the following example. Suppose that we want to
7203 display exponents in LaTeX output not as superscripts but with little
7204 upwards-pointing arrows. This can be achieved in the following way:
7205
7206 @example
7207 void my_print_power_as_latex(const power & p,
7208                              const print_latex & c,
7209                              unsigned level)
7210 @{
7211     // get the precedence of the 'power' class
7212     unsigned power_prec = p.precedence();
7213
7214     // if the parent operator has the same or a higher precedence
7215     // we need parentheses around the power
7216     if (level >= power_prec)
7217         c.s << '(';
7218
7219     // print the basis and exponent, each enclosed in braces, and
7220     // separated by an uparrow
7221     c.s << '@{';
7222     p.op(0).print(c, power_prec);
7223     c.s << "@}\\uparrow@{";
7224     p.op(1).print(c, power_prec);
7225     c.s << '@}';
7226
7227     // don't forget the closing parenthesis
7228     if (level >= power_prec)
7229         c.s << ')';
7230 @}
7231                                                                                 
7232 int main()
7233 @{
7234     // a sample expression
7235     symbol x("x"), y("y");
7236     ex e = -3*pow(x, 3)*pow(y, -2) + pow(x+y, 2) - 1;
7237
7238     // switch to LaTeX mode
7239     cout << latex;
7240
7241     // this prints "-1+@{(y+x)@}^@{2@}-3 \frac@{x^@{3@}@}@{y^@{2@}@}"
7242     cout << e << endl;
7243
7244     // now we replace the method for the LaTeX output of powers with
7245     // our own one
7246     set_print_func<power, print_latex>(my_print_power_as_latex);
7247
7248     // this prints "-1+@{@{(y+x)@}@}\uparrow@{2@}-3 \frac@{@{x@}\uparrow@{3@}@}@{@{y@}
7249     //              \uparrow@{2@}@}"
7250     cout << e << endl;
7251 @}
7252 @end example
7253
7254 Some notes:
7255
7256 @itemize
7257
7258 @item
7259 The first argument of @code{my_print_power_as_latex} could also have been
7260 a @code{const basic &}, the second one a @code{const print_context &}.
7261
7262 @item
7263 The above code depends on @code{mul} objects converting their operands to
7264 @code{power} objects for the purpose of printing.
7265
7266 @item
7267 The output of products including negative powers as fractions is also
7268 controlled by the @code{mul} class.
7269
7270 @item
7271 The @code{power/print_latex} method provided by GiNaC prints square roots
7272 using @code{\sqrt}, but the above code doesn't.
7273
7274 @end itemize
7275
7276 It's not possible to restore a method table entry to its previous or default
7277 value. Once you have called @code{set_print_func()}, you can only override
7278 it with another call to @code{set_print_func()}, but you can't easily go back
7279 to the default behavior again (you can, of course, dig around in the GiNaC
7280 sources, find the method that is installed at startup
7281 (@code{power::do_print_latex} in this case), and @code{set_print_func} that
7282 one; that is, after you circumvent the C++ member access control@dots{}).
7283
7284 @subsection Print methods for functions
7285
7286 Symbolic functions employ a print method dispatch mechanism similar to the
7287 one used for classes. The methods are specified with @code{print_func<C>()}
7288 function options. If you don't specify any special print methods, the function
7289 will be printed with its name (or LaTeX name, if supplied), followed by a
7290 comma-separated list of arguments enclosed in parentheses.
7291
7292 For example, this is what GiNaC's @samp{abs()} function is defined like:
7293
7294 @example
7295 static ex abs_eval(const ex & arg) @{ ... @}
7296 static ex abs_evalf(const ex & arg) @{ ... @}
7297                                                                                 
7298 static void abs_print_latex(const ex & arg, const print_context & c)
7299 @{
7300     c.s << "@{|"; arg.print(c); c.s << "|@}";
7301 @}
7302                                                                                 
7303 static void abs_print_csrc_float(const ex & arg, const print_context & c)
7304 @{
7305     c.s << "fabs("; arg.print(c); c.s << ")";
7306 @}
7307                                                                                 
7308 REGISTER_FUNCTION(abs, eval_func(abs_eval).
7309                        evalf_func(abs_evalf).
7310                        print_func<print_latex>(abs_print_latex).
7311                        print_func<print_csrc_float>(abs_print_csrc_float).
7312                        print_func<print_csrc_double>(abs_print_csrc_float));
7313 @end example
7314
7315 This will display @samp{abs(x)} as @samp{|x|} in LaTeX mode and @code{fabs(x)}
7316 in non-CLN C source output, but as @code{abs(x)} in all other formats.
7317
7318 There is currently no equivalent of @code{set_print_func()} for functions.
7319
7320 @subsection Adding new output formats
7321
7322 Creating a new output format involves subclassing @code{print_context},
7323 which is somewhat similar to adding a new algebraic class
7324 (@pxref{Adding classes}). There is a macro @code{GINAC_DECLARE_PRINT_CONTEXT}
7325 that needs to go into the class definition, and a corresponding macro
7326 @code{GINAC_IMPLEMENT_PRINT_CONTEXT} that has to appear at global scope.
7327 Every @code{print_context} class needs to provide a default constructor
7328 and a constructor from an @code{std::ostream} and an @code{unsigned}
7329 options value.
7330
7331 Here is an example for a user-defined @code{print_context} class:
7332
7333 @example
7334 class print_myformat : public print_dflt
7335 @{
7336     GINAC_DECLARE_PRINT_CONTEXT(print_myformat, print_dflt)
7337 public:
7338     print_myformat(std::ostream & os, unsigned opt = 0)
7339      : print_dflt(os, opt) @{@}
7340 @};
7341
7342 print_myformat::print_myformat() : print_dflt(std::cout) @{@}
7343
7344 GINAC_IMPLEMENT_PRINT_CONTEXT(print_myformat, print_dflt)
7345 @end example
7346
7347 That's all there is to it. None of the actual expression output logic is
7348 implemented in this class. It merely serves as a selector for choosing
7349 a particular format. The algorithms for printing expressions in the new
7350 format are implemented as print methods, as described above.
7351
7352 @code{print_myformat} is a subclass of @code{print_dflt}, so it behaves
7353 exactly like GiNaC's default output format:
7354
7355 @example
7356 @{
7357     symbol x("x");
7358     ex e = pow(x, 2) + 1;
7359
7360     // this prints "1+x^2"
7361     cout << e << endl;
7362     
7363     // this also prints "1+x^2"
7364     e.print(print_myformat()); cout << endl;
7365
7366     ...
7367 @}
7368 @end example
7369
7370 To fill @code{print_myformat} with life, we need to supply appropriate
7371 print methods with @code{set_print_func()}, like this:
7372
7373 @example
7374 // This prints powers with '**' instead of '^'. See the LaTeX output
7375 // example above for explanations.
7376 void print_power_as_myformat(const power & p,
7377                              const print_myformat & c,
7378                              unsigned level)
7379 @{
7380     unsigned power_prec = p.precedence();
7381     if (level >= power_prec)
7382         c.s << '(';
7383     p.op(0).print(c, power_prec);
7384     c.s << "**";
7385     p.op(1).print(c, power_prec);
7386     if (level >= power_prec)
7387         c.s << ')';
7388 @}
7389
7390 @{
7391     ...
7392     // install a new print method for power objects
7393     set_print_func<power, print_myformat>(print_power_as_myformat);
7394
7395     // now this prints "1+x**2"
7396     e.print(print_myformat()); cout << endl;
7397
7398     // but the default format is still "1+x^2"
7399     cout << e << endl;
7400 @}
7401 @end example
7402
7403
7404 @node Structures, Adding classes, Printing, Extending GiNaC
7405 @c    node-name, next, previous, up
7406 @section Structures
7407
7408 If you are doing some very specialized things with GiNaC, or if you just
7409 need some more organized way to store data in your expressions instead of
7410 anonymous lists, you may want to implement your own algebraic classes.
7411 ('algebraic class' means any class directly or indirectly derived from
7412 @code{basic} that can be used in GiNaC expressions).
7413
7414 GiNaC offers two ways of accomplishing this: either by using the
7415 @code{structure<T>} template class, or by rolling your own class from
7416 scratch. This section will discuss the @code{structure<T>} template which
7417 is easier to use but more limited, while the implementation of custom
7418 GiNaC classes is the topic of the next section. However, you may want to
7419 read both sections because many common concepts and member functions are
7420 shared by both concepts, and it will also allow you to decide which approach
7421 is most suited to your needs.
7422
7423 The @code{structure<T>} template, defined in the GiNaC header file
7424 @file{structure.h}, wraps a type that you supply (usually a C++ @code{struct}
7425 or @code{class}) into a GiNaC object that can be used in expressions.
7426
7427 @subsection Example: scalar products
7428
7429 Let's suppose that we need a way to handle some kind of abstract scalar
7430 product of the form @samp{<x|y>} in expressions. Objects of the scalar
7431 product class have to store their left and right operands, which can in turn
7432 be arbitrary expressions. Here is a possible way to represent such a
7433 product in a C++ @code{struct}:
7434
7435 @example
7436 #include <iostream>
7437 using namespace std;
7438
7439 #include <ginac/ginac.h>
7440 using namespace GiNaC;
7441
7442 struct sprod_s @{
7443     ex left, right;
7444
7445     sprod_s() @{@}
7446     sprod_s(ex l, ex r) : left(l), right(r) @{@}
7447 @};
7448 @end example
7449
7450 The default constructor is required. Now, to make a GiNaC class out of this
7451 data structure, we need only one line:
7452
7453 @example
7454 typedef structure<sprod_s> sprod;
7455 @end example
7456
7457 That's it. This line constructs an algebraic class @code{sprod} which
7458 contains objects of type @code{sprod_s}. We can now use @code{sprod} in
7459 expressions like any other GiNaC class:
7460
7461 @example
7462 ...
7463     symbol a("a"), b("b");
7464     ex e = sprod(sprod_s(a, b));
7465 ...
7466 @end example
7467
7468 Note the difference between @code{sprod} which is the algebraic class, and
7469 @code{sprod_s} which is the unadorned C++ structure containing the @code{left}
7470 and @code{right} data members. As shown above, an @code{sprod} can be
7471 constructed from an @code{sprod_s} object.
7472
7473 If you find the nested @code{sprod(sprod_s())} constructor too unwieldy,
7474 you could define a little wrapper function like this:
7475
7476 @example
7477 inline ex make_sprod(ex left, ex right)
7478 @{
7479     return sprod(sprod_s(left, right));
7480 @}
7481 @end example
7482
7483 The @code{sprod_s} object contained in @code{sprod} can be accessed with
7484 the GiNaC @code{ex_to<>()} function followed by the @code{->} operator or
7485 @code{get_struct()}:
7486
7487 @example
7488 ...
7489     cout << ex_to<sprod>(e)->left << endl;
7490      // -> a
7491     cout << ex_to<sprod>(e).get_struct().right << endl;
7492      // -> b
7493 ...
7494 @end example
7495
7496 You only have read access to the members of @code{sprod_s}.
7497
7498 The type definition of @code{sprod} is enough to write your own algorithms
7499 that deal with scalar products, for example:
7500
7501 @example
7502 ex swap_sprod(ex p)
7503 @{
7504     if (is_a<sprod>(p)) @{
7505         const sprod_s & sp = ex_to<sprod>(p).get_struct();
7506         return make_sprod(sp.right, sp.left);
7507     @} else
7508         return p;
7509 @}
7510
7511 ...
7512     f = swap_sprod(e);
7513      // f is now <b|a>
7514 ...
7515 @end example
7516
7517 @subsection Structure output
7518
7519 While the @code{sprod} type is useable it still leaves something to be
7520 desired, most notably proper output:
7521
7522 @example
7523 ...
7524     cout << e << endl;
7525      // -> [structure object]
7526 ...
7527 @end example
7528
7529 By default, any structure types you define will be printed as
7530 @samp{[structure object]}. To override this you can either specialize the
7531 template's @code{print()} member function, or specify print methods with
7532 @code{set_print_func<>()}, as described in @ref{Printing}. Unfortunately,
7533 it's not possible to supply class options like @code{print_func<>()} to
7534 structures, so for a self-contained structure type you need to resort to
7535 overriding the @code{print()} function, which is also what we will do here.
7536
7537 The member functions of GiNaC classes are described in more detail in the
7538 next section, but it shouldn't be hard to figure out what's going on here:
7539
7540 @example
7541 void sprod::print(const print_context & c, unsigned level) const
7542 @{
7543     // tree debug output handled by superclass
7544     if (is_a<print_tree>(c))
7545         inherited::print(c, level);
7546
7547     // get the contained sprod_s object
7548     const sprod_s & sp = get_struct();
7549
7550     // print_context::s is a reference to an ostream
7551     c.s << "<" << sp.left << "|" << sp.right << ">";
7552 @}
7553 @end example
7554
7555 Now we can print expressions containing scalar products:
7556
7557 @example
7558 ...
7559     cout << e << endl;
7560      // -> <a|b>
7561     cout << swap_sprod(e) << endl;
7562      // -> <b|a>
7563 ...
7564 @end example
7565
7566 @subsection Comparing structures
7567
7568 The @code{sprod} class defined so far still has one important drawback: all
7569 scalar products are treated as being equal because GiNaC doesn't know how to
7570 compare objects of type @code{sprod_s}. This can lead to some confusing
7571 and undesired behavior:
7572
7573 @example
7574 ...
7575     cout << make_sprod(a, b) - make_sprod(a*a, b*b) << endl;
7576      // -> 0
7577     cout << make_sprod(a, b) + make_sprod(a*a, b*b) << endl;
7578      // -> 2*<a|b> or 2*<a^2|b^2> (which one is undefined)
7579 ...
7580 @end example
7581
7582 To remedy this, we first need to define the operators @code{==} and @code{<}
7583 for objects of type @code{sprod_s}:
7584
7585 @example
7586 inline bool operator==(const sprod_s & lhs, const sprod_s & rhs)
7587 @{
7588     return lhs.left.is_equal(rhs.left) && lhs.right.is_equal(rhs.right);
7589 @}
7590
7591 inline bool operator<(const sprod_s & lhs, const sprod_s & rhs)
7592 @{
7593     return lhs.left.compare(rhs.left) < 0
7594            ? true : lhs.right.compare(rhs.right) < 0;
7595 @}
7596 @end example
7597
7598 The ordering established by the @code{<} operator doesn't have to make any
7599 algebraic sense, but it needs to be well defined. Note that we can't use
7600 expressions like @code{lhs.left == rhs.left} or @code{lhs.left < rhs.left}
7601 in the implementation of these operators because they would construct
7602 GiNaC @code{relational} objects which in the case of @code{<} do not
7603 establish a well defined ordering (for arbitrary expressions, GiNaC can't
7604 decide which one is algebraically 'less').
7605
7606 Next, we need to change our definition of the @code{sprod} type to let
7607 GiNaC know that an ordering relation exists for the embedded objects:
7608
7609 @example
7610 typedef structure<sprod_s, compare_std_less> sprod;
7611 @end example
7612
7613 @code{sprod} objects then behave as expected:
7614
7615 @example
7616 ...
7617     cout << make_sprod(a, b) - make_sprod(a*a, b*b) << endl;
7618      // -> <a|b>-<a^2|b^2>
7619     cout << make_sprod(a, b) + make_sprod(a*a, b*b) << endl;
7620      // -> <a|b>+<a^2|b^2>
7621     cout << make_sprod(a, b) - make_sprod(a, b) << endl;
7622      // -> 0
7623     cout << make_sprod(a, b) + make_sprod(a, b) << endl;
7624      // -> 2*<a|b>
7625 ...
7626 @end example
7627
7628 The @code{compare_std_less} policy parameter tells GiNaC to use the
7629 @code{std::less} and @code{std::equal_to} functors to compare objects of
7630 type @code{sprod_s}. By default, these functors forward their work to the
7631 standard @code{<} and @code{==} operators, which we have overloaded.
7632 Alternatively, we could have specialized @code{std::less} and
7633 @code{std::equal_to} for class @code{sprod_s}.
7634
7635 GiNaC provides two other comparison policies for @code{structure<T>}
7636 objects: the default @code{compare_all_equal}, and @code{compare_bitwise}
7637 which does a bit-wise comparison of the contained @code{T} objects.
7638 This should be used with extreme care because it only works reliably with
7639 built-in integral types, and it also compares any padding (filler bytes of
7640 undefined value) that the @code{T} class might have.
7641
7642 @subsection Subexpressions
7643
7644 Our scalar product class has two subexpressions: the left and right
7645 operands. It might be a good idea to make them accessible via the standard
7646 @code{nops()} and @code{op()} methods:
7647
7648 @example
7649 size_t sprod::nops() const
7650 @{
7651     return 2;
7652 @}
7653
7654 ex sprod::op(size_t i) const
7655 @{
7656     switch (i) @{
7657     case 0:
7658         return get_struct().left;
7659     case 1:
7660         return get_struct().right;
7661     default:
7662         throw std::range_error("sprod::op(): no such operand");
7663     @}
7664 @}
7665 @end example
7666
7667 Implementing @code{nops()} and @code{op()} for container types such as
7668 @code{sprod} has two other nice side effects:
7669
7670 @itemize @bullet
7671 @item
7672 @code{has()} works as expected
7673 @item
7674 GiNaC generates better hash keys for the objects (the default implementation
7675 of @code{calchash()} takes subexpressions into account)
7676 @end itemize
7677
7678 @cindex @code{let_op()}
7679 There is a non-const variant of @code{op()} called @code{let_op()} that
7680 allows replacing subexpressions:
7681
7682 @example
7683 ex & sprod::let_op(size_t i)
7684 @{
7685     // every non-const member function must call this
7686     ensure_if_modifiable();
7687
7688     switch (i) @{
7689     case 0:
7690         return get_struct().left;
7691     case 1:
7692         return get_struct().right;
7693     default:
7694         throw std::range_error("sprod::let_op(): no such operand");
7695     @}
7696 @}
7697 @end example
7698
7699 Once we have provided @code{let_op()} we also get @code{subs()} and
7700 @code{map()} for free. In fact, every container class that returns a non-null
7701 @code{nops()} value must either implement @code{let_op()} or provide custom
7702 implementations of @code{subs()} and @code{map()}.
7703
7704 In turn, the availability of @code{map()} enables the recursive behavior of a
7705 couple of other default method implementations, in particular @code{evalf()},
7706 @code{evalm()}, @code{normal()}, @code{diff()} and @code{expand()}. Although
7707 we probably want to provide our own version of @code{expand()} for scalar
7708 products that turns expressions like @samp{<a+b|c>} into @samp{<a|c>+<b|c>}.
7709 This is left as an exercise for the reader.
7710
7711 The @code{structure<T>} template defines many more member functions that
7712 you can override by specialization to customize the behavior of your
7713 structures. You are referred to the next section for a description of
7714 some of these (especially @code{eval()}). There is, however, one topic
7715 that shall be addressed here, as it demonstrates one peculiarity of the
7716 @code{structure<T>} template: archiving.
7717
7718 @subsection Archiving structures
7719
7720 If you don't know how the archiving of GiNaC objects is implemented, you
7721 should first read the next section and then come back here. You're back?
7722 Good.
7723
7724 To implement archiving for structures it is not enough to provide
7725 specializations for the @code{archive()} member function and the
7726 unarchiving constructor (the @code{unarchive()} function has a default
7727 implementation). You also need to provide a unique name (as a string literal)
7728 for each structure type you define. This is because in GiNaC archives,
7729 the class of an object is stored as a string, the class name.
7730
7731 By default, this class name (as returned by the @code{class_name()} member
7732 function) is @samp{structure} for all structure classes. This works as long
7733 as you have only defined one structure type, but if you use two or more you
7734 need to provide a different name for each by specializing the
7735 @code{get_class_name()} member function. Here is a sample implementation
7736 for enabling archiving of the scalar product type defined above:
7737
7738 @example
7739 const char *sprod::get_class_name() @{ return "sprod"; @}
7740
7741 void sprod::archive(archive_node & n) const
7742 @{
7743     inherited::archive(n);
7744     n.add_ex("left", get_struct().left);
7745     n.add_ex("right", get_struct().right);
7746 @}
7747
7748 sprod::structure(const archive_node & n, lst & sym_lst) : inherited(n, sym_lst)
7749 @{
7750     n.find_ex("left", get_struct().left, sym_lst);
7751     n.find_ex("right", get_struct().right, sym_lst);
7752 @}
7753 @end example
7754
7755 Note that the unarchiving constructor is @code{sprod::structure} and not
7756 @code{sprod::sprod}, and that we don't need to supply an
7757 @code{sprod::unarchive()} function.
7758
7759
7760 @node Adding classes, A comparison with other CAS, Structures, Extending GiNaC
7761 @c    node-name, next, previous, up
7762 @section Adding classes
7763
7764 The @code{structure<T>} template provides an way to extend GiNaC with custom
7765 algebraic classes that is easy to use but has its limitations, the most
7766 severe of which being that you can't add any new member functions to
7767 structures. To be able to do this, you need to write a new class definition
7768 from scratch.
7769
7770 This section will explain how to implement new algebraic classes in GiNaC by
7771 giving the example of a simple 'string' class. After reading this section
7772 you will know how to properly declare a GiNaC class and what the minimum
7773 required member functions are that you have to implement. We only cover the
7774 implementation of a 'leaf' class here (i.e. one that doesn't contain
7775 subexpressions). Creating a container class like, for example, a class
7776 representing tensor products is more involved but this section should give
7777 you enough information so you can consult the source to GiNaC's predefined
7778 classes if you want to implement something more complicated.
7779
7780 @subsection GiNaC's run-time type information system
7781
7782 @cindex hierarchy of classes
7783 @cindex RTTI
7784 All algebraic classes (that is, all classes that can appear in expressions)
7785 in GiNaC are direct or indirect subclasses of the class @code{basic}. So a
7786 @code{basic *} (which is essentially what an @code{ex} is) represents a
7787 generic pointer to an algebraic class. Occasionally it is necessary to find
7788 out what the class of an object pointed to by a @code{basic *} really is.
7789 Also, for the unarchiving of expressions it must be possible to find the
7790 @code{unarchive()} function of a class given the class name (as a string). A
7791 system that provides this kind of information is called a run-time type
7792 information (RTTI) system. The C++ language provides such a thing (see the
7793 standard header file @file{<typeinfo>}) but for efficiency reasons GiNaC
7794 implements its own, simpler RTTI.
7795
7796 The RTTI in GiNaC is based on two mechanisms:
7797
7798 @itemize @bullet
7799
7800 @item
7801 The @code{basic} class declares a member variable @code{tinfo_key} which
7802 holds a variable of @code{tinfo_t} type (which is actually just
7803 @code{const void*}) that identifies the object's class.
7804
7805 @item
7806 By means of some clever tricks with static members, GiNaC maintains a list
7807 of information for all classes derived from @code{basic}. The information
7808 available includes the class names, the @code{tinfo_key}s, and pointers
7809 to the unarchiving functions. This class registry is defined in the
7810 @file{registrar.h} header file.
7811
7812 @end itemize
7813
7814 The disadvantage of this proprietary RTTI implementation is that there's
7815 a little more to do when implementing new classes (C++'s RTTI works more
7816 or less automatically) but don't worry, most of the work is simplified by
7817 macros.
7818
7819 @subsection A minimalistic example
7820
7821 Now we will start implementing a new class @code{mystring} that allows
7822 placing character strings in algebraic expressions (this is not very useful,
7823 but it's just an example). This class will be a direct subclass of
7824 @code{basic}. You can use this sample implementation as a starting point
7825 for your own classes.
7826
7827 The code snippets given here assume that you have included some header files
7828 as follows:
7829
7830 @example
7831 #include <iostream>
7832 #include <string>   
7833 #include <stdexcept>
7834 using namespace std;
7835
7836 #include <ginac/ginac.h>
7837 using namespace GiNaC;
7838 @end example
7839
7840 Now we can write down the class declaration. The class stores a C++
7841 @code{string} and the user shall be able to construct a @code{mystring}
7842 object from a C or C++ string:
7843
7844 @example
7845 class mystring : public basic
7846 @{
7847     GINAC_DECLARE_REGISTERED_CLASS(mystring, basic)
7848   
7849 public:
7850     mystring(const string & s);
7851     mystring(const char * s);
7852
7853 private:
7854     string str;
7855 @};
7856
7857 GINAC_IMPLEMENT_REGISTERED_CLASS(mystring, basic)
7858 @end example
7859
7860 The @code{GINAC_DECLARE_REGISTERED_CLASS} and @code{GINAC_IMPLEMENT_REGISTERED_CLASS}
7861 macros are defined in @file{registrar.h}. They take the name of the class
7862 and its direct superclass as arguments and insert all required declarations
7863 for the RTTI system. The @code{GINAC_DECLARE_REGISTERED_CLASS} should be
7864 the first line after the opening brace of the class definition. The
7865 @code{GINAC_IMPLEMENT_REGISTERED_CLASS} may appear anywhere else in the
7866 source (at global scope, of course, not inside a function).
7867
7868 @code{GINAC_DECLARE_REGISTERED_CLASS} contains, among other things the
7869 declarations of the default constructor and a couple of other functions that
7870 are required. It also defines a type @code{inherited} which refers to the
7871 superclass so you don't have to modify your code every time you shuffle around
7872 the class hierarchy. @code{GINAC_IMPLEMENT_REGISTERED_CLASS} registers the
7873 class with the GiNaC RTTI (there is also a
7874 @code{GINAC_IMPLEMENT_REGISTERED_CLASS_OPT} which allows specifying additional
7875 options for the class, and which we will be using instead in a few minutes).
7876
7877 Now there are seven member functions we have to implement to get a working
7878 class:
7879
7880 @itemize
7881
7882 @item
7883 @code{mystring()}, the default constructor.
7884
7885 @item
7886 @code{void archive(archive_node & n)}, the archiving function. This stores all
7887 information needed to reconstruct an object of this class inside an
7888 @code{archive_node}.
7889
7890 @item
7891 @code{mystring(const archive_node & n, lst & sym_lst)}, the unarchiving
7892 constructor. This constructs an instance of the class from the information
7893 found in an @code{archive_node}.
7894
7895 @item
7896 @code{ex unarchive(const archive_node & n, lst & sym_lst)}, the static
7897 unarchiving function. It constructs a new instance by calling the unarchiving
7898 constructor.
7899
7900 @item
7901 @cindex @code{compare_same_type()}
7902 @code{int compare_same_type(const basic & other)}, which is used internally
7903 by GiNaC to establish a canonical sort order for terms. It returns 0, +1 or
7904 -1, depending on the relative order of this object and the @code{other}
7905 object. If it returns 0, the objects are considered equal.
7906 @strong{Please notice:} This has nothing to do with the (numeric) ordering
7907 relationship expressed by @code{<}, @code{>=} etc (which cannot be defined
7908 for non-numeric classes). For example, @code{numeric(1).compare_same_type(numeric(2))}
7909 may return +1 even though 1 is clearly smaller than 2. Every GiNaC class
7910 must provide a @code{compare_same_type()} function, even those representing
7911 objects for which no reasonable algebraic ordering relationship can be
7912 defined.
7913
7914 @item
7915 And, of course, @code{mystring(const string & s)} and @code{mystring(const char * s)}
7916 which are the two constructors we declared.
7917
7918 @end itemize
7919
7920 Let's proceed step-by-step. The default constructor looks like this:
7921
7922 @example
7923 mystring::mystring() : inherited(&mystring::tinfo_static) @{@}
7924 @end example
7925
7926 The golden rule is that in all constructors you have to set the
7927 @code{tinfo_key} member to the @code{&your_class_name::tinfo_static}
7928 @footnote{Each GiNaC class has a static member called tinfo_static.
7929 This member is declared by the GINAC_DECLARE_REGISTERED_CLASS macros
7930 and defined by the GINAC_IMPLEMENT_REGISTERED_CLASS macros.}. Otherwise
7931 it will be set by the constructor of the superclass and all hell will break
7932 loose in the RTTI. For your convenience, the @code{basic} class provides
7933 a constructor that takes a @code{tinfo_key} value, which we are using here
7934 (remember that in our case @code{inherited == basic}).  If the superclass
7935 didn't have such a constructor, we would have to set the @code{tinfo_key}
7936 to the right value manually.
7937
7938 In the default constructor you should set all other member variables to
7939 reasonable default values (we don't need that here since our @code{str}
7940 member gets set to an empty string automatically).
7941
7942 Next are the three functions for archiving. You have to implement them even
7943 if you don't plan to use archives, but the minimum required implementation
7944 is really simple.  First, the archiving function:
7945
7946 @example
7947 void mystring::archive(archive_node & n) const
7948 @{
7949     inherited::archive(n);
7950     n.add_string("string", str);
7951 @}
7952 @end example
7953
7954 The only thing that is really required is calling the @code{archive()}
7955 function of the superclass. Optionally, you can store all information you
7956 deem necessary for representing the object into the passed
7957 @code{archive_node}.  We are just storing our string here. For more
7958 information on how the archiving works, consult the @file{archive.h} header
7959 file.
7960
7961 The unarchiving constructor is basically the inverse of the archiving
7962 function:
7963
7964 @example
7965 mystring::mystring(const archive_node & n, lst & sym_lst) : inherited(n, sym_lst)
7966 @{
7967     n.find_string("string", str);
7968 @}
7969 @end example
7970
7971 If you don't need archiving, just leave this function empty (but you must
7972 invoke the unarchiving constructor of the superclass). Note that we don't
7973 have to set the @code{tinfo_key} here because it is done automatically
7974 by the unarchiving constructor of the @code{basic} class.
7975
7976 Finally, the unarchiving function:
7977
7978 @example
7979 ex mystring::unarchive(const archive_node & n, lst & sym_lst)
7980 @{
7981     return (new mystring(n, sym_lst))->setflag(status_flags::dynallocated);
7982 @}
7983 @end example
7984
7985 You don't have to understand how exactly this works. Just copy these
7986 four lines into your code literally (replacing the class name, of
7987 course).  It calls the unarchiving constructor of the class and unless
7988 you are doing something very special (like matching @code{archive_node}s
7989 to global objects) you don't need a different implementation. For those
7990 who are interested: setting the @code{dynallocated} flag puts the object
7991 under the control of GiNaC's garbage collection.  It will get deleted
7992 automatically once it is no longer referenced.
7993
7994 Our @code{compare_same_type()} function uses a provided function to compare
7995 the string members:
7996
7997 @example
7998 int mystring::compare_same_type(const basic & other) const
7999 @{
8000     const mystring &o = static_cast<const mystring &>(other);
8001     int cmpval = str.compare(o.str);
8002     if (cmpval == 0)
8003         return 0;
8004     else if (cmpval < 0)
8005         return -1;
8006     else
8007         return 1;
8008 @}
8009 @end example
8010
8011 Although this function takes a @code{basic &}, it will always be a reference
8012 to an object of exactly the same class (objects of different classes are not
8013 comparable), so the cast is safe. If this function returns 0, the two objects
8014 are considered equal (in the sense that @math{A-B=0}), so you should compare
8015 all relevant member variables.
8016
8017 Now the only thing missing is our two new constructors:
8018
8019 @example
8020 mystring::mystring(const string & s)
8021     : inherited(&mystring::tinfo_static), str(s) @{@}
8022 mystring::mystring(const char * s)
8023     : inherited(&mystring::tinfo_static), str(s) @{@}
8024 @end example
8025
8026 No surprises here. We set the @code{str} member from the argument and
8027 remember to pass the right @code{tinfo_key} to the @code{basic} constructor.
8028
8029 That's it! We now have a minimal working GiNaC class that can store
8030 strings in algebraic expressions. Let's confirm that the RTTI works:
8031
8032 @example
8033 ex e = mystring("Hello, world!");
8034 cout << is_a<mystring>(e) << endl;
8035  // -> 1 (true)
8036
8037 cout << ex_to<basic>(e).class_name() << endl;
8038  // -> mystring
8039 @end example
8040
8041 Obviously it does. Let's see what the expression @code{e} looks like:
8042
8043 @example
8044 cout << e << endl;
8045  // -> [mystring object]
8046 @end example
8047
8048 Hm, not exactly what we expect, but of course the @code{mystring} class
8049 doesn't yet know how to print itself. This can be done either by implementing
8050 the @code{print()} member function, or, preferably, by specifying a
8051 @code{print_func<>()} class option. Let's say that we want to print the string
8052 surrounded by double quotes:
8053
8054 @example
8055 class mystring : public basic
8056 @{
8057     ...
8058 protected:
8059     void do_print(const print_context & c, unsigned level = 0) const;
8060     ...
8061 @};
8062
8063 void mystring::do_print(const print_context & c, unsigned level) const
8064 @{
8065     // print_context::s is a reference to an ostream
8066     c.s << '\"' << str << '\"';
8067 @}
8068 @end example
8069
8070 The @code{level} argument is only required for container classes to
8071 correctly parenthesize the output.
8072
8073 Now we need to tell GiNaC that @code{mystring} objects should use the
8074 @code{do_print()} member function for printing themselves. For this, we
8075 replace the line
8076
8077 @example
8078 GINAC_IMPLEMENT_REGISTERED_CLASS(mystring, basic)
8079 @end example
8080
8081 with
8082
8083 @example
8084 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(mystring, basic,
8085   print_func<print_context>(&mystring::do_print))
8086 @end example
8087
8088 Let's try again to print the expression:
8089
8090 @example
8091 cout << e << endl;
8092  // -> "Hello, world!"
8093 @end example
8094
8095 Much better. If we wanted to have @code{mystring} objects displayed in a
8096 different way depending on the output format (default, LaTeX, etc.), we
8097 would have supplied multiple @code{print_func<>()} options with different
8098 template parameters (@code{print_dflt}, @code{print_latex}, etc.),
8099 separated by dots. This is similar to the way options are specified for
8100 symbolic functions. @xref{Printing}, for a more in-depth description of the
8101 way expression output is implemented in GiNaC.
8102
8103 The @code{mystring} class can be used in arbitrary expressions:
8104
8105 @example
8106 e += mystring("GiNaC rulez"); 
8107 cout << e << endl;
8108  // -> "GiNaC rulez"+"Hello, world!"
8109 @end example
8110
8111 (GiNaC's automatic term reordering is in effect here), or even
8112
8113 @example
8114 e = pow(mystring("One string"), 2*sin(Pi-mystring("Another string")));
8115 cout << e << endl;
8116  // -> "One string"^(2*sin(-"Another string"+Pi))
8117 @end example
8118
8119 Whether this makes sense is debatable but remember that this is only an
8120 example. At least it allows you to implement your own symbolic algorithms
8121 for your objects.
8122
8123 Note that GiNaC's algebraic rules remain unchanged:
8124
8125 @example
8126 e = mystring("Wow") * mystring("Wow");
8127 cout << e << endl;
8128  // -> "Wow"^2
8129
8130 e = pow(mystring("First")-mystring("Second"), 2);
8131 cout << e.expand() << endl;
8132  // -> -2*"First"*"Second"+"First"^2+"Second"^2
8133 @end example
8134
8135 There's no way to, for example, make GiNaC's @code{add} class perform string
8136 concatenation. You would have to implement this yourself.
8137
8138 @subsection Automatic evaluation
8139
8140 @cindex evaluation
8141 @cindex @code{eval()}
8142 @cindex @code{hold()}
8143 When dealing with objects that are just a little more complicated than the
8144 simple string objects we have implemented, chances are that you will want to
8145 have some automatic simplifications or canonicalizations performed on them.
8146 This is done in the evaluation member function @code{eval()}. Let's say that
8147 we wanted all strings automatically converted to lowercase with
8148 non-alphabetic characters stripped, and empty strings removed:
8149
8150 @example
8151 class mystring : public basic
8152 @{
8153     ...
8154 public:
8155     ex eval(int level = 0) const;
8156     ...
8157 @};
8158
8159 ex mystring::eval(int level) const
8160 @{
8161     string new_str;
8162     for (size_t i=0; i<str.length(); i++) @{
8163         char c = str[i];
8164         if (c >= 'A' && c <= 'Z') 
8165             new_str += tolower(c);
8166         else if (c >= 'a' && c <= 'z')
8167             new_str += c;
8168     @}
8169
8170     if (new_str.length() == 0)
8171         return 0;
8172     else
8173         return mystring(new_str).hold();
8174 @}
8175 @end example
8176
8177 The @code{level} argument is used to limit the recursion depth of the
8178 evaluation.  We don't have any subexpressions in the @code{mystring}
8179 class so we are not concerned with this.  If we had, we would call the
8180 @code{eval()} functions of the subexpressions with @code{level - 1} as
8181 the argument if @code{level != 1}.  The @code{hold()} member function
8182 sets a flag in the object that prevents further evaluation.  Otherwise
8183 we might end up in an endless loop.  When you want to return the object
8184 unmodified, use @code{return this->hold();}.
8185
8186 Let's confirm that it works:
8187
8188 @example
8189 ex e = mystring("Hello, world!") + mystring("!?#");
8190 cout << e << endl;
8191  // -> "helloworld"
8192
8193 e = mystring("Wow!") + mystring("WOW") + mystring(" W ** o ** W");  
8194 cout << e << endl;
8195  // -> 3*"wow"
8196 @end example
8197
8198 @subsection Optional member functions
8199
8200 We have implemented only a small set of member functions to make the class
8201 work in the GiNaC framework. There are two functions that are not strictly
8202 required but will make operations with objects of the class more efficient:
8203
8204 @cindex @code{calchash()}
8205 @cindex @code{is_equal_same_type()}
8206 @example
8207 unsigned calchash() const;
8208 bool is_equal_same_type(const basic & other) const;
8209 @end example
8210
8211 The @code{calchash()} method returns an @code{unsigned} hash value for the
8212 object which will allow GiNaC to compare and canonicalize expressions much
8213 more efficiently. You should consult the implementation of some of the built-in
8214 GiNaC classes for examples of hash functions. The default implementation of
8215 @code{calchash()} calculates a hash value out of the @code{tinfo_key} of the
8216 class and all subexpressions that are accessible via @code{op()}.
8217
8218 @code{is_equal_same_type()} works like @code{compare_same_type()} but only
8219 tests for equality without establishing an ordering relation, which is often
8220 faster. The default implementation of @code{is_equal_same_type()} just calls
8221 @code{compare_same_type()} and tests its result for zero.
8222
8223 @subsection Other member functions
8224
8225 For a real algebraic class, there are probably some more functions that you
8226 might want to provide:
8227
8228 @example
8229 bool info(unsigned inf) const;
8230 ex evalf(int level = 0) const;
8231 ex series(const relational & r, int order, unsigned options = 0) const;
8232 ex derivative(const symbol & s) const;
8233 @end example
8234
8235 If your class stores sub-expressions (see the scalar product example in the
8236 previous section) you will probably want to override
8237
8238 @cindex @code{let_op()}
8239 @example
8240 size_t nops() cont;
8241 ex op(size_t i) const;
8242 ex & let_op(size_t i);
8243 ex subs(const lst & ls, const lst & lr, unsigned options = 0) const;
8244 ex map(map_function & f) const;
8245 @end example
8246
8247 @code{let_op()} is a variant of @code{op()} that allows write access. The
8248 default implementations of @code{subs()} and @code{map()} use it, so you have
8249 to implement either @code{let_op()}, or @code{subs()} and @code{map()}.
8250
8251 You can, of course, also add your own new member functions. Remember
8252 that the RTTI may be used to get information about what kinds of objects
8253 you are dealing with (the position in the class hierarchy) and that you
8254 can always extract the bare object from an @code{ex} by stripping the
8255 @code{ex} off using the @code{ex_to<mystring>(e)} function when that
8256 should become a need.
8257
8258 That's it. May the source be with you!
8259
8260 @subsection Upgrading extension classes from older version of GiNaC
8261
8262 If you got some extension classes for GiNaC 1.3.X some changes are
8263 necessary in order to make your code work with GiNaC 1.4.
8264
8265 @itemize @bullet
8266 @item constructors which set @code{tinfo_key} such as
8267
8268 @example
8269 myclass::myclass() : inherited(TINFO_myclass) @{@}
8270 @end example
8271
8272 need to be rewritten as
8273
8274 @example
8275 myclass::myclass() : inherited(&myclass::tinfo_static) @{@}
8276 @end example
8277
8278 @item TINO_myclass is not necessary any more and can be removed.
8279
8280 @end itemize
8281
8282
8283 @node A comparison with other CAS, Advantages, Adding classes, Top
8284 @c    node-name, next, previous, up
8285 @chapter A Comparison With Other CAS
8286 @cindex advocacy
8287
8288 This chapter will give you some information on how GiNaC compares to
8289 other, traditional Computer Algebra Systems, like @emph{Maple},
8290 @emph{Mathematica} or @emph{Reduce}, where it has advantages and
8291 disadvantages over these systems.
8292
8293 @menu
8294 * Advantages::                       Strengths of the GiNaC approach.
8295 * Disadvantages::                    Weaknesses of the GiNaC approach.
8296 * Why C++?::                         Attractiveness of C++.
8297 @end menu
8298
8299 @node Advantages, Disadvantages, A comparison with other CAS, A comparison with other CAS
8300 @c    node-name, next, previous, up
8301 @section Advantages
8302
8303 GiNaC has several advantages over traditional Computer
8304 Algebra Systems, like 
8305
8306 @itemize @bullet
8307
8308 @item
8309 familiar language: all common CAS implement their own proprietary
8310 grammar which you have to learn first (and maybe learn again when your
8311 vendor decides to `enhance' it).  With GiNaC you can write your program
8312 in common C++, which is standardized.
8313
8314 @cindex STL
8315 @item
8316 structured data types: you can build up structured data types using
8317 @code{struct}s or @code{class}es together with STL features instead of
8318 using unnamed lists of lists of lists.
8319
8320 @item
8321 strongly typed: in CAS, you usually have only one kind of variables
8322 which can hold contents of an arbitrary type.  This 4GL like feature is
8323 nice for novice programmers, but dangerous.
8324     
8325 @item
8326 development tools: powerful development tools exist for C++, like fancy
8327 editors (e.g. with automatic indentation and syntax highlighting),
8328 debuggers, visualization tools, documentation generators@dots{}
8329
8330 @item
8331 modularization: C++ programs can easily be split into modules by
8332 separating interface and implementation.
8333
8334 @item
8335 price: GiNaC is distributed under the GNU Public License which means
8336 that it is free and available with source code.  And there are excellent
8337 C++-compilers for free, too.
8338     
8339 @item
8340 extendable: you can add your own classes to GiNaC, thus extending it on
8341 a very low level.  Compare this to a traditional CAS that you can
8342 usually only extend on a high level by writing in the language defined
8343 by the parser.  In particular, it turns out to be almost impossible to
8344 fix bugs in a traditional system.
8345
8346 @item
8347 multiple interfaces: Though real GiNaC programs have to be written in
8348 some editor, then be compiled, linked and executed, there are more ways
8349 to work with the GiNaC engine.  Many people want to play with
8350 expressions interactively, as in traditional CASs.  Currently, two such
8351 windows into GiNaC have been implemented and many more are possible: the
8352 tiny @command{ginsh} that is part of the distribution exposes GiNaC's
8353 types to a command line and second, as a more consistent approach, an
8354 interactive interface to the Cint C++ interpreter has been put together
8355 (called GiNaC-cint) that allows an interactive scripting interface
8356 consistent with the C++ language.  It is available from the usual GiNaC
8357 FTP-site.
8358
8359 @item
8360 seamless integration: it is somewhere between difficult and impossible
8361 to call CAS functions from within a program written in C++ or any other
8362 programming language and vice versa.  With GiNaC, your symbolic routines
8363 are part of your program.  You can easily call third party libraries,
8364 e.g. for numerical evaluation or graphical interaction.  All other
8365 approaches are much more cumbersome: they range from simply ignoring the
8366 problem (i.e. @emph{Maple}) to providing a method for `embedding' the
8367 system (i.e. @emph{Yacas}).
8368
8369 @item
8370 efficiency: often large parts of a program do not need symbolic
8371 calculations at all.  Why use large integers for loop variables or
8372 arbitrary precision arithmetics where @code{int} and @code{double} are
8373 sufficient?  For pure symbolic applications, GiNaC is comparable in
8374 speed with other CAS.
8375
8376 @end itemize
8377
8378
8379 @node Disadvantages, Why C++?, Advantages, A comparison with other CAS
8380 @c    node-name, next, previous, up
8381 @section Disadvantages
8382
8383 Of course it also has some disadvantages:
8384
8385 @itemize @bullet
8386
8387 @item
8388 advanced features: GiNaC cannot compete with a program like
8389 @emph{Reduce} which exists for more than 30 years now or @emph{Maple}
8390 which grows since 1981 by the work of dozens of programmers, with
8391 respect to mathematical features.  Integration, factorization,
8392 non-trivial simplifications, limits etc. are missing in GiNaC (and are
8393 not planned for the near future).
8394
8395 @item
8396 portability: While the GiNaC library itself is designed to avoid any
8397 platform dependent features (it should compile on any ANSI compliant C++
8398 compiler), the currently used version of the CLN library (fast large
8399 integer and arbitrary precision arithmetics) can only by compiled
8400 without hassle on systems with the C++ compiler from the GNU Compiler
8401 Collection (GCC).@footnote{This is because CLN uses PROVIDE/REQUIRE like
8402 macros to let the compiler gather all static initializations, which
8403 works for GNU C++ only.  Feel free to contact the authors in case you
8404 really believe that you need to use a different compiler.  We have
8405 occasionally used other compilers and may be able to give you advice.}
8406 GiNaC uses recent language features like explicit constructors, mutable
8407 members, RTTI, @code{dynamic_cast}s and STL, so ANSI compliance is meant
8408 literally.  Recent GCC versions starting at 2.95.3, although itself not
8409 yet ANSI compliant, support all needed features.
8410     
8411 @end itemize
8412
8413
8414 @node Why C++?, Internal structures, Disadvantages, A comparison with other CAS
8415 @c    node-name, next, previous, up
8416 @section Why C++?
8417
8418 Why did we choose to implement GiNaC in C++ instead of Java or any other
8419 language?  C++ is not perfect: type checking is not strict (casting is
8420 possible), separation between interface and implementation is not
8421 complete, object oriented design is not enforced.  The main reason is
8422 the often scolded feature of operator overloading in C++.  While it may
8423 be true that operating on classes with a @code{+} operator is rarely
8424 meaningful, it is perfectly suited for algebraic expressions.  Writing
8425 @math{3x+5y} as @code{3*x+5*y} instead of
8426 @code{x.times(3).plus(y.times(5))} looks much more natural.
8427 Furthermore, the main developers are more familiar with C++ than with
8428 any other programming language.
8429
8430
8431 @node Internal structures, Expressions are reference counted, Why C++? , Top
8432 @c    node-name, next, previous, up
8433 @appendix Internal structures
8434
8435 @menu
8436 * Expressions are reference counted::
8437 * Internal representation of products and sums::
8438 @end menu
8439
8440 @node Expressions are reference counted, Internal representation of products and sums, Internal structures, Internal structures
8441 @c    node-name, next, previous, up
8442 @appendixsection Expressions are reference counted
8443
8444 @cindex reference counting
8445 @cindex copy-on-write
8446 @cindex garbage collection
8447 In GiNaC, there is an @emph{intrusive reference-counting} mechanism at work
8448 where the counter belongs to the algebraic objects derived from class
8449 @code{basic} but is maintained by the smart pointer class @code{ptr}, of
8450 which @code{ex} contains an instance. If you understood that, you can safely
8451 skip the rest of this passage.
8452
8453 Expressions are extremely light-weight since internally they work like
8454 handles to the actual representation.  They really hold nothing more
8455 than a pointer to some other object.  What this means in practice is
8456 that whenever you create two @code{ex} and set the second equal to the
8457 first no copying process is involved. Instead, the copying takes place
8458 as soon as you try to change the second.  Consider the simple sequence
8459 of code:
8460
8461 @example
8462 #include <iostream>
8463 #include <ginac/ginac.h>
8464 using namespace std;
8465 using namespace GiNaC;
8466
8467 int main()
8468 @{
8469     symbol x("x"), y("y"), z("z");
8470     ex e1, e2;
8471
8472     e1 = sin(x + 2*y) + 3*z + 41;
8473     e2 = e1;                // e2 points to same object as e1
8474     cout << e2 << endl;     // prints sin(x+2*y)+3*z+41
8475     e2 += 1;                // e2 is copied into a new object
8476     cout << e2 << endl;     // prints sin(x+2*y)+3*z+42
8477 @}
8478 @end example
8479
8480 The line @code{e2 = e1;} creates a second expression pointing to the
8481 object held already by @code{e1}.  The time involved for this operation
8482 is therefore constant, no matter how large @code{e1} was.  Actual
8483 copying, however, must take place in the line @code{e2 += 1;} because
8484 @code{e1} and @code{e2} are not handles for the same object any more.
8485 This concept is called @dfn{copy-on-write semantics}.  It increases
8486 performance considerably whenever one object occurs multiple times and
8487 represents a simple garbage collection scheme because when an @code{ex}
8488 runs out of scope its destructor checks whether other expressions handle
8489 the object it points to too and deletes the object from memory if that
8490 turns out not to be the case.  A slightly less trivial example of
8491 differentiation using the chain-rule should make clear how powerful this
8492 can be:
8493
8494 @example
8495 @{
8496     symbol x("x"), y("y");
8497
8498     ex e1 = x + 3*y;
8499     ex e2 = pow(e1, 3);
8500     ex e3 = diff(sin(e2), x);   // first derivative of sin(e2) by x
8501     cout << e1 << endl          // prints x+3*y
8502          << e2 << endl          // prints (x+3*y)^3
8503          << e3 << endl;         // prints 3*(x+3*y)^2*cos((x+3*y)^3)
8504 @}
8505 @end example
8506
8507 Here, @code{e1} will actually be referenced three times while @code{e2}
8508 will be referenced two times.  When the power of an expression is built,
8509 that expression needs not be copied.  Likewise, since the derivative of
8510 a power of an expression can be easily expressed in terms of that
8511 expression, no copying of @code{e1} is involved when @code{e3} is
8512 constructed.  So, when @code{e3} is constructed it will print as
8513 @code{3*(x+3*y)^2*cos((x+3*y)^3)} but the argument of @code{cos()} only
8514 holds a reference to @code{e2} and the factor in front is just
8515 @code{3*e1^2}.
8516
8517 As a user of GiNaC, you cannot see this mechanism of copy-on-write
8518 semantics.  When you insert an expression into a second expression, the
8519 result behaves exactly as if the contents of the first expression were
8520 inserted.  But it may be useful to remember that this is not what
8521 happens.  Knowing this will enable you to write much more efficient
8522 code.  If you still have an uncertain feeling with copy-on-write
8523 semantics, we recommend you have a look at the
8524 @uref{http://www.parashift.com/c++-faq-lite/, C++-FAQ lite} by
8525 Marshall Cline.  Chapter 16 covers this issue and presents an
8526 implementation which is pretty close to the one in GiNaC.
8527
8528
8529 @node Internal representation of products and sums, Package tools, Expressions are reference counted, Internal structures
8530 @c    node-name, next, previous, up
8531 @appendixsection Internal representation of products and sums
8532
8533 @cindex representation
8534 @cindex @code{add}
8535 @cindex @code{mul}
8536 @cindex @code{power}
8537 Although it should be completely transparent for the user of
8538 GiNaC a short discussion of this topic helps to understand the sources
8539 and also explain performance to a large degree.  Consider the 
8540 unexpanded symbolic expression 
8541 @tex
8542 $2d^3 \left( 4a + 5b - 3 \right)$
8543 @end tex
8544 @ifnottex
8545 @math{2*d^3*(4*a+5*b-3)}
8546 @end ifnottex
8547 which could naively be represented by a tree of linear containers for
8548 addition and multiplication, one container for exponentiation with base
8549 and exponent and some atomic leaves of symbols and numbers in this
8550 fashion:
8551
8552 @image{repnaive}
8553
8554 @cindex pair-wise representation
8555 However, doing so results in a rather deeply nested tree which will
8556 quickly become inefficient to manipulate.  We can improve on this by
8557 representing the sum as a sequence of terms, each one being a pair of a
8558 purely numeric multiplicative coefficient and its rest.  In the same
8559 spirit we can store the multiplication as a sequence of terms, each
8560 having a numeric exponent and a possibly complicated base, the tree
8561 becomes much more flat:
8562
8563 @image{reppair}
8564
8565 The number @code{3} above the symbol @code{d} shows that @code{mul}
8566 objects are treated similarly where the coefficients are interpreted as
8567 @emph{exponents} now.  Addition of sums of terms or multiplication of
8568 products with numerical exponents can be coded to be very efficient with
8569 such a pair-wise representation.  Internally, this handling is performed
8570 by most CAS in this way.  It typically speeds up manipulations by an
8571 order of magnitude.  The overall multiplicative factor @code{2} and the
8572 additive term @code{-3} look somewhat out of place in this
8573 representation, however, since they are still carrying a trivial
8574 exponent and multiplicative factor @code{1} respectively.  Within GiNaC,
8575 this is avoided by adding a field that carries an overall numeric
8576 coefficient.  This results in the realistic picture of internal
8577 representation for
8578 @tex
8579 $2d^3 \left( 4a + 5b - 3 \right)$:
8580 @end tex
8581 @ifnottex
8582 @math{2*d^3*(4*a+5*b-3)}:
8583 @end ifnottex
8584
8585 @image{repreal}
8586
8587 @cindex radical
8588 This also allows for a better handling of numeric radicals, since
8589 @code{sqrt(2)} can now be carried along calculations.  Now it should be
8590 clear, why both classes @code{add} and @code{mul} are derived from the
8591 same abstract class: the data representation is the same, only the
8592 semantics differs.  In the class hierarchy, methods for polynomial
8593 expansion and the like are reimplemented for @code{add} and @code{mul},
8594 but the data structure is inherited from @code{expairseq}.
8595
8596
8597 @node Package tools, Configure script options, Internal representation of products and sums, Top
8598 @c    node-name, next, previous, up
8599 @appendix Package tools
8600
8601 If you are creating a software package that uses the GiNaC library,
8602 setting the correct command line options for the compiler and linker can
8603 be difficult.  The @command{pkg-config} utility makes this process
8604 easier.  GiNaC supplies all necessary data in @file{ginac.pc} (installed
8605 into @code{/usr/local/lib/pkgconfig} by default). To compile a simple
8606 program use @footnote{If GiNaC is installed into some non-standard
8607 directory @var{prefix} one should set the @var{PKG_CONFIG_PATH}
8608 environment variable to @var{prefix}/lib/pkgconfig for this to work.}
8609 @example
8610 g++ -o simple `pkg-config --cflags --libs ginac` simple.cpp
8611 @end example
8612
8613 This command line might expand to (for example):
8614 @example
8615 g++ -o simple -lginac -lcln simple.cpp
8616 @end example
8617
8618 Not only is the form using @command{pkg-config} easier to type, it will
8619 work on any system, no matter how GiNaC was configured.
8620
8621 For packages configured using GNU automake, @command{pkg-config} also
8622 provides the @code{PKG_CHECK_MODULES} macro to automate the process of
8623 checking for libraries
8624
8625 @example
8626 PKG_CHECK_MODULES(MYAPP, ginac >= MINIMUM_VERSION, 
8627                   [@var{ACTION-IF-FOUND}],
8628                   [@var{ACTION-IF-NOT-FOUND}])
8629 @end example
8630
8631 This macro:
8632
8633 @itemize @bullet
8634
8635 @item
8636 Determines the location of GiNaC using data from @file{ginac.pc}, which is
8637 either found in the default @command{pkg-config} search path, or from 
8638 the environment variable @env{PKG_CONFIG_PATH}.
8639
8640 @item
8641 Tests the installed libraries to make sure that their version
8642 is later than @var{MINIMUM-VERSION}.
8643
8644 @item
8645 If the required version was found, sets the @env{MYAPP_CFLAGS} variable
8646 to the output of @command{pkg-config --cflags ginac} and the @env{MYAPP_LIBS}
8647 variable to the output of @command{pkg-config --libs ginac}, and calls
8648 @samp{AC_SUBST()} for these variables so they can be used in generated
8649 makefiles, and then executes @var{ACTION-IF-FOUND}.
8650
8651 @item
8652 If the required version was not found, executes @var{ACTION-IF-NOT-FOUND}.
8653
8654 @end itemize
8655
8656 @menu
8657 * Configure script options::  Configuring a package that uses GiNaC
8658 * Example package::           Example of a package using GiNaC
8659 @end menu
8660
8661
8662 @node Configure script options, Example package, Package tools, Package tools 
8663 @c    node-name, next, previous, up
8664 @subsection Configuring a package that uses GiNaC
8665
8666 The directory where the GiNaC libraries are installed needs
8667 to be found by your system's dynamic linkers (both compile- and run-time
8668 ones).  See the documentation of your system linker for details.  Also
8669 make sure that @file{ginac.pc} is in @command{pkg-config}'s search path,
8670 @xref{pkg-config, ,pkg-config, *manpages*}.
8671
8672 The short summary below describes how to do this on a GNU/Linux
8673 system.
8674
8675 Suppose GiNaC is installed into the directory @samp{PREFIX}. To tell
8676 the linkers where to find the library one should
8677
8678 @itemize @bullet
8679 @item
8680 edit @file{/etc/ld.so.conf} and run @command{ldconfig}. For example,
8681 @example
8682 # echo PREFIX/lib >> /etc/ld.so.conf
8683 # ldconfig
8684 @end example
8685
8686 @item
8687 or set the environment variables @env{LD_LIBRARY_PATH} and @env{LD_RUN_PATH}
8688 @example
8689 $ export LD_LIBRARY_PATH=PREFIX/lib
8690 $ export LD_RUN_PATH=PREFIX/lib
8691 @end example
8692
8693 @item
8694 or give a @samp{-L} and @samp{--rpath} flags when running configure,
8695 for instance:
8696
8697 @example
8698 $ LDFLAGS='-Wl,-LPREFIX/lib -Wl,--rpath=PREFIX/lib' ./configure
8699 @end example
8700 @end itemize
8701
8702 To tell @command{pkg-config} where the @file{ginac.pc} file is,
8703 set the @env{PKG_CONFIG_PATH} environment variable:
8704 @example
8705 $ export PKG_CONFIG_PATH=PREFIX/lib/pkgconfig
8706 @end example
8707
8708 Finally, run the @command{configure} script
8709 @example
8710 $ ./configure 
8711 @end example
8712
8713 @c There are many other ways to do the same, @xref{Options, ,Command Line Options, ld, GNU ld manual}.
8714
8715 @node Example package, Bibliography, Configure script options, Package tools
8716 @c    node-name, next, previous, up
8717 @subsection Example of a package using GiNaC
8718
8719 The following shows how to build a simple package using automake
8720 and the @samp{PKG_CHECK_MODULES} macro. The program used here is @file{simple.cpp}:
8721
8722 @example
8723 #include <iostream>
8724 #include <ginac/ginac.h>
8725
8726 int main()
8727 @{
8728     GiNaC::symbol x("x");
8729     GiNaC::ex a = GiNaC::sin(x);
8730     std::cout << "Derivative of " << a 
8731               << " is " << a.diff(x) << std::endl;
8732     return 0;
8733 @}
8734 @end example
8735
8736 You should first read the introductory portions of the automake
8737 Manual, if you are not already familiar with it.
8738
8739 Two files are needed, @file{configure.ac}, which is used to build the
8740 configure script:
8741
8742 @example
8743 dnl Process this file with autoreconf to produce a configure script.
8744 AC_INIT([simple], 1.0.0, bogus@@example.net)
8745 AC_CONFIG_SRCDIR(simple.cpp)
8746 AM_INIT_AUTOMAKE([foreign 1.8])
8747
8748 AC_PROG_CXX
8749 AC_PROG_INSTALL
8750 AC_LANG([C++])
8751
8752 PKG_CHECK_MODULES(SIMPLE, ginac >= 1.3.7)
8753
8754 AC_OUTPUT(Makefile)
8755 @end example
8756
8757 The @samp{PKG_CHECK_MODULES} macro does the following: If a GiNaC version
8758 greater or equal than 1.3.7 is found, then it defines @var{SIMPLE_CFLAGS}
8759 and @var{SIMPLE_LIBS}. Otherwise, it dies with the error message like
8760 @example
8761 configure: error: Package requirements (ginac >= 1.3.7) were not met:
8762
8763 Requested 'ginac >= 1.3.7' but version of GiNaC is 1.3.5
8764
8765 Consider adjusting the PKG_CONFIG_PATH environment variable if you
8766 installed software in a non-standard prefix.
8767
8768 Alternatively, you may set the environment variables SIMPLE_CFLAGS
8769 and SIMPLE_LIBS to avoid the need to call pkg-config.
8770 See the pkg-config man page for more details.
8771 @end example
8772
8773 And the @file{Makefile.am}, which will be used to build the Makefile.
8774
8775 @example
8776 ## Process this file with automake to produce Makefile.in
8777 bin_PROGRAMS = simple
8778 simple_SOURCES = simple.cpp
8779 simple_CPPFLAGS = $(SIMPLE_CFLAGS)
8780 simple_LDADD = $(SIMPLE_LIBS)
8781 @end example
8782
8783 This @file{Makefile.am}, says that we are building a single executable,
8784 from a single source file @file{simple.cpp}. Since every program
8785 we are building uses GiNaC we could have simply added @var{SIMPLE_CFLAGS}
8786 to @var{CPPFLAGS} and @var{SIMPLE_LIBS} to @var{LIBS}. However, it is
8787 more flexible to specify libraries and complier options on a per-program
8788 basis.
8789
8790 To try this example out, create a new directory and add the three
8791 files above to it.
8792
8793 Now execute the following command:
8794
8795 @example
8796 $ autoreconf -i
8797 @end example
8798
8799 You now have a package that can be built in the normal fashion
8800
8801 @example
8802 $ ./configure
8803 $ make
8804 $ make install
8805 @end example
8806
8807
8808 @node Bibliography, Concept index, Example package, Top
8809 @c    node-name, next, previous, up
8810 @appendix Bibliography
8811
8812 @itemize @minus{}
8813
8814 @item
8815 @cite{ISO/IEC 14882:1998: Programming Languages: C++}
8816
8817 @item
8818 @cite{CLN: A Class Library for Numbers}, @email{haible@@ilog.fr, Bruno Haible}
8819
8820 @item
8821 @cite{The C++ Programming Language}, Bjarne Stroustrup, 3rd Edition, ISBN 0-201-88954-4, Addison Wesley
8822
8823 @item
8824 @cite{C++ FAQs}, Marshall Cline, ISBN 0-201-58958-3, 1995, Addison Wesley
8825
8826 @item
8827 @cite{Algorithms for Computer Algebra}, Keith O. Geddes, Stephen R. Czapor,
8828 and George Labahn, ISBN 0-7923-9259-0, 1992, Kluwer Academic Publishers, Norwell, Massachusetts
8829
8830 @item
8831 @cite{Computer Algebra: Systems and Algorithms for Algebraic Computation},
8832 James H. Davenport, Yvon Siret and Evelyne Tournier, ISBN 0-12-204230-1, 1988, 
8833 Academic Press, London
8834
8835 @item
8836 @cite{Computer Algebra Systems - A Practical Guide},
8837 Michael J. Wester (editor), ISBN 0-471-98353-5, 1999, Wiley, Chichester
8838
8839 @item
8840 @cite{The Art of Computer Programming, Vol 2: Seminumerical Algorithms},
8841 Donald E. Knuth, ISBN 0-201-89684-2, 1998, Addison Wesley
8842
8843 @item
8844 @cite{Pi Unleashed}, J@"org Arndt and Christoph Haenel,
8845 ISBN 3-540-66572-2, 2001, Springer, Heidelberg
8846
8847 @item
8848 @cite{The Role of gamma5 in Dimensional Regularization}, Dirk Kreimer, hep-ph/9401354
8849
8850 @end itemize
8851
8852
8853 @node Concept index, , Bibliography, Top
8854 @c    node-name, next, previous, up
8855 @unnumbered Concept index
8856
8857 @printindex cp
8858
8859 @bye