e284e03e7377c5980a15ce8731aad2e15e49421a
[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-2000 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-2000 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 * Important Algorithms::         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-2000 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 GiNaC;
184
185 int main()
186 @{
187     symbol x("x"), y("y");
188     ex poly;
189
190     for (int i=0; i<3; ++i)
191         poly += factorial(i+16)*pow(x,i)*pow(y,2-i);
192
193     cout << poly << endl;
194     return 0;
195 @}
196 @end example
197
198 Assuming the file is called @file{hello.cc}, on our system we can compile
199 and run it like this:
200
201 @example
202 $ c++ hello.cc -o hello -lcln -lginac
203 $ ./hello
204 355687428096000*x*y+20922789888000*y^2+6402373705728000*x^2
205 @end example
206
207 (@xref{Package Tools}, for tools that help you when creating a software
208 package that uses GiNaC.)
209
210 @cindex Hermite polynomial
211 Next, there is a more meaningful C++ program that calls a function which
212 generates Hermite polynomials in a specified free variable.
213
214 @example
215 #include <ginac/ginac.h>
216 using namespace GiNaC;
217
218 ex HermitePoly(const symbol & x, int n)
219 @{
220     ex HKer=exp(-pow(x, 2));
221     // uses the identity H_n(x) == (-1)^n exp(x^2) (d/dx)^n exp(-x^2)
222     return normal(pow(-1, n) * diff(HKer, x, n) / HKer);
223 @}
224
225 int main()
226 @{
227     symbol z("z");
228
229     for (int i=0; i<6; ++i)
230         cout << "H_" << i << "(z) == " << HermitePoly(z,i) << endl;
231
232     return 0;
233 @}
234 @end example
235
236 When run, this will type out
237
238 @example
239 H_0(z) == 1
240 H_1(z) == 2*z
241 H_2(z) == 4*z^2-2
242 H_3(z) == -12*z+8*z^3
243 H_4(z) == -48*z^2+16*z^4+12
244 H_5(z) == 120*z-160*z^3+32*z^5
245 @end example
246
247 This method of generating the coefficients is of course far from optimal
248 for production purposes.
249
250 In order to show some more examples of what GiNaC can do we will now use
251 the @command{ginsh}, a simple GiNaC interactive shell that provides a
252 convenient window into GiNaC's capabilities.
253
254
255 @node What it can do for you, Installation, How to use it from within C++, A Tour of GiNaC
256 @c    node-name, next, previous, up
257 @section What it can do for you
258
259 @cindex @command{ginsh}
260 After invoking @command{ginsh} one can test and experiment with GiNaC's
261 features much like in other Computer Algebra Systems except that it does
262 not provide programming constructs like loops or conditionals.  For a
263 concise description of the @command{ginsh} syntax we refer to its
264 accompanied man page. Suffice to say that assignments and comparisons in
265 @command{ginsh} are written as they are in C, i.e. @code{=} assigns and
266 @code{==} compares.
267
268 It can manipulate arbitrary precision integers in a very fast way.
269 Rational numbers are automatically converted to fractions of coprime
270 integers:
271
272 @example
273 > x=3^150;
274 369988485035126972924700782451696644186473100389722973815184405301748249
275 > y=3^149;
276 123329495011708990974900260817232214728824366796574324605061468433916083
277 > x/y;
278 3
279 > y/x;
280 1/3
281 @end example
282
283 Exact numbers are always retained as exact numbers and only evaluated as
284 floating point numbers if requested.  For instance, with numeric
285 radicals is dealt pretty much as with symbols.  Products of sums of them
286 can be expanded:
287
288 @example
289 > expand((1+a^(1/5)-a^(2/5))^3);
290 1+3*a+3*a^(1/5)-5*a^(3/5)-a^(6/5)
291 > expand((1+3^(1/5)-3^(2/5))^3);
292 10-5*3^(3/5)
293 > evalf((1+3^(1/5)-3^(2/5))^3);
294 0.33408977534118624228
295 @end example
296
297 The function @code{evalf} that was used above converts any number in
298 GiNaC's expressions into floating point numbers.  This can be done to
299 arbitrary predefined accuracy:
300
301 @example
302 > evalf(1/7);
303 0.14285714285714285714
304 > Digits=150;
305 150
306 > evalf(1/7);
307 0.1428571428571428571428571428571428571428571428571428571428571428571428
308 5714285714285714285714285714285714285
309 @end example
310
311 Exact numbers other than rationals that can be manipulated in GiNaC
312 include predefined constants like Archimedes' @code{Pi}.  They can both
313 be used in symbolic manipulations (as an exact number) as well as in
314 numeric expressions (as an inexact number):
315
316 @example
317 > a=Pi^2+x;
318 x+Pi^2
319 > evalf(a);
320 9.869604401089358619+x
321 > x=2;
322 2
323 > evalf(a);
324 11.869604401089358619
325 @end example
326
327 Built-in functions evaluate immediately to exact numbers if
328 this is possible.  Conversions that can be safely performed are done
329 immediately; conversions that are not generally valid are not done:
330
331 @example
332 > cos(42*Pi);
333 1
334 > cos(acos(x));
335 x
336 > acos(cos(x));
337 acos(cos(x))
338 @end example
339
340 (Note that converting the last input to @code{x} would allow one to
341 conclude that @code{42*Pi} is equal to @code{0}.)
342
343 Linear equation systems can be solved along with basic linear
344 algebra manipulations over symbolic expressions.  In C++ GiNaC offers
345 a matrix class for this purpose but we can see what it can do using
346 @command{ginsh}'s notation of double brackets to type them in:
347
348 @example
349 > lsolve(a+x*y==z,x);
350 y^(-1)*(z-a);
351 > lsolve([3*x+5*y == 7, -2*x+10*y == -5], [x, y]);
352 [x==19/8,y==-1/40]
353 > M = [[ [[1, 3]], [[-3, 2]] ]];
354 [[ [[1,3]], [[-3,2]] ]]
355 > determinant(M);
356 11
357 > charpoly(M,lambda);
358 lambda^2-3*lambda+11
359 @end example
360
361 Multivariate polynomials and rational functions may be expanded,
362 collected and normalized (i.e. converted to a ratio of two coprime 
363 polynomials):
364
365 @example
366 > a = x^4 + 2*x^2*y^2 + 4*x^3*y + 12*x*y^3 - 3*y^4;
367 -3*y^4+x^4+12*x*y^3+2*x^2*y^2+4*x^3*y
368 > b = x^2 + 4*x*y - y^2;
369 -y^2+x^2+4*x*y
370 > expand(a*b);
371 3*y^6+x^6-24*x*y^5+43*x^2*y^4+16*x^3*y^3+17*x^4*y^2+8*x^5*y
372 > collect(a*b,x);
373 3*y^6+48*x*y^4+2*x^2*y^2+x^4*(-y^2+x^2+4*x*y)+4*x^3*y*(-y^2+x^2+4*x*y)
374 > normal(a/b);
375 3*y^2+x^2
376 @end example
377
378 You can differentiate functions and expand them as Taylor or Laurent
379 series in a very natural syntax (the second argument of @code{series} is
380 a relation defining the evaluation point, the third specifies the
381 order):
382
383 @cindex Zeta function
384 @example
385 > diff(tan(x),x);
386 tan(x)^2+1
387 > series(sin(x),x==0,4);
388 x-1/6*x^3+Order(x^4)
389 > series(1/tan(x),x==0,4);
390 x^(-1)-1/3*x+Order(x^2)
391 > series(tgamma(x),x==0,3);
392 x^(-1)-Euler+(1/12*Pi^2+1/2*Euler^2)*x+
393 (-1/3*zeta(3)-1/12*Pi^2*Euler-1/6*Euler^3)*x^2+Order(x^3)
394 > evalf(");
395 x^(-1)-0.5772156649015328606+(0.9890559953279725555)*x
396 -(0.90747907608088628905)*x^2+Order(x^3)
397 > series(tgamma(2*sin(x)-2),x==Pi/2,6);
398 -(x-1/2*Pi)^(-2)+(-1/12*Pi^2-1/2*Euler^2-1/240)*(x-1/2*Pi)^2
399 -Euler-1/12+Order((x-1/2*Pi)^3)
400 @end example
401
402 Here we have made use of the @command{ginsh}-command @code{"} to pop the
403 previously evaluated element from @command{ginsh}'s internal stack.
404
405 If you ever wanted to convert units in C or C++ and found this is
406 cumbersome, here is the solution.  Symbolic types can always be used as
407 tags for different types of objects.  Converting from wrong units to the
408 metric system is now easy:
409
410 @example
411 > in=.0254*m;
412 0.0254*m
413 > lb=.45359237*kg;
414 0.45359237*kg
415 > 200*lb/in^2;
416 140613.91592783185568*kg*m^(-2)
417 @end example
418
419
420 @node Installation, Prerequisites, What it can do for you, Top
421 @c    node-name, next, previous, up
422 @chapter Installation
423
424 @cindex CLN
425 GiNaC's installation follows the spirit of most GNU software. It is
426 easily installed on your system by three steps: configuration, build,
427 installation.
428
429 @menu
430 * Prerequisites::                Packages upon which GiNaC depends.
431 * Configuration::                How to configure GiNaC.
432 * Building GiNaC::               How to compile GiNaC.
433 * Installing GiNaC::             How to install GiNaC on your system.
434 @end menu
435
436
437 @node Prerequisites, Configuration, Installation, Installation
438 @c    node-name, next, previous, up
439 @section Prerequisites
440
441 In order to install GiNaC on your system, some prerequisites need to be
442 met.  First of all, you need to have a C++-compiler adhering to the
443 ANSI-standard @cite{ISO/IEC 14882:1998(E)}.  We used @acronym{GCC} for
444 development so if you have a different compiler you are on your own.
445 For the configuration to succeed you need a Posix compliant shell
446 installed in @file{/bin/sh}, GNU @command{bash} is fine.  Perl is needed
447 by the built process as well, since some of the source files are
448 automatically generated by Perl scripts.  Last but not least, Bruno
449 Haible's library @acronym{CLN} is extensively used and needs to be
450 installed on your system.  Please get it either from
451 @uref{ftp://ftp.santafe.edu/pub/gnu/}, from
452 @uref{ftp://ftpthep.physik.uni-mainz.de/pub/gnu/, GiNaC's FTP site} or
453 from @uref{ftp://ftp.ilog.fr/pub/Users/haible/gnu/, Bruno Haible's FTP
454 site} (it is covered by GPL) and install it prior to trying to install
455 GiNaC.  The configure script checks if it can find it and if it cannot
456 it will refuse to continue.
457
458
459 @node Configuration, Building GiNaC, Prerequisites, Installation
460 @c    node-name, next, previous, up
461 @section Configuration
462 @cindex configuration
463 @cindex Autoconf
464
465 To configure GiNaC means to prepare the source distribution for
466 building.  It is done via a shell script called @command{configure} that
467 is shipped with the sources and was originally generated by GNU
468 Autoconf.  Since a configure script generated by GNU Autoconf never
469 prompts, all customization must be done either via command line
470 parameters or environment variables.  It accepts a list of parameters,
471 the complete set of which can be listed by calling it with the
472 @option{--help} option.  The most important ones will be shortly
473 described in what follows:
474
475 @itemize @bullet
476
477 @item
478 @option{--disable-shared}: When given, this option switches off the
479 build of a shared library, i.e. a @file{.so} file.  This may be convenient
480 when developing because it considerably speeds up compilation.
481
482 @item
483 @option{--prefix=@var{PREFIX}}: The directory where the compiled library
484 and headers are installed. It defaults to @file{/usr/local} which means
485 that the library is installed in the directory @file{/usr/local/lib},
486 the header files in @file{/usr/local/include/ginac} and the documentation
487 (like this one) into @file{/usr/local/share/doc/GiNaC}.
488
489 @item
490 @option{--libdir=@var{LIBDIR}}: Use this option in case you want to have
491 the library installed in some other directory than
492 @file{@var{PREFIX}/lib/}.
493
494 @item
495 @option{--includedir=@var{INCLUDEDIR}}: Use this option in case you want
496 to have the header files installed in some other directory than
497 @file{@var{PREFIX}/include/ginac/}. For instance, if you specify
498 @option{--includedir=/usr/include} you will end up with the header files
499 sitting in the directory @file{/usr/include/ginac/}. Note that the
500 subdirectory @file{ginac} is enforced by this process in order to
501 keep the header files separated from others.  This avoids some
502 clashes and allows for an easier deinstallation of GiNaC. This ought
503 to be considered A Good Thing (tm).
504
505 @item
506 @option{--datadir=@var{DATADIR}}: This option may be given in case you
507 want to have the documentation installed in some other directory than
508 @file{@var{PREFIX}/share/doc/GiNaC/}.
509
510 @end itemize
511
512 In addition, you may specify some environment variables.
513 @env{CXX} holds the path and the name of the C++ compiler
514 in case you want to override the default in your path.  (The
515 @command{configure} script searches your path for @command{c++},
516 @command{g++}, @command{gcc}, @command{CC}, @command{cxx}
517 and @command{cc++} in that order.)  It may be very useful to
518 define some compiler flags with the @env{CXXFLAGS} environment
519 variable, like optimization, debugging information and warning
520 levels.  If omitted, it defaults to @option{-g -O2}.
521
522 The whole process is illustrated in the following two
523 examples. (Substitute @command{setenv @var{VARIABLE} @var{value}} for
524 @command{export @var{VARIABLE}=@var{value}} if the Berkeley C shell is
525 your login shell.)
526
527 Here is a simple configuration for a site-wide GiNaC library assuming
528 everything is in default paths:
529
530 @example
531 $ export CXXFLAGS="-Wall -O2"
532 $ ./configure
533 @end example
534
535 And here is a configuration for a private static GiNaC library with
536 several components sitting in custom places (site-wide @acronym{GCC} and
537 private @acronym{CLN}).  The compiler is pursuaded to be picky and full
538 assertions and debugging information are switched on:
539
540 @example
541 $ export CXX=/usr/local/gnu/bin/c++
542 $ export CPPFLAGS="$(CPPFLAGS) -I$(HOME)/include"
543 $ export CXXFLAGS="$(CXXFLAGS) -DDO_GINAC_ASSERT -ggdb -Wall -ansi -pedantic"
544 $ export LDFLAGS="$(LDFLAGS) -L$(HOME)/lib"
545 $ ./configure --disable-shared --prefix=$(HOME)
546 @end example
547
548
549 @node Building GiNaC, Installing GiNaC, Configuration, Installation
550 @c    node-name, next, previous, up
551 @section Building GiNaC
552 @cindex building GiNaC
553
554 After proper configuration you should just build the whole
555 library by typing
556 @example
557 $ make
558 @end example
559 at the command prompt and go for a cup of coffee.  The exact time it
560 takes to compile GiNaC depends not only on the speed of your machines
561 but also on other parameters, for instance what value for @env{CXXFLAGS}
562 you entered.  Optimization may be very time-consuming.
563
564 Just to make sure GiNaC works properly you may run a collection of
565 regression tests by typing
566
567 @example
568 $ make check
569 @end example
570
571 This will compile some sample programs, run them and check the output
572 for correctness.  The regression tests fall in three categories.  First,
573 the so called @emph{exams} are performed, simple tests where some
574 predefined input is evaluated (like a pupils' exam).  Second, the
575 @emph{checks} test the coherence of results among each other with
576 possible random input.  Third, some @emph{timings} are performed, which
577 benchmark some predefined problems with different sizes and display the
578 CPU time used in seconds.  Each individual test should return a message
579 @samp{passed}.  This is mostly intended to be a QA-check if something
580 was broken during development, not a sanity check of your system.  Some
581 of the tests in sections @emph{checks} and @emph{timings} may require
582 insane amounts of memory and CPU time.  Feel free to kill them if your
583 machine catches fire.  Another quite important intent is to allow people
584 to fiddle around with optimization.
585
586 Generally, the top-level Makefile runs recursively to the
587 subdirectories.  It is therfore safe to go into any subdirectory
588 (@code{doc/}, @code{ginsh/}, ...) and simply type @code{make}
589 @var{target} there in case something went wrong.
590
591
592 @node Installing GiNaC, Basic Concepts, Building GiNaC, Installation
593 @c    node-name, next, previous, up
594 @section Installing GiNaC
595 @cindex installation
596
597 To install GiNaC on your system, simply type
598
599 @example
600 $ make install
601 @end example
602
603 As described in the section about configuration the files will be
604 installed in the following directories (the directories will be created
605 if they don't already exist):
606
607 @itemize @bullet
608
609 @item
610 @file{libginac.a} will go into @file{@var{PREFIX}/lib/} (or
611 @file{@var{LIBDIR}}) which defaults to @file{/usr/local/lib/}.
612 So will @file{libginac.so} unless the configure script was
613 given the option @option{--disable-shared}.  The proper symlinks
614 will be established as well.
615
616 @item
617 All the header files will be installed into @file{@var{PREFIX}/include/ginac/}
618 (or @file{@var{INCLUDEDIR}/ginac/}, if specified).
619
620 @item
621 All documentation (HTML and Postscript) will be stuffed into
622 @file{@var{PREFIX}/share/doc/GiNaC/} (or
623 @file{@var{DATADIR}/doc/GiNaC/}, if @var{DATADIR} was specified).
624
625 @end itemize
626
627 For the sake of completeness we will list some other useful make
628 targets: @command{make clean} deletes all files generated by
629 @command{make}, i.e. all the object files.  In addition @command{make
630 distclean} removes all files generated by the configuration and
631 @command{make maintainer-clean} goes one step further and deletes files
632 that may require special tools to rebuild (like the @command{libtool}
633 for instance).  Finally @command{make uninstall} removes the installed
634 library, header files and documentation@footnote{Uninstallation does not
635 work after you have called @command{make distclean} since the
636 @file{Makefile} is itself generated by the configuration from
637 @file{Makefile.in} and hence deleted by @command{make distclean}.  There
638 are two obvious ways out of this dilemma.  First, you can run the
639 configuration again with the same @var{PREFIX} thus creating a
640 @file{Makefile} with a working @samp{uninstall} target.  Second, you can
641 do it by hand since you now know where all the files went during
642 installation.}.
643
644
645 @node Basic Concepts, Expressions, Installing GiNaC, Top
646 @c    node-name, next, previous, up
647 @chapter Basic Concepts
648
649 This chapter will describe the different fundamental objects that can be
650 handled by GiNaC.  But before doing so, it is worthwhile introducing you
651 to the more commonly used class of expressions, representing a flexible
652 meta-class for storing all mathematical objects.
653
654 @menu
655 * Expressions::                  The fundamental GiNaC class.
656 * The Class Hierarchy::          Overview of GiNaC's classes.
657 * Symbols::                      Symbolic objects.
658 * Numbers::                      Numerical objects.
659 * Constants::                    Pre-defined constants.
660 * Fundamental containers::       The power, add and mul classes.
661 * Built-in functions::           Mathematical functions.
662 * Relations::                    Equality, Inequality and all that.
663 * Archiving::                    Storing expression libraries in files.
664 @end menu
665
666
667 @node Expressions, The Class Hierarchy, Basic Concepts, Basic Concepts
668 @c    node-name, next, previous, up
669 @section Expressions
670 @cindex expression (class @code{ex})
671 @cindex @code{has()}
672
673 The most common class of objects a user deals with is the expression
674 @code{ex}, representing a mathematical object like a variable, number,
675 function, sum, product, etc...  Expressions may be put together to form
676 new expressions, passed as arguments to functions, and so on.  Here is a
677 little collection of valid expressions:
678
679 @example
680 ex MyEx1 = 5;                       // simple number
681 ex MyEx2 = x + 2*y;                 // polynomial in x and y
682 ex MyEx3 = (x + 1)/(x - 1);         // rational expression
683 ex MyEx4 = sin(x + 2*y) + 3*z + 41; // containing a function
684 ex MyEx5 = MyEx4 + 1;               // similar to above
685 @end example
686
687 Expressions are handles to other more fundamental objects, that many
688 times contain other expressions thus creating a tree of expressions
689 (@xref{Internal Structures}, for particular examples).  Most methods on
690 @code{ex} therefore run top-down through such an expression tree.  For
691 example, the method @code{has()} scans recursively for occurrences of
692 something inside an expression.  Thus, if you have declared @code{MyEx4}
693 as in the example above @code{MyEx4.has(y)} will find @code{y} inside
694 the argument of @code{sin} and hence return @code{true}.
695
696 The next sections will outline the general picture of GiNaC's class
697 hierarchy and describe the classes of objects that are handled by
698 @code{ex}.
699
700
701 @node The Class Hierarchy, Symbols, Expressions, Basic Concepts
702 @c    node-name, next, previous, up
703 @section The Class Hierarchy
704
705 GiNaC's class hierarchy consists of several classes representing
706 mathematical objects, all of which (except for @code{ex} and some
707 helpers) are internally derived from one abstract base class called
708 @code{basic}.  You do not have to deal with objects of class
709 @code{basic}, instead you'll be dealing with symbols, numbers,
710 containers of expressions and so on.  You'll soon learn in this chapter
711 how many of the functions on symbols are really classes.  This is
712 because simple symbolic arithmetic is not supported by languages like
713 C++ so in a certain way GiNaC has to implement its own arithmetic.
714
715 @cindex container
716 @cindex atom
717 To get an idea about what kinds of symbolic composits may be built we
718 have a look at the most important classes in the class hierarchy.  The
719 oval classes are atomic ones and the squared classes are containers.
720 The dashed line symbolizes a `points to' or `handles' relationship while
721 the solid lines stand for `inherits from' relationship in the class
722 hierarchy:
723
724 @image{classhierarchy}
725
726 Some of the classes shown here (the ones sitting in white boxes) are
727 abstract base classes that are of no interest at all for the user.  They
728 are used internally in order to avoid code duplication if two or more
729 classes derived from them share certain features.  An example would be
730 @code{expairseq}, which is a container for a sequence of pairs each
731 consisting of one expression and a number (@code{numeric}).  What
732 @emph{is} visible to the user are the derived classes @code{add} and
733 @code{mul}, representing sums of terms and products, respectively.
734 @xref{Internal Structures}, where these two classes are described in
735 more detail.
736
737 At this point, we only summarize what kind of mathematical objects are
738 stored in the different classes in above diagram in order to give you a
739 overview:
740
741 @cartouche
742 @multitable @columnfractions .22 .78
743 @item @code{symbol} @tab Algebraic symbols @math{a}, @math{x}, @math{y}@dots{}
744 @item @code{constant} @tab Constants like 
745 @tex
746 $\pi$
747 @end tex
748 @ifnottex
749 @math{Pi}
750 @end ifnottex
751 @item @code{numeric} @tab All kinds of numbers, @math{42}, @math{7/3*I}, @math{3.14159}@dots{}
752 @item @code{add} @tab Sums like @math{x+y} or @math{a+(2*b)+3}
753 @item @code{mul} @tab Products like @math{x*y} or @math{a*(x+y+z)*b*2}
754 @item @code{power} @tab Exponentials such as @math{x^2}, @math{a^b}, 
755 @tex
756 $\sqrt{2}$
757 @end tex
758 @ifnottex
759 @code{sqrt(}@math{2}@code{)}
760 @end ifnottex
761 @dots{}
762 @item @code{pseries} @tab Power Series, e.g. @math{x+1/6*x^3+1/120*x^5+O(x^7)}
763 @item @code{function} @tab A symbolic function like @math{sin(2*x)}
764 @item @code{lst} @tab Lists of expressions [@math{x}, @math{2*y}, @math{3+z}]
765 @item @code{matrix} @tab @math{n}x@math{m} matrices of expressions
766 @item @code{relational} @tab A relation like the identity @math{x}@code{==}@math{y}
767 @item @code{color} @tab Element of the @math{SU(3)} Lie-algebra
768 @item @code{isospin} @tab Element of the @math{SU(2)} Lie-algebra
769 @item @code{idx} @tab Index of a tensor object
770 @item @code{coloridx} @tab Index of a @math{SU(3)} tensor
771 @end multitable
772 @end cartouche
773
774 @node Symbols, Numbers, The Class Hierarchy, Basic Concepts
775 @c    node-name, next, previous, up
776 @section Symbols
777 @cindex @code{symbol} (class)
778 @cindex hierarchy of classes
779
780 @cindex atom
781 Symbols are for symbolic manipulation what atoms are for chemistry.  You
782 can declare objects of class @code{symbol} as any other object simply by
783 saying @code{symbol x,y;}.  There is, however, a catch in here having to
784 do with the fact that C++ is a compiled language.  The information about
785 the symbol's name is thrown away by the compiler but at a later stage
786 you may want to print expressions holding your symbols.  In order to
787 avoid confusion GiNaC's symbols are able to know their own name.  This
788 is accomplished by declaring its name for output at construction time in
789 the fashion @code{symbol x("x");}.  If you declare a symbol using the
790 default constructor (i.e. without string argument) the system will deal
791 out a unique name.  That name may not be suitable for printing but for
792 internal routines when no output is desired it is often enough.  We'll
793 come across examples of such symbols later in this tutorial.
794
795 This implies that the strings passed to symbols at construction time may
796 not be used for comparing two of them.  It is perfectly legitimate to
797 write @code{symbol x("x"),y("x");} but it is likely to lead into
798 trouble.  Here, @code{x} and @code{y} are different symbols and
799 statements like @code{x-y} will not be simplified to zero although the
800 output @code{x-x} looks funny.  Such output may also occur when there
801 are two different symbols in two scopes, for instance when you call a
802 function that declares a symbol with a name already existent in a symbol
803 in the calling function.  Again, comparing them (using @code{operator==}
804 for instance) will always reveal their difference.  Watch out, please.
805
806 @cindex @code{subs()}
807 Although symbols can be assigned expressions for internal reasons, you
808 should not do it (and we are not going to tell you how it is done).  If
809 you want to replace a symbol with something else in an expression, you
810 can use the expression's @code{.subs()} method.
811
812
813 @node Numbers, Constants, Symbols, Basic Concepts
814 @c    node-name, next, previous, up
815 @section Numbers
816 @cindex @code{numeric} (class)
817
818 @cindex GMP
819 @cindex CLN
820 @cindex rational
821 @cindex fraction
822 For storing numerical things, GiNaC uses Bruno Haible's library
823 @acronym{CLN}.  The classes therein serve as foundation classes for
824 GiNaC.  @acronym{CLN} stands for Class Library for Numbers or
825 alternatively for Common Lisp Numbers.  In order to find out more about
826 @acronym{CLN}'s internals the reader is refered to the documentation of
827 that library.  @inforef{Introduction, , cln}, for more
828 information. Suffice to say that it is by itself build on top of another
829 library, the GNU Multiple Precision library @acronym{GMP}, which is an
830 extremely fast library for arbitrary long integers and rationals as well
831 as arbitrary precision floating point numbers.  It is very commonly used
832 by several popular cryptographic applications.  @acronym{CLN} extends
833 @acronym{GMP} by several useful things: First, it introduces the complex
834 number field over either reals (i.e. floating point numbers with
835 arbitrary precision) or rationals.  Second, it automatically converts
836 rationals to integers if the denominator is unity and complex numbers to
837 real numbers if the imaginary part vanishes and also correctly treats
838 algebraic functions.  Third it provides good implementations of
839 state-of-the-art algorithms for all trigonometric and hyperbolic
840 functions as well as for calculation of some useful constants.
841
842 The user can construct an object of class @code{numeric} in several
843 ways.  The following example shows the four most important constructors.
844 It uses construction from C-integer, construction of fractions from two
845 integers, construction from C-float and construction from a string:
846
847 @example
848 #include <ginac/ginac.h>
849 using namespace GiNaC;
850
851 int main()
852 @{
853     numeric two(2);                       // exact integer 2
854     numeric r(2,3);                       // exact fraction 2/3
855     numeric e(2.71828);                   // floating point number
856     numeric p("3.1415926535897932385");   // floating point number
857     // Trott's constant in scientific notation:
858     numeric trott("1.0841015122311136151E-2");
859     
860     cout << two*p << endl;  // floating point 6.283...
861     // ...
862 @}
863 @end example
864
865 Note that all those constructors are @emph{explicit} which means you are
866 not allowed to write @code{numeric two=2;}.  This is because the basic
867 objects to be handled by GiNaC are the expressions @code{ex} and we want
868 to keep things simple and wish objects like @code{pow(x,2)} to be
869 handled the same way as @code{pow(x,a)}, which means that we need to
870 allow a general @code{ex} as base and exponent.  Therefore there is an
871 implicit constructor from C-integers directly to expressions handling
872 numerics at work in most of our examples.  This design really becomes
873 convenient when one declares own functions having more than one
874 parameter but it forbids using implicit constructors because that would
875 lead to compile-time ambiguities.
876
877 It may be tempting to construct numbers writing @code{numeric r(3/2)}.
878 This would, however, call C's built-in operator @code{/} for integers
879 first and result in a numeric holding a plain integer 1.  @strong{Never
880 use the operator @code{/} on integers} unless you know exactly what you
881 are doing!  Use the constructor from two integers instead, as shown in
882 the example above.  Writing @code{numeric(1)/2} may look funny but works
883 also.
884
885 @cindex @code{Digits}
886 @cindex accuracy
887 We have seen now the distinction between exact numbers and floating
888 point numbers.  Clearly, the user should never have to worry about
889 dynamically created exact numbers, since their `exactness' always
890 determines how they ought to be handled, i.e. how `long' they are.  The
891 situation is different for floating point numbers.  Their accuracy is
892 controlled by one @emph{global} variable, called @code{Digits}.  (For
893 those readers who know about Maple: it behaves very much like Maple's
894 @code{Digits}).  All objects of class numeric that are constructed from
895 then on will be stored with a precision matching that number of decimal
896 digits:
897
898 @example
899 #include <ginac/ginac.h>
900 using namespace GiNaC;
901
902 void foo()
903 @{
904     numeric three(3.0), one(1.0);
905     numeric x = one/three;
906
907     cout << "in " << Digits << " digits:" << endl;
908     cout << x << endl;
909     cout << Pi.evalf() << endl;
910 @}
911
912 int main()
913 @{
914     foo();
915     Digits = 60;
916     foo();
917     return 0;
918 @}
919 @end example
920
921 The above example prints the following output to screen:
922
923 @example
924 in 17 digits:
925 0.333333333333333333
926 3.14159265358979324
927 in 60 digits:
928 0.333333333333333333333333333333333333333333333333333333333333333333
929 3.14159265358979323846264338327950288419716939937510582097494459231
930 @end example
931
932 It should be clear that objects of class @code{numeric} should be used
933 for constructing numbers or for doing arithmetic with them.  The objects
934 one deals with most of the time are the polymorphic expressions @code{ex}.
935
936 @subsection Tests on numbers
937
938 Once you have declared some numbers, assigned them to expressions and
939 done some arithmetic with them it is frequently desired to retrieve some
940 kind of information from them like asking whether that number is
941 integer, rational, real or complex.  For those cases GiNaC provides
942 several useful methods.  (Internally, they fall back to invocations of
943 certain CLN functions.)
944
945 As an example, let's construct some rational number, multiply it with
946 some multiple of its denominator and test what comes out:
947
948 @example
949 #include <ginac/ginac.h>
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 @}
967 @end example
968
969 Note that the variable @code{answer} is constructed here as an integer
970 by @code{numeric}'s copy constructor but in an intermediate step it
971 holds a rational number represented as integer numerator and integer
972 denominator.  When multiplied by 10, the denominator becomes unity and
973 the result is automatically converted to a pure integer again.
974 Internally, the underlying @acronym{CLN} is responsible for this
975 behaviour and we refer the reader to @acronym{CLN}'s documentation.
976 Suffice to say that the same behaviour applies to complex numbers as
977 well as return values of certain functions.  Complex numbers are
978 automatically converted to real numbers if the imaginary part becomes
979 zero.  The full set of tests that can be applied is listed in the
980 following table.
981
982 @cartouche
983 @multitable @columnfractions .30 .70
984 @item @strong{Method} @tab @strong{Returns true if the object is@dots{}}
985 @item @code{.is_zero()}
986 @tab @dots{}equal to zero
987 @item @code{.is_positive()}
988 @tab @dots{}not complex and greater than 0
989 @item @code{.is_integer()}
990 @tab @dots{}a (non-complex) integer
991 @item @code{.is_pos_integer()}
992 @tab @dots{}an integer and greater than 0
993 @item @code{.is_nonneg_integer()}
994 @tab @dots{}an integer and greater equal 0
995 @item @code{.is_even()}
996 @tab @dots{}an even integer
997 @item @code{.is_odd()}
998 @tab @dots{}an odd integer
999 @item @code{.is_prime()}
1000 @tab @dots{}a prime integer (probabilistic primality test)
1001 @item @code{.is_rational()}
1002 @tab @dots{}an exact rational number (integers are rational, too)
1003 @item @code{.is_real()}
1004 @tab @dots{}a real integer, rational or float (i.e. is not complex)
1005 @item @code{.is_cinteger()}
1006 @tab @dots{}a (complex) integer, such as @math{2-3*I}
1007 @item @code{.is_crational()}
1008 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
1009 @end multitable
1010 @end cartouche
1011
1012
1013 @node Constants, Fundamental containers, Numbers, Basic Concepts
1014 @c    node-name, next, previous, up
1015 @section Constants
1016 @cindex @code{constant} (class)
1017
1018 @cindex @code{Pi}
1019 @cindex @code{Catalan}
1020 @cindex @code{Euler}
1021 @cindex @code{evalf()}
1022 Constants behave pretty much like symbols except that they return some
1023 specific number when the method @code{.evalf()} is called.
1024
1025 The predefined known constants are:
1026
1027 @cartouche
1028 @multitable @columnfractions .14 .30 .56
1029 @item @strong{Name} @tab @strong{Common Name} @tab @strong{Numerical Value (to 35 digits)}
1030 @item @code{Pi}
1031 @tab Archimedes' constant
1032 @tab 3.14159265358979323846264338327950288
1033 @item @code{Catalan}
1034 @tab Catalan's constant
1035 @tab 0.91596559417721901505460351493238411
1036 @item @code{Euler}
1037 @tab Euler's (or Euler-Mascheroni) constant
1038 @tab 0.57721566490153286060651209008240243
1039 @end multitable
1040 @end cartouche
1041
1042
1043 @node Fundamental containers, Built-in functions, Constants, Basic Concepts
1044 @c    node-name, next, previous, up
1045 @section Fundamental containers: the @code{power}, @code{add} and @code{mul} classes
1046 @cindex polynomial
1047 @cindex @code{add}
1048 @cindex @code{mul}
1049 @cindex @code{power}
1050
1051 Simple polynomial expressions are written down in GiNaC pretty much like
1052 in other CAS or like expressions involving numerical variables in C.
1053 The necessary operators @code{+}, @code{-}, @code{*} and @code{/} have
1054 been overloaded to achieve this goal.  When you run the following
1055 program, the constructor for an object of type @code{mul} is
1056 automatically called to hold the product of @code{a} and @code{b} and
1057 then the constructor for an object of type @code{add} is called to hold
1058 the sum of that @code{mul} object and the number one:
1059
1060 @example
1061 #include <ginac/ginac.h>
1062 using namespace GiNaC;
1063
1064 int main()
1065 @{
1066     symbol a("a"), b("b");
1067     ex MyTerm = 1+a*b;
1068     // ...
1069 @}
1070 @end example
1071
1072 @cindex @code{pow()}
1073 For exponentiation, you have already seen the somewhat clumsy (though C-ish)
1074 statement @code{pow(x,2);} to represent @code{x} squared.  This direct
1075 construction is necessary since we cannot safely overload the constructor
1076 @code{^} in C++ to construct a @code{power} object.  If we did, it would
1077 have several counterintuitive effects:
1078
1079 @itemize @bullet
1080 @item
1081 Due to C's operator precedence, @code{2*x^2} would be parsed as @code{(2*x)^2}.
1082 @item
1083 Due to the binding of the operator @code{^}, @code{x^a^b} would result in
1084 @code{(x^a)^b}. This would be confusing since most (though not all) other CAS
1085 interpret this as @code{x^(a^b)}.
1086 @item
1087 Also, expressions involving integer exponents are very frequently used,
1088 which makes it even more dangerous to overload @code{^} since it is then
1089 hard to distinguish between the semantics as exponentiation and the one
1090 for exclusive or.  (It would be embarassing to return @code{1} where one
1091 has requested @code{2^3}.)
1092 @end itemize
1093
1094 @cindex @command{ginsh}
1095 All effects are contrary to mathematical notation and differ from the
1096 way most other CAS handle exponentiation, therefore overloading @code{^}
1097 is ruled out for GiNaC's C++ part.  The situation is different in
1098 @command{ginsh}, there the exponentiation-@code{^} exists.  (Also note
1099 that the other frequently used exponentiation operator @code{**} does
1100 not exist at all in C++).
1101
1102 To be somewhat more precise, objects of the three classes described
1103 here, are all containers for other expressions.  An object of class
1104 @code{power} is best viewed as a container with two slots, one for the
1105 basis, one for the exponent.  All valid GiNaC expressions can be
1106 inserted.  However, basic transformations like simplifying
1107 @code{pow(pow(x,2),3)} to @code{x^6} automatically are only performed
1108 when this is mathematically possible.  If we replace the outer exponent
1109 three in the example by some symbols @code{a}, the simplification is not
1110 safe and will not be performed, since @code{a} might be @code{1/2} and
1111 @code{x} negative.
1112
1113 Objects of type @code{add} and @code{mul} are containers with an
1114 arbitrary number of slots for expressions to be inserted.  Again, simple
1115 and safe simplifications are carried out like transforming
1116 @code{3*x+4-x} to @code{2*x+4}.
1117
1118 The general rule is that when you construct such objects, GiNaC
1119 automatically creates them in canonical form, which might differ from
1120 the form you typed in your program.  This allows for rapid comparison of
1121 expressions, since after all @code{a-a} is simply zero.  Note, that the
1122 canonical form is not necessarily lexicographical ordering or in any way
1123 easily guessable.  It is only guaranteed that constructing the same
1124 expression twice, either implicitly or explicitly, results in the same
1125 canonical form.
1126
1127
1128 @node Built-in functions, Relations, Fundamental containers, Basic Concepts
1129 @c    node-name, next, previous, up
1130 @section Built-in functions
1131 @cindex @code{function} (class)
1132 @cindex trigonometric function
1133 @cindex hyperbolic function
1134
1135 There are quite a number of useful functions hard-wired into GiNaC.  For
1136 instance, all trigonometric and hyperbolic functions are implemented.
1137 They are all objects of class @code{function}.  They accept one or more
1138 expressions as arguments and return one expression.  If the arguments
1139 are not numerical, the evaluation of the function may be halted, as it
1140 does in the next example:
1141
1142 @cindex Gamma function
1143 @cindex @code{subs()}
1144 @example
1145 #include <ginac/ginac.h>
1146 using namespace GiNaC;
1147
1148 int main()
1149 @{
1150     symbol x("x"), y("y");
1151     
1152     ex foo = x+y/2;
1153     cout << "tgamma(" << foo << ") -> " << tgamma(foo) << endl;
1154     ex bar = foo.subs(y==1);
1155     cout << "tgamma(" << bar << ") -> " << tgamma(bar) << endl;
1156     ex foobar = bar.subs(x==7);
1157     cout << "tgamma(" << foobar << ") -> " << tgamma(foobar) << endl;
1158     // ...
1159 @}
1160 @end example
1161
1162 This program shows how the function returns itself twice and finally an
1163 expression that may be really useful:
1164
1165 @example
1166 tgamma(x+(1/2)*y) -> tgamma(x+(1/2)*y)
1167 tgamma(x+1/2) -> tgamma(x+1/2)
1168 tgamma(15/2) -> (135135/128)*Pi^(1/2)
1169 @end example
1170
1171 @cindex branch cut
1172 For functions that have a branch cut in the complex plane GiNaC follows
1173 the conventions for C++ as defined in the ANSI standard.  In particular:
1174 the natural logarithm (@code{log}) and the square root (@code{sqrt})
1175 both have their branch cuts running along the negative real axis where
1176 the points on the axis itself belong to the upper part.
1177
1178 Besides evaluation most of these functions allow differentiation, series
1179 expansion and so on.  Read the next chapter in order to learn more about
1180 this.
1181
1182
1183 @node Relations, Archiving, Built-in functions, Basic Concepts
1184 @c    node-name, next, previous, up
1185 @section Relations
1186 @cindex @code{relational} (class)
1187
1188 Sometimes, a relation holding between two expressions must be stored
1189 somehow.  The class @code{relational} is a convenient container for such
1190 purposes.  A relation is by definition a container for two @code{ex} and
1191 a relation between them that signals equality, inequality and so on.
1192 They are created by simply using the C++ operators @code{==}, @code{!=},
1193 @code{<}, @code{<=}, @code{>} and @code{>=} between two expressions.
1194
1195 @xref{Built-in functions}, for examples where various applications of
1196 the @code{.subs()} method show how objects of class relational are used
1197 as arguments.  There they provide an intuitive syntax for substitutions.
1198 They can also used for creating systems of equations that are to be
1199 solved for unknown variables.  More applications of this class will
1200 appear throughout the next chapters.
1201
1202
1203 @node Archiving, Important Algorithms, Relations, Basic Concepts
1204 @c    node-name, next, previous, up
1205 @section Archiving Expressions
1206 @cindex I/O
1207 @cindex @code{archive} (class)
1208
1209 GiNaC allows creating @dfn{archives} of expressions which can be stored
1210 to or retrieved from files. To create an archive, you declare an object
1211 of class @code{archive} and archive expressions in it, giving each
1212 expressions a unique name:
1213
1214 @example
1215 #include <ginac/ginac.h>
1216 #include <fstream>
1217 using namespace GiNaC;
1218
1219 int main()
1220 @{
1221     symbol x("x"), y("y"), z("z");
1222
1223     ex foo = sin(x + 2*y) + 3*z + 41;
1224     ex bar = foo + 1;
1225
1226     archive a;
1227     a.archive_ex(foo, "foo");
1228     a.archive_ex(bar, "the second one");
1229     // ...
1230 @end example
1231
1232 The archive can then be written to a file:
1233
1234 @example
1235     // ...
1236     ofstream out("foobar.gar");
1237     out << a;
1238     out.close();
1239     // ...
1240 @end example
1241
1242 The file @file{foobar.gar} contains all information that is needed to
1243 reconstruct the expressions @code{foo} and @code{bar}.
1244
1245 @cindex @command{viewgar}
1246 The tool @command{viewgar} that comes with GiNaC can be used to view
1247 the contents of GiNaC archive files:
1248
1249 @example
1250 $ viewgar foobar.gar
1251 foo = 41+sin(x+2*y)+3*z
1252 the second one = 42+sin(x+2*y)+3*z
1253 @end example
1254
1255 The point of writing archive files is of course that they can later be
1256 read in again:
1257
1258 @example
1259     // ...
1260     archive a2;
1261     ifstream in("foobar.gar");
1262     in >> a2;
1263     // ...
1264 @end example
1265
1266 And the stored expressions can be retrieved by their name:
1267
1268 @example
1269     // ...
1270     lst syms;
1271     syms.append(x); syms.append(y);
1272
1273     ex ex1 = a2.unarchive_ex(syms, "foo");
1274     ex ex2 = a2.unarchive_ex(syms, "the second one");
1275
1276     cout << ex1 << endl;              // prints "41+sin(x+2*y)+3*z"
1277     cout << ex2 << endl;              // prints "42+sin(x+2*y)+3*z"
1278     cout << ex1.subs(x == 2) << endl; // prints "41+sin(2+2*y)+3*z"
1279     // ...
1280 @}
1281 @end example
1282
1283 Note that you have to supply a list of the symbols which are to be inserted
1284 in the expressions. Symbols in archives are stored by their name only and
1285 if you don't specify which symbols you have, unarchiving the expression will
1286 create new symbols with that name. E.g. if you hadn't included @code{x} in
1287 the @code{syms} list above, the @code{ex1.subs(x == 2)} statement would
1288 have had no effect because the @code{x} in @code{ex1} would have been a
1289 different symbol than the @code{x} which was defined at the beginning of
1290 the program, altough both would appear as @samp{x} when printed.
1291
1292
1293
1294 @node Important Algorithms, Polynomial Expansion, Archiving, Top
1295 @c    node-name, next, previous, up
1296 @chapter Important Algorithms
1297 @cindex polynomial
1298
1299 In this chapter the most important algorithms provided by GiNaC will be
1300 described.  Some of them are implemented as functions on expressions,
1301 others are implemented as methods provided by expression objects.  If
1302 they are methods, there exists a wrapper function around it, so you can
1303 alternatively call it in a functional way as shown in the simple
1304 example:
1305
1306 @example
1307 #include <ginac/ginac.h>
1308 using namespace GiNaC;
1309
1310 int main()
1311 @{
1312     ex x = numeric(1.0);
1313     
1314     cout << "As method:   " << sin(x).evalf() << endl;
1315     cout << "As function: " << evalf(sin(x)) << endl;
1316     // ...
1317 @}
1318 @end example
1319
1320 @cindex @code{subs()}
1321 The general rule is that wherever methods accept one or more parameters
1322 (@var{arg1}, @var{arg2}, @dots{}) the order of arguments the function
1323 wrapper accepts is the same but preceded by the object to act on
1324 (@var{object}, @var{arg1}, @var{arg2}, @dots{}).  This approach is the
1325 most natural one in an OO model but it may lead to confusion for MapleV
1326 users because where they would type @code{A:=x+1; subs(x=2,A);} GiNaC
1327 would require @code{A=x+1; subs(A,x==2);} (after proper declaration of
1328 @code{A} and @code{x}).  On the other hand, since MapleV returns 3 on
1329 @code{A:=x^2+3; coeff(A,x,0);} (GiNaC: @code{A=pow(x,2)+3;
1330 coeff(A,x,0);}) it is clear that MapleV is not trying to be consistent
1331 here.  Also, users of MuPAD will in most cases feel more comfortable
1332 with GiNaC's convention.  All function wrappers are implemented
1333 as simple inline functions which just call the corresponding method and
1334 are only provided for users uncomfortable with OO who are dead set to
1335 avoid method invocations.  Generally, nested function wrappers are much
1336 harder to read than a sequence of methods and should therefore be
1337 avoided if possible.  On the other hand, not everything in GiNaC is a
1338 method on class @code{ex} and sometimes calling a function cannot be
1339 avoided.
1340
1341 @menu
1342 * Polynomial Expansion::
1343 * Collecting expressions::
1344 * Polynomial Arithmetic::
1345 * Symbolic Differentiation::
1346 * Series Expansion::
1347 @end menu
1348
1349
1350 @node Polynomial Expansion, Collecting expressions, Important Algorithms, Important Algorithms
1351 @c    node-name, next, previous, up
1352 @section Polynomial Expansion
1353 @cindex @code{expand()}
1354
1355 A polynomial in one or more variables has many equivalent
1356 representations.  Some useful ones serve a specific purpose.  Consider
1357 for example the trivariate polynomial @math{4*x*y + x*z + 20*y^2 +
1358 21*y*z + 4*z^2} (written down here in output-style).  It is equivalent
1359 to the factorized polynomial @math{(x + 5*y + 4*z)*(4*y + z)}.  Other
1360 representations are the recursive ones where one collects for exponents
1361 in one of the three variable.  Since the factors are themselves
1362 polynomials in the remaining two variables the procedure can be
1363 repeated.  In our expample, two possibilities would be @math{(4*y + z)*x
1364 + 20*y^2 + 21*y*z + 4*z^2} and @math{20*y^2 + (21*z + 4*x)*y + 4*z^2 +
1365 x*z}.
1366
1367 To bring an expression into expanded form, its method @code{.expand()}
1368 may be called.  In our example above, this corresponds to @math{4*x*y +
1369 x*z + 20*y^2 + 21*y*z + 4*z^2}.  Again, since the canonical form in
1370 GiNaC is not easily guessable you should be prepared to see different
1371 orderings of terms in such sums!
1372
1373
1374 @node Collecting expressions, Polynomial Arithmetic, Polynomial Expansion, Important Algorithms
1375 @c    node-name, next, previous, up
1376 @section Collecting expressions
1377 @cindex @code{collect()}
1378 @cindex @code{coeff()}
1379
1380 Another useful representation of multivariate polynomials is as a
1381 univariate polynomial in one of the variables with the coefficients
1382 being polynomials in the remaining variables.  The method
1383 @code{collect()} accomplishes this task.  Here is its declaration:
1384
1385 @example
1386 ex ex::collect(const symbol & s);
1387 @end example
1388
1389 Note that the original polynomial needs to be in expanded form in order
1390 to be able to find the coefficients properly.  The range of occuring
1391 coefficients can be checked using the two methods
1392
1393 @cindex @code{degree()}
1394 @cindex @code{ldegree()}
1395 @example
1396 int ex::degree(const symbol & s);
1397 int ex::ldegree(const symbol & s);
1398 @end example
1399
1400 where @code{degree()} returns the highest coefficient and
1401 @code{ldegree()} the lowest one.  (These two methods work also reliably
1402 on non-expanded input polynomials).  An application is illustrated in
1403 the next example, where a multivariate polynomial is analyzed:
1404
1405 @example
1406 #include <ginac/ginac.h>
1407 using namespace GiNaC;
1408
1409 int main()
1410 @{
1411     symbol x("x"), y("y");
1412     ex PolyInp = 4*pow(x,3)*y + 5*x*pow(y,2) + 3*y
1413                  - pow(x+y,2) + 2*pow(y+2,2) - 8;
1414     ex Poly = PolyInp.expand();
1415     
1416     for (int i=Poly.ldegree(x); i<=Poly.degree(x); ++i) @{
1417         cout << "The x^" << i << "-coefficient is "
1418              << Poly.coeff(x,i) << endl;
1419     @}
1420     cout << "As polynomial in y: " 
1421          << Poly.collect(y) << endl;
1422     // ...
1423 @}
1424 @end example
1425
1426 When run, it returns an output in the following fashion:
1427
1428 @example
1429 The x^0-coefficient is y^2+11*y
1430 The x^1-coefficient is 5*y^2-2*y
1431 The x^2-coefficient is -1
1432 The x^3-coefficient is 4*y
1433 As polynomial in y: -x^2+(5*x+1)*y^2+(-2*x+4*x^3+11)*y
1434 @end example
1435
1436 As always, the exact output may vary between different versions of GiNaC
1437 or even from run to run since the internal canonical ordering is not
1438 within the user's sphere of influence.
1439
1440
1441 @node Polynomial Arithmetic, Symbolic Differentiation, Collecting expressions, Important Algorithms
1442 @c    node-name, next, previous, up
1443 @section Polynomial Arithmetic
1444
1445 @subsection GCD and LCM
1446 @cindex GCD
1447 @cindex LCM
1448
1449 The functions for polynomial greatest common divisor and least common
1450 multiple have the synopsis:
1451
1452 @example
1453 ex gcd(const ex & a, const ex & b);
1454 ex lcm(const ex & a, const ex & b);
1455 @end example
1456
1457 The functions @code{gcd()} and @code{lcm()} accept two expressions
1458 @code{a} and @code{b} as arguments and return a new expression, their
1459 greatest common divisor or least common multiple, respectively.  If the
1460 polynomials @code{a} and @code{b} are coprime @code{gcd(a,b)} returns 1
1461 and @code{lcm(a,b)} returns the product of @code{a} and @code{b}.
1462
1463 @example
1464 #include <ginac/ginac.h>
1465 using namespace GiNaC;
1466
1467 int main()
1468 @{
1469     symbol x("x"), y("y"), z("z");
1470     ex P_a = 4*x*y + x*z + 20*pow(y, 2) + 21*y*z + 4*pow(z, 2);
1471     ex P_b = x*y + 3*x*z + 5*pow(y, 2) + 19*y*z + 12*pow(z, 2);
1472
1473     ex P_gcd = gcd(P_a, P_b);
1474     // x + 5*y + 4*z
1475     ex P_lcm = lcm(P_a, P_b);
1476     // 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
1477     // ...
1478 @}
1479 @end example
1480
1481 @subsection The @code{normal} method
1482 @cindex @code{normal()}
1483 @cindex temporary replacement
1484
1485 While in common symbolic code @code{gcd()} and @code{lcm()} are not too
1486 heavily used, simplification is called for frequently.  Therefore
1487 @code{.normal()}, which provides some basic form of simplification, has
1488 become a method of class @code{ex}, just like @code{.expand()}.  It
1489 converts a rational function into an equivalent rational function where
1490 numerator and denominator are coprime.  This means, it finds the GCD of
1491 numerator and denominator and cancels it.  If it encounters some object
1492 which does not belong to the domain of rationals (a function for
1493 instance), that object is replaced by a temporary symbol.  This means
1494 that both expressions @code{t1} and @code{t2} are indeed simplified in
1495 this little program:
1496
1497 @example
1498 #include <ginac/ginac.h>
1499 using namespace GiNaC;
1500
1501 int main()
1502 @{
1503     symbol x("x");
1504     ex t1 = (pow(x,2) + 2*x + 1)/(x + 1);
1505     ex t2 = (pow(sin(x),2) + 2*sin(x) + 1)/(sin(x) + 1);
1506     cout << "t1 is " << t1.normal() << endl;
1507     cout << "t2 is " << t2.normal() << endl;
1508     // ...
1509 @}
1510 @end example
1511
1512 Of course this works for multivariate polynomials too, so the ratio of
1513 the sample-polynomials from the section about GCD and LCM above would be
1514 normalized to @code{P_a/P_b} = @code{(4*y+z)/(y+3*z)}.
1515
1516
1517 @node Symbolic Differentiation, Series Expansion, Polynomial Arithmetic, Important Algorithms
1518 @c    node-name, next, previous, up
1519 @section Symbolic Differentiation
1520 @cindex differentiation
1521 @cindex @code{diff()}
1522 @cindex chain rule
1523 @cindex product rule
1524
1525 GiNaC's objects know how to differentiate themselves.  Thus, a
1526 polynomial (class @code{add}) knows that its derivative is the sum of
1527 the derivatives of all the monomials:
1528
1529 @example
1530 #include <ginac/ginac.h>
1531 using namespace GiNaC;
1532
1533 int main()
1534 @{
1535     symbol x("x"), y("y"), z("z");
1536     ex P = pow(x, 5) + pow(x, 2) + y;
1537
1538     cout << P.diff(x,2) << endl;  // 20*x^3 + 2
1539     cout << P.diff(y) << endl;    // 1
1540     cout << P.diff(z) << endl;    // 0
1541     // ...
1542 @}
1543 @end example
1544
1545 If a second integer parameter @var{n} is given, the @code{diff} method
1546 returns the @var{n}th derivative.
1547
1548 If @emph{every} object and every function is told what its derivative
1549 is, all derivatives of composed objects can be calculated using the
1550 chain rule and the product rule.  Consider, for instance the expression
1551 @code{1/cosh(x)}.  Since the derivative of @code{cosh(x)} is
1552 @code{sinh(x)} and the derivative of @code{pow(x,-1)} is
1553 @code{-pow(x,-2)}, GiNaC can readily compute the composition.  It turns
1554 out that the composition is the generating function for Euler Numbers,
1555 i.e. the so called @var{n}th Euler number is the coefficient of
1556 @code{x^n/n!} in the expansion of @code{1/cosh(x)}.  We may use this
1557 identity to code a function that generates Euler numbers in just three
1558 lines:
1559
1560 @cindex Euler numbers
1561 @example
1562 #include <ginac/ginac.h>
1563 using namespace GiNaC;
1564
1565 ex EulerNumber(unsigned n)
1566 @{
1567     symbol x;
1568     const ex generator = pow(cosh(x),-1);
1569     return generator.diff(x,n).subs(x==0);
1570 @}
1571
1572 int main()
1573 @{
1574     for (unsigned i=0; i<11; i+=2)
1575         cout << EulerNumber(i) << endl;
1576     return 0;
1577 @}
1578 @end example
1579
1580 When you run it, it produces the sequence @code{1}, @code{-1}, @code{5},
1581 @code{-61}, @code{1385}, @code{-50521}.  We increment the loop variable
1582 @code{i} by two since all odd Euler numbers vanish anyways.
1583
1584
1585 @node Series Expansion, Extending GiNaC, Symbolic Differentiation, Important Algorithms
1586 @c    node-name, next, previous, up
1587 @section Series Expansion
1588 @cindex @code{series()}
1589 @cindex Taylor expansion
1590 @cindex Laurent expansion
1591 @cindex @code{pseries} (class)
1592
1593 Expressions know how to expand themselves as a Taylor series or (more
1594 generally) a Laurent series.  As in most conventional Computer Algebra
1595 Systems, no distinction is made between those two.  There is a class of
1596 its own for storing such series (@code{class pseries}) and a built-in
1597 function (called @code{Order}) for storing the order term of the series.
1598 As a consequence, if you want to work with series, i.e. multiply two
1599 series, you need to call the method @code{ex::series} again to convert
1600 it to a series object with the usual structure (expansion plus order
1601 term).  A sample application from special relativity could read:
1602
1603 @example
1604 #include <ginac/ginac.h>
1605 using namespace GiNaC;
1606
1607 int main()
1608 @{
1609     symbol v("v"), c("c");
1610     
1611     ex gamma = 1/sqrt(1 - pow(v/c,2));
1612     ex mass_nonrel = gamma.series(v==0, 10);
1613     
1614     cout << "the relativistic mass increase with v is " << endl
1615          << mass_nonrel << endl;
1616     
1617     cout << "the inverse square of this series is " << endl
1618          << pow(mass_nonrel,-2).series(v==0, 10) << endl;
1619     
1620     // ...
1621 @}
1622 @end example
1623
1624 Only calling the series method makes the last output simplify to
1625 @math{1-v^2/c^2+O(v^10)}, without that call we would just have a long
1626 series raised to the power @math{-2}.
1627
1628 @cindex M@'echain's formula
1629 As another instructive application, let us calculate the numerical 
1630 value of Archimedes' constant
1631 @tex
1632 $\pi$
1633 @end tex
1634 (for which there already exists the built-in constant @code{Pi}) 
1635 using M@'echain's amazing formula
1636 @tex
1637 $\pi=16$~atan~$\!\left(1 \over 5 \right)-4$~atan~$\!\left(1 \over 239 \right)$.
1638 @end tex
1639 @ifnottex
1640 @math{Pi==16*atan(1/5)-4*atan(1/239)}.
1641 @end ifnottex
1642 We may expand the arcus tangent around @code{0} and insert the fractions
1643 @code{1/5} and @code{1/239}.  But, as we have seen, a series in GiNaC
1644 carries an order term with it and the question arises what the system is
1645 supposed to do when the fractions are plugged into that order term.  The
1646 solution is to use the function @code{series_to_poly()} to simply strip
1647 the order term off:
1648
1649 @example
1650 #include <ginac/ginac.h>
1651 using namespace GiNaC;
1652
1653 ex mechain_pi(int degr)
1654 @{
1655     symbol x;
1656     ex pi_expansion = series_to_poly(atan(x).series(x,degr));
1657     ex pi_approx = 16*pi_expansion.subs(x==numeric(1,5))
1658                    -4*pi_expansion.subs(x==numeric(1,239));
1659     return pi_approx;
1660 @}
1661
1662 int main()
1663 @{
1664     ex pi_frac;
1665     for (int i=2; i<12; i+=2) @{
1666         pi_frac = mechain_pi(i);
1667         cout << i << ":\t" << pi_frac << endl
1668              << "\t" << pi_frac.evalf() << endl;
1669     @}
1670     return 0;
1671 @}
1672 @end example
1673
1674 Note how we just called @code{.series(x,degr)} instead of
1675 @code{.series(x==0,degr)}.  This is a simple shortcut for @code{ex}'s
1676 method @code{series()}: if the first argument is a symbol the expression
1677 is expanded in that symbol around point @code{0}.  When you run this
1678 program, it will type out:
1679
1680 @example
1681 2:      3804/1195
1682         3.1832635983263598326
1683 4:      5359397032/1706489875
1684         3.1405970293260603143
1685 6:      38279241713339684/12184551018734375
1686         3.141621029325034425
1687 8:      76528487109180192540976/24359780855939418203125
1688         3.141591772182177295
1689 10:     327853873402258685803048818236/104359128170408663038552734375
1690         3.1415926824043995174
1691 @end example
1692
1693
1694 @node Extending GiNaC, What does not belong into GiNaC, Series Expansion, Top
1695 @c    node-name, next, previous, up
1696 @chapter Extending GiNaC
1697
1698 By reading so far you should have gotten a fairly good understanding of
1699 GiNaC's design-patterns.  From here on you should start reading the
1700 sources.  All we can do now is issue some recommendations how to tackle
1701 GiNaC's many loose ends in order to fulfill everybody's dreams.  If you
1702 develop some useful extension please don't hesitate to contact the GiNaC
1703 authors---they will happily incorporate them into future versions.
1704
1705 @menu
1706 * What does not belong into GiNaC::  What to avoid.
1707 * Symbolic functions::               Implementing symbolic functions.
1708 @end menu
1709
1710
1711 @node What does not belong into GiNaC, Symbolic functions, Extending GiNaC, Extending GiNaC
1712 @c    node-name, next, previous, up
1713 @section What doesn't belong into GiNaC
1714
1715 @cindex @command{ginsh}
1716 First of all, GiNaC's name must be read literally.  It is designed to be
1717 a library for use within C++.  The tiny @command{ginsh} accompanying
1718 GiNaC makes this even more clear: it doesn't even attempt to provide a
1719 language.  There are no loops or conditional expressions in
1720 @command{ginsh}, it is merely a window into the library for the
1721 programmer to test stuff (or to show off).  Still, the design of a
1722 complete CAS with a language of its own, graphical capabilites and all
1723 this on top of GiNaC is possible and is without doubt a nice project for
1724 the future.
1725
1726 There are many built-in functions in GiNaC that do not know how to
1727 evaluate themselves numerically to a precision declared at runtime
1728 (using @code{Digits}).  Some may be evaluated at certain points, but not
1729 generally.  This ought to be fixed.  However, doing numerical
1730 computations with GiNaC's quite abstract classes is doomed to be
1731 inefficient.  For this purpose, the underlying foundation classes
1732 provided by @acronym{CLN} are much better suited.
1733
1734
1735 @node Symbolic functions, A Comparison With Other CAS, What does not belong into GiNaC, Extending GiNaC
1736 @c    node-name, next, previous, up
1737 @section Symbolic functions
1738
1739 The easiest and most instructive way to start with is probably to
1740 implement your own function.  Objects of class @code{function} are
1741 inserted into the system via a kind of `registry'.  They get a serial
1742 number that is used internally to identify them but you usually need not
1743 worry about this.  What you have to care for are functions that are
1744 called when the user invokes certain methods.  These are usual
1745 C++-functions accepting a number of @code{ex} as arguments and returning
1746 one @code{ex}.  As an example, if we have a look at a simplified
1747 implementation of the cosine trigonometric function, we first need a
1748 function that is called when one wishes to @code{eval} it.  It could
1749 look something like this:
1750
1751 @example
1752 static ex cos_eval_method(const ex & x)
1753 @{
1754     // if (!x%(2*Pi)) return 1
1755     // if (!x%Pi) return -1
1756     // if (!x%Pi/2) return 0
1757     // care for other cases...
1758     return cos(x).hold();
1759 @}
1760 @end example
1761
1762 @cindex @code{hold()}
1763 @cindex evaluation
1764 The last line returns @code{cos(x)} if we don't know what else to do and
1765 stops a potential recursive evaluation by saying @code{.hold()}, which
1766 sets a flag to the expression signaling that it has been evaluated.  We
1767 should also implement a method for numerical evaluation and since we are
1768 lazy we sweep the problem under the rug by calling someone else's
1769 function that does so, in this case the one in class @code{numeric}:
1770
1771 @example
1772 static ex cos_evalf(const ex & x)
1773 @{
1774     return cos(ex_to_numeric(x));
1775 @}
1776 @end example
1777
1778 Differentiation will surely turn up and so we need to tell @code{cos}
1779 what the first derivative is (higher derivatives (@code{.diff(x,3)} for
1780 instance are then handled automatically by @code{basic::diff} and
1781 @code{ex::diff}):
1782
1783 @example
1784 static ex cos_deriv(const ex & x, unsigned diff_param)
1785 @{
1786     return -sin(x);
1787 @}
1788 @end example
1789
1790 @cindex product rule
1791 The second parameter is obligatory but uninteresting at this point.  It
1792 specifies which parameter to differentiate in a partial derivative in
1793 case the function has more than one parameter and its main application
1794 is for correct handling of the chain rule.  For Taylor expansion, it is
1795 enough to know how to differentiate.  But if the function you want to
1796 implement does have a pole somewhere in the complex plane, you need to
1797 write another method for Laurent expansion around that point.
1798
1799 Now that all the ingrediences for @code{cos} have been set up, we need
1800 to tell the system about it.  This is done by a macro and we are not
1801 going to descibe how it expands, please consult your preprocessor if you
1802 are curious:
1803
1804 @example
1805 REGISTER_FUNCTION(cos, eval_func(cos_eval).
1806                        evalf_func(cos_evalf).
1807                        derivative_func(cos_deriv));
1808 @end example
1809
1810 The first argument is the function's name used for calling it and for
1811 output.  The second binds the corresponding methods as options to this
1812 object.  Options are separated by a dot and can be given in an arbitrary
1813 order.  GiNaC functions understand several more options which are always
1814 specified as @code{.option(params)}, for example a method for series
1815 expansion @code{.series_func(cos_series)}.  Again, if no series
1816 expansion method is given, GiNaC defaults to simple Taylor expansion,
1817 which is correct if there are no poles involved as is the case for the
1818 @code{cos} function.  The way GiNaC handles poles in case there are any
1819 is best understood by studying one of the examples, like the Gamma
1820 (@code{tgamma}) function for instance.  (In essence the function first
1821 checks if there is a pole at the evaluation point and falls back to
1822 Taylor expansion if there isn't.  Then, the pole is regularized by some
1823 suitable transformation.)  Also, the new function needs to be declared
1824 somewhere.  This may also be done by a convenient preprocessor macro:
1825
1826 @example
1827 DECLARE_FUNCTION_1P(cos)
1828 @end example
1829
1830 The suffix @code{_1P} stands for @emph{one parameter}.  Of course, this
1831 implementation of @code{cos} is very incomplete and lacks several safety
1832 mechanisms.  Please, have a look at the real implementation in GiNaC.
1833 (By the way: in case you are worrying about all the macros above we can
1834 assure you that functions are GiNaC's most macro-intense classes.  We
1835 have done our best to avoid macros where we can.)
1836
1837 That's it. May the source be with you!
1838
1839
1840 @node A Comparison With Other CAS, Advantages, Symbolic functions, Top
1841 @c    node-name, next, previous, up
1842 @chapter A Comparison With Other CAS
1843 @cindex advocacy
1844
1845 This chapter will give you some information on how GiNaC compares to
1846 other, traditional Computer Algebra Systems, like @emph{Maple},
1847 @emph{Mathematica} or @emph{Reduce}, where it has advantages and
1848 disadvantages over these systems.
1849
1850 @menu
1851 * Advantages::                       Stengths of the GiNaC approach.
1852 * Disadvantages::                    Weaknesses of the GiNaC approach.
1853 * Why C++?::                         Attractiveness of C++.
1854 @end menu
1855
1856 @node Advantages, Disadvantages, A Comparison With Other CAS, A Comparison With Other CAS
1857 @c    node-name, next, previous, up
1858 @section Advantages
1859
1860 GiNaC has several advantages over traditional Computer
1861 Algebra Systems, like 
1862
1863 @itemize @bullet
1864
1865 @item
1866 familiar language: all common CAS implement their own proprietary
1867 grammar which you have to learn first (and maybe learn again when your
1868 vendor decides to `enhance' it).  With GiNaC you can write your program
1869 in common C++, which is standardized.
1870
1871 @cindex STL
1872 @item
1873 structured data types: you can build up structured data types using
1874 @code{struct}s or @code{class}es together with STL features instead of
1875 using unnamed lists of lists of lists.
1876
1877 @item
1878 strongly typed: in CAS, you usually have only one kind of variables
1879 which can hold contents of an arbitrary type.  This 4GL like feature is
1880 nice for novice programmers, but dangerous.
1881     
1882 @item
1883 development tools: powerful development tools exist for C++, like fancy
1884 editors (e.g. with automatic indentation and syntax highlighting),
1885 debuggers, visualization tools, documentation generators...
1886
1887 @item
1888 modularization: C++ programs can easily be split into modules by
1889 separating interface and implementation.
1890
1891 @item
1892 price: GiNaC is distributed under the GNU Public License which means
1893 that it is free and available with source code.  And there are excellent
1894 C++-compilers for free, too.
1895     
1896 @item
1897 extendable: you can add your own classes to GiNaC, thus extending it on
1898 a very low level.  Compare this to a traditional CAS that you can
1899 usually only extend on a high level by writing in the language defined
1900 by the parser.  In particular, it turns out to be almost impossible to
1901 fix bugs in a traditional system.
1902
1903 @item
1904 multiple interfaces: Though real GiNaC programs have to be written in
1905 some editor, then be compiled, linked and executed, there are more ways
1906 to work with the GiNaC engine.  Many people want to play with
1907 expressions interactively, as in traditional CASs.  Currently, two such
1908 windows into GiNaC have been implemented and many more are possible: the
1909 tiny @command{ginsh} that is part of the distribution exposes GiNaC's
1910 types to a command line and second, as a more consistent approach, an
1911 interactive interface to the @acronym{Cint} C++ interpreter has been put
1912 together (called @acronym{GiNaC-cint}) that allows an interactive
1913 scripting interface consistent with the C++ language.
1914
1915 @item
1916 seemless integration: it is somewhere between difficult and impossible
1917 to call CAS functions from within a program written in C++ or any other
1918 programming language and vice versa.  With GiNaC, your symbolic routines
1919 are part of your program.  You can easily call third party libraries,
1920 e.g. for numerical evaluation or graphical interaction.  All other
1921 approaches are much more cumbersome: they range from simply ignoring the
1922 problem (i.e. @emph{Maple}) to providing a method for `embedding' the
1923 system (i.e. @emph{Yacas}).
1924
1925 @item
1926 efficiency: often large parts of a program do not need symbolic
1927 calculations at all.  Why use large integers for loop variables or
1928 arbitrary precision arithmetics where @code{int} and @code{double} are
1929 sufficient?  For pure symbolic applications, GiNaC is comparable in
1930 speed with other CAS.
1931
1932 @end itemize
1933
1934
1935 @node Disadvantages, Why C++?, Advantages, A Comparison With Other CAS
1936 @c    node-name, next, previous, up
1937 @section Disadvantages
1938
1939 Of course it also has some disadvantages:
1940
1941 @itemize @bullet
1942
1943 @item
1944 advanced features: GiNaC cannot compete with a program like
1945 @emph{Reduce} which exists for more than 30 years now or @emph{Maple}
1946 which grows since 1981 by the work of dozens of programmers, with
1947 respect to mathematical features.  Integration, factorization,
1948 non-trivial simplifications, limits etc. are missing in GiNaC (and are
1949 not planned for the near future).
1950
1951 @item
1952 portability: While the GiNaC library itself is designed to avoid any
1953 platform dependent features (it should compile on any ANSI compliant C++
1954 compiler), the currently used version of the CLN library (fast large
1955 integer and arbitrary precision arithmetics) can be compiled only on
1956 systems with a recently new C++ compiler from the GNU Compiler
1957 Collection (@acronym{GCC}).@footnote{This is because CLN uses
1958 PROVIDE/REQUIRE like macros to let the compiler gather all static
1959 initializations, which works for GNU C++ only.}  GiNaC uses recent
1960 language features like explicit constructors, mutable members, RTTI,
1961 @code{dynamic_cast}s and STL, so ANSI compliance is meant literally.
1962 Recent @acronym{GCC} versions starting at 2.95, although itself not yet
1963 ANSI compliant, support all needed features.
1964     
1965 @end itemize
1966
1967
1968 @node Why C++?, Internal Structures, Disadvantages, A Comparison With Other CAS
1969 @c    node-name, next, previous, up
1970 @section Why C++?
1971
1972 Why did we choose to implement GiNaC in C++ instead of Java or any other
1973 language?  C++ is not perfect: type checking is not strict (casting is
1974 possible), separation between interface and implementation is not
1975 complete, object oriented design is not enforced.  The main reason is
1976 the often scolded feature of operator overloading in C++.  While it may
1977 be true that operating on classes with a @code{+} operator is rarely
1978 meaningful, it is perfectly suited for algebraic expressions.  Writing
1979 @math{3x+5y} as @code{3*x+5*y} instead of
1980 @code{x.times(3).plus(y.times(5))} looks much more natural.
1981 Furthermore, the main developers are more familiar with C++ than with
1982 any other programming language.
1983
1984
1985 @node Internal Structures, Expressions are reference counted, Why C++? , Top
1986 @c    node-name, next, previous, up
1987 @appendix Internal Structures
1988
1989 @menu
1990 * Expressions are reference counted::
1991 * Internal representation of products and sums::
1992 @end menu
1993
1994 @node Expressions are reference counted, Internal representation of products and sums, Internal Structures, Internal Structures
1995 @c    node-name, next, previous, up
1996 @appendixsection Expressions are reference counted
1997
1998 @cindex reference counting
1999 @cindex copy-on-write
2000 @cindex garbage collection
2001 An expression is extremely light-weight since internally it works like a
2002 handle to the actual representation and really holds nothing more than a
2003 pointer to some other object. What this means in practice is that
2004 whenever you create two @code{ex} and set the second equal to the first
2005 no copying process is involved. Instead, the copying takes place as soon
2006 as you try to change the second.  Consider the simple sequence of code:
2007
2008 @example
2009 #include <ginac/ginac.h>
2010 using namespace GiNaC;
2011
2012 int main()
2013 @{
2014     symbol x("x"), y("y"), z("z");
2015     ex e1, e2;
2016
2017     e1 = sin(x + 2*y) + 3*z + 41;
2018     e2 = e1;                // e2 points to same object as e1
2019     cout << e2 << endl;     // prints sin(x+2*y)+3*z+41
2020     e2 += 1;                // e2 is copied into a new object
2021     cout << e2 << endl;     // prints sin(x+2*y)+3*z+42
2022     // ...
2023 @}
2024 @end example
2025
2026 The line @code{e2 = e1;} creates a second expression pointing to the
2027 object held already by @code{e1}.  The time involved for this operation
2028 is therefore constant, no matter how large @code{e1} was.  Actual
2029 copying, however, must take place in the line @code{e2 += 1;} because
2030 @code{e1} and @code{e2} are not handles for the same object any more.
2031 This concept is called @dfn{copy-on-write semantics}.  It increases
2032 performance considerably whenever one object occurs multiple times and
2033 represents a simple garbage collection scheme because when an @code{ex}
2034 runs out of scope its destructor checks whether other expressions handle
2035 the object it points to too and deletes the object from memory if that
2036 turns out not to be the case.  A slightly less trivial example of
2037 differentiation using the chain-rule should make clear how powerful this
2038 can be:
2039
2040 @example
2041 #include <ginac/ginac.h>
2042 using namespace GiNaC;
2043
2044 int main()
2045 @{
2046     symbol x("x"), y("y");
2047
2048     ex e1 = x + 3*y;
2049     ex e2 = pow(e1, 3);
2050     ex e3 = diff(sin(e2), x);   // first derivative of sin(e2) by x
2051     cout << e1 << endl          // prints x+3*y
2052          << e2 << endl          // prints (x+3*y)^3
2053          << e3 << endl;         // prints 3*(x+3*y)^2*cos((x+3*y)^3)
2054     // ...
2055 @}
2056 @end example
2057
2058 Here, @code{e1} will actually be referenced three times while @code{e2}
2059 will be referenced two times.  When the power of an expression is built,
2060 that expression needs not be copied.  Likewise, since the derivative of
2061 a power of an expression can be easily expressed in terms of that
2062 expression, no copying of @code{e1} is involved when @code{e3} is
2063 constructed.  So, when @code{e3} is constructed it will print as
2064 @code{3*(x+3*y)^2*cos((x+3*y)^3)} but the argument of @code{cos()} only
2065 holds a reference to @code{e2} and the factor in front is just
2066 @code{3*e1^2}.
2067
2068 As a user of GiNaC, you cannot see this mechanism of copy-on-write
2069 semantics.  When you insert an expression into a second expression, the
2070 result behaves exactly as if the contents of the first expression were
2071 inserted.  But it may be useful to remember that this is not what
2072 happens.  Knowing this will enable you to write much more efficient
2073 code.  If you still have an uncertain feeling with copy-on-write
2074 semantics, we recommend you have a look at the
2075 @uref{http://www.cerfnet.com/~mpcline/c++-faq-lite/, C++-FAQ lite} by
2076 Marshall Cline.  Chapter 16 covers this issue and presents an
2077 implementation which is pretty close to the one in GiNaC.
2078
2079
2080 @node Internal representation of products and sums, Package Tools, Expressions are reference counted, Internal Structures
2081 @c    node-name, next, previous, up
2082 @appendixsection Internal representation of products and sums
2083
2084 @cindex representation
2085 @cindex @code{add}
2086 @cindex @code{mul}
2087 @cindex @code{power}
2088 Although it should be completely transparent for the user of
2089 GiNaC a short discussion of this topic helps to understand the sources
2090 and also explain performance to a large degree.  Consider the 
2091 unexpanded symbolic expression 
2092 @tex
2093 $2d^3 \left( 4a + 5b - 3 \right)$
2094 @end tex
2095 @ifnottex
2096 @math{2*d^3*(4*a+5*b-3)}
2097 @end ifnottex
2098 which could naively be represented by a tree of linear containers for
2099 addition and multiplication, one container for exponentiation with base
2100 and exponent and some atomic leaves of symbols and numbers in this
2101 fashion:
2102
2103 @image{repnaive}
2104
2105 @cindex pair-wise representation
2106 However, doing so results in a rather deeply nested tree which will
2107 quickly become inefficient to manipulate.  We can improve on this by
2108 representing the sum as a sequence of terms, each one being a pair of a
2109 purely numeric multiplicative coefficient and its rest.  In the same
2110 spirit we can store the multiplication as a sequence of terms, each
2111 having a numeric exponent and a possibly complicated base, the tree
2112 becomes much more flat:
2113
2114 @image{reppair}
2115
2116 The number @code{3} above the symbol @code{d} shows that @code{mul}
2117 objects are treated similarly where the coefficients are interpreted as
2118 @emph{exponents} now.  Addition of sums of terms or multiplication of
2119 products with numerical exponents can be coded to be very efficient with
2120 such a pair-wise representation.  Internally, this handling is performed
2121 by most CAS in this way.  It typically speeds up manipulations by an
2122 order of magnitude.  The overall multiplicative factor @code{2} and the
2123 additive term @code{-3} look somewhat out of place in this
2124 representation, however, since they are still carrying a trivial
2125 exponent and multiplicative factor @code{1} respectively.  Within GiNaC,
2126 this is avoided by adding a field that carries an overall numeric
2127 coefficient.  This results in the realistic picture of internal
2128 representation for
2129 @tex
2130 $2d^3 \left( 4a + 5b - 3 \right)$:
2131 @end tex
2132 @ifnottex
2133 @math{2*d^3*(4*a+5*b-3)}:
2134 @end ifnottex
2135
2136 @image{repreal}
2137
2138 @cindex radical
2139 This also allows for a better handling of numeric radicals, since
2140 @code{sqrt(2)} can now be carried along calculations.  Now it should be
2141 clear, why both classes @code{add} and @code{mul} are derived from the
2142 same abstract class: the data representation is the same, only the
2143 semantics differs.  In the class hierarchy, methods for polynomial
2144 expansion and the like are reimplemented for @code{add} and @code{mul},
2145 but the data structure is inherited from @code{expairseq}.
2146
2147
2148 @node Package Tools, ginac-config, Internal representation of products and sums, Top
2149 @c    node-name, next, previous, up
2150 @appendix Package Tools
2151
2152 If you are creating a software package that uses the GiNaC library,
2153 setting the correct command line options for the compiler and linker
2154 can be difficult. GiNaC includes two tools to make this process easier.
2155
2156 @menu
2157 * ginac-config::   A shell script to detect compiler and linker flags.
2158 * AM_PATH_GINAC::  Macro for GNU automake.
2159 @end menu
2160
2161
2162 @node ginac-config, AM_PATH_GINAC, Package Tools, Package Tools
2163 @c    node-name, next, previous, up
2164 @section @command{ginac-config}
2165 @cindex ginac-config
2166
2167 @command{ginac-config} is a shell script that you can use to determine
2168 the compiler and linker command line options required to compile and
2169 link a program with the GiNaC library.
2170
2171 @command{ginac-config} takes the following flags:
2172
2173 @table @samp
2174 @item --version
2175 Prints out the version of GiNaC installed.
2176 @item --cppflags
2177 Prints '-I' flags pointing to the installed header files.
2178 @item --libs
2179 Prints out the linker flags necessary to link a program against GiNaC.
2180 @item --prefix[=@var{PREFIX}]
2181 If @var{PREFIX} is specified, overrides the configured value of @env{$prefix}.
2182 (And of exec-prefix, unless @code{--exec-prefix} is also specified)
2183 Otherwise, prints out the configured value of @env{$prefix}.
2184 @item --exec-prefix[=@var{PREFIX}]
2185 If @var{PREFIX} is specified, overrides the configured value of @env{$exec_prefix}.
2186 Otherwise, prints out the configured value of @env{$exec_prefix}.
2187 @end table
2188
2189 Typically, @command{ginac-config} will be used within a configure
2190 script, as described below. It, however, can also be used directly from
2191 the command line using backquotes to compile a simple program. For
2192 example:
2193
2194 @example
2195 c++ -o simple `ginac-config --cppflags` simple.cpp `ginac-config --libs`
2196 @end example
2197
2198 This command line might expand to (for example):
2199
2200 @example
2201 cc -o simple -I/usr/local/include simple.cpp -L/usr/local/lib \
2202   -lginac -lcln -lstdc++
2203 @end example
2204
2205 Not only is the form using @command{ginac-config} easier to type, it will
2206 work on any system, no matter how GiNaC was configured.
2207
2208
2209 @node AM_PATH_GINAC, Configure script options, ginac-config, Package Tools
2210 @c    node-name, next, previous, up
2211 @section @samp{AM_PATH_GINAC}
2212 @cindex AM_PATH_GINAC
2213
2214 For packages configured using GNU automake, GiNaC also provides
2215 a macro to automate the process of checking for GiNaC.
2216
2217 @example
2218 AM_PATH_GINAC([@var{MINIMUM-VERSION}, [@var{ACTION-IF-FOUND} [, @var{ACTION-IF-NOT-FOUND}]]])
2219 @end example
2220
2221 This macro:
2222
2223 @itemize @bullet
2224
2225 @item
2226 Determines the location of GiNaC using @command{ginac-config}, which is
2227 either found in the user's path, or from the environment variable
2228 @env{GINACLIB_CONFIG}.
2229
2230 @item
2231 Tests the installed libraries to make sure that their version
2232 is later than @var{MINIMUM-VERSION}. (A default version will be used
2233 if not specified)
2234
2235 @item
2236 If the required version was found, sets the @env{GINACLIB_CPPFLAGS} variable
2237 to the output of @command{ginac-config --cppflags} and the @env{GINACLIB_LIBS}
2238 variable to the output of @command{ginac-config --libs}, and calls
2239 @samp{AC_SUBST()} for these variables so they can be used in generated
2240 makefiles, and then executes @var{ACTION-IF-FOUND}.
2241
2242 @item
2243 If the required version was not found, sets @env{GINACLIB_CPPFLAGS} and
2244 @env{GINACLIB_LIBS} to empty strings, and executes @var{ACTION-IF-NOT-FOUND}.
2245
2246 @end itemize
2247
2248 This macro is in file @file{ginac.m4} which is installed in
2249 @file{$datadir/aclocal}. Note that if automake was installed with a
2250 different @samp{--prefix} than GiNaC, you will either have to manually
2251 move @file{ginac.m4} to automake's @file{$datadir/aclocal}, or give
2252 aclocal the @samp{-I} option when running it.
2253
2254 @menu
2255 * Configure script options::  Configuring a package that uses AM_PATH_GINAC.
2256 * Example package::           Example of a package using AM_PATH_GINAC.
2257 @end menu
2258
2259
2260 @node Configure script options, Example package, AM_PATH_GINAC, AM_PATH_GINAC
2261 @c    node-name, next, previous, up
2262 @subsection Configuring a package that uses @samp{AM_PATH_GINAC}
2263
2264 Simply make sure that @command{ginac-config} is in your path, and run
2265 the configure script.
2266
2267 Notes:
2268
2269 @itemize @bullet
2270
2271 @item
2272 The directory where the GiNaC libraries are installed needs
2273 to be found by your system's dynamic linker.
2274   
2275 This is generally done by
2276
2277 @display
2278 editing @file{/etc/ld.so.conf} and running @command{ldconfig}
2279 @end display
2280
2281 or by
2282    
2283 @display
2284 setting the environment variable @env{LD_LIBRARY_PATH},
2285 @end display
2286
2287 or, as a last resort, 
2288  
2289 @display
2290 giving a @samp{-R} or @samp{-rpath} flag (depending on your linker) when
2291 running configure, for instance:
2292
2293 @example
2294 LDFLAGS=-R/home/cbauer/lib ./configure
2295 @end example
2296 @end display
2297
2298 @item
2299 You can also specify a @command{ginac-config} not in your path by
2300 setting the @env{GINACLIB_CONFIG} environment variable to the
2301 name of the executable
2302
2303 @item
2304 If you move the GiNaC package from its installed location,
2305 you will either need to modify @command{ginac-config} script
2306 manually to point to the new location or rebuild GiNaC.
2307
2308 @end itemize
2309
2310 Advanced note:
2311
2312 @itemize @bullet
2313 @item
2314 configure flags
2315   
2316 @example
2317 --with-ginac-prefix=@var{PREFIX}
2318 --with-ginac-exec-prefix=@var{PREFIX}
2319 @end example
2320
2321 are provided to override the prefix and exec-prefix that were stored
2322 in the @command{ginac-config} shell script by GiNaC's configure. You are
2323 generally better off configuring GiNaC with the right path to begin with.
2324 @end itemize
2325
2326
2327 @node Example package, Bibliography, Configure script options, AM_PATH_GINAC
2328 @c    node-name, next, previous, up
2329 @subsection Example of a package using @samp{AM_PATH_GINAC}
2330
2331 The following shows how to build a simple package using automake
2332 and the @samp{AM_PATH_GINAC} macro. The program used here is @file{simple.cpp}:
2333
2334 @example
2335 #include <ginac/ginac.h>
2336 using namespace GiNaC;
2337
2338 int main(void)
2339 @{
2340     symbol x("x");
2341     ex a = sin(x); 
2342     cout << "Derivative of " << a << " is " << a.diff(x) << endl;
2343     return 0;
2344 @}
2345 @end example
2346
2347 You should first read the introductory portions of the automake
2348 Manual, if you are not already familiar with it.
2349
2350 Two files are needed, @file{configure.in}, which is used to build the
2351 configure script:
2352
2353 @example
2354 dnl Process this file with autoconf to produce a configure script.
2355 AC_INIT(simple.cpp)
2356 AM_INIT_AUTOMAKE(simple.cpp, 1.0.0)
2357
2358 AC_PROG_CXX
2359 AC_PROG_INSTALL
2360 AC_LANG_CPLUSPLUS
2361
2362 AM_PATH_GINAC(0.4.0, [
2363   LIBS="$LIBS $GINACLIB_LIBS"
2364   CPPFLAGS="$CFLAGS $GINACLIB_CPPFLAGS"  
2365 ], AC_MSG_ERROR([need to have GiNaC installed]))
2366
2367 AC_OUTPUT(Makefile)
2368 @end example
2369
2370 The only command in this which is not standard for automake
2371 is the @samp{AM_PATH_GINAC} macro.
2372
2373 That command does the following:
2374
2375 @display
2376 If a GiNaC version greater than 0.4.0 is found, adds @env{$GINACLIB_LIBS} to 
2377 @env{$LIBS} and @env{$GINACLIB_CPPFLAGS} to @env{$CPPFLAGS}. Otherwise, dies
2378 with the error message `need to have GiNaC installed'
2379 @end display
2380
2381 And the @file{Makefile.am}, which will be used to build the Makefile.
2382
2383 @example
2384 ## Process this file with automake to produce Makefile.in
2385 bin_PROGRAMS = simple
2386 simple_SOURCES = simple.cpp
2387 @end example
2388
2389 This @file{Makefile.am}, says that we are building a single executable,
2390 from a single sourcefile @file{simple.cpp}. Since every program
2391 we are building uses GiNaC we simply added the GiNaC options
2392 to @env{$LIBS} and @env{$CPPFLAGS}, but in other circumstances, we might
2393 want to specify them on a per-program basis: for instance by
2394 adding the lines:
2395
2396 @example
2397 simple_LDADD = $(GINACLIB_LIBS)
2398 INCLUDES = $(GINACLIB_CPPFLAGS)
2399 @end example
2400
2401 to the @file{Makefile.am}.
2402
2403 To try this example out, create a new directory and add the three
2404 files above to it.
2405
2406 Now execute the following commands:
2407
2408 @example
2409 $ automake --add-missing
2410 $ aclocal
2411 $ autoconf
2412 @end example
2413
2414 You now have a package that can be built in the normal fashion
2415
2416 @example
2417 $ ./configure
2418 $ make
2419 $ make install
2420 @end example
2421
2422
2423 @node Bibliography, Concept Index, Example package, Top
2424 @c    node-name, next, previous, up
2425 @appendix Bibliography
2426
2427 @itemize @minus{}
2428
2429 @item
2430 @cite{ISO/IEC 14882:1998: Programming Languages: C++}
2431
2432 @item
2433 @cite{CLN: A Class Library for Numbers}, @email{haible@@ilog.fr, Bruno Haible}
2434
2435 @item
2436 @cite{The C++ Programming Language}, Bjarne Stroustrup, 3rd Edition, ISBN 0-201-88954-4, Addison Wesley
2437
2438 @item
2439 @cite{C++ FAQs}, Marshall Cline, ISBN 0-201-58958-3, 1995, Addison Wesley
2440
2441 @item
2442 @cite{Algorithms for Computer Algebra}, Keith O. Geddes, Stephen R. Czapor,
2443 and George Labahn, ISBN 0-7923-9259-0, 1992, Kluwer Academic Publishers, Norwell, Massachusetts
2444
2445 @item
2446 @cite{Computer Algebra: Systems and Algorithms for Algebraic Computation},
2447 J.H. Davenport, Y. Siret, and E. Tournier, ISBN 0-12-204230-1, 1988, 
2448 Academic Press, London
2449
2450 @end itemize
2451
2452
2453 @node Concept Index, , Bibliography, Top
2454 @c    node-name, next, previous, up
2455 @unnumbered Concept Index
2456
2457 @printindex cp
2458
2459 @bye
2460