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