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