- Complete revamp of methods in class matrix. Some redundant (and poor)
[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 * Methods and Functions::        Algorithms for symbolic manipulations.
86 * Extending GiNaC::              How to extend the library.
87 * A Comparison With Other CAS::  Compares GiNaC to traditional CAS.
88 * Internal Structures::          Description of some internal structures.
89 * Package Tools::                Configuring packages to work with GiNaC.
90 * Bibliography::
91 * Concept Index::
92 @end menu
93
94
95 @node Introduction, A Tour of GiNaC, Top, Top
96 @c    node-name, next, previous, up
97 @chapter Introduction
98 @cindex history of GiNaC
99
100 The motivation behind GiNaC derives from the observation that most
101 present day computer algebra systems (CAS) are linguistically and
102 semantically impoverished.  Although they are quite powerful tools for
103 learning math and solving particular problems they lack modern
104 linguistical structures that allow for the creation of large-scale
105 projects.  GiNaC is an attempt to overcome this situation by extending a
106 well established and standardized computer language (C++) by some
107 fundamental symbolic capabilities, thus allowing for integrated systems
108 that embed symbolic manipulations together with more established areas
109 of computer science (like computation-intense numeric applications,
110 graphical interfaces, etc.) under one roof.
111
112 The particular problem that led to the writing of the GiNaC framework is
113 still a very active field of research, namely the calculation of higher
114 order corrections to elementary particle interactions.  There,
115 theoretical physicists are interested in matching present day theories
116 against experiments taking place at particle accelerators.  The
117 computations involved are so complex they call for a combined symbolical
118 and numerical approach.  This turned out to be quite difficult to
119 accomplish with the present day CAS we have worked with so far and so we
120 tried to fill the gap by writing GiNaC.  But of course its applications
121 are in no way restricted to theoretical physics.
122
123 This tutorial is intended for the novice user who is new to GiNaC but
124 already has some background in C++ programming.  However, since a
125 hand-made documentation like this one is difficult to keep in sync with
126 the development, the actual documentation is inside the sources in the
127 form of comments.  That documentation may be parsed by one of the many
128 Javadoc-like documentation systems.  If you fail at generating it you
129 may access it from @uref{http://www.ginac.de/reference/, the GiNaC home
130 page}.  It is an invaluable resource not only for the advanced user who
131 wishes to extend the system (or chase bugs) but for everybody who wants
132 to comprehend the inner workings of GiNaC.  This little tutorial on the
133 other hand only covers the basic things that are unlikely to change in
134 the near future.
135
136 @section License
137 The GiNaC framework for symbolic computation within the C++ programming
138 language is Copyright @copyright{} 1999-2000 Johannes Gutenberg
139 University Mainz, Germany.
140
141 This program is free software; you can redistribute it and/or
142 modify it under the terms of the GNU General Public License as
143 published by the Free Software Foundation; either version 2 of the
144 License, or (at your option) any later version.
145
146 This program is distributed in the hope that it will be useful, but
147 WITHOUT ANY WARRANTY; without even the implied warranty of
148 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
149 General Public License for more details.
150
151 You should have received a copy of the GNU General Public License
152 along with this program; see the file COPYING.  If not, write to the
153 Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
154 MA 02111-1307, USA.
155
156
157 @node A Tour of GiNaC, How to use it from within C++, Introduction, Top
158 @c    node-name, next, previous, up
159 @chapter A Tour of GiNaC
160
161 This quick tour of GiNaC wants to arise your interest in the
162 subsequent chapters by showing off a bit.  Please excuse us if it
163 leaves many open questions.
164
165 @menu
166 * How to use it from within C++::  Two simple examples.
167 * What it can do for you::         A Tour of GiNaC's features.
168 @end menu
169
170
171 @node How to use it from within C++, What it can do for you, A Tour of GiNaC, A Tour of GiNaC
172 @c    node-name, next, previous, up
173 @section How to use it from within C++
174
175 The GiNaC open framework for symbolic computation within the C++ programming
176 language does not try to define a language of its own as conventional
177 CAS do.  Instead, it extends the capabilities of C++ by symbolic
178 manipulations.  Here is how to generate and print a simple (and rather
179 pointless) bivariate polynomial with some large coefficients:
180
181 @example
182 #include <ginac/ginac.h>
183 using namespace GiNaC;
184
185 int main()
186 @{
187     symbol x("x"), y("y");
188     ex poly;
189
190     for (int i=0; i<3; ++i)
191         poly += factorial(i+16)*pow(x,i)*pow(y,2-i);
192
193     cout << poly << endl;
194     return 0;
195 @}
196 @end example
197
198 Assuming the file is called @file{hello.cc}, on our system we can compile
199 and run it like this:
200
201 @example
202 $ c++ hello.cc -o hello -lcln -lginac
203 $ ./hello
204 355687428096000*x*y+20922789888000*y^2+6402373705728000*x^2
205 @end example
206
207 (@xref{Package Tools}, for tools that help you when creating a software
208 package that uses GiNaC.)
209
210 @cindex Hermite polynomial
211 Next, there is a more meaningful C++ program that calls a function which
212 generates Hermite polynomials in a specified free variable.
213
214 @example
215 #include <ginac/ginac.h>
216 using namespace GiNaC;
217
218 ex HermitePoly(const symbol & x, int n)
219 @{
220     ex HKer=exp(-pow(x, 2));
221     // uses the identity H_n(x) == (-1)^n exp(x^2) (d/dx)^n exp(-x^2)
222     return normal(pow(-1, n) * diff(HKer, x, n) / HKer);
223 @}
224
225 int main()
226 @{
227     symbol z("z");
228
229     for (int i=0; i<6; ++i)
230         cout << "H_" << i << "(z) == " << HermitePoly(z,i) << endl;
231
232     return 0;
233 @}
234 @end example
235
236 When run, this will type out
237
238 @example
239 H_0(z) == 1
240 H_1(z) == 2*z
241 H_2(z) == 4*z^2-2
242 H_3(z) == -12*z+8*z^3
243 H_4(z) == -48*z^2+16*z^4+12
244 H_5(z) == 120*z-160*z^3+32*z^5
245 @end example
246
247 This method of generating the coefficients is of course far from optimal
248 for production purposes.
249
250 In order to show some more examples of what GiNaC can do we will now use
251 the @command{ginsh}, a simple GiNaC interactive shell that provides a
252 convenient window into GiNaC's capabilities.
253
254
255 @node What it can do for you, Installation, How to use it from within C++, A Tour of GiNaC
256 @c    node-name, next, previous, up
257 @section What it can do for you
258
259 @cindex @command{ginsh}
260 After invoking @command{ginsh} one can test and experiment with GiNaC's
261 features much like in other Computer Algebra Systems except that it does
262 not provide programming constructs like loops or conditionals.  For a
263 concise description of the @command{ginsh} syntax we refer to its
264 accompanied man page. Suffice to say that assignments and comparisons in
265 @command{ginsh} are written as they are in C, i.e. @code{=} assigns and
266 @code{==} compares.
267
268 It can manipulate arbitrary precision integers in a very fast way.
269 Rational numbers are automatically converted to fractions of coprime
270 integers:
271
272 @example
273 > x=3^150;
274 369988485035126972924700782451696644186473100389722973815184405301748249
275 > y=3^149;
276 123329495011708990974900260817232214728824366796574324605061468433916083
277 > x/y;
278 3
279 > y/x;
280 1/3
281 @end example
282
283 Exact numbers are always retained as exact numbers and only evaluated as
284 floating point numbers if requested.  For instance, with numeric
285 radicals is dealt pretty much as with symbols.  Products of sums of them
286 can be expanded:
287
288 @example
289 > expand((1+a^(1/5)-a^(2/5))^3);
290 1+3*a+3*a^(1/5)-5*a^(3/5)-a^(6/5)
291 > expand((1+3^(1/5)-3^(2/5))^3);
292 10-5*3^(3/5)
293 > evalf((1+3^(1/5)-3^(2/5))^3);
294 0.33408977534118624228
295 @end example
296
297 The function @code{evalf} that was used above converts any number in
298 GiNaC's expressions into floating point numbers.  This can be done to
299 arbitrary predefined accuracy:
300
301 @example
302 > evalf(1/7);
303 0.14285714285714285714
304 > Digits=150;
305 150
306 > evalf(1/7);
307 0.1428571428571428571428571428571428571428571428571428571428571428571428
308 5714285714285714285714285714285714285
309 @end example
310
311 Exact numbers other than rationals that can be manipulated in GiNaC
312 include predefined constants like Archimedes' @code{Pi}.  They can both
313 be used in symbolic manipulations (as an exact number) as well as in
314 numeric expressions (as an inexact number):
315
316 @example
317 > a=Pi^2+x;
318 x+Pi^2
319 > evalf(a);
320 9.869604401089358619+x
321 > x=2;
322 2
323 > evalf(a);
324 11.869604401089358619
325 @end example
326
327 Built-in functions evaluate immediately to exact numbers if
328 this is possible.  Conversions that can be safely performed are done
329 immediately; conversions that are not generally valid are not done:
330
331 @example
332 > cos(42*Pi);
333 1
334 > cos(acos(x));
335 x
336 > acos(cos(x));
337 acos(cos(x))
338 @end example
339
340 (Note that converting the last input to @code{x} would allow one to
341 conclude that @code{42*Pi} is equal to @code{0}.)
342
343 Linear equation systems can be solved along with basic linear
344 algebra manipulations over symbolic expressions.  In C++ GiNaC offers
345 a matrix class for this purpose but we can see what it can do using
346 @command{ginsh}'s notation of double brackets to type them in:
347
348 @example
349 > lsolve(a+x*y==z,x);
350 y^(-1)*(z-a);
351 > lsolve([3*x+5*y == 7, -2*x+10*y == -5], [x, y]);
352 [x==19/8,y==-1/40]
353 > M = [[ [[1, 3]], [[-3, 2]] ]];
354 [[ [[1,3]], [[-3,2]] ]]
355 > determinant(M);
356 11
357 > charpoly(M,lambda);
358 lambda^2-3*lambda+11
359 @end example
360
361 Multivariate polynomials and rational functions may be expanded,
362 collected and normalized (i.e. converted to a ratio of two coprime 
363 polynomials):
364
365 @example
366 > a = x^4 + 2*x^2*y^2 + 4*x^3*y + 12*x*y^3 - 3*y^4;
367 -3*y^4+x^4+12*x*y^3+2*x^2*y^2+4*x^3*y
368 > b = x^2 + 4*x*y - y^2;
369 -y^2+x^2+4*x*y
370 > expand(a*b);
371 3*y^6+x^6-24*x*y^5+43*x^2*y^4+16*x^3*y^3+17*x^4*y^2+8*x^5*y
372 > collect(a*b,x);
373 3*y^6+48*x*y^4+2*x^2*y^2+x^4*(-y^2+x^2+4*x*y)+4*x^3*y*(-y^2+x^2+4*x*y)
374 > normal(a/b);
375 3*y^2+x^2
376 @end example
377
378 You can differentiate functions and expand them as Taylor or Laurent
379 series in a very natural syntax (the second argument of @code{series} is
380 a relation defining the evaluation point, the third specifies the
381 order):
382
383 @cindex Zeta function
384 @example
385 > diff(tan(x),x);
386 tan(x)^2+1
387 > series(sin(x),x==0,4);
388 x-1/6*x^3+Order(x^4)
389 > series(1/tan(x),x==0,4);
390 x^(-1)-1/3*x+Order(x^2)
391 > series(tgamma(x),x==0,3);
392 x^(-1)-Euler+(1/12*Pi^2+1/2*Euler^2)*x+
393 (-1/3*zeta(3)-1/12*Pi^2*Euler-1/6*Euler^3)*x^2+Order(x^3)
394 > evalf(");
395 x^(-1)-0.5772156649015328606+(0.9890559953279725555)*x
396 -(0.90747907608088628905)*x^2+Order(x^3)
397 > series(tgamma(2*sin(x)-2),x==Pi/2,6);
398 -(x-1/2*Pi)^(-2)+(-1/12*Pi^2-1/2*Euler^2-1/240)*(x-1/2*Pi)^2
399 -Euler-1/12+Order((x-1/2*Pi)^3)
400 @end example
401
402 Here we have made use of the @command{ginsh}-command @code{"} to pop the
403 previously evaluated element from @command{ginsh}'s internal stack.
404
405 If you ever wanted to convert units in C or C++ and found this is
406 cumbersome, here is the solution.  Symbolic types can always be used as
407 tags for different types of objects.  Converting from wrong units to the
408 metric system is now easy:
409
410 @example
411 > in=.0254*m;
412 0.0254*m
413 > lb=.45359237*kg;
414 0.45359237*kg
415 > 200*lb/in^2;
416 140613.91592783185568*kg*m^(-2)
417 @end example
418
419
420 @node Installation, Prerequisites, What it can do for you, Top
421 @c    node-name, next, previous, up
422 @chapter Installation
423
424 @cindex CLN
425 GiNaC's installation follows the spirit of most GNU software. It is
426 easily installed on your system by three steps: configuration, build,
427 installation.
428
429 @menu
430 * Prerequisites::                Packages upon which GiNaC depends.
431 * Configuration::                How to configure GiNaC.
432 * Building GiNaC::               How to compile GiNaC.
433 * Installing GiNaC::             How to install GiNaC on your system.
434 @end menu
435
436
437 @node Prerequisites, Configuration, Installation, Installation
438 @c    node-name, next, previous, up
439 @section Prerequisites
440
441 In order to install GiNaC on your system, some prerequisites need to be
442 met.  First of all, you need to have a C++-compiler adhering to the
443 ANSI-standard @cite{ISO/IEC 14882:1998(E)}.  We used @acronym{GCC} for
444 development so if you have a different compiler you are on your own.
445 For the configuration to succeed you need a Posix compliant shell
446 installed in @file{/bin/sh}, GNU @command{bash} is fine.  Perl is needed
447 by the built process as well, since some of the source files are
448 automatically generated by Perl scripts.  Last but not least, Bruno
449 Haible's library @acronym{CLN} is extensively used and needs to be
450 installed on your system.  Please get it either from
451 @uref{ftp://ftp.santafe.edu/pub/gnu/}, from
452 @uref{ftp://ftpthep.physik.uni-mainz.de/pub/gnu/, GiNaC's FTP site} or
453 from @uref{ftp://ftp.ilog.fr/pub/Users/haible/gnu/, Bruno Haible's FTP
454 site} (it is covered by GPL) and install it prior to trying to install
455 GiNaC.  The configure script checks if it can find it and if it cannot
456 it will refuse to continue.
457
458
459 @node Configuration, Building GiNaC, Prerequisites, Installation
460 @c    node-name, next, previous, up
461 @section Configuration
462 @cindex configuration
463 @cindex Autoconf
464
465 To configure GiNaC means to prepare the source distribution for
466 building.  It is done via a shell script called @command{configure} that
467 is shipped with the sources and was originally generated by GNU
468 Autoconf.  Since a configure script generated by GNU Autoconf never
469 prompts, all customization must be done either via command line
470 parameters or environment variables.  It accepts a list of parameters,
471 the complete set of which can be listed by calling it with the
472 @option{--help} option.  The most important ones will be shortly
473 described in what follows:
474
475 @itemize @bullet
476
477 @item
478 @option{--disable-shared}: When given, this option switches off the
479 build of a shared library, i.e. a @file{.so} file.  This may be convenient
480 when developing because it considerably speeds up compilation.
481
482 @item
483 @option{--prefix=@var{PREFIX}}: The directory where the compiled library
484 and headers are installed. It defaults to @file{/usr/local} which means
485 that the library is installed in the directory @file{/usr/local/lib},
486 the header files in @file{/usr/local/include/ginac} and the documentation
487 (like this one) into @file{/usr/local/share/doc/GiNaC}.
488
489 @item
490 @option{--libdir=@var{LIBDIR}}: Use this option in case you want to have
491 the library installed in some other directory than
492 @file{@var{PREFIX}/lib/}.
493
494 @item
495 @option{--includedir=@var{INCLUDEDIR}}: Use this option in case you want
496 to have the header files installed in some other directory than
497 @file{@var{PREFIX}/include/ginac/}. For instance, if you specify
498 @option{--includedir=/usr/include} you will end up with the header files
499 sitting in the directory @file{/usr/include/ginac/}. Note that the
500 subdirectory @file{ginac} is enforced by this process in order to
501 keep the header files separated from others.  This avoids some
502 clashes and allows for an easier deinstallation of GiNaC. This ought
503 to be considered A Good Thing (tm).
504
505 @item
506 @option{--datadir=@var{DATADIR}}: This option may be given in case you
507 want to have the documentation installed in some other directory than
508 @file{@var{PREFIX}/share/doc/GiNaC/}.
509
510 @end itemize
511
512 In addition, you may specify some environment variables.
513 @env{CXX} holds the path and the name of the C++ compiler
514 in case you want to override the default in your path.  (The
515 @command{configure} script searches your path for @command{c++},
516 @command{g++}, @command{gcc}, @command{CC}, @command{cxx}
517 and @command{cc++} in that order.)  It may be very useful to
518 define some compiler flags with the @env{CXXFLAGS} environment
519 variable, like optimization, debugging information and warning
520 levels.  If omitted, it defaults to @option{-g -O2}.
521
522 The whole process is illustrated in the following two
523 examples. (Substitute @command{setenv @var{VARIABLE} @var{value}} for
524 @command{export @var{VARIABLE}=@var{value}} if the Berkeley C shell is
525 your login shell.)
526
527 Here is a simple configuration for a site-wide GiNaC library assuming
528 everything is in default paths:
529
530 @example
531 $ export CXXFLAGS="-Wall -O2"
532 $ ./configure
533 @end example
534
535 And here is a configuration for a private static GiNaC library with
536 several components sitting in custom places (site-wide @acronym{GCC} and
537 private @acronym{CLN}).  The compiler is pursuaded to be picky and full
538 assertions and debugging information are switched on:
539
540 @example
541 $ export CXX=/usr/local/gnu/bin/c++
542 $ export CPPFLAGS="$(CPPFLAGS) -I$(HOME)/include"
543 $ export CXXFLAGS="$(CXXFLAGS) -DDO_GINAC_ASSERT -ggdb -Wall -ansi -pedantic"
544 $ export LDFLAGS="$(LDFLAGS) -L$(HOME)/lib"
545 $ ./configure --disable-shared --prefix=$(HOME)
546 @end example
547
548
549 @node Building GiNaC, Installing GiNaC, Configuration, Installation
550 @c    node-name, next, previous, up
551 @section Building GiNaC
552 @cindex building GiNaC
553
554 After proper configuration you should just build the whole
555 library by typing
556 @example
557 $ make
558 @end example
559 at the command prompt and go for a cup of coffee.  The exact time it
560 takes to compile GiNaC depends not only on the speed of your machines
561 but also on other parameters, for instance what value for @env{CXXFLAGS}
562 you entered.  Optimization may be very time-consuming.
563
564 Just to make sure GiNaC works properly you may run a collection of
565 regression tests by typing
566
567 @example
568 $ make check
569 @end example
570
571 This will compile some sample programs, run them and check the output
572 for correctness.  The regression tests fall in three categories.  First,
573 the so called @emph{exams} are performed, simple tests where some
574 predefined input is evaluated (like a pupils' exam).  Second, the
575 @emph{checks} test the coherence of results among each other with
576 possible random input.  Third, some @emph{timings} are performed, which
577 benchmark some predefined problems with different sizes and display the
578 CPU time used in seconds.  Each individual test should return a message
579 @samp{passed}.  This is mostly intended to be a QA-check if something
580 was broken during development, not a sanity check of your system.  Some
581 of the tests in sections @emph{checks} and @emph{timings} may require
582 insane amounts of memory and CPU time.  Feel free to kill them if your
583 machine catches fire.  Another quite important intent is to allow people
584 to fiddle around with optimization.
585
586 Generally, the top-level Makefile runs recursively to the
587 subdirectories.  It is therfore safe to go into any subdirectory
588 (@code{doc/}, @code{ginsh/}, ...) and simply type @code{make}
589 @var{target} there in case something went wrong.
590
591
592 @node Installing GiNaC, Basic Concepts, Building GiNaC, Installation
593 @c    node-name, next, previous, up
594 @section Installing GiNaC
595 @cindex installation
596
597 To install GiNaC on your system, simply type
598
599 @example
600 $ make install
601 @end example
602
603 As described in the section about configuration the files will be
604 installed in the following directories (the directories will be created
605 if they don't already exist):
606
607 @itemize @bullet
608
609 @item
610 @file{libginac.a} will go into @file{@var{PREFIX}/lib/} (or
611 @file{@var{LIBDIR}}) which defaults to @file{/usr/local/lib/}.
612 So will @file{libginac.so} unless the configure script was
613 given the option @option{--disable-shared}.  The proper symlinks
614 will be established as well.
615
616 @item
617 All the header files will be installed into @file{@var{PREFIX}/include/ginac/}
618 (or @file{@var{INCLUDEDIR}/ginac/}, if specified).
619
620 @item
621 All documentation (HTML and Postscript) will be stuffed into
622 @file{@var{PREFIX}/share/doc/GiNaC/} (or
623 @file{@var{DATADIR}/doc/GiNaC/}, if @var{DATADIR} was specified).
624
625 @end itemize
626
627 For the sake of completeness we will list some other useful make
628 targets: @command{make clean} deletes all files generated by
629 @command{make}, i.e. all the object files.  In addition @command{make
630 distclean} removes all files generated by the configuration and
631 @command{make maintainer-clean} goes one step further and deletes files
632 that may require special tools to rebuild (like the @command{libtool}
633 for instance).  Finally @command{make uninstall} removes the installed
634 library, header files and documentation@footnote{Uninstallation does not
635 work after you have called @command{make distclean} since the
636 @file{Makefile} is itself generated by the configuration from
637 @file{Makefile.in} and hence deleted by @command{make distclean}.  There
638 are two obvious ways out of this dilemma.  First, you can run the
639 configuration again with the same @var{PREFIX} thus creating a
640 @file{Makefile} with a working @samp{uninstall} target.  Second, you can
641 do it by hand since you now know where all the files went during
642 installation.}.
643
644
645 @node Basic Concepts, Expressions, Installing GiNaC, Top
646 @c    node-name, next, previous, up
647 @chapter Basic Concepts
648
649 This chapter will describe the different fundamental objects that can be
650 handled by GiNaC.  But before doing so, it is worthwhile introducing you
651 to the more commonly used class of expressions, representing a flexible
652 meta-class for storing all mathematical objects.
653
654 @menu
655 * Expressions::                  The fundamental GiNaC class.
656 * The Class Hierarchy::          Overview of GiNaC's classes.
657 * Symbols::                      Symbolic objects.
658 * Numbers::                      Numerical objects.
659 * Constants::                    Pre-defined constants.
660 * Fundamental containers::       The power, add and mul classes.
661 * Lists::                        Lists of expressions.
662 * Mathematical functions::       Mathematical functions.
663 * Relations::                    Equality, Inequality and all that.
664 @end menu
665
666
667 @node Expressions, The Class Hierarchy, Basic Concepts, Basic Concepts
668 @c    node-name, next, previous, up
669 @section Expressions
670 @cindex expression (class @code{ex})
671 @cindex @code{has()}
672
673 The most common class of objects a user deals with is the expression
674 @code{ex}, representing a mathematical object like a variable, number,
675 function, sum, product, etc...  Expressions may be put together to form
676 new expressions, passed as arguments to functions, and so on.  Here is a
677 little collection of valid expressions:
678
679 @example
680 ex MyEx1 = 5;                       // simple number
681 ex MyEx2 = x + 2*y;                 // polynomial in x and y
682 ex MyEx3 = (x + 1)/(x - 1);         // rational expression
683 ex MyEx4 = sin(x + 2*y) + 3*z + 41; // containing a function
684 ex MyEx5 = MyEx4 + 1;               // similar to above
685 @end example
686
687 Expressions are handles to other more fundamental objects, that often
688 contain other expressions thus creating a tree of expressions
689 (@xref{Internal Structures}, for particular examples).  Most methods on
690 @code{ex} therefore run top-down through such an expression tree.  For
691 example, the method @code{has()} scans recursively for occurrences of
692 something inside an expression.  Thus, if you have declared @code{MyEx4}
693 as in the example above @code{MyEx4.has(y)} will find @code{y} inside
694 the argument of @code{sin} and hence return @code{true}.
695
696 The next sections will outline the general picture of GiNaC's class
697 hierarchy and describe the classes of objects that are handled by
698 @code{ex}.
699
700
701 @node The Class Hierarchy, Symbols, Expressions, Basic Concepts
702 @c    node-name, next, previous, up
703 @section The Class Hierarchy
704
705 GiNaC's class hierarchy consists of several classes representing
706 mathematical objects, all of which (except for @code{ex} and some
707 helpers) are internally derived from one abstract base class called
708 @code{basic}.  You do not have to deal with objects of class
709 @code{basic}, instead you'll be dealing with symbols, numbers,
710 containers of expressions and so on.
711
712 @cindex container
713 @cindex atom
714 To get an idea about what kinds of symbolic composits may be built we
715 have a look at the most important classes in the class hierarchy and
716 some of the relations among the classes:
717
718 @image{classhierarchy}
719
720 The abstract classes shown here (the ones without drop-shadow) are of no
721 interest for the user.  They are used internally in order to avoid code
722 duplication if two or more classes derived from them share certain
723 features.  An example is @code{expairseq}, a container for a sequence of
724 pairs each consisting of one expression and a number (@code{numeric}).
725 What @emph{is} visible to the user are the derived classes @code{add}
726 and @code{mul}, representing sums and products.  @xref{Internal
727 Structures}, where these two classes are described in more detail.  The
728 following table shortly summarizes what kinds of mathematical objects
729 are stored in the different classes:
730
731 @cartouche
732 @multitable @columnfractions .22 .78
733 @item @code{symbol} @tab Algebraic symbols @math{a}, @math{x}, @math{y}@dots{}
734 @item @code{constant} @tab Constants like 
735 @tex
736 $\pi$
737 @end tex
738 @ifnottex
739 @math{Pi}
740 @end ifnottex
741 @item @code{numeric} @tab All kinds of numbers, @math{42}, @math{7/3*I}, @math{3.14159}@dots{}
742 @item @code{add} @tab Sums like @math{x+y} or @math{a-(2*b)+3}
743 @item @code{mul} @tab Products like @math{x*y} or @math{2*a^2*(x+y+z)/b}
744 @item @code{power} @tab Exponentials such as @math{x^2}, @math{a^b}, 
745 @tex
746 $\sqrt{2}$
747 @end tex
748 @ifnottex
749 @code{sqrt(}@math{2}@code{)}
750 @end ifnottex
751 @dots{}
752 @item @code{pseries} @tab Power Series, e.g. @math{x-1/6*x^3+1/120*x^5+O(x^7)}
753 @item @code{function} @tab A symbolic function like @math{sin(2*x)}
754 @item @code{lst} @tab Lists of expressions [@math{x}, @math{2*y}, @math{3+z}]
755 @item @code{matrix} @tab @math{n}x@math{m} matrices of expressions
756 @item @code{relational} @tab A relation like the identity @math{x}@code{==}@math{y}
757 @item @code{color}, @code{coloridx} @tab Element and index of the @math{SU(3)} Lie-algebra
758 @item @code{isospin} @tab Element of the @math{SU(2)} Lie-algebra
759 @item @code{idx} @tab Index of a general tensor object
760 @end multitable
761 @end cartouche
762
763 @node Symbols, Numbers, The Class Hierarchy, Basic Concepts
764 @c    node-name, next, previous, up
765 @section Symbols
766 @cindex @code{symbol} (class)
767 @cindex hierarchy of classes
768
769 @cindex atom
770 Symbols are for symbolic manipulation what atoms are for chemistry.  You
771 can declare objects of class @code{symbol} as any other object simply by
772 saying @code{symbol x,y;}.  There is, however, a catch in here having to
773 do with the fact that C++ is a compiled language.  The information about
774 the symbol's name is thrown away by the compiler but at a later stage
775 you may want to print expressions holding your symbols.  In order to
776 avoid confusion GiNaC's symbols are able to know their own name.  This
777 is accomplished by declaring its name for output at construction time in
778 the fashion @code{symbol x("x");}.  If you declare a symbol using the
779 default constructor (i.e. without string argument) the system will deal
780 out a unique name.  That name may not be suitable for printing but for
781 internal routines when no output is desired it is often enough.  We'll
782 come across examples of such symbols later in this tutorial.
783
784 This implies that the strings passed to symbols at construction time may
785 not be used for comparing two of them.  It is perfectly legitimate to
786 write @code{symbol x("x"),y("x");} but it is likely to lead into
787 trouble.  Here, @code{x} and @code{y} are different symbols and
788 statements like @code{x-y} will not be simplified to zero although the
789 output @code{x-x} looks funny.  Such output may also occur when there
790 are two different symbols in two scopes, for instance when you call a
791 function that declares a symbol with a name already existent in a symbol
792 in the calling function.  Again, comparing them (using @code{operator==}
793 for instance) will always reveal their difference.  Watch out, please.
794
795 @cindex @code{subs()}
796 Although symbols can be assigned expressions for internal reasons, you
797 should not do it (and we are not going to tell you how it is done).  If
798 you want to replace a symbol with something else in an expression, you
799 can use the expression's @code{.subs()} method (@xref{Substituting Symbols},
800 for more information).
801
802
803 @node Numbers, Constants, Symbols, Basic Concepts
804 @c    node-name, next, previous, up
805 @section Numbers
806 @cindex @code{numeric} (class)
807
808 @cindex GMP
809 @cindex CLN
810 @cindex rational
811 @cindex fraction
812 For storing numerical things, GiNaC uses Bruno Haible's library
813 @acronym{CLN}.  The classes therein serve as foundation classes for
814 GiNaC.  @acronym{CLN} stands for Class Library for Numbers or
815 alternatively for Common Lisp Numbers.  In order to find out more about
816 @acronym{CLN}'s internals the reader is refered to the documentation of
817 that library.  @inforef{Introduction, , cln}, for more
818 information. Suffice to say that it is by itself build on top of another
819 library, the GNU Multiple Precision library @acronym{GMP}, which is an
820 extremely fast library for arbitrary long integers and rationals as well
821 as arbitrary precision floating point numbers.  It is very commonly used
822 by several popular cryptographic applications.  @acronym{CLN} extends
823 @acronym{GMP} by several useful things: First, it introduces the complex
824 number field over either reals (i.e. floating point numbers with
825 arbitrary precision) or rationals.  Second, it automatically converts
826 rationals to integers if the denominator is unity and complex numbers to
827 real numbers if the imaginary part vanishes and also correctly treats
828 algebraic functions.  Third it provides good implementations of
829 state-of-the-art algorithms for all trigonometric and hyperbolic
830 functions as well as for calculation of some useful constants.
831
832 The user can construct an object of class @code{numeric} in several
833 ways.  The following example shows the four most important constructors.
834 It uses construction from C-integer, construction of fractions from two
835 integers, construction from C-float and construction from a string:
836
837 @example
838 #include <ginac/ginac.h>
839 using namespace GiNaC;
840
841 int main()
842 @{
843     numeric two(2);                       // exact integer 2
844     numeric r(2,3);                       // exact fraction 2/3
845     numeric e(2.71828);                   // floating point number
846     numeric p("3.1415926535897932385");   // floating point number
847     // Trott's constant in scientific notation:
848     numeric trott("1.0841015122311136151E-2");
849     
850     cout << two*p << endl;  // floating point 6.283...
851 @}
852 @end example
853
854 Note that all those constructors are @emph{explicit} which means you are
855 not allowed to write @code{numeric two=2;}.  This is because the basic
856 objects to be handled by GiNaC are the expressions @code{ex} and we want
857 to keep things simple and wish objects like @code{pow(x,2)} to be
858 handled the same way as @code{pow(x,a)}, which means that we need to
859 allow a general @code{ex} as base and exponent.  Therefore there is an
860 implicit constructor from C-integers directly to expressions handling
861 numerics at work in most of our examples.  This design really becomes
862 convenient when one declares own functions having more than one
863 parameter but it forbids using implicit constructors because that would
864 lead to compile-time ambiguities.
865
866 It may be tempting to construct numbers writing @code{numeric r(3/2)}.
867 This would, however, call C's built-in operator @code{/} for integers
868 first and result in a numeric holding a plain integer 1.  @strong{Never
869 use the operator @code{/} on integers} unless you know exactly what you
870 are doing!  Use the constructor from two integers instead, as shown in
871 the example above.  Writing @code{numeric(1)/2} may look funny but works
872 also.
873
874 @cindex @code{Digits}
875 @cindex accuracy
876 We have seen now the distinction between exact numbers and floating
877 point numbers.  Clearly, the user should never have to worry about
878 dynamically created exact numbers, since their `exactness' always
879 determines how they ought to be handled, i.e. how `long' they are.  The
880 situation is different for floating point numbers.  Their accuracy is
881 controlled by one @emph{global} variable, called @code{Digits}.  (For
882 those readers who know about Maple: it behaves very much like Maple's
883 @code{Digits}).  All objects of class numeric that are constructed from
884 then on will be stored with a precision matching that number of decimal
885 digits:
886
887 @example
888 #include <ginac/ginac.h>
889 using namespace GiNaC;
890
891 void foo()
892 @{
893     numeric three(3.0), one(1.0);
894     numeric x = one/three;
895
896     cout << "in " << Digits << " digits:" << endl;
897     cout << x << endl;
898     cout << Pi.evalf() << endl;
899 @}
900
901 int main()
902 @{
903     foo();
904     Digits = 60;
905     foo();
906     return 0;
907 @}
908 @end example
909
910 The above example prints the following output to screen:
911
912 @example
913 in 17 digits:
914 0.333333333333333333
915 3.14159265358979324
916 in 60 digits:
917 0.333333333333333333333333333333333333333333333333333333333333333333
918 3.14159265358979323846264338327950288419716939937510582097494459231
919 @end example
920
921 It should be clear that objects of class @code{numeric} should be used
922 for constructing numbers or for doing arithmetic with them.  The objects
923 one deals with most of the time are the polymorphic expressions @code{ex}.
924
925 @subsection Tests on numbers
926
927 Once you have declared some numbers, assigned them to expressions and
928 done some arithmetic with them it is frequently desired to retrieve some
929 kind of information from them like asking whether that number is
930 integer, rational, real or complex.  For those cases GiNaC provides
931 several useful methods.  (Internally, they fall back to invocations of
932 certain CLN functions.)
933
934 As an example, let's construct some rational number, multiply it with
935 some multiple of its denominator and test what comes out:
936
937 @example
938 #include <ginac/ginac.h>
939 using namespace GiNaC;
940
941 // some very important constants:
942 const numeric twentyone(21);
943 const numeric ten(10);
944 const numeric five(5);
945
946 int main()
947 @{
948     numeric answer = twentyone;
949
950     answer /= five;
951     cout << answer.is_integer() << endl;  // false, it's 21/5
952     answer *= ten;
953     cout << answer.is_integer() << endl;  // true, it's 42 now!
954 @}
955 @end example
956
957 Note that the variable @code{answer} is constructed here as an integer
958 by @code{numeric}'s copy constructor but in an intermediate step it
959 holds a rational number represented as integer numerator and integer
960 denominator.  When multiplied by 10, the denominator becomes unity and
961 the result is automatically converted to a pure integer again.
962 Internally, the underlying @acronym{CLN} is responsible for this
963 behaviour and we refer the reader to @acronym{CLN}'s documentation.
964 Suffice to say that the same behaviour applies to complex numbers as
965 well as return values of certain functions.  Complex numbers are
966 automatically converted to real numbers if the imaginary part becomes
967 zero.  The full set of tests that can be applied is listed in the
968 following table.
969
970 @cartouche
971 @multitable @columnfractions .30 .70
972 @item @strong{Method} @tab @strong{Returns true if the object is@dots{}}
973 @item @code{.is_zero()}
974 @tab @dots{}equal to zero
975 @item @code{.is_positive()}
976 @tab @dots{}not complex and greater than 0
977 @item @code{.is_integer()}
978 @tab @dots{}a (non-complex) integer
979 @item @code{.is_pos_integer()}
980 @tab @dots{}an integer and greater than 0
981 @item @code{.is_nonneg_integer()}
982 @tab @dots{}an integer and greater equal 0
983 @item @code{.is_even()}
984 @tab @dots{}an even integer
985 @item @code{.is_odd()}
986 @tab @dots{}an odd integer
987 @item @code{.is_prime()}
988 @tab @dots{}a prime integer (probabilistic primality test)
989 @item @code{.is_rational()}
990 @tab @dots{}an exact rational number (integers are rational, too)
991 @item @code{.is_real()}
992 @tab @dots{}a real integer, rational or float (i.e. is not complex)
993 @item @code{.is_cinteger()}
994 @tab @dots{}a (complex) integer (such as @math{2-3*I})
995 @item @code{.is_crational()}
996 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
997 @end multitable
998 @end cartouche
999
1000
1001 @node Constants, Fundamental containers, Numbers, Basic Concepts
1002 @c    node-name, next, previous, up
1003 @section Constants
1004 @cindex @code{constant} (class)
1005
1006 @cindex @code{Pi}
1007 @cindex @code{Catalan}
1008 @cindex @code{Euler}
1009 @cindex @code{evalf()}
1010 Constants behave pretty much like symbols except that they return some
1011 specific number when the method @code{.evalf()} is called.
1012
1013 The predefined known constants are:
1014
1015 @cartouche
1016 @multitable @columnfractions .14 .30 .56
1017 @item @strong{Name} @tab @strong{Common Name} @tab @strong{Numerical Value (to 35 digits)}
1018 @item @code{Pi}
1019 @tab Archimedes' constant
1020 @tab 3.14159265358979323846264338327950288
1021 @item @code{Catalan}
1022 @tab Catalan's constant
1023 @tab 0.91596559417721901505460351493238411
1024 @item @code{Euler}
1025 @tab Euler's (or Euler-Mascheroni) constant
1026 @tab 0.57721566490153286060651209008240243
1027 @end multitable
1028 @end cartouche
1029
1030
1031 @node Fundamental containers, Lists, Constants, Basic Concepts
1032 @c    node-name, next, previous, up
1033 @section Fundamental containers: the @code{power}, @code{add} and @code{mul} classes
1034 @cindex polynomial
1035 @cindex @code{add}
1036 @cindex @code{mul}
1037 @cindex @code{power}
1038
1039 Simple polynomial expressions are written down in GiNaC pretty much like
1040 in other CAS or like expressions involving numerical variables in C.
1041 The necessary operators @code{+}, @code{-}, @code{*} and @code{/} have
1042 been overloaded to achieve this goal.  When you run the following
1043 program, the constructor for an object of type @code{mul} is
1044 automatically called to hold the product of @code{a} and @code{b} and
1045 then the constructor for an object of type @code{add} is called to hold
1046 the sum of that @code{mul} object and the number one:
1047
1048 @example
1049 #include <ginac/ginac.h>
1050 using namespace GiNaC;
1051
1052 int main()
1053 @{
1054     symbol a("a"), b("b");
1055     ex MyTerm = 1+a*b;
1056     // ...
1057 @}
1058 @end example
1059
1060 @cindex @code{pow()}
1061 For exponentiation, you have already seen the somewhat clumsy (though C-ish)
1062 statement @code{pow(x,2);} to represent @code{x} squared.  This direct
1063 construction is necessary since we cannot safely overload the constructor
1064 @code{^} in C++ to construct a @code{power} object.  If we did, it would
1065 have several counterintuitive effects:
1066
1067 @itemize @bullet
1068 @item
1069 Due to C's operator precedence, @code{2*x^2} would be parsed as @code{(2*x)^2}.
1070 @item
1071 Due to the binding of the operator @code{^}, @code{x^a^b} would result in
1072 @code{(x^a)^b}. This would be confusing since most (though not all) other CAS
1073 interpret this as @code{x^(a^b)}.
1074 @item
1075 Also, expressions involving integer exponents are very frequently used,
1076 which makes it even more dangerous to overload @code{^} since it is then
1077 hard to distinguish between the semantics as exponentiation and the one
1078 for exclusive or.  (It would be embarassing to return @code{1} where one
1079 has requested @code{2^3}.)
1080 @end itemize
1081
1082 @cindex @command{ginsh}
1083 All effects are contrary to mathematical notation and differ from the
1084 way most other CAS handle exponentiation, therefore overloading @code{^}
1085 is ruled out for GiNaC's C++ part.  The situation is different in
1086 @command{ginsh}, there the exponentiation-@code{^} exists.  (Also note
1087 that the other frequently used exponentiation operator @code{**} does
1088 not exist at all in C++).
1089
1090 To be somewhat more precise, objects of the three classes described
1091 here, are all containers for other expressions.  An object of class
1092 @code{power} is best viewed as a container with two slots, one for the
1093 basis, one for the exponent.  All valid GiNaC expressions can be
1094 inserted.  However, basic transformations like simplifying
1095 @code{pow(pow(x,2),3)} to @code{x^6} automatically are only performed
1096 when this is mathematically possible.  If we replace the outer exponent
1097 three in the example by some symbols @code{a}, the simplification is not
1098 safe and will not be performed, since @code{a} might be @code{1/2} and
1099 @code{x} negative.
1100
1101 Objects of type @code{add} and @code{mul} are containers with an
1102 arbitrary number of slots for expressions to be inserted.  Again, simple
1103 and safe simplifications are carried out like transforming
1104 @code{3*x+4-x} to @code{2*x+4}.
1105
1106 The general rule is that when you construct such objects, GiNaC
1107 automatically creates them in canonical form, which might differ from
1108 the form you typed in your program.  This allows for rapid comparison of
1109 expressions, since after all @code{a-a} is simply zero.  Note, that the
1110 canonical form is not necessarily lexicographical ordering or in any way
1111 easily guessable.  It is only guaranteed that constructing the same
1112 expression twice, either implicitly or explicitly, results in the same
1113 canonical form.
1114
1115
1116 @node Lists, Mathematical functions, Fundamental containers, Basic Concepts
1117 @c    node-name, next, previous, up
1118 @section Lists of expressions
1119 @cindex @code{lst} (class)
1120 @cindex lists
1121 @cindex @code{nops()}
1122 @cindex @code{op()}
1123 @cindex @code{append()}
1124 @cindex @code{prepend()}
1125
1126 The GiNaC class @code{lst} serves for holding a list of arbitrary expressions.
1127 These are sometimes used to supply a variable number of arguments of the same
1128 type to GiNaC methods such as @code{subs()} and @code{to_rational()}, so you
1129 should have a basic understanding about them.
1130
1131 Lists of up to 15 expressions can be directly constructed from single
1132 expressions:
1133
1134 @example
1135 @{
1136     symbol x("x"), y("y");
1137     lst l(x, 2, y, x+y);
1138     // now, l is a list holding the expressions 'x', '2', 'y', and 'x+y'
1139     // ...
1140 @end example
1141
1142 Use the @code{nops()} method to determine the size (number of expressions) of
1143 a list and the @code{op()} method to access individual elements:
1144
1145 @example
1146     // ...
1147     cout << l.nops() << endl;                   // prints '4'
1148     cout << l.op(2) << " " << l.op(0) << endl;  // prints 'y x'
1149     // ...
1150 @end example
1151
1152 Finally you can append or prepend an expression to a list with the
1153 @code{append()} and @code{prepend()} methods:
1154
1155 @example
1156     // ...
1157     l.append(4*x);   // l is now [x, 2, y, x+y, 4*x]
1158     l.prepend(0);    // l is now [0, x, 2, y, x+y, 4*x]
1159 @}
1160 @end example
1161
1162
1163 @node Mathematical functions, Relations, Lists, Basic Concepts
1164 @c    node-name, next, previous, up
1165 @section Mathematical functions
1166 @cindex @code{function} (class)
1167 @cindex trigonometric function
1168 @cindex hyperbolic function
1169
1170 There are quite a number of useful functions hard-wired into GiNaC.  For
1171 instance, all trigonometric and hyperbolic functions are implemented
1172 (@xref{Built-in Functions}, for a complete list).
1173
1174 These functions are all objects of class @code{function}.  They accept one
1175 or more expressions as arguments and return one expression.  If the arguments
1176 are not numerical, the evaluation of the function may be halted, as it
1177 does in the next example:
1178
1179 @cindex Gamma function
1180 @cindex @code{subs()}
1181 @example
1182 #include <ginac/ginac.h>
1183 using namespace GiNaC;
1184
1185 int main()
1186 @{
1187     symbol x("x"), y("y");
1188     
1189     ex foo = x+y/2;
1190     cout << "tgamma(" << foo << ") -> " << tgamma(foo) << endl;
1191     ex bar = foo.subs(y==1);
1192     cout << "tgamma(" << bar << ") -> " << tgamma(bar) << endl;
1193     ex foobar = bar.subs(x==7);
1194     cout << "tgamma(" << foobar << ") -> " << tgamma(foobar) << endl;
1195 @}
1196 @end example
1197
1198 This program shows how the function returns itself twice and finally an
1199 expression that may be really useful:
1200
1201 @example
1202 tgamma(x+(1/2)*y) -> tgamma(x+(1/2)*y)
1203 tgamma(x+1/2) -> tgamma(x+1/2)
1204 tgamma(15/2) -> (135135/128)*Pi^(1/2)
1205 @end example
1206
1207 Besides evaluation most of these functions allow differentiation, series
1208 expansion and so on.  Read the next chapter in order to learn more about
1209 this.
1210
1211
1212 @node Relations, Methods and Functions, Mathematical functions, Basic Concepts
1213 @c    node-name, next, previous, up
1214 @section Relations
1215 @cindex @code{relational} (class)
1216
1217 Sometimes, a relation holding between two expressions must be stored
1218 somehow.  The class @code{relational} is a convenient container for such
1219 purposes.  A relation is by definition a container for two @code{ex} and
1220 a relation between them that signals equality, inequality and so on.
1221 They are created by simply using the C++ operators @code{==}, @code{!=},
1222 @code{<}, @code{<=}, @code{>} and @code{>=} between two expressions.
1223
1224 @xref{Mathematical functions}, for examples where various applications
1225 of the @code{.subs()} method show how objects of class relational are
1226 used as arguments.  There they provide an intuitive syntax for
1227 substitutions.  They are also used as arguments to the @code{ex::series}
1228 method, where the left hand side of the relation specifies the variable
1229 to expand in and the right hand side the expansion point.  They can also
1230 be used for creating systems of equations that are to be solved for
1231 unknown variables.  But the most common usage of objects of this class
1232 is rather inconspicuous in statements of the form @code{if
1233 (expand(pow(a+b,2))==a*a+2*a*b+b*b) @{...@}}.  Here, an implicit
1234 conversion from @code{relational} to @code{bool} takes place.  Note,
1235 however, that @code{==} here does not perform any simplifications, hence
1236 @code{expand()} must be called explicitly.
1237
1238
1239 @node Methods and Functions, Information About Expressions, Relations, Top
1240 @c    node-name, next, previous, up
1241 @chapter Methods and Functions
1242 @cindex polynomial
1243
1244 In this chapter the most important algorithms provided by GiNaC will be
1245 described.  Some of them are implemented as functions on expressions,
1246 others are implemented as methods provided by expression objects.  If
1247 they are methods, there exists a wrapper function around it, so you can
1248 alternatively call it in a functional way as shown in the simple
1249 example:
1250
1251 @example
1252 #include <ginac/ginac.h>
1253 using namespace GiNaC;
1254
1255 int main()
1256 @{
1257     ex x = numeric(1.0);
1258     
1259     cout << "As method:   " << sin(x).evalf() << endl;
1260     cout << "As function: " << evalf(sin(x)) << endl;
1261 @}
1262 @end example
1263
1264 @cindex @code{subs()}
1265 The general rule is that wherever methods accept one or more parameters
1266 (@var{arg1}, @var{arg2}, @dots{}) the order of arguments the function
1267 wrapper accepts is the same but preceded by the object to act on
1268 (@var{object}, @var{arg1}, @var{arg2}, @dots{}).  This approach is the
1269 most natural one in an OO model but it may lead to confusion for MapleV
1270 users because where they would type @code{A:=x+1; subs(x=2,A);} GiNaC
1271 would require @code{A=x+1; subs(A,x==2);} (after proper declaration of
1272 @code{A} and @code{x}).  On the other hand, since MapleV returns 3 on
1273 @code{A:=x^2+3; coeff(A,x,0);} (GiNaC: @code{A=pow(x,2)+3;
1274 coeff(A,x,0);}) it is clear that MapleV is not trying to be consistent
1275 here.  Also, users of MuPAD will in most cases feel more comfortable
1276 with GiNaC's convention.  All function wrappers are implemented
1277 as simple inline functions which just call the corresponding method and
1278 are only provided for users uncomfortable with OO who are dead set to
1279 avoid method invocations.  Generally, nested function wrappers are much
1280 harder to read than a sequence of methods and should therefore be
1281 avoided if possible.  On the other hand, not everything in GiNaC is a
1282 method on class @code{ex} and sometimes calling a function cannot be
1283 avoided.
1284
1285 @menu
1286 * Information About Expressions::
1287 * Substituting Symbols::
1288 * Polynomial Arithmetic::           Working with polynomials.
1289 * Rational Expressions::            Working with rational functions.
1290 * Symbolic Differentiation::
1291 * Series Expansion::                Taylor and Laurent expansion.
1292 * Built-in Functions::              List of predefined mathematical functions.
1293 * Input/Output::                    Input and output of expressions.
1294 @end menu
1295
1296
1297 @node Information About Expressions, Substituting Symbols, Methods and Functions, Methods and Functions
1298 @c    node-name, next, previous, up
1299 @section Getting information about expressions
1300
1301 @subsection Checking expression types
1302 @cindex @code{is_ex_of_type()}
1303 @cindex @code{info()}
1304
1305 Sometimes it's useful to check whether a given expression is a plain number,
1306 a sum, a polynomial with integer coefficients, or of some other specific type.
1307 GiNaC provides two functions for this (the first one is actually a macro):
1308
1309 @example
1310 bool is_ex_of_type(const ex & e, TYPENAME t);
1311 bool ex::info(unsigned flag);
1312 @end example
1313
1314 @code{is_ex_of_type()} allows you to check whether the top-level object of
1315 an expression @samp{e} is an instance of the GiNaC class @samp{t}
1316 (@xref{The Class Hierarchy}, for a list of all classes). This is most useful,
1317 e.g., for checking whether an expression is a number, a sum, or a product:
1318
1319 @example
1320 @{
1321     symbol x("x");
1322     ex e1 = 42;
1323     ex e2 = 4*x - 3;
1324     is_ex_of_type(e1, numeric);  // true
1325     is_ex_of_type(e2, numeric);  // false
1326     is_ex_of_type(e1, add);      // false
1327     is_ex_of_type(e2, add);      // true
1328     is_ex_of_type(e1, mul);      // false
1329     is_ex_of_type(e2, mul);      // false
1330 @}
1331 @end example
1332
1333 The @code{info()} method is used for checking certain attributes of
1334 expressions. The possible values for the @code{flag} argument are defined
1335 in @file{ginac/flags.h}, the most important being explained in the following
1336 table:
1337
1338 @cartouche
1339 @multitable @columnfractions .30 .70
1340 @item @strong{Flag} @tab @strong{Returns true if the object is@dots{}}
1341 @item @code{numeric}
1342 @tab @dots{}a number (same as @code{is_ex_of_type(..., numeric)})
1343 @item @code{real}
1344 @tab @dots{}a real integer, rational or float (i.e. is not complex)
1345 @item @code{rational}
1346 @tab @dots{}an exact rational number (integers are rational, too)
1347 @item @code{integer}
1348 @tab @dots{}a (non-complex) integer
1349 @item @code{crational}
1350 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
1351 @item @code{cinteger}
1352 @tab @dots{}a (complex) integer (such as @math{2-3*I})
1353 @item @code{positive}
1354 @tab @dots{}not complex and greater than 0
1355 @item @code{negative}
1356 @tab @dots{}not complex and less than 0
1357 @item @code{nonnegative}
1358 @tab @dots{}not complex and greater than or equal to 0
1359 @item @code{posint}
1360 @tab @dots{}an integer greater than 0
1361 @item @code{negint}
1362 @tab @dots{}an integer less than 0
1363 @item @code{nonnegint}
1364 @tab @dots{}an integer greater than or equal to 0
1365 @item @code{even}
1366 @tab @dots{}an even integer
1367 @item @code{odd}
1368 @tab @dots{}an odd integer
1369 @item @code{prime}
1370 @tab @dots{}a prime integer (probabilistic primality test)
1371 @item @code{relation}
1372 @tab @dots{}a relation (same as @code{is_ex_of_type(..., relational)})
1373 @item @code{relation_equal}
1374 @tab @dots{}a @code{==} relation
1375 @item @code{relation_not_equal}
1376 @tab @dots{}a @code{!=} relation
1377 @item @code{relation_less}
1378 @tab @dots{}a @code{<} relation
1379 @item @code{relation_less_or_equal}
1380 @tab @dots{}a @code{<=} relation
1381 @item @code{relation_greater}
1382 @tab @dots{}a @code{>} relation
1383 @item @code{relation_greater_or_equal}
1384 @tab @dots{}a @code{>=} relation
1385 @item @code{symbol}
1386 @tab @dots{}a symbol (same as @code{is_ex_of_type(..., symbol)})
1387 @item @code{list}
1388 @tab @dots{}a list (same as @code{is_ex_of_type(..., lst)})
1389 @item @code{polynomial}
1390 @tab @dots{}a polynomial (i.e. only consists of sums and products of numbers and symbols with positive integer powers)
1391 @item @code{integer_polynomial}
1392 @tab @dots{}a polynomial with (non-complex) integer coefficients
1393 @item @code{cinteger_polynomial}
1394 @tab @dots{}a polynomial with (possibly complex) integer coefficients (such as @math{2-3*I})
1395 @item @code{rational_polynomial}
1396 @tab @dots{}a polynomial with (non-complex) rational coefficients
1397 @item @code{crational_polynomial}
1398 @tab @dots{}a polynomial with (possibly complex) rational coefficients (such as @math{2/3+7/2*I})
1399 @item @code{rational_function}
1400 @tab @dots{}a rational function (@math{x+y}, @math{z/(x+y)})
1401 @item @code{algebraic}
1402 @tab @dots{}an algebraic object (@math{sqrt(2)}, @math{sqrt(x)-1})
1403 @end multitable
1404 @end cartouche
1405
1406
1407 @subsection Accessing subexpressions
1408 @cindex @code{nops()}
1409 @cindex @code{op()}
1410 @cindex @code{has()}
1411 @cindex container
1412 @cindex @code{relational} (class)
1413
1414 GiNaC provides the two methods
1415
1416 @example
1417 unsigned ex::nops();
1418 ex ex::op(unsigned i);
1419 @end example
1420
1421 for accessing the subexpressions in the container-like GiNaC classes like
1422 @code{add}, @code{mul}, @code{lst}, and @code{function}. @code{nops()}
1423 determines the number of subexpressions (@samp{operands}) contained, while
1424 @code{op()} returns the @code{i}-th (0..@code{nops()-1}) subexpression.
1425 In the case of a @code{power} object, @code{op(0)} will return the basis
1426 and @code{op(1)} the exponent.
1427
1428 The left-hand and right-hand side expressions of objects of class
1429 @code{relational} (and only of these) can also be accessed with the methods
1430
1431 @example
1432 ex ex::lhs();
1433 ex ex::rhs();
1434 @end example
1435
1436 Finally, the method
1437
1438 @example
1439 bool ex::has(const ex & other);
1440 @end example
1441
1442 checks whether an expression contains the given subexpression @code{other}.
1443 This only works reliably if @code{other} is of an atomic class such as a
1444 @code{numeric} or a @code{symbol}. It is, e.g., not possible to verify that
1445 @code{a+b+c} contains @code{a+c} (or @code{a+b}) as a subexpression.
1446
1447
1448 @subsection Comparing expressions
1449 @cindex @code{is_equal()}
1450 @cindex @code{is_zero()}
1451
1452 Expressions can be compared with the usual C++ relational operators like
1453 @code{==}, @code{>}, and @code{<} but if the expressions contain symbols,
1454 the result is usually not determinable and the result will be @code{false},
1455 except in the case of the @code{!=} operator. You should also be aware that
1456 GiNaC will only do the most trivial test for equality (subtracting both
1457 expressions), so something like @code{(pow(x,2)+x)/x==x+1} will return
1458 @code{false}.
1459
1460 Actually, if you construct an expression like @code{a == b}, this will be
1461 represented by an object of the @code{relational} class (@xref{Relations}.)
1462 which is not evaluated until (explicitly or implicitely) cast to a @code{bool}.
1463
1464 There are also two methods
1465
1466 @example
1467 bool ex::is_equal(const ex & other);
1468 bool ex::is_zero();
1469 @end example
1470
1471 for checking whether one expression is equal to another, or equal to zero,
1472 respectively.
1473
1474 @strong{Warning:} You will also find an @code{ex::compare()} method in the
1475 GiNaC header files. This method is however only to be used internally by
1476 GiNaC to establish a canonical sort order for terms, and using it to compare
1477 expressions will give very surprising results.
1478
1479
1480 @node Substituting Symbols, Polynomial Arithmetic, Information About Expressions, Methods and Functions
1481 @c    node-name, next, previous, up
1482 @section Substituting symbols
1483 @cindex @code{subs()}
1484
1485 Symbols can be replaced with expressions via the @code{.subs()} method:
1486
1487 @example
1488 ex ex::subs(const ex & e);
1489 ex ex::subs(const lst & syms, const lst & repls);
1490 @end example
1491
1492 In the first form, @code{subs()} accepts a relational of the form
1493 @samp{symbol == expression} or a @code{lst} of such relationals. E.g.
1494
1495 @example
1496 @{
1497     symbol x("x"), y("y");
1498     ex e1 = 2*x^2-4*x+3;
1499     cout << "e1(7) = " << e1.subs(x == 7) << endl;
1500     ex e2 = x*y + x;
1501     cout << "e2(-2, 4) = " << e2.subs(lst(x == -2, y == 4)) << endl;
1502 @}
1503 @end example
1504
1505 will print @samp{73} and @samp{-10}, respectively.
1506
1507 If you specify multiple substitutions, they are performed in parallel, so e.g.
1508 @code{subs(lst(x == y, y == x))} exchanges @samp{x} and @samp{y}.
1509
1510 The second form of @code{subs()} takes two lists, one for the symbols and
1511 one for the expressions to be substituted (both lists must contain the same
1512 number of elements). Using this form, you would write @code{subs(lst(x, y), lst(y, x))}
1513 to exchange @samp{x} and @samp{y}.
1514
1515
1516 @node Polynomial Arithmetic, Rational Expressions, Substituting Symbols, Methods and Functions
1517 @c    node-name, next, previous, up
1518 @section Polynomial arithmetic
1519
1520 @subsection Expanding and collecting
1521 @cindex @code{expand()}
1522 @cindex @code{collect()}
1523
1524 A polynomial in one or more variables has many equivalent
1525 representations.  Some useful ones serve a specific purpose.  Consider
1526 for example the trivariate polynomial @math{4*x*y + x*z + 20*y^2 +
1527 21*y*z + 4*z^2} (written down here in output-style).  It is equivalent
1528 to the factorized polynomial @math{(x + 5*y + 4*z)*(4*y + z)}.  Other
1529 representations are the recursive ones where one collects for exponents
1530 in one of the three variable.  Since the factors are themselves
1531 polynomials in the remaining two variables the procedure can be
1532 repeated.  In our expample, two possibilities would be @math{(4*y + z)*x
1533 + 20*y^2 + 21*y*z + 4*z^2} and @math{20*y^2 + (21*z + 4*x)*y + 4*z^2 +
1534 x*z}.
1535
1536 To bring an expression into expanded form, its method
1537
1538 @example
1539 ex ex::expand();
1540 @end example
1541
1542 may be called.  In our example above, this corresponds to @math{4*x*y +
1543 x*z + 20*y^2 + 21*y*z + 4*z^2}.  Again, since the canonical form in
1544 GiNaC is not easily guessable you should be prepared to see different
1545 orderings of terms in such sums!
1546
1547 Another useful representation of multivariate polynomials is as a
1548 univariate polynomial in one of the variables with the coefficients
1549 being polynomials in the remaining variables.  The method
1550 @code{collect()} accomplishes this task:
1551
1552 @example
1553 ex ex::collect(const symbol & s);
1554 @end example
1555
1556 Note that the original polynomial needs to be in expanded form in order
1557 to be able to find the coefficients properly.
1558
1559 @subsection Degree and coefficients
1560 @cindex @code{degree()}
1561 @cindex @code{ldegree()}
1562 @cindex @code{coeff()}
1563
1564 The degree and low degree of a polynomial can be obtained using the two
1565 methods
1566
1567 @example
1568 int ex::degree(const symbol & s);
1569 int ex::ldegree(const symbol & s);
1570 @end example
1571
1572 which also work reliably on non-expanded input polynomials (they even work
1573 on rational functions, returning the asymptotic degree). To extract
1574 a coefficient with a certain power from an expanded polynomial you use
1575
1576 @example
1577 ex ex::coeff(const symbol & s, int n);
1578 @end example
1579
1580 You can also obtain the leading and trailing coefficients with the methods
1581
1582 @example
1583 ex ex::lcoeff(const symbol & s);
1584 ex ex::tcoeff(const symbol & s);
1585 @end example
1586
1587 which are equivalent to @code{coeff(s, degree(s))} and @code{coeff(s, ldegree(s))},
1588 respectively.
1589
1590 An application is illustrated in the next example, where a multivariate
1591 polynomial is analyzed:
1592
1593 @example
1594 #include <ginac/ginac.h>
1595 using namespace GiNaC;
1596
1597 int main()
1598 @{
1599     symbol x("x"), y("y");
1600     ex PolyInp = 4*pow(x,3)*y + 5*x*pow(y,2) + 3*y
1601                  - pow(x+y,2) + 2*pow(y+2,2) - 8;
1602     ex Poly = PolyInp.expand();
1603     
1604     for (int i=Poly.ldegree(x); i<=Poly.degree(x); ++i) @{
1605         cout << "The x^" << i << "-coefficient is "
1606              << Poly.coeff(x,i) << endl;
1607     @}
1608     cout << "As polynomial in y: " 
1609          << Poly.collect(y) << endl;
1610 @}
1611 @end example
1612
1613 When run, it returns an output in the following fashion:
1614
1615 @example
1616 The x^0-coefficient is y^2+11*y
1617 The x^1-coefficient is 5*y^2-2*y
1618 The x^2-coefficient is -1
1619 The x^3-coefficient is 4*y
1620 As polynomial in y: -x^2+(5*x+1)*y^2+(-2*x+4*x^3+11)*y
1621 @end example
1622
1623 As always, the exact output may vary between different versions of GiNaC
1624 or even from run to run since the internal canonical ordering is not
1625 within the user's sphere of influence.
1626
1627
1628 @subsection Polynomial division
1629 @cindex polynomial division
1630 @cindex quotient
1631 @cindex remainder
1632 @cindex pseudo-remainder
1633 @cindex @code{quo()}
1634 @cindex @code{rem()}
1635 @cindex @code{prem()}
1636 @cindex @code{divide()}
1637
1638 The two functions
1639
1640 @example
1641 ex quo(const ex & a, const ex & b, const symbol & x);
1642 ex rem(const ex & a, const ex & b, const symbol & x);
1643 @end example
1644
1645 compute the quotient and remainder of univariate polynomials in the variable
1646 @samp{x}. The results satisfy @math{a = b*quo(a, b, x) + rem(a, b, x)}.
1647
1648 The additional function
1649
1650 @example
1651 ex prem(const ex & a, const ex & b, const symbol & x);
1652 @end example
1653
1654 computes the pseudo-remainder of @samp{a} and @samp{b} which satisfies
1655 @math{c*a = b*q + prem(a, b, x)}, where @math{c = b.lcoeff(x) ^ (a.degree(x) - b.degree(x) + 1)}.
1656
1657 Exact division of multivariate polynomials is performed by the function
1658
1659 @example
1660 bool divide(const ex & a, const ex & b, ex & q);
1661 @end example
1662
1663 If @samp{b} divides @samp{a} over the rationals, this function returns @code{true}
1664 and returns the quotient in the variable @code{q}. Otherwise it returns @code{false}
1665 in which case the value of @code{q} is undefined.
1666
1667
1668 @subsection Unit, content and primitive part
1669 @cindex @code{unit()}
1670 @cindex @code{content()}
1671 @cindex @code{primpart()}
1672
1673 The methods
1674
1675 @example
1676 ex ex::unit(const symbol & x);
1677 ex ex::content(const symbol & x);
1678 ex ex::primpart(const symbol & x);
1679 @end example
1680
1681 return the unit part, content part, and primitive polynomial of a multivariate
1682 polynomial with respect to the variable @samp{x} (the unit part being the sign
1683 of the leading coefficient, the content part being the GCD of the coefficients,
1684 and the primitive polynomial being the input polynomial divided by the unit and
1685 content parts). The product of unit, content, and primitive part is the
1686 original polynomial.
1687
1688
1689 @subsection GCD and LCM
1690 @cindex GCD
1691 @cindex LCM
1692 @cindex @code{gcd()}
1693 @cindex @code{lcm()}
1694
1695 The functions for polynomial greatest common divisor and least common
1696 multiple have the synopsis
1697
1698 @example
1699 ex gcd(const ex & a, const ex & b);
1700 ex lcm(const ex & a, const ex & b);
1701 @end example
1702
1703 The functions @code{gcd()} and @code{lcm()} accept two expressions
1704 @code{a} and @code{b} as arguments and return a new expression, their
1705 greatest common divisor or least common multiple, respectively.  If the
1706 polynomials @code{a} and @code{b} are coprime @code{gcd(a,b)} returns 1
1707 and @code{lcm(a,b)} returns the product of @code{a} and @code{b}.
1708
1709 @example
1710 #include <ginac/ginac.h>
1711 using namespace GiNaC;
1712
1713 int main()
1714 @{
1715     symbol x("x"), y("y"), z("z");
1716     ex P_a = 4*x*y + x*z + 20*pow(y, 2) + 21*y*z + 4*pow(z, 2);
1717     ex P_b = x*y + 3*x*z + 5*pow(y, 2) + 19*y*z + 12*pow(z, 2);
1718
1719     ex P_gcd = gcd(P_a, P_b);
1720     // x + 5*y + 4*z
1721     ex P_lcm = lcm(P_a, P_b);
1722     // 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
1723 @}
1724 @end example
1725
1726
1727 @node Rational Expressions, Symbolic Differentiation, Polynomial Arithmetic, Methods and Functions
1728 @c    node-name, next, previous, up
1729 @section Rational expressions
1730
1731 @subsection The @code{normal} method
1732 @cindex @code{normal()}
1733 @cindex simplification
1734 @cindex temporary replacement
1735
1736 Some basic from of simplification of expressions is called for frequently.
1737 GiNaC provides the method @code{.normal()}, which converts a rational function
1738 into an equivalent rational function of the form @samp{numerator/denominator}
1739 where numerator and denominator are coprime.  If the input expression is already
1740 a fraction, it just finds the GCD of numerator and denominator and cancels it,
1741 otherwise it performs fraction addition and multiplication.
1742
1743 @code{.normal()} can also be used on expressions which are not rational functions
1744 as it will replace all non-rational objects (like functions or non-integer
1745 powers) by temporary symbols to bring the expression to the domain of rational
1746 functions before performing the normalization, and re-substituting these
1747 symbols afterwards. This algorithm is also available as a separate method
1748 @code{.to_rational()}, described below.
1749
1750 This means that both expressions @code{t1} and @code{t2} are indeed
1751 simplified in this little program:
1752
1753 @example
1754 #include <ginac/ginac.h>
1755 using namespace GiNaC;
1756
1757 int main()
1758 @{
1759     symbol x("x");
1760     ex t1 = (pow(x,2) + 2*x + 1)/(x + 1);
1761     ex t2 = (pow(sin(x),2) + 2*sin(x) + 1)/(sin(x) + 1);
1762     cout << "t1 is " << t1.normal() << endl;
1763     cout << "t2 is " << t2.normal() << endl;
1764 @}
1765 @end example
1766
1767 Of course this works for multivariate polynomials too, so the ratio of
1768 the sample-polynomials from the section about GCD and LCM above would be
1769 normalized to @code{P_a/P_b} = @code{(4*y+z)/(y+3*z)}.
1770
1771
1772 @subsection Numerator and denominator
1773 @cindex numerator
1774 @cindex denominator
1775 @cindex @code{numer()}
1776 @cindex @code{denom()}
1777
1778 The numerator and denominator of an expression can be obtained with
1779
1780 @example
1781 ex ex::numer();
1782 ex ex::denom();
1783 @end example
1784
1785 These functions will first normalize the expression as described above and
1786 then return the numerator or denominator, respectively.
1787
1788
1789 @subsection Converting to a rational expression
1790 @cindex @code{to_rational()}
1791
1792 Some of the methods described so far only work on polynomials or rational
1793 functions. GiNaC provides a way to extend the domain of these functions to
1794 general expressions by using the temporary replacement algorithm described
1795 above. You do this by calling
1796
1797 @example
1798 ex ex::to_rational(lst &l);
1799 @end example
1800
1801 on the expression to be converted. The supplied @code{lst} will be filled
1802 with the generated temporary symbols and their replacement expressions in
1803 a format that can be used directly for the @code{subs()} method. It can also
1804 already contain a list of replacements from an earlier application of
1805 @code{.to_rational()}, so it's possible to use it on multiple expressions
1806 and get consistent results.
1807
1808 For example,
1809
1810 @example
1811 @{
1812     symbol x("x");
1813     ex a = pow(sin(x), 2) - pow(cos(x), 2);
1814     ex b = sin(x) + cos(x);
1815     ex q;
1816     lst l;
1817     divide(a.to_rational(l), b.to_rational(l), q);
1818     cout << q.subs(l) << endl;
1819 @}
1820 @end example
1821
1822 will print @samp{sin(x)-cos(x)}.
1823
1824
1825 @node Symbolic Differentiation, Series Expansion, Rational Expressions, Methods and Functions
1826 @c    node-name, next, previous, up
1827 @section Symbolic differentiation
1828 @cindex differentiation
1829 @cindex @code{diff()}
1830 @cindex chain rule
1831 @cindex product rule
1832
1833 GiNaC's objects know how to differentiate themselves.  Thus, a
1834 polynomial (class @code{add}) knows that its derivative is the sum of
1835 the derivatives of all the monomials:
1836
1837 @example
1838 #include <ginac/ginac.h>
1839 using namespace GiNaC;
1840
1841 int main()
1842 @{
1843     symbol x("x"), y("y"), z("z");
1844     ex P = pow(x, 5) + pow(x, 2) + y;
1845
1846     cout << P.diff(x,2) << endl;  // 20*x^3 + 2
1847     cout << P.diff(y) << endl;    // 1
1848     cout << P.diff(z) << endl;    // 0
1849 @}
1850 @end example
1851
1852 If a second integer parameter @var{n} is given, the @code{diff} method
1853 returns the @var{n}th derivative.
1854
1855 If @emph{every} object and every function is told what its derivative
1856 is, all derivatives of composed objects can be calculated using the
1857 chain rule and the product rule.  Consider, for instance the expression
1858 @code{1/cosh(x)}.  Since the derivative of @code{cosh(x)} is
1859 @code{sinh(x)} and the derivative of @code{pow(x,-1)} is
1860 @code{-pow(x,-2)}, GiNaC can readily compute the composition.  It turns
1861 out that the composition is the generating function for Euler Numbers,
1862 i.e. the so called @var{n}th Euler number is the coefficient of
1863 @code{x^n/n!} in the expansion of @code{1/cosh(x)}.  We may use this
1864 identity to code a function that generates Euler numbers in just three
1865 lines:
1866
1867 @cindex Euler numbers
1868 @example
1869 #include <ginac/ginac.h>
1870 using namespace GiNaC;
1871
1872 ex EulerNumber(unsigned n)
1873 @{
1874     symbol x;
1875     const ex generator = pow(cosh(x),-1);
1876     return generator.diff(x,n).subs(x==0);
1877 @}
1878
1879 int main()
1880 @{
1881     for (unsigned i=0; i<11; i+=2)
1882         cout << EulerNumber(i) << endl;
1883     return 0;
1884 @}
1885 @end example
1886
1887 When you run it, it produces the sequence @code{1}, @code{-1}, @code{5},
1888 @code{-61}, @code{1385}, @code{-50521}.  We increment the loop variable
1889 @code{i} by two since all odd Euler numbers vanish anyways.
1890
1891
1892 @node Series Expansion, Built-in Functions, Symbolic Differentiation, Methods and Functions
1893 @c    node-name, next, previous, up
1894 @section Series expansion
1895 @cindex @code{series()}
1896 @cindex Taylor expansion
1897 @cindex Laurent expansion
1898 @cindex @code{pseries} (class)
1899
1900 Expressions know how to expand themselves as a Taylor series or (more
1901 generally) a Laurent series.  As in most conventional Computer Algebra
1902 Systems, no distinction is made between those two.  There is a class of
1903 its own for storing such series (@code{class pseries}) and a built-in
1904 function (called @code{Order}) for storing the order term of the series.
1905 As a consequence, if you want to work with series, i.e. multiply two
1906 series, you need to call the method @code{ex::series} again to convert
1907 it to a series object with the usual structure (expansion plus order
1908 term).  A sample application from special relativity could read:
1909
1910 @example
1911 #include <ginac/ginac.h>
1912 using namespace GiNaC;
1913
1914 int main()
1915 @{
1916     symbol v("v"), c("c");
1917     
1918     ex gamma = 1/sqrt(1 - pow(v/c,2));
1919     ex mass_nonrel = gamma.series(v==0, 10);
1920     
1921     cout << "the relativistic mass increase with v is " << endl
1922          << mass_nonrel << endl;
1923     
1924     cout << "the inverse square of this series is " << endl
1925          << pow(mass_nonrel,-2).series(v==0, 10) << endl;
1926 @}
1927 @end example
1928
1929 Only calling the series method makes the last output simplify to
1930 @math{1-v^2/c^2+O(v^10)}, without that call we would just have a long
1931 series raised to the power @math{-2}.
1932
1933 @cindex M@'echain's formula
1934 As another instructive application, let us calculate the numerical 
1935 value of Archimedes' constant
1936 @tex
1937 $\pi$
1938 @end tex
1939 (for which there already exists the built-in constant @code{Pi}) 
1940 using M@'echain's amazing formula
1941 @tex
1942 $\pi=16$~atan~$\!\left(1 \over 5 \right)-4$~atan~$\!\left(1 \over 239 \right)$.
1943 @end tex
1944 @ifnottex
1945 @math{Pi==16*atan(1/5)-4*atan(1/239)}.
1946 @end ifnottex
1947 We may expand the arcus tangent around @code{0} and insert the fractions
1948 @code{1/5} and @code{1/239}.  But, as we have seen, a series in GiNaC
1949 carries an order term with it and the question arises what the system is
1950 supposed to do when the fractions are plugged into that order term.  The
1951 solution is to use the function @code{series_to_poly()} to simply strip
1952 the order term off:
1953
1954 @example
1955 #include <ginac/ginac.h>
1956 using namespace GiNaC;
1957
1958 ex mechain_pi(int degr)
1959 @{
1960     symbol x;
1961     ex pi_expansion = series_to_poly(atan(x).series(x,degr));
1962     ex pi_approx = 16*pi_expansion.subs(x==numeric(1,5))
1963                    -4*pi_expansion.subs(x==numeric(1,239));
1964     return pi_approx;
1965 @}
1966
1967 int main()
1968 @{
1969     ex pi_frac;
1970     for (int i=2; i<12; i+=2) @{
1971         pi_frac = mechain_pi(i);
1972         cout << i << ":\t" << pi_frac << endl
1973              << "\t" << pi_frac.evalf() << endl;
1974     @}
1975     return 0;
1976 @}
1977 @end example
1978
1979 Note how we just called @code{.series(x,degr)} instead of
1980 @code{.series(x==0,degr)}.  This is a simple shortcut for @code{ex}'s
1981 method @code{series()}: if the first argument is a symbol the expression
1982 is expanded in that symbol around point @code{0}.  When you run this
1983 program, it will type out:
1984
1985 @example
1986 2:      3804/1195
1987         3.1832635983263598326
1988 4:      5359397032/1706489875
1989         3.1405970293260603143
1990 6:      38279241713339684/12184551018734375
1991         3.141621029325034425
1992 8:      76528487109180192540976/24359780855939418203125
1993         3.141591772182177295
1994 10:     327853873402258685803048818236/104359128170408663038552734375
1995         3.1415926824043995174
1996 @end example
1997
1998
1999 @node Built-in Functions, Input/Output, Series Expansion, Methods and Functions
2000 @c    node-name, next, previous, up
2001 @section Predefined mathematical functions
2002
2003 GiNaC contains the following predefined mathematical functions:
2004
2005 @cartouche
2006 @multitable @columnfractions .30 .70
2007 @item @strong{Name} @tab @strong{Function}
2008 @item @code{abs(x)}
2009 @tab absolute value
2010 @item @code{csgn(x)}
2011 @tab complex sign
2012 @item @code{sqrt(x)}
2013 @tab square root (not a GiNaC function proper but equivalent to @code{pow(x, numeric(1, 2)})
2014 @item @code{sin(x)}
2015 @tab sine
2016 @item @code{cos(x)}
2017 @tab cosine
2018 @item @code{tan(x)}
2019 @tab tangent
2020 @item @code{asin(x)}
2021 @tab inverse sine
2022 @item @code{acos(x)}
2023 @tab inverse cosine
2024 @item @code{atan(x)}
2025 @tab inverse tangent
2026 @item @code{atan2(y, x)}
2027 @tab inverse tangent with two arguments
2028 @item @code{sinh(x)}
2029 @tab hyperbolic sine
2030 @item @code{cosh(x)}
2031 @tab hyperbolic cosine
2032 @item @code{tanh(x)}
2033 @tab hyperbolic tangent
2034 @item @code{asinh(x)}
2035 @tab inverse hyperbolic sine
2036 @item @code{acosh(x)}
2037 @tab inverse hyperbolic cosine
2038 @item @code{atanh(x)}
2039 @tab inverse hyperbolic tangent
2040 @item @code{exp(x)}
2041 @tab exponential function
2042 @item @code{log(x)}
2043 @tab natural logarithm
2044 @item @code{Li2(x)}
2045 @tab Dilogarithm
2046 @item @code{zeta(x)}
2047 @tab Riemann's zeta function
2048 @item @code{zeta(n, x)}
2049 @tab derivatives of Riemann's zeta function
2050 @item @code{tgamma(x)}
2051 @tab Gamma function
2052 @item @code{lgamma(x)}
2053 @tab logarithm of Gamma function
2054 @item @code{beta(x, y)}
2055 @tab Beta function (@code{tgamma(x)*tgamma(y)/tgamma(x+y)})
2056 @item @code{psi(x)}
2057 @tab psi (digamma) function
2058 @item @code{psi(n, x)}
2059 @tab derivatives of psi function (polygamma functions)
2060 @item @code{factorial(n)}
2061 @tab factorial function
2062 @item @code{binomial(n, m)}
2063 @tab binomial coefficients
2064 @item @code{Order(x)}
2065 @tab order term function in truncated power series
2066 @item @code{Derivative(x, l)}
2067 @tab inert partial differentiation operator (used internally)
2068 @end multitable
2069 @end cartouche
2070
2071 @cindex branch cut
2072 For functions that have a branch cut in the complex plane GiNaC follows
2073 the conventions for C++ as defined in the ANSI standard as far as
2074 possible.  In particular: the natural logarithm (@code{log}) and the
2075 square root (@code{sqrt}) both have their branch cuts running along the
2076 negative real axis where the points on the axis itself belong to the
2077 upper part (i.e. continuous with quadrant II).  The inverse
2078 trigonometric and hyperbolic functions are not defined for complex
2079 arguments by the C++ standard, however.  Here, we follow the conventions
2080 used by CLN, which in turn follow the carefully designed definitions
2081 in the Common Lisp standard.  Hopefully, future revisions of the C++
2082 standard incorporate these functions in the complex domain in a manner
2083 compatible with Common Lisp.
2084
2085
2086 @node Input/Output, Extending GiNaC, Built-in Functions, Methods and Functions
2087 @c    node-name, next, previous, up
2088 @section Input and output of expressions
2089 @cindex I/O
2090
2091 @subsection Expression output
2092 @cindex printing
2093 @cindex output of expressions
2094
2095 The easiest way to print an expression is to write it to a stream:
2096
2097 @example
2098 @{
2099     symbol x("x");
2100     ex e = 4.5+pow(x,2)*3/2;
2101     cout << e << endl;    // prints '4.5+3/2*x^2'
2102     // ...
2103 @end example
2104
2105 The output format is identical to the @command{ginsh} input syntax and
2106 to that used by most computer algebra systems, but not directly pastable
2107 into a GiNaC C++ program (note that in the above example, @code{pow(x,2)}
2108 is printed as @samp{x^2}).
2109
2110 To print an expression in a way that can be directly used in a C or C++
2111 program, you use the method
2112
2113 @example
2114 void ex::printcsrc(ostream & os, unsigned type, const char *name);
2115 @end example
2116
2117 This outputs a line in the form of a variable definition @code{<type> <name> = <expression>}.
2118 The possible types are defined in @file{ginac/flags.h} (@code{csrc_types})
2119 and mostly affect the way in which floating point numbers are written:
2120
2121 @example
2122     // ...
2123     e.printcsrc(cout, csrc_types::ctype_float, "f");
2124     e.printcsrc(cout, csrc_types::ctype_double, "d");
2125     e.printcsrc(cout, csrc_types::ctype_cl_N, "n");
2126     // ...
2127 @end example
2128
2129 The above example will produce (note the @code{x^2} being converted to @code{x*x}):
2130
2131 @example
2132 float f = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
2133 double d = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
2134 cl_N n = (cl_F("3.0")/cl_F("2.0"))*(x*x)+cl_F("4.5");
2135 @end example
2136
2137 Finally, there are the two methods @code{printraw()} and @code{printtree()} intended for GiNaC
2138 developers, that provide a dump of the internal structure of an expression for
2139 debugging purposes:
2140
2141 @example
2142     // ...
2143     e.printraw(cout); cout << endl << endl;
2144     e.printtree(cout);
2145 @}
2146 @end example
2147
2148 produces
2149
2150 @example
2151 ex(+((power(ex(symbol(name=x,serial=1,hash=150875740,flags=11)),ex(numeric(2)),hash=2,flags=3),numeric(3/2)),,hash=0,flags=3))
2152
2153 type=Q25GiNaC3add, hash=0 (0x0), flags=3, nops=2
2154     power: hash=2 (0x2), flags=3
2155         x (symbol): serial=1, hash=150875740 (0x8fe2e5c), flags=11
2156         2 (numeric): hash=2147483714 (0x80000042), flags=11
2157     3/2 (numeric): hash=2147483745 (0x80000061), flags=11
2158     -----
2159     overall_coeff
2160     4.5L0 (numeric): hash=2147483723 (0x8000004b), flags=11
2161     =====
2162 @end example
2163
2164 The @code{printtree()} method is also available in @command{ginsh} as the
2165 @code{print()} function.
2166
2167
2168 @subsection Expression input
2169 @cindex input of expressions
2170
2171 GiNaC provides no way to directly read an expression from a stream because
2172 you will usually want the user to be able to enter something like @samp{2*x+sin(y)}
2173 and have the @samp{x} and @samp{y} correspond to the symbols @code{x} and
2174 @code{y} you defined in your program and there is no way to specify the
2175 desired symbols to the @code{>>} stream input operator.
2176
2177 Instead, GiNaC lets you construct an expression from a string, specifying the
2178 list of symbols to be used:
2179
2180 @example
2181 @{
2182     symbol x("x"), y("y");
2183     ex e("2*x+sin(y)", lst(x, y));
2184 @}
2185 @end example
2186
2187 The input syntax is the same as that used by @command{ginsh} and the stream
2188 output operator @code{<<}. The symbols in the string are matched by name to
2189 the symbols in the list and if GiNaC encounters a symbol not specified in
2190 the list it will throw an exception.
2191
2192 With this constructor, it's also easy to implement interactive GiNaC programs:
2193
2194 @example
2195 #include <iostream>
2196 #include <string>
2197 #include <stdexcept>
2198 #include <ginac/ginac.h>
2199 using namespace GiNaC;
2200
2201 int main()
2202 @{
2203      symbol x("x");
2204      string s;
2205
2206      cout << "Enter an expression containing 'x': ";
2207      getline(cin, s);
2208
2209      try @{
2210          ex e(s, lst(x));
2211          cout << "The derivative of " << e << " with respect to x is ";
2212          cout << e.diff(x) << ".\n";
2213      @} catch (exception &p) @{
2214          cerr << p.what() << endl;
2215      @}
2216 @}
2217 @end example
2218
2219
2220 @subsection Archiving
2221 @cindex @code{archive} (class)
2222 @cindex archiving
2223
2224 GiNaC allows creating @dfn{archives} of expressions which can be stored
2225 to or retrieved from files. To create an archive, you declare an object
2226 of class @code{archive} and archive expressions in it, giving each
2227 expression a unique name:
2228
2229 @example
2230 #include <ginac/ginac.h>
2231 #include <fstream>
2232 using namespace GiNaC;
2233
2234 int main()
2235 @{
2236     symbol x("x"), y("y"), z("z");
2237
2238     ex foo = sin(x + 2*y) + 3*z + 41;
2239     ex bar = foo + 1;
2240
2241     archive a;
2242     a.archive_ex(foo, "foo");
2243     a.archive_ex(bar, "the second one");
2244     // ...
2245 @end example
2246
2247 The archive can then be written to a file:
2248
2249 @example
2250     // ...
2251     ofstream out("foobar.gar");
2252     out << a;
2253     out.close();
2254     // ...
2255 @end example
2256
2257 The file @file{foobar.gar} contains all information that is needed to
2258 reconstruct the expressions @code{foo} and @code{bar}.
2259
2260 @cindex @command{viewgar}
2261 The tool @command{viewgar} that comes with GiNaC can be used to view
2262 the contents of GiNaC archive files:
2263
2264 @example
2265 $ viewgar foobar.gar
2266 foo = 41+sin(x+2*y)+3*z
2267 the second one = 42+sin(x+2*y)+3*z
2268 @end example
2269
2270 The point of writing archive files is of course that they can later be
2271 read in again:
2272
2273 @example
2274     // ...
2275     archive a2;
2276     ifstream in("foobar.gar");
2277     in >> a2;
2278     // ...
2279 @end example
2280
2281 And the stored expressions can be retrieved by their name:
2282
2283 @example
2284     // ...
2285     lst syms(x, y);
2286
2287     ex ex1 = a2.unarchive_ex(syms, "foo");
2288     ex ex2 = a2.unarchive_ex(syms, "the second one");
2289
2290     cout << ex1 << endl;              // prints "41+sin(x+2*y)+3*z"
2291     cout << ex2 << endl;              // prints "42+sin(x+2*y)+3*z"
2292     cout << ex1.subs(x == 2) << endl; // prints "41+sin(2+2*y)+3*z"
2293 @}
2294 @end example
2295
2296 Note that you have to supply a list of the symbols which are to be inserted
2297 in the expressions. Symbols in archives are stored by their name only and
2298 if you don't specify which symbols you have, unarchiving the expression will
2299 create new symbols with that name. E.g. if you hadn't included @code{x} in
2300 the @code{syms} list above, the @code{ex1.subs(x == 2)} statement would
2301 have had no effect because the @code{x} in @code{ex1} would have been a
2302 different symbol than the @code{x} which was defined at the beginning of
2303 the program, altough both would appear as @samp{x} when printed.
2304
2305
2306
2307 @node Extending GiNaC, What does not belong into GiNaC, Input/Output, Top
2308 @c    node-name, next, previous, up
2309 @chapter Extending GiNaC
2310
2311 By reading so far you should have gotten a fairly good understanding of
2312 GiNaC's design-patterns.  From here on you should start reading the
2313 sources.  All we can do now is issue some recommendations how to tackle
2314 GiNaC's many loose ends in order to fulfill everybody's dreams.  If you
2315 develop some useful extension please don't hesitate to contact the GiNaC
2316 authors---they will happily incorporate them into future versions.
2317
2318 @menu
2319 * What does not belong into GiNaC::  What to avoid.
2320 * Symbolic functions::               Implementing symbolic functions.
2321 @end menu
2322
2323
2324 @node What does not belong into GiNaC, Symbolic functions, Extending GiNaC, Extending GiNaC
2325 @c    node-name, next, previous, up
2326 @section What doesn't belong into GiNaC
2327
2328 @cindex @command{ginsh}
2329 First of all, GiNaC's name must be read literally.  It is designed to be
2330 a library for use within C++.  The tiny @command{ginsh} accompanying
2331 GiNaC makes this even more clear: it doesn't even attempt to provide a
2332 language.  There are no loops or conditional expressions in
2333 @command{ginsh}, it is merely a window into the library for the
2334 programmer to test stuff (or to show off).  Still, the design of a
2335 complete CAS with a language of its own, graphical capabilites and all
2336 this on top of GiNaC is possible and is without doubt a nice project for
2337 the future.
2338
2339 There are many built-in functions in GiNaC that do not know how to
2340 evaluate themselves numerically to a precision declared at runtime
2341 (using @code{Digits}).  Some may be evaluated at certain points, but not
2342 generally.  This ought to be fixed.  However, doing numerical
2343 computations with GiNaC's quite abstract classes is doomed to be
2344 inefficient.  For this purpose, the underlying foundation classes
2345 provided by @acronym{CLN} are much better suited.
2346
2347
2348 @node Symbolic functions, A Comparison With Other CAS, What does not belong into GiNaC, Extending GiNaC
2349 @c    node-name, next, previous, up
2350 @section Symbolic functions
2351
2352 The easiest and most instructive way to start with is probably to
2353 implement your own function.  GiNaC's functions are objects of class
2354 @code{function}.  The preprocessor is then used to convert the function
2355 names to objects with a corresponding serial number that is used
2356 internally to identify them.  You usually need not worry about this
2357 number.  New functions may be inserted into the system via a kind of
2358 `registry'.  It is your responsibility to care for some functions that
2359 are called when the user invokes certain methods.  These are usual
2360 C++-functions accepting a number of @code{ex} as arguments and returning
2361 one @code{ex}.  As an example, if we have a look at a simplified
2362 implementation of the cosine trigonometric function, we first need a
2363 function that is called when one wishes to @code{eval} it.  It could
2364 look something like this:
2365
2366 @example
2367 static ex cos_eval_method(const ex & x)
2368 @{
2369     // if (!x%(2*Pi)) return 1
2370     // if (!x%Pi) return -1
2371     // if (!x%Pi/2) return 0
2372     // care for other cases...
2373     return cos(x).hold();
2374 @}
2375 @end example
2376
2377 @cindex @code{hold()}
2378 @cindex evaluation
2379 The last line returns @code{cos(x)} if we don't know what else to do and
2380 stops a potential recursive evaluation by saying @code{.hold()}, which
2381 sets a flag to the expression signaling that it has been evaluated.  We
2382 should also implement a method for numerical evaluation and since we are
2383 lazy we sweep the problem under the rug by calling someone else's
2384 function that does so, in this case the one in class @code{numeric}:
2385
2386 @example
2387 static ex cos_evalf(const ex & x)
2388 @{
2389     return cos(ex_to_numeric(x));
2390 @}
2391 @end example
2392
2393 Differentiation will surely turn up and so we need to tell @code{cos}
2394 what the first derivative is (higher derivatives (@code{.diff(x,3)} for
2395 instance are then handled automatically by @code{basic::diff} and
2396 @code{ex::diff}):
2397
2398 @example
2399 static ex cos_deriv(const ex & x, unsigned diff_param)
2400 @{
2401     return -sin(x);
2402 @}
2403 @end example
2404
2405 @cindex product rule
2406 The second parameter is obligatory but uninteresting at this point.  It
2407 specifies which parameter to differentiate in a partial derivative in
2408 case the function has more than one parameter and its main application
2409 is for correct handling of the chain rule.  For Taylor expansion, it is
2410 enough to know how to differentiate.  But if the function you want to
2411 implement does have a pole somewhere in the complex plane, you need to
2412 write another method for Laurent expansion around that point.
2413
2414 Now that all the ingredients for @code{cos} have been set up, we need
2415 to tell the system about it.  This is done by a macro and we are not
2416 going to descibe how it expands, please consult your preprocessor if you
2417 are curious:
2418
2419 @example
2420 REGISTER_FUNCTION(cos, eval_func(cos_eval).
2421                        evalf_func(cos_evalf).
2422                        derivative_func(cos_deriv));
2423 @end example
2424
2425 The first argument is the function's name used for calling it and for
2426 output.  The second binds the corresponding methods as options to this
2427 object.  Options are separated by a dot and can be given in an arbitrary
2428 order.  GiNaC functions understand several more options which are always
2429 specified as @code{.option(params)}, for example a method for series
2430 expansion @code{.series_func(cos_series)}.  Again, if no series
2431 expansion method is given, GiNaC defaults to simple Taylor expansion,
2432 which is correct if there are no poles involved as is the case for the
2433 @code{cos} function.  The way GiNaC handles poles in case there are any
2434 is best understood by studying one of the examples, like the Gamma
2435 (@code{tgamma}) function for instance.  (In essence the function first
2436 checks if there is a pole at the evaluation point and falls back to
2437 Taylor expansion if there isn't.  Then, the pole is regularized by some
2438 suitable transformation.)  Also, the new function needs to be declared
2439 somewhere.  This may also be done by a convenient preprocessor macro:
2440
2441 @example
2442 DECLARE_FUNCTION_1P(cos)
2443 @end example
2444
2445 The suffix @code{_1P} stands for @emph{one parameter}.  Of course, this
2446 implementation of @code{cos} is very incomplete and lacks several safety
2447 mechanisms.  Please, have a look at the real implementation in GiNaC.
2448 (By the way: in case you are worrying about all the macros above we can
2449 assure you that functions are GiNaC's most macro-intense classes.  We
2450 have done our best to avoid macros where we can.)
2451
2452 That's it. May the source be with you!
2453
2454
2455 @node A Comparison With Other CAS, Advantages, Symbolic functions, Top
2456 @c    node-name, next, previous, up
2457 @chapter A Comparison With Other CAS
2458 @cindex advocacy
2459
2460 This chapter will give you some information on how GiNaC compares to
2461 other, traditional Computer Algebra Systems, like @emph{Maple},
2462 @emph{Mathematica} or @emph{Reduce}, where it has advantages and
2463 disadvantages over these systems.
2464
2465 @menu
2466 * Advantages::                       Stengths of the GiNaC approach.
2467 * Disadvantages::                    Weaknesses of the GiNaC approach.
2468 * Why C++?::                         Attractiveness of C++.
2469 @end menu
2470
2471 @node Advantages, Disadvantages, A Comparison With Other CAS, A Comparison With Other CAS
2472 @c    node-name, next, previous, up
2473 @section Advantages
2474
2475 GiNaC has several advantages over traditional Computer
2476 Algebra Systems, like 
2477
2478 @itemize @bullet
2479
2480 @item
2481 familiar language: all common CAS implement their own proprietary
2482 grammar which you have to learn first (and maybe learn again when your
2483 vendor decides to `enhance' it).  With GiNaC you can write your program
2484 in common C++, which is standardized.
2485
2486 @cindex STL
2487 @item
2488 structured data types: you can build up structured data types using
2489 @code{struct}s or @code{class}es together with STL features instead of
2490 using unnamed lists of lists of lists.
2491
2492 @item
2493 strongly typed: in CAS, you usually have only one kind of variables
2494 which can hold contents of an arbitrary type.  This 4GL like feature is
2495 nice for novice programmers, but dangerous.
2496     
2497 @item
2498 development tools: powerful development tools exist for C++, like fancy
2499 editors (e.g. with automatic indentation and syntax highlighting),
2500 debuggers, visualization tools, documentation generators...
2501
2502 @item
2503 modularization: C++ programs can easily be split into modules by
2504 separating interface and implementation.
2505
2506 @item
2507 price: GiNaC is distributed under the GNU Public License which means
2508 that it is free and available with source code.  And there are excellent
2509 C++-compilers for free, too.
2510     
2511 @item
2512 extendable: you can add your own classes to GiNaC, thus extending it on
2513 a very low level.  Compare this to a traditional CAS that you can
2514 usually only extend on a high level by writing in the language defined
2515 by the parser.  In particular, it turns out to be almost impossible to
2516 fix bugs in a traditional system.
2517
2518 @item
2519 multiple interfaces: Though real GiNaC programs have to be written in
2520 some editor, then be compiled, linked and executed, there are more ways
2521 to work with the GiNaC engine.  Many people want to play with
2522 expressions interactively, as in traditional CASs.  Currently, two such
2523 windows into GiNaC have been implemented and many more are possible: the
2524 tiny @command{ginsh} that is part of the distribution exposes GiNaC's
2525 types to a command line and second, as a more consistent approach, an
2526 interactive interface to the @acronym{Cint} C++ interpreter has been put
2527 together (called @acronym{GiNaC-cint}) that allows an interactive
2528 scripting interface consistent with the C++ language.
2529
2530 @item
2531 seemless integration: it is somewhere between difficult and impossible
2532 to call CAS functions from within a program written in C++ or any other
2533 programming language and vice versa.  With GiNaC, your symbolic routines
2534 are part of your program.  You can easily call third party libraries,
2535 e.g. for numerical evaluation or graphical interaction.  All other
2536 approaches are much more cumbersome: they range from simply ignoring the
2537 problem (i.e. @emph{Maple}) to providing a method for `embedding' the
2538 system (i.e. @emph{Yacas}).
2539
2540 @item
2541 efficiency: often large parts of a program do not need symbolic
2542 calculations at all.  Why use large integers for loop variables or
2543 arbitrary precision arithmetics where @code{int} and @code{double} are
2544 sufficient?  For pure symbolic applications, GiNaC is comparable in
2545 speed with other CAS.
2546
2547 @end itemize
2548
2549
2550 @node Disadvantages, Why C++?, Advantages, A Comparison With Other CAS
2551 @c    node-name, next, previous, up
2552 @section Disadvantages
2553
2554 Of course it also has some disadvantages:
2555
2556 @itemize @bullet
2557
2558 @item
2559 advanced features: GiNaC cannot compete with a program like
2560 @emph{Reduce} which exists for more than 30 years now or @emph{Maple}
2561 which grows since 1981 by the work of dozens of programmers, with
2562 respect to mathematical features.  Integration, factorization,
2563 non-trivial simplifications, limits etc. are missing in GiNaC (and are
2564 not planned for the near future).
2565
2566 @item
2567 portability: While the GiNaC library itself is designed to avoid any
2568 platform dependent features (it should compile on any ANSI compliant C++
2569 compiler), the currently used version of the CLN library (fast large
2570 integer and arbitrary precision arithmetics) can be compiled only on
2571 systems with a recently new C++ compiler from the GNU Compiler
2572 Collection (@acronym{GCC}).@footnote{This is because CLN uses
2573 PROVIDE/REQUIRE like macros to let the compiler gather all static
2574 initializations, which works for GNU C++ only.}  GiNaC uses recent
2575 language features like explicit constructors, mutable members, RTTI,
2576 @code{dynamic_cast}s and STL, so ANSI compliance is meant literally.
2577 Recent @acronym{GCC} versions starting at 2.95, although itself not yet
2578 ANSI compliant, support all needed features.
2579     
2580 @end itemize
2581
2582
2583 @node Why C++?, Internal Structures, Disadvantages, A Comparison With Other CAS
2584 @c    node-name, next, previous, up
2585 @section Why C++?
2586
2587 Why did we choose to implement GiNaC in C++ instead of Java or any other
2588 language?  C++ is not perfect: type checking is not strict (casting is
2589 possible), separation between interface and implementation is not
2590 complete, object oriented design is not enforced.  The main reason is
2591 the often scolded feature of operator overloading in C++.  While it may
2592 be true that operating on classes with a @code{+} operator is rarely
2593 meaningful, it is perfectly suited for algebraic expressions.  Writing
2594 @math{3x+5y} as @code{3*x+5*y} instead of
2595 @code{x.times(3).plus(y.times(5))} looks much more natural.
2596 Furthermore, the main developers are more familiar with C++ than with
2597 any other programming language.
2598
2599
2600 @node Internal Structures, Expressions are reference counted, Why C++? , Top
2601 @c    node-name, next, previous, up
2602 @appendix Internal Structures
2603
2604 @menu
2605 * Expressions are reference counted::
2606 * Internal representation of products and sums::
2607 @end menu
2608
2609 @node Expressions are reference counted, Internal representation of products and sums, Internal Structures, Internal Structures
2610 @c    node-name, next, previous, up
2611 @appendixsection Expressions are reference counted
2612
2613 @cindex reference counting
2614 @cindex copy-on-write
2615 @cindex garbage collection
2616 An expression is extremely light-weight since internally it works like a
2617 handle to the actual representation and really holds nothing more than a
2618 pointer to some other object. What this means in practice is that
2619 whenever you create two @code{ex} and set the second equal to the first
2620 no copying process is involved. Instead, the copying takes place as soon
2621 as you try to change the second.  Consider the simple sequence of code:
2622
2623 @example
2624 #include <ginac/ginac.h>
2625 using namespace GiNaC;
2626
2627 int main()
2628 @{
2629     symbol x("x"), y("y"), z("z");
2630     ex e1, e2;
2631
2632     e1 = sin(x + 2*y) + 3*z + 41;
2633     e2 = e1;                // e2 points to same object as e1
2634     cout << e2 << endl;     // prints sin(x+2*y)+3*z+41
2635     e2 += 1;                // e2 is copied into a new object
2636     cout << e2 << endl;     // prints sin(x+2*y)+3*z+42
2637 @}
2638 @end example
2639
2640 The line @code{e2 = e1;} creates a second expression pointing to the
2641 object held already by @code{e1}.  The time involved for this operation
2642 is therefore constant, no matter how large @code{e1} was.  Actual
2643 copying, however, must take place in the line @code{e2 += 1;} because
2644 @code{e1} and @code{e2} are not handles for the same object any more.
2645 This concept is called @dfn{copy-on-write semantics}.  It increases
2646 performance considerably whenever one object occurs multiple times and
2647 represents a simple garbage collection scheme because when an @code{ex}
2648 runs out of scope its destructor checks whether other expressions handle
2649 the object it points to too and deletes the object from memory if that
2650 turns out not to be the case.  A slightly less trivial example of
2651 differentiation using the chain-rule should make clear how powerful this
2652 can be:
2653
2654 @example
2655 #include <ginac/ginac.h>
2656 using namespace GiNaC;
2657
2658 int main()
2659 @{
2660     symbol x("x"), y("y");
2661
2662     ex e1 = x + 3*y;
2663     ex e2 = pow(e1, 3);
2664     ex e3 = diff(sin(e2), x);   // first derivative of sin(e2) by x
2665     cout << e1 << endl          // prints x+3*y
2666          << e2 << endl          // prints (x+3*y)^3
2667          << e3 << endl;         // prints 3*(x+3*y)^2*cos((x+3*y)^3)
2668 @}
2669 @end example
2670
2671 Here, @code{e1} will actually be referenced three times while @code{e2}
2672 will be referenced two times.  When the power of an expression is built,
2673 that expression needs not be copied.  Likewise, since the derivative of
2674 a power of an expression can be easily expressed in terms of that
2675 expression, no copying of @code{e1} is involved when @code{e3} is
2676 constructed.  So, when @code{e3} is constructed it will print as
2677 @code{3*(x+3*y)^2*cos((x+3*y)^3)} but the argument of @code{cos()} only
2678 holds a reference to @code{e2} and the factor in front is just
2679 @code{3*e1^2}.
2680
2681 As a user of GiNaC, you cannot see this mechanism of copy-on-write
2682 semantics.  When you insert an expression into a second expression, the
2683 result behaves exactly as if the contents of the first expression were
2684 inserted.  But it may be useful to remember that this is not what
2685 happens.  Knowing this will enable you to write much more efficient
2686 code.  If you still have an uncertain feeling with copy-on-write
2687 semantics, we recommend you have a look at the
2688 @uref{http://www.cerfnet.com/~mpcline/c++-faq-lite/, C++-FAQ lite} by
2689 Marshall Cline.  Chapter 16 covers this issue and presents an
2690 implementation which is pretty close to the one in GiNaC.
2691
2692
2693 @node Internal representation of products and sums, Package Tools, Expressions are reference counted, Internal Structures
2694 @c    node-name, next, previous, up
2695 @appendixsection Internal representation of products and sums
2696
2697 @cindex representation
2698 @cindex @code{add}
2699 @cindex @code{mul}
2700 @cindex @code{power}
2701 Although it should be completely transparent for the user of
2702 GiNaC a short discussion of this topic helps to understand the sources
2703 and also explain performance to a large degree.  Consider the 
2704 unexpanded symbolic expression 
2705 @tex
2706 $2d^3 \left( 4a + 5b - 3 \right)$
2707 @end tex
2708 @ifnottex
2709 @math{2*d^3*(4*a+5*b-3)}
2710 @end ifnottex
2711 which could naively be represented by a tree of linear containers for
2712 addition and multiplication, one container for exponentiation with base
2713 and exponent and some atomic leaves of symbols and numbers in this
2714 fashion:
2715
2716 @image{repnaive}
2717
2718 @cindex pair-wise representation
2719 However, doing so results in a rather deeply nested tree which will
2720 quickly become inefficient to manipulate.  We can improve on this by
2721 representing the sum as a sequence of terms, each one being a pair of a
2722 purely numeric multiplicative coefficient and its rest.  In the same
2723 spirit we can store the multiplication as a sequence of terms, each
2724 having a numeric exponent and a possibly complicated base, the tree
2725 becomes much more flat:
2726
2727 @image{reppair}
2728
2729 The number @code{3} above the symbol @code{d} shows that @code{mul}
2730 objects are treated similarly where the coefficients are interpreted as
2731 @emph{exponents} now.  Addition of sums of terms or multiplication of
2732 products with numerical exponents can be coded to be very efficient with
2733 such a pair-wise representation.  Internally, this handling is performed
2734 by most CAS in this way.  It typically speeds up manipulations by an
2735 order of magnitude.  The overall multiplicative factor @code{2} and the
2736 additive term @code{-3} look somewhat out of place in this
2737 representation, however, since they are still carrying a trivial
2738 exponent and multiplicative factor @code{1} respectively.  Within GiNaC,
2739 this is avoided by adding a field that carries an overall numeric
2740 coefficient.  This results in the realistic picture of internal
2741 representation for
2742 @tex
2743 $2d^3 \left( 4a + 5b - 3 \right)$:
2744 @end tex
2745 @ifnottex
2746 @math{2*d^3*(4*a+5*b-3)}:
2747 @end ifnottex
2748
2749 @image{repreal}
2750
2751 @cindex radical
2752 This also allows for a better handling of numeric radicals, since
2753 @code{sqrt(2)} can now be carried along calculations.  Now it should be
2754 clear, why both classes @code{add} and @code{mul} are derived from the
2755 same abstract class: the data representation is the same, only the
2756 semantics differs.  In the class hierarchy, methods for polynomial
2757 expansion and the like are reimplemented for @code{add} and @code{mul},
2758 but the data structure is inherited from @code{expairseq}.
2759
2760
2761 @node Package Tools, ginac-config, Internal representation of products and sums, Top
2762 @c    node-name, next, previous, up
2763 @appendix Package Tools
2764
2765 If you are creating a software package that uses the GiNaC library,
2766 setting the correct command line options for the compiler and linker
2767 can be difficult. GiNaC includes two tools to make this process easier.
2768
2769 @menu
2770 * ginac-config::   A shell script to detect compiler and linker flags.
2771 * AM_PATH_GINAC::  Macro for GNU automake.
2772 @end menu
2773
2774
2775 @node ginac-config, AM_PATH_GINAC, Package Tools, Package Tools
2776 @c    node-name, next, previous, up
2777 @section @command{ginac-config}
2778 @cindex ginac-config
2779
2780 @command{ginac-config} is a shell script that you can use to determine
2781 the compiler and linker command line options required to compile and
2782 link a program with the GiNaC library.
2783
2784 @command{ginac-config} takes the following flags:
2785
2786 @table @samp
2787 @item --version
2788 Prints out the version of GiNaC installed.
2789 @item --cppflags
2790 Prints '-I' flags pointing to the installed header files.
2791 @item --libs
2792 Prints out the linker flags necessary to link a program against GiNaC.
2793 @item --prefix[=@var{PREFIX}]
2794 If @var{PREFIX} is specified, overrides the configured value of @env{$prefix}.
2795 (And of exec-prefix, unless @code{--exec-prefix} is also specified)
2796 Otherwise, prints out the configured value of @env{$prefix}.
2797 @item --exec-prefix[=@var{PREFIX}]
2798 If @var{PREFIX} is specified, overrides the configured value of @env{$exec_prefix}.
2799 Otherwise, prints out the configured value of @env{$exec_prefix}.
2800 @end table
2801
2802 Typically, @command{ginac-config} will be used within a configure
2803 script, as described below. It, however, can also be used directly from
2804 the command line using backquotes to compile a simple program. For
2805 example:
2806
2807 @example
2808 c++ -o simple `ginac-config --cppflags` simple.cpp `ginac-config --libs`
2809 @end example
2810
2811 This command line might expand to (for example):
2812
2813 @example
2814 cc -o simple -I/usr/local/include simple.cpp -L/usr/local/lib \
2815   -lginac -lcln -lstdc++
2816 @end example
2817
2818 Not only is the form using @command{ginac-config} easier to type, it will
2819 work on any system, no matter how GiNaC was configured.
2820
2821
2822 @node AM_PATH_GINAC, Configure script options, ginac-config, Package Tools
2823 @c    node-name, next, previous, up
2824 @section @samp{AM_PATH_GINAC}
2825 @cindex AM_PATH_GINAC
2826
2827 For packages configured using GNU automake, GiNaC also provides
2828 a macro to automate the process of checking for GiNaC.
2829
2830 @example
2831 AM_PATH_GINAC([@var{MINIMUM-VERSION}, [@var{ACTION-IF-FOUND} [, @var{ACTION-IF-NOT-FOUND}]]])
2832 @end example
2833
2834 This macro:
2835
2836 @itemize @bullet
2837
2838 @item
2839 Determines the location of GiNaC using @command{ginac-config}, which is
2840 either found in the user's path, or from the environment variable
2841 @env{GINACLIB_CONFIG}.
2842
2843 @item
2844 Tests the installed libraries to make sure that their version
2845 is later than @var{MINIMUM-VERSION}. (A default version will be used
2846 if not specified)
2847
2848 @item
2849 If the required version was found, sets the @env{GINACLIB_CPPFLAGS} variable
2850 to the output of @command{ginac-config --cppflags} and the @env{GINACLIB_LIBS}
2851 variable to the output of @command{ginac-config --libs}, and calls
2852 @samp{AC_SUBST()} for these variables so they can be used in generated
2853 makefiles, and then executes @var{ACTION-IF-FOUND}.
2854
2855 @item
2856 If the required version was not found, sets @env{GINACLIB_CPPFLAGS} and
2857 @env{GINACLIB_LIBS} to empty strings, and executes @var{ACTION-IF-NOT-FOUND}.
2858
2859 @end itemize
2860
2861 This macro is in file @file{ginac.m4} which is installed in
2862 @file{$datadir/aclocal}. Note that if automake was installed with a
2863 different @samp{--prefix} than GiNaC, you will either have to manually
2864 move @file{ginac.m4} to automake's @file{$datadir/aclocal}, or give
2865 aclocal the @samp{-I} option when running it.
2866
2867 @menu
2868 * Configure script options::  Configuring a package that uses AM_PATH_GINAC.
2869 * Example package::           Example of a package using AM_PATH_GINAC.
2870 @end menu
2871
2872
2873 @node Configure script options, Example package, AM_PATH_GINAC, AM_PATH_GINAC
2874 @c    node-name, next, previous, up
2875 @subsection Configuring a package that uses @samp{AM_PATH_GINAC}
2876
2877 Simply make sure that @command{ginac-config} is in your path, and run
2878 the configure script.
2879
2880 Notes:
2881
2882 @itemize @bullet
2883
2884 @item
2885 The directory where the GiNaC libraries are installed needs
2886 to be found by your system's dynamic linker.
2887   
2888 This is generally done by
2889
2890 @display
2891 editing @file{/etc/ld.so.conf} and running @command{ldconfig}
2892 @end display
2893
2894 or by
2895    
2896 @display
2897 setting the environment variable @env{LD_LIBRARY_PATH},
2898 @end display
2899
2900 or, as a last resort, 
2901  
2902 @display
2903 giving a @samp{-R} or @samp{-rpath} flag (depending on your linker) when
2904 running configure, for instance:
2905
2906 @example
2907 LDFLAGS=-R/home/cbauer/lib ./configure
2908 @end example
2909 @end display
2910
2911 @item
2912 You can also specify a @command{ginac-config} not in your path by
2913 setting the @env{GINACLIB_CONFIG} environment variable to the
2914 name of the executable
2915
2916 @item
2917 If you move the GiNaC package from its installed location,
2918 you will either need to modify @command{ginac-config} script
2919 manually to point to the new location or rebuild GiNaC.
2920
2921 @end itemize
2922
2923 Advanced note:
2924
2925 @itemize @bullet
2926 @item
2927 configure flags
2928   
2929 @example
2930 --with-ginac-prefix=@var{PREFIX}
2931 --with-ginac-exec-prefix=@var{PREFIX}
2932 @end example
2933
2934 are provided to override the prefix and exec-prefix that were stored
2935 in the @command{ginac-config} shell script by GiNaC's configure. You are
2936 generally better off configuring GiNaC with the right path to begin with.
2937 @end itemize
2938
2939
2940 @node Example package, Bibliography, Configure script options, AM_PATH_GINAC
2941 @c    node-name, next, previous, up
2942 @subsection Example of a package using @samp{AM_PATH_GINAC}
2943
2944 The following shows how to build a simple package using automake
2945 and the @samp{AM_PATH_GINAC} macro. The program used here is @file{simple.cpp}:
2946
2947 @example
2948 #include <ginac/ginac.h>
2949 using namespace GiNaC;
2950
2951 int main(void)
2952 @{
2953     symbol x("x");
2954     ex a = sin(x); 
2955     cout << "Derivative of " << a << " is " << a.diff(x) << endl;
2956     return 0;
2957 @}
2958 @end example
2959
2960 You should first read the introductory portions of the automake
2961 Manual, if you are not already familiar with it.
2962
2963 Two files are needed, @file{configure.in}, which is used to build the
2964 configure script:
2965
2966 @example
2967 dnl Process this file with autoconf to produce a configure script.
2968 AC_INIT(simple.cpp)
2969 AM_INIT_AUTOMAKE(simple.cpp, 1.0.0)
2970
2971 AC_PROG_CXX
2972 AC_PROG_INSTALL
2973 AC_LANG_CPLUSPLUS
2974
2975 AM_PATH_GINAC(0.4.0, [
2976   LIBS="$LIBS $GINACLIB_LIBS"
2977   CPPFLAGS="$CFLAGS $GINACLIB_CPPFLAGS"  
2978 ], AC_MSG_ERROR([need to have GiNaC installed]))
2979
2980 AC_OUTPUT(Makefile)
2981 @end example
2982
2983 The only command in this which is not standard for automake
2984 is the @samp{AM_PATH_GINAC} macro.
2985
2986 That command does the following:
2987
2988 @display
2989 If a GiNaC version greater than 0.4.0 is found, adds @env{$GINACLIB_LIBS} to 
2990 @env{$LIBS} and @env{$GINACLIB_CPPFLAGS} to @env{$CPPFLAGS}. Otherwise, dies
2991 with the error message `need to have GiNaC installed'
2992 @end display
2993
2994 And the @file{Makefile.am}, which will be used to build the Makefile.
2995
2996 @example
2997 ## Process this file with automake to produce Makefile.in
2998 bin_PROGRAMS = simple
2999 simple_SOURCES = simple.cpp
3000 @end example
3001
3002 This @file{Makefile.am}, says that we are building a single executable,
3003 from a single sourcefile @file{simple.cpp}. Since every program
3004 we are building uses GiNaC we simply added the GiNaC options
3005 to @env{$LIBS} and @env{$CPPFLAGS}, but in other circumstances, we might
3006 want to specify them on a per-program basis: for instance by
3007 adding the lines:
3008
3009 @example
3010 simple_LDADD = $(GINACLIB_LIBS)
3011 INCLUDES = $(GINACLIB_CPPFLAGS)
3012 @end example
3013
3014 to the @file{Makefile.am}.
3015
3016 To try this example out, create a new directory and add the three
3017 files above to it.
3018
3019 Now execute the following commands:
3020
3021 @example
3022 $ automake --add-missing
3023 $ aclocal
3024 $ autoconf
3025 @end example
3026
3027 You now have a package that can be built in the normal fashion
3028
3029 @example
3030 $ ./configure
3031 $ make
3032 $ make install
3033 @end example
3034
3035
3036 @node Bibliography, Concept Index, Example package, Top
3037 @c    node-name, next, previous, up
3038 @appendix Bibliography
3039
3040 @itemize @minus{}
3041
3042 @item
3043 @cite{ISO/IEC 14882:1998: Programming Languages: C++}
3044
3045 @item
3046 @cite{CLN: A Class Library for Numbers}, @email{haible@@ilog.fr, Bruno Haible}
3047
3048 @item
3049 @cite{The C++ Programming Language}, Bjarne Stroustrup, 3rd Edition, ISBN 0-201-88954-4, Addison Wesley
3050
3051 @item
3052 @cite{C++ FAQs}, Marshall Cline, ISBN 0-201-58958-3, 1995, Addison Wesley
3053
3054 @item
3055 @cite{Algorithms for Computer Algebra}, Keith O. Geddes, Stephen R. Czapor,
3056 and George Labahn, ISBN 0-7923-9259-0, 1992, Kluwer Academic Publishers, Norwell, Massachusetts
3057
3058 @item
3059 @cite{Computer Algebra: Systems and Algorithms for Algebraic Computation},
3060 J.H. Davenport, Y. Siret, and E. Tournier, ISBN 0-12-204230-1, 1988, 
3061 Academic Press, London
3062
3063 @end itemize
3064
3065
3066 @node Concept Index, , Bibliography, Top
3067 @c    node-name, next, previous, up
3068 @unnumbered Concept Index
3069
3070 @printindex cp
3071
3072 @bye
3073