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