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