d4348f3644cf2df9505d10eefb827e8942ae46dc
[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-2001 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-2001 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-2001 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{ex_to_numeric()}
1304 @cindex @code{ex_to_@dots{}}
1305 @cindex @code{Converting ex to other classes}
1306 @cindex @code{info()}
1307
1308 Sometimes it's useful to check whether a given expression is a plain number,
1309 a sum, a polynomial with integer coefficients, or of some other specific type.
1310 GiNaC provides two functions for this (the first one is actually a macro):
1311
1312 @example
1313 bool is_ex_of_type(const ex & e, TYPENAME t);
1314 bool ex::info(unsigned flag);
1315 @end example
1316
1317 When the test made by @code{is_ex_of_type()} returns true, it is safe to
1318 call one of the functions @code{ex_to_@dots{}}, where @code{@dots{}} is
1319 one of the class names (@xref{The Class Hierarchy}, for a list of all
1320 classes). For example, assuming @code{e} is an @code{ex}:
1321
1322 @example
1323 @{
1324     @dots{}
1325     if (is_ex_of_type(e, numeric))
1326         numeric n = ex_to_numeric(e);
1327     @dots{}
1328 @}
1329 @end example
1330
1331 @code{is_ex_of_type()} allows you to check whether the top-level object of
1332 an expression @samp{e} is an instance of the GiNaC class @samp{t}
1333 (@xref{The Class Hierarchy}, for a list of all classes). This is most useful,
1334 e.g., for checking whether an expression is a number, a sum, or a product:
1335
1336 @example
1337 @{
1338     symbol x("x");
1339     ex e1 = 42;
1340     ex e2 = 4*x - 3;
1341     is_ex_of_type(e1, numeric);  // true
1342     is_ex_of_type(e2, numeric);  // false
1343     is_ex_of_type(e1, add);      // false
1344     is_ex_of_type(e2, add);      // true
1345     is_ex_of_type(e1, mul);      // false
1346     is_ex_of_type(e2, mul);      // false
1347 @}
1348 @end example
1349
1350 The @code{info()} method is used for checking certain attributes of
1351 expressions. The possible values for the @code{flag} argument are defined
1352 in @file{ginac/flags.h}, the most important being explained in the following
1353 table:
1354
1355 @cartouche
1356 @multitable @columnfractions .30 .70
1357 @item @strong{Flag} @tab @strong{Returns true if the object is@dots{}}
1358 @item @code{numeric}
1359 @tab @dots{}a number (same as @code{is_ex_of_type(..., numeric)})
1360 @item @code{real}
1361 @tab @dots{}a real integer, rational or float (i.e. is not complex)
1362 @item @code{rational}
1363 @tab @dots{}an exact rational number (integers are rational, too)
1364 @item @code{integer}
1365 @tab @dots{}a (non-complex) integer
1366 @item @code{crational}
1367 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
1368 @item @code{cinteger}
1369 @tab @dots{}a (complex) integer (such as @math{2-3*I})
1370 @item @code{positive}
1371 @tab @dots{}not complex and greater than 0
1372 @item @code{negative}
1373 @tab @dots{}not complex and less than 0
1374 @item @code{nonnegative}
1375 @tab @dots{}not complex and greater than or equal to 0
1376 @item @code{posint}
1377 @tab @dots{}an integer greater than 0
1378 @item @code{negint}
1379 @tab @dots{}an integer less than 0
1380 @item @code{nonnegint}
1381 @tab @dots{}an integer greater than or equal to 0
1382 @item @code{even}
1383 @tab @dots{}an even integer
1384 @item @code{odd}
1385 @tab @dots{}an odd integer
1386 @item @code{prime}
1387 @tab @dots{}a prime integer (probabilistic primality test)
1388 @item @code{relation}
1389 @tab @dots{}a relation (same as @code{is_ex_of_type(..., relational)})
1390 @item @code{relation_equal}
1391 @tab @dots{}a @code{==} relation
1392 @item @code{relation_not_equal}
1393 @tab @dots{}a @code{!=} relation
1394 @item @code{relation_less}
1395 @tab @dots{}a @code{<} relation
1396 @item @code{relation_less_or_equal}
1397 @tab @dots{}a @code{<=} relation
1398 @item @code{relation_greater}
1399 @tab @dots{}a @code{>} relation
1400 @item @code{relation_greater_or_equal}
1401 @tab @dots{}a @code{>=} relation
1402 @item @code{symbol}
1403 @tab @dots{}a symbol (same as @code{is_ex_of_type(..., symbol)})
1404 @item @code{list}
1405 @tab @dots{}a list (same as @code{is_ex_of_type(..., lst)})
1406 @item @code{polynomial}
1407 @tab @dots{}a polynomial (i.e. only consists of sums and products of numbers and symbols with positive integer powers)
1408 @item @code{integer_polynomial}
1409 @tab @dots{}a polynomial with (non-complex) integer coefficients
1410 @item @code{cinteger_polynomial}
1411 @tab @dots{}a polynomial with (possibly complex) integer coefficients (such as @math{2-3*I})
1412 @item @code{rational_polynomial}
1413 @tab @dots{}a polynomial with (non-complex) rational coefficients
1414 @item @code{crational_polynomial}
1415 @tab @dots{}a polynomial with (possibly complex) rational coefficients (such as @math{2/3+7/2*I})
1416 @item @code{rational_function}
1417 @tab @dots{}a rational function (@math{x+y}, @math{z/(x+y)})
1418 @item @code{algebraic}
1419 @tab @dots{}an algebraic object (@math{sqrt(2)}, @math{sqrt(x)-1})
1420 @end multitable
1421 @end cartouche
1422
1423
1424 @subsection Accessing subexpressions
1425 @cindex @code{nops()}
1426 @cindex @code{op()}
1427 @cindex @code{has()}
1428 @cindex container
1429 @cindex @code{relational} (class)
1430
1431 GiNaC provides the two methods
1432
1433 @example
1434 unsigned ex::nops();
1435 ex ex::op(unsigned i);
1436 @end example
1437
1438 for accessing the subexpressions in the container-like GiNaC classes like
1439 @code{add}, @code{mul}, @code{lst}, and @code{function}. @code{nops()}
1440 determines the number of subexpressions (@samp{operands}) contained, while
1441 @code{op()} returns the @code{i}-th (0..@code{nops()-1}) subexpression.
1442 In the case of a @code{power} object, @code{op(0)} will return the basis
1443 and @code{op(1)} the exponent.
1444
1445 The left-hand and right-hand side expressions of objects of class
1446 @code{relational} (and only of these) can also be accessed with the methods
1447
1448 @example
1449 ex ex::lhs();
1450 ex ex::rhs();
1451 @end example
1452
1453 Finally, the method
1454
1455 @example
1456 bool ex::has(const ex & other);
1457 @end example
1458
1459 checks whether an expression contains the given subexpression @code{other}.
1460 This only works reliably if @code{other} is of an atomic class such as a
1461 @code{numeric} or a @code{symbol}. It is, e.g., not possible to verify that
1462 @code{a+b+c} contains @code{a+c} (or @code{a+b}) as a subexpression.
1463
1464
1465 @subsection Comparing expressions
1466 @cindex @code{is_equal()}
1467 @cindex @code{is_zero()}
1468
1469 Expressions can be compared with the usual C++ relational operators like
1470 @code{==}, @code{>}, and @code{<} but if the expressions contain symbols,
1471 the result is usually not determinable and the result will be @code{false},
1472 except in the case of the @code{!=} operator. You should also be aware that
1473 GiNaC will only do the most trivial test for equality (subtracting both
1474 expressions), so something like @code{(pow(x,2)+x)/x==x+1} will return
1475 @code{false}.
1476
1477 Actually, if you construct an expression like @code{a == b}, this will be
1478 represented by an object of the @code{relational} class (@xref{Relations}.)
1479 which is not evaluated until (explicitly or implicitely) cast to a @code{bool}.
1480
1481 There are also two methods
1482
1483 @example
1484 bool ex::is_equal(const ex & other);
1485 bool ex::is_zero();
1486 @end example
1487
1488 for checking whether one expression is equal to another, or equal to zero,
1489 respectively.
1490
1491 @strong{Warning:} You will also find an @code{ex::compare()} method in the
1492 GiNaC header files. This method is however only to be used internally by
1493 GiNaC to establish a canonical sort order for terms, and using it to compare
1494 expressions will give very surprising results.
1495
1496
1497 @node Substituting Symbols, Polynomial Arithmetic, Information About Expressions, Methods and Functions
1498 @c    node-name, next, previous, up
1499 @section Substituting symbols
1500 @cindex @code{subs()}
1501
1502 Symbols can be replaced with expressions via the @code{.subs()} method:
1503
1504 @example
1505 ex ex::subs(const ex & e);
1506 ex ex::subs(const lst & syms, const lst & repls);
1507 @end example
1508
1509 In the first form, @code{subs()} accepts a relational of the form
1510 @samp{symbol == expression} or a @code{lst} of such relationals. E.g.
1511
1512 @example
1513 @{
1514     symbol x("x"), y("y");
1515     ex e1 = 2*x^2-4*x+3;
1516     cout << "e1(7) = " << e1.subs(x == 7) << endl;
1517     ex e2 = x*y + x;
1518     cout << "e2(-2, 4) = " << e2.subs(lst(x == -2, y == 4)) << endl;
1519 @}
1520 @end example
1521
1522 will print @samp{73} and @samp{-10}, respectively.
1523
1524 If you specify multiple substitutions, they are performed in parallel, so e.g.
1525 @code{subs(lst(x == y, y == x))} exchanges @samp{x} and @samp{y}.
1526
1527 The second form of @code{subs()} takes two lists, one for the symbols and
1528 one for the expressions to be substituted (both lists must contain the same
1529 number of elements). Using this form, you would write @code{subs(lst(x, y), lst(y, x))}
1530 to exchange @samp{x} and @samp{y}.
1531
1532
1533 @node Polynomial Arithmetic, Rational Expressions, Substituting Symbols, Methods and Functions
1534 @c    node-name, next, previous, up
1535 @section Polynomial arithmetic
1536
1537 @subsection Expanding and collecting
1538 @cindex @code{expand()}
1539 @cindex @code{collect()}
1540
1541 A polynomial in one or more variables has many equivalent
1542 representations.  Some useful ones serve a specific purpose.  Consider
1543 for example the trivariate polynomial @math{4*x*y + x*z + 20*y^2 +
1544 21*y*z + 4*z^2} (written down here in output-style).  It is equivalent
1545 to the factorized polynomial @math{(x + 5*y + 4*z)*(4*y + z)}.  Other
1546 representations are the recursive ones where one collects for exponents
1547 in one of the three variable.  Since the factors are themselves
1548 polynomials in the remaining two variables the procedure can be
1549 repeated.  In our expample, two possibilities would be @math{(4*y + z)*x
1550 + 20*y^2 + 21*y*z + 4*z^2} and @math{20*y^2 + (21*z + 4*x)*y + 4*z^2 +
1551 x*z}.
1552
1553 To bring an expression into expanded form, its method
1554
1555 @example
1556 ex ex::expand();
1557 @end example
1558
1559 may be called.  In our example above, this corresponds to @math{4*x*y +
1560 x*z + 20*y^2 + 21*y*z + 4*z^2}.  Again, since the canonical form in
1561 GiNaC is not easily guessable you should be prepared to see different
1562 orderings of terms in such sums!
1563
1564 Another useful representation of multivariate polynomials is as a
1565 univariate polynomial in one of the variables with the coefficients
1566 being polynomials in the remaining variables.  The method
1567 @code{collect()} accomplishes this task:
1568
1569 @example
1570 ex ex::collect(const symbol & s);
1571 @end example
1572
1573 Note that the original polynomial needs to be in expanded form in order
1574 to be able to find the coefficients properly.
1575
1576 @subsection Degree and coefficients
1577 @cindex @code{degree()}
1578 @cindex @code{ldegree()}
1579 @cindex @code{coeff()}
1580
1581 The degree and low degree of a polynomial can be obtained using the two
1582 methods
1583
1584 @example
1585 int ex::degree(const symbol & s);
1586 int ex::ldegree(const symbol & s);
1587 @end example
1588
1589 which also work reliably on non-expanded input polynomials (they even work
1590 on rational functions, returning the asymptotic degree). To extract
1591 a coefficient with a certain power from an expanded polynomial you use
1592
1593 @example
1594 ex ex::coeff(const symbol & s, int n);
1595 @end example
1596
1597 You can also obtain the leading and trailing coefficients with the methods
1598
1599 @example
1600 ex ex::lcoeff(const symbol & s);
1601 ex ex::tcoeff(const symbol & s);
1602 @end example
1603
1604 which are equivalent to @code{coeff(s, degree(s))} and @code{coeff(s, ldegree(s))},
1605 respectively.
1606
1607 An application is illustrated in the next example, where a multivariate
1608 polynomial is analyzed:
1609
1610 @example
1611 #include <ginac/ginac.h>
1612 using namespace GiNaC;
1613
1614 int main()
1615 @{
1616     symbol x("x"), y("y");
1617     ex PolyInp = 4*pow(x,3)*y + 5*x*pow(y,2) + 3*y
1618                  - pow(x+y,2) + 2*pow(y+2,2) - 8;
1619     ex Poly = PolyInp.expand();
1620     
1621     for (int i=Poly.ldegree(x); i<=Poly.degree(x); ++i) @{
1622         cout << "The x^" << i << "-coefficient is "
1623              << Poly.coeff(x,i) << endl;
1624     @}
1625     cout << "As polynomial in y: " 
1626          << Poly.collect(y) << endl;
1627 @}
1628 @end example
1629
1630 When run, it returns an output in the following fashion:
1631
1632 @example
1633 The x^0-coefficient is y^2+11*y
1634 The x^1-coefficient is 5*y^2-2*y
1635 The x^2-coefficient is -1
1636 The x^3-coefficient is 4*y
1637 As polynomial in y: -x^2+(5*x+1)*y^2+(-2*x+4*x^3+11)*y
1638 @end example
1639
1640 As always, the exact output may vary between different versions of GiNaC
1641 or even from run to run since the internal canonical ordering is not
1642 within the user's sphere of influence.
1643
1644
1645 @subsection Polynomial division
1646 @cindex polynomial division
1647 @cindex quotient
1648 @cindex remainder
1649 @cindex pseudo-remainder
1650 @cindex @code{quo()}
1651 @cindex @code{rem()}
1652 @cindex @code{prem()}
1653 @cindex @code{divide()}
1654
1655 The two functions
1656
1657 @example
1658 ex quo(const ex & a, const ex & b, const symbol & x);
1659 ex rem(const ex & a, const ex & b, const symbol & x);
1660 @end example
1661
1662 compute the quotient and remainder of univariate polynomials in the variable
1663 @samp{x}. The results satisfy @math{a = b*quo(a, b, x) + rem(a, b, x)}.
1664
1665 The additional function
1666
1667 @example
1668 ex prem(const ex & a, const ex & b, const symbol & x);
1669 @end example
1670
1671 computes the pseudo-remainder of @samp{a} and @samp{b} which satisfies
1672 @math{c*a = b*q + prem(a, b, x)}, where @math{c = b.lcoeff(x) ^ (a.degree(x) - b.degree(x) + 1)}.
1673
1674 Exact division of multivariate polynomials is performed by the function
1675
1676 @example
1677 bool divide(const ex & a, const ex & b, ex & q);
1678 @end example
1679
1680 If @samp{b} divides @samp{a} over the rationals, this function returns @code{true}
1681 and returns the quotient in the variable @code{q}. Otherwise it returns @code{false}
1682 in which case the value of @code{q} is undefined.
1683
1684
1685 @subsection Unit, content and primitive part
1686 @cindex @code{unit()}
1687 @cindex @code{content()}
1688 @cindex @code{primpart()}
1689
1690 The methods
1691
1692 @example
1693 ex ex::unit(const symbol & x);
1694 ex ex::content(const symbol & x);
1695 ex ex::primpart(const symbol & x);
1696 @end example
1697
1698 return the unit part, content part, and primitive polynomial of a multivariate
1699 polynomial with respect to the variable @samp{x} (the unit part being the sign
1700 of the leading coefficient, the content part being the GCD of the coefficients,
1701 and the primitive polynomial being the input polynomial divided by the unit and
1702 content parts). The product of unit, content, and primitive part is the
1703 original polynomial.
1704
1705
1706 @subsection GCD and LCM
1707 @cindex GCD
1708 @cindex LCM
1709 @cindex @code{gcd()}
1710 @cindex @code{lcm()}
1711
1712 The functions for polynomial greatest common divisor and least common
1713 multiple have the synopsis
1714
1715 @example
1716 ex gcd(const ex & a, const ex & b);
1717 ex lcm(const ex & a, const ex & b);
1718 @end example
1719
1720 The functions @code{gcd()} and @code{lcm()} accept two expressions
1721 @code{a} and @code{b} as arguments and return a new expression, their
1722 greatest common divisor or least common multiple, respectively.  If the
1723 polynomials @code{a} and @code{b} are coprime @code{gcd(a,b)} returns 1
1724 and @code{lcm(a,b)} returns the product of @code{a} and @code{b}.
1725
1726 @example
1727 #include <ginac/ginac.h>
1728 using namespace GiNaC;
1729
1730 int main()
1731 @{
1732     symbol x("x"), y("y"), z("z");
1733     ex P_a = 4*x*y + x*z + 20*pow(y, 2) + 21*y*z + 4*pow(z, 2);
1734     ex P_b = x*y + 3*x*z + 5*pow(y, 2) + 19*y*z + 12*pow(z, 2);
1735
1736     ex P_gcd = gcd(P_a, P_b);
1737     // x + 5*y + 4*z
1738     ex P_lcm = lcm(P_a, P_b);
1739     // 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
1740 @}
1741 @end example
1742
1743
1744 @node Rational Expressions, Symbolic Differentiation, Polynomial Arithmetic, Methods and Functions
1745 @c    node-name, next, previous, up
1746 @section Rational expressions
1747
1748 @subsection The @code{normal} method
1749 @cindex @code{normal()}
1750 @cindex simplification
1751 @cindex temporary replacement
1752
1753 Some basic form of simplification of expressions is called for frequently.
1754 GiNaC provides the method @code{.normal()}, which converts a rational function
1755 into an equivalent rational function of the form @samp{numerator/denominator}
1756 where numerator and denominator are coprime.  If the input expression is already
1757 a fraction, it just finds the GCD of numerator and denominator and cancels it,
1758 otherwise it performs fraction addition and multiplication.
1759
1760 @code{.normal()} can also be used on expressions which are not rational functions
1761 as it will replace all non-rational objects (like functions or non-integer
1762 powers) by temporary symbols to bring the expression to the domain of rational
1763 functions before performing the normalization, and re-substituting these
1764 symbols afterwards. This algorithm is also available as a separate method
1765 @code{.to_rational()}, described below.
1766
1767 This means that both expressions @code{t1} and @code{t2} are indeed
1768 simplified in this little program:
1769
1770 @example
1771 #include <ginac/ginac.h>
1772 using namespace GiNaC;
1773
1774 int main()
1775 @{
1776     symbol x("x");
1777     ex t1 = (pow(x,2) + 2*x + 1)/(x + 1);
1778     ex t2 = (pow(sin(x),2) + 2*sin(x) + 1)/(sin(x) + 1);
1779     cout << "t1 is " << t1.normal() << endl;
1780     cout << "t2 is " << t2.normal() << endl;
1781 @}
1782 @end example
1783
1784 Of course this works for multivariate polynomials too, so the ratio of
1785 the sample-polynomials from the section about GCD and LCM above would be
1786 normalized to @code{P_a/P_b} = @code{(4*y+z)/(y+3*z)}.
1787
1788
1789 @subsection Numerator and denominator
1790 @cindex numerator
1791 @cindex denominator
1792 @cindex @code{numer()}
1793 @cindex @code{denom()}
1794
1795 The numerator and denominator of an expression can be obtained with
1796
1797 @example
1798 ex ex::numer();
1799 ex ex::denom();
1800 @end example
1801
1802 These functions will first normalize the expression as described above and
1803 then return the numerator or denominator, respectively.
1804
1805
1806 @subsection Converting to a rational expression
1807 @cindex @code{to_rational()}
1808
1809 Some of the methods described so far only work on polynomials or rational
1810 functions. GiNaC provides a way to extend the domain of these functions to
1811 general expressions by using the temporary replacement algorithm described
1812 above. You do this by calling
1813
1814 @example
1815 ex ex::to_rational(lst &l);
1816 @end example
1817
1818 on the expression to be converted. The supplied @code{lst} will be filled
1819 with the generated temporary symbols and their replacement expressions in
1820 a format that can be used directly for the @code{subs()} method. It can also
1821 already contain a list of replacements from an earlier application of
1822 @code{.to_rational()}, so it's possible to use it on multiple expressions
1823 and get consistent results.
1824
1825 For example,
1826
1827 @example
1828 @{
1829     symbol x("x");
1830     ex a = pow(sin(x), 2) - pow(cos(x), 2);
1831     ex b = sin(x) + cos(x);
1832     ex q;
1833     lst l;
1834     divide(a.to_rational(l), b.to_rational(l), q);
1835     cout << q.subs(l) << endl;
1836 @}
1837 @end example
1838
1839 will print @samp{sin(x)-cos(x)}.
1840
1841
1842 @node Symbolic Differentiation, Series Expansion, Rational Expressions, Methods and Functions
1843 @c    node-name, next, previous, up
1844 @section Symbolic differentiation
1845 @cindex differentiation
1846 @cindex @code{diff()}
1847 @cindex chain rule
1848 @cindex product rule
1849
1850 GiNaC's objects know how to differentiate themselves.  Thus, a
1851 polynomial (class @code{add}) knows that its derivative is the sum of
1852 the derivatives of all the monomials:
1853
1854 @example
1855 #include <ginac/ginac.h>
1856 using namespace GiNaC;
1857
1858 int main()
1859 @{
1860     symbol x("x"), y("y"), z("z");
1861     ex P = pow(x, 5) + pow(x, 2) + y;
1862
1863     cout << P.diff(x,2) << endl;  // 20*x^3 + 2
1864     cout << P.diff(y) << endl;    // 1
1865     cout << P.diff(z) << endl;    // 0
1866 @}
1867 @end example
1868
1869 If a second integer parameter @var{n} is given, the @code{diff} method
1870 returns the @var{n}th derivative.
1871
1872 If @emph{every} object and every function is told what its derivative
1873 is, all derivatives of composed objects can be calculated using the
1874 chain rule and the product rule.  Consider, for instance the expression
1875 @code{1/cosh(x)}.  Since the derivative of @code{cosh(x)} is
1876 @code{sinh(x)} and the derivative of @code{pow(x,-1)} is
1877 @code{-pow(x,-2)}, GiNaC can readily compute the composition.  It turns
1878 out that the composition is the generating function for Euler Numbers,
1879 i.e. the so called @var{n}th Euler number is the coefficient of
1880 @code{x^n/n!} in the expansion of @code{1/cosh(x)}.  We may use this
1881 identity to code a function that generates Euler numbers in just three
1882 lines:
1883
1884 @cindex Euler numbers
1885 @example
1886 #include <ginac/ginac.h>
1887 using namespace GiNaC;
1888
1889 ex EulerNumber(unsigned n)
1890 @{
1891     symbol x;
1892     const ex generator = pow(cosh(x),-1);
1893     return generator.diff(x,n).subs(x==0);
1894 @}
1895
1896 int main()
1897 @{
1898     for (unsigned i=0; i<11; i+=2)
1899         cout << EulerNumber(i) << endl;
1900     return 0;
1901 @}
1902 @end example
1903
1904 When you run it, it produces the sequence @code{1}, @code{-1}, @code{5},
1905 @code{-61}, @code{1385}, @code{-50521}.  We increment the loop variable
1906 @code{i} by two since all odd Euler numbers vanish anyways.
1907
1908
1909 @node Series Expansion, Built-in Functions, Symbolic Differentiation, Methods and Functions
1910 @c    node-name, next, previous, up
1911 @section Series expansion
1912 @cindex @code{series()}
1913 @cindex Taylor expansion
1914 @cindex Laurent expansion
1915 @cindex @code{pseries} (class)
1916
1917 Expressions know how to expand themselves as a Taylor series or (more
1918 generally) a Laurent series.  As in most conventional Computer Algebra
1919 Systems, no distinction is made between those two.  There is a class of
1920 its own for storing such series (@code{class pseries}) and a built-in
1921 function (called @code{Order}) for storing the order term of the series.
1922 As a consequence, if you want to work with series, i.e. multiply two
1923 series, you need to call the method @code{ex::series} again to convert
1924 it to a series object with the usual structure (expansion plus order
1925 term).  A sample application from special relativity could read:
1926
1927 @example
1928 #include <ginac/ginac.h>
1929 using namespace GiNaC;
1930
1931 int main()
1932 @{
1933     symbol v("v"), c("c");
1934     
1935     ex gamma = 1/sqrt(1 - pow(v/c,2));
1936     ex mass_nonrel = gamma.series(v==0, 10);
1937     
1938     cout << "the relativistic mass increase with v is " << endl
1939          << mass_nonrel << endl;
1940     
1941     cout << "the inverse square of this series is " << endl
1942          << pow(mass_nonrel,-2).series(v==0, 10) << endl;
1943 @}
1944 @end example
1945
1946 Only calling the series method makes the last output simplify to
1947 @math{1-v^2/c^2+O(v^10)}, without that call we would just have a long
1948 series raised to the power @math{-2}.
1949
1950 @cindex M@'echain's formula
1951 As another instructive application, let us calculate the numerical 
1952 value of Archimedes' constant
1953 @tex
1954 $\pi$
1955 @end tex
1956 (for which there already exists the built-in constant @code{Pi}) 
1957 using M@'echain's amazing formula
1958 @tex
1959 $\pi=16$~atan~$\!\left(1 \over 5 \right)-4$~atan~$\!\left(1 \over 239 \right)$.
1960 @end tex
1961 @ifnottex
1962 @math{Pi==16*atan(1/5)-4*atan(1/239)}.
1963 @end ifnottex
1964 We may expand the arcus tangent around @code{0} and insert the fractions
1965 @code{1/5} and @code{1/239}.  But, as we have seen, a series in GiNaC
1966 carries an order term with it and the question arises what the system is
1967 supposed to do when the fractions are plugged into that order term.  The
1968 solution is to use the function @code{series_to_poly()} to simply strip
1969 the order term off:
1970
1971 @example
1972 #include <ginac/ginac.h>
1973 using namespace GiNaC;
1974
1975 ex mechain_pi(int degr)
1976 @{
1977     symbol x;
1978     ex pi_expansion = series_to_poly(atan(x).series(x,degr));
1979     ex pi_approx = 16*pi_expansion.subs(x==numeric(1,5))
1980                    -4*pi_expansion.subs(x==numeric(1,239));
1981     return pi_approx;
1982 @}
1983
1984 int main()
1985 @{
1986     ex pi_frac;
1987     for (int i=2; i<12; i+=2) @{
1988         pi_frac = mechain_pi(i);
1989         cout << i << ":\t" << pi_frac << endl
1990              << "\t" << pi_frac.evalf() << endl;
1991     @}
1992     return 0;
1993 @}
1994 @end example
1995
1996 Note how we just called @code{.series(x,degr)} instead of
1997 @code{.series(x==0,degr)}.  This is a simple shortcut for @code{ex}'s
1998 method @code{series()}: if the first argument is a symbol the expression
1999 is expanded in that symbol around point @code{0}.  When you run this
2000 program, it will type out:
2001
2002 @example
2003 2:      3804/1195
2004         3.1832635983263598326
2005 4:      5359397032/1706489875
2006         3.1405970293260603143
2007 6:      38279241713339684/12184551018734375
2008         3.141621029325034425
2009 8:      76528487109180192540976/24359780855939418203125
2010         3.141591772182177295
2011 10:     327853873402258685803048818236/104359128170408663038552734375
2012         3.1415926824043995174
2013 @end example
2014
2015
2016 @node Built-in Functions, Input/Output, Series Expansion, Methods and Functions
2017 @c    node-name, next, previous, up
2018 @section Predefined mathematical functions
2019
2020 GiNaC contains the following predefined mathematical functions:
2021
2022 @cartouche
2023 @multitable @columnfractions .30 .70
2024 @item @strong{Name} @tab @strong{Function}
2025 @item @code{abs(x)}
2026 @tab absolute value
2027 @item @code{csgn(x)}
2028 @tab complex sign
2029 @item @code{sqrt(x)}
2030 @tab square root (not a GiNaC function proper but equivalent to @code{pow(x, numeric(1, 2)})
2031 @item @code{sin(x)}
2032 @tab sine
2033 @item @code{cos(x)}
2034 @tab cosine
2035 @item @code{tan(x)}
2036 @tab tangent
2037 @item @code{asin(x)}
2038 @tab inverse sine
2039 @item @code{acos(x)}
2040 @tab inverse cosine
2041 @item @code{atan(x)}
2042 @tab inverse tangent
2043 @item @code{atan2(y, x)}
2044 @tab inverse tangent with two arguments
2045 @item @code{sinh(x)}
2046 @tab hyperbolic sine
2047 @item @code{cosh(x)}
2048 @tab hyperbolic cosine
2049 @item @code{tanh(x)}
2050 @tab hyperbolic tangent
2051 @item @code{asinh(x)}
2052 @tab inverse hyperbolic sine
2053 @item @code{acosh(x)}
2054 @tab inverse hyperbolic cosine
2055 @item @code{atanh(x)}
2056 @tab inverse hyperbolic tangent
2057 @item @code{exp(x)}
2058 @tab exponential function
2059 @item @code{log(x)}
2060 @tab natural logarithm
2061 @item @code{Li2(x)}
2062 @tab Dilogarithm
2063 @item @code{zeta(x)}
2064 @tab Riemann's zeta function
2065 @item @code{zeta(n, x)}
2066 @tab derivatives of Riemann's zeta function
2067 @item @code{tgamma(x)}
2068 @tab Gamma function
2069 @item @code{lgamma(x)}
2070 @tab logarithm of Gamma function
2071 @item @code{beta(x, y)}
2072 @tab Beta function (@code{tgamma(x)*tgamma(y)/tgamma(x+y)})
2073 @item @code{psi(x)}
2074 @tab psi (digamma) function
2075 @item @code{psi(n, x)}
2076 @tab derivatives of psi function (polygamma functions)
2077 @item @code{factorial(n)}
2078 @tab factorial function
2079 @item @code{binomial(n, m)}
2080 @tab binomial coefficients
2081 @item @code{Order(x)}
2082 @tab order term function in truncated power series
2083 @item @code{Derivative(x, l)}
2084 @tab inert partial differentiation operator (used internally)
2085 @end multitable
2086 @end cartouche
2087
2088 @cindex branch cut
2089 For functions that have a branch cut in the complex plane GiNaC follows
2090 the conventions for C++ as defined in the ANSI standard as far as
2091 possible.  In particular: the natural logarithm (@code{log}) and the
2092 square root (@code{sqrt}) both have their branch cuts running along the
2093 negative real axis where the points on the axis itself belong to the
2094 upper part (i.e. continuous with quadrant II).  The inverse
2095 trigonometric and hyperbolic functions are not defined for complex
2096 arguments by the C++ standard, however.  In GiNaC we follow the
2097 conventions used by CLN, which in turn follow the carefully designed
2098 definitions in the Common Lisp standard.  It should be noted that this
2099 convention is identical to the one used by the C99 standard and by most
2100 serious CAS.  It is to be expected that future revisions of the C++
2101 standard incorporate these functions in the complex domain in a manner
2102 compatible with C99.
2103
2104
2105 @node Input/Output, Extending GiNaC, Built-in Functions, Methods and Functions
2106 @c    node-name, next, previous, up
2107 @section Input and output of expressions
2108 @cindex I/O
2109
2110 @subsection Expression output
2111 @cindex printing
2112 @cindex output of expressions
2113
2114 The easiest way to print an expression is to write it to a stream:
2115
2116 @example
2117 @{
2118     symbol x("x");
2119     ex e = 4.5+pow(x,2)*3/2;
2120     cout << e << endl;    // prints '4.5+3/2*x^2'
2121     // ...
2122 @end example
2123
2124 The output format is identical to the @command{ginsh} input syntax and
2125 to that used by most computer algebra systems, but not directly pastable
2126 into a GiNaC C++ program (note that in the above example, @code{pow(x,2)}
2127 is printed as @samp{x^2}).
2128
2129 To print an expression in a way that can be directly used in a C or C++
2130 program, you use the method
2131
2132 @example
2133 void ex::printcsrc(ostream & os, unsigned type, const char *name);
2134 @end example
2135
2136 This outputs a line in the form of a variable definition @code{<type> <name> = <expression>}.
2137 The possible types are defined in @file{ginac/flags.h} (@code{csrc_types})
2138 and mostly affect the way in which floating point numbers are written:
2139
2140 @example
2141     // ...
2142     e.printcsrc(cout, csrc_types::ctype_float, "f");
2143     e.printcsrc(cout, csrc_types::ctype_double, "d");
2144     e.printcsrc(cout, csrc_types::ctype_cl_N, "n");
2145     // ...
2146 @end example
2147
2148 The above example will produce (note the @code{x^2} being converted to @code{x*x}):
2149
2150 @example
2151 float f = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
2152 double d = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
2153 cl_N n = (cl_F("3.0")/cl_F("2.0"))*(x*x)+cl_F("4.5");
2154 @end example
2155
2156 Finally, there are the two methods @code{printraw()} and @code{printtree()} intended for GiNaC
2157 developers, that provide a dump of the internal structure of an expression for
2158 debugging purposes:
2159
2160 @example
2161     // ...
2162     e.printraw(cout); cout << endl << endl;
2163     e.printtree(cout);
2164 @}
2165 @end example
2166
2167 produces
2168
2169 @example
2170 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))
2171
2172 type=Q25GiNaC3add, hash=0 (0x0), flags=3, nops=2
2173     power: hash=2 (0x2), flags=3
2174         x (symbol): serial=1, hash=150875740 (0x8fe2e5c), flags=11
2175         2 (numeric): hash=2147483714 (0x80000042), flags=11
2176     3/2 (numeric): hash=2147483745 (0x80000061), flags=11
2177     -----
2178     overall_coeff
2179     4.5L0 (numeric): hash=2147483723 (0x8000004b), flags=11
2180     =====
2181 @end example
2182
2183 The @code{printtree()} method is also available in @command{ginsh} as the
2184 @code{print()} function.
2185
2186
2187 @subsection Expression input
2188 @cindex input of expressions
2189
2190 GiNaC provides no way to directly read an expression from a stream because
2191 you will usually want the user to be able to enter something like @samp{2*x+sin(y)}
2192 and have the @samp{x} and @samp{y} correspond to the symbols @code{x} and
2193 @code{y} you defined in your program and there is no way to specify the
2194 desired symbols to the @code{>>} stream input operator.
2195
2196 Instead, GiNaC lets you construct an expression from a string, specifying the
2197 list of symbols to be used:
2198
2199 @example
2200 @{
2201     symbol x("x"), y("y");
2202     ex e("2*x+sin(y)", lst(x, y));
2203 @}
2204 @end example
2205
2206 The input syntax is the same as that used by @command{ginsh} and the stream
2207 output operator @code{<<}. The symbols in the string are matched by name to
2208 the symbols in the list and if GiNaC encounters a symbol not specified in
2209 the list it will throw an exception.
2210
2211 With this constructor, it's also easy to implement interactive GiNaC programs:
2212
2213 @example
2214 #include <iostream>
2215 #include <string>
2216 #include <stdexcept>
2217 #include <ginac/ginac.h>
2218 using namespace GiNaC;
2219
2220 int main()
2221 @{
2222      symbol x("x");
2223      string s;
2224
2225      cout << "Enter an expression containing 'x': ";
2226      getline(cin, s);
2227
2228      try @{
2229          ex e(s, lst(x));
2230          cout << "The derivative of " << e << " with respect to x is ";
2231          cout << e.diff(x) << ".\n";
2232      @} catch (exception &p) @{
2233          cerr << p.what() << endl;
2234      @}
2235 @}
2236 @end example
2237
2238
2239 @subsection Archiving
2240 @cindex @code{archive} (class)
2241 @cindex archiving
2242
2243 GiNaC allows creating @dfn{archives} of expressions which can be stored
2244 to or retrieved from files. To create an archive, you declare an object
2245 of class @code{archive} and archive expressions in it, giving each
2246 expression a unique name:
2247
2248 @example
2249 #include <ginac/ginac.h>
2250 #include <fstream>
2251 using namespace GiNaC;
2252
2253 int main()
2254 @{
2255     symbol x("x"), y("y"), z("z");
2256
2257     ex foo = sin(x + 2*y) + 3*z + 41;
2258     ex bar = foo + 1;
2259
2260     archive a;
2261     a.archive_ex(foo, "foo");
2262     a.archive_ex(bar, "the second one");
2263     // ...
2264 @end example
2265
2266 The archive can then be written to a file:
2267
2268 @example
2269     // ...
2270     ofstream out("foobar.gar");
2271     out << a;
2272     out.close();
2273     // ...
2274 @end example
2275
2276 The file @file{foobar.gar} contains all information that is needed to
2277 reconstruct the expressions @code{foo} and @code{bar}.
2278
2279 @cindex @command{viewgar}
2280 The tool @command{viewgar} that comes with GiNaC can be used to view
2281 the contents of GiNaC archive files:
2282
2283 @example
2284 $ viewgar foobar.gar
2285 foo = 41+sin(x+2*y)+3*z
2286 the second one = 42+sin(x+2*y)+3*z
2287 @end example
2288
2289 The point of writing archive files is of course that they can later be
2290 read in again:
2291
2292 @example
2293     // ...
2294     archive a2;
2295     ifstream in("foobar.gar");
2296     in >> a2;
2297     // ...
2298 @end example
2299
2300 And the stored expressions can be retrieved by their name:
2301
2302 @example
2303     // ...
2304     lst syms(x, y);
2305
2306     ex ex1 = a2.unarchive_ex(syms, "foo");
2307     ex ex2 = a2.unarchive_ex(syms, "the second one");
2308
2309     cout << ex1 << endl;              // prints "41+sin(x+2*y)+3*z"
2310     cout << ex2 << endl;              // prints "42+sin(x+2*y)+3*z"
2311     cout << ex1.subs(x == 2) << endl; // prints "41+sin(2+2*y)+3*z"
2312 @}
2313 @end example
2314
2315 Note that you have to supply a list of the symbols which are to be inserted
2316 in the expressions. Symbols in archives are stored by their name only and
2317 if you don't specify which symbols you have, unarchiving the expression will
2318 create new symbols with that name. E.g. if you hadn't included @code{x} in
2319 the @code{syms} list above, the @code{ex1.subs(x == 2)} statement would
2320 have had no effect because the @code{x} in @code{ex1} would have been a
2321 different symbol than the @code{x} which was defined at the beginning of
2322 the program, altough both would appear as @samp{x} when printed.
2323
2324
2325
2326 @node Extending GiNaC, What does not belong into GiNaC, Input/Output, Top
2327 @c    node-name, next, previous, up
2328 @chapter Extending GiNaC
2329
2330 By reading so far you should have gotten a fairly good understanding of
2331 GiNaC's design-patterns.  From here on you should start reading the
2332 sources.  All we can do now is issue some recommendations how to tackle
2333 GiNaC's many loose ends in order to fulfill everybody's dreams.  If you
2334 develop some useful extension please don't hesitate to contact the GiNaC
2335 authors---they will happily incorporate them into future versions.
2336
2337 @menu
2338 * What does not belong into GiNaC::  What to avoid.
2339 * Symbolic functions::               Implementing symbolic functions.
2340 * Adding classes::                   Defining new algebraic classes.
2341 @end menu
2342
2343
2344 @node What does not belong into GiNaC, Symbolic functions, Extending GiNaC, Extending GiNaC
2345 @c    node-name, next, previous, up
2346 @section What doesn't belong into GiNaC
2347
2348 @cindex @command{ginsh}
2349 First of all, GiNaC's name must be read literally.  It is designed to be
2350 a library for use within C++.  The tiny @command{ginsh} accompanying
2351 GiNaC makes this even more clear: it doesn't even attempt to provide a
2352 language.  There are no loops or conditional expressions in
2353 @command{ginsh}, it is merely a window into the library for the
2354 programmer to test stuff (or to show off).  Still, the design of a
2355 complete CAS with a language of its own, graphical capabilites and all
2356 this on top of GiNaC is possible and is without doubt a nice project for
2357 the future.
2358
2359 There are many built-in functions in GiNaC that do not know how to
2360 evaluate themselves numerically to a precision declared at runtime
2361 (using @code{Digits}).  Some may be evaluated at certain points, but not
2362 generally.  This ought to be fixed.  However, doing numerical
2363 computations with GiNaC's quite abstract classes is doomed to be
2364 inefficient.  For this purpose, the underlying foundation classes
2365 provided by @acronym{CLN} are much better suited.
2366
2367
2368 @node Symbolic functions, Adding classes, What does not belong into GiNaC, Extending GiNaC
2369 @c    node-name, next, previous, up
2370 @section Symbolic functions
2371
2372 The easiest and most instructive way to start with is probably to
2373 implement your own function.  GiNaC's functions are objects of class
2374 @code{function}.  The preprocessor is then used to convert the function
2375 names to objects with a corresponding serial number that is used
2376 internally to identify them.  You usually need not worry about this
2377 number.  New functions may be inserted into the system via a kind of
2378 `registry'.  It is your responsibility to care for some functions that
2379 are called when the user invokes certain methods.  These are usual
2380 C++-functions accepting a number of @code{ex} as arguments and returning
2381 one @code{ex}.  As an example, if we have a look at a simplified
2382 implementation of the cosine trigonometric function, we first need a
2383 function that is called when one wishes to @code{eval} it.  It could
2384 look something like this:
2385
2386 @example
2387 static ex cos_eval_method(const ex & x)
2388 @{
2389     // if (!x%(2*Pi)) return 1
2390     // if (!x%Pi) return -1
2391     // if (!x%Pi/2) return 0
2392     // care for other cases...
2393     return cos(x).hold();
2394 @}
2395 @end example
2396
2397 @cindex @code{hold()}
2398 @cindex evaluation
2399 The last line returns @code{cos(x)} if we don't know what else to do and
2400 stops a potential recursive evaluation by saying @code{.hold()}, which
2401 sets a flag to the expression signaling that it has been evaluated.  We
2402 should also implement a method for numerical evaluation and since we are
2403 lazy we sweep the problem under the rug by calling someone else's
2404 function that does so, in this case the one in class @code{numeric}:
2405
2406 @example
2407 static ex cos_evalf(const ex & x)
2408 @{
2409     return cos(ex_to_numeric(x));
2410 @}
2411 @end example
2412
2413 Differentiation will surely turn up and so we need to tell @code{cos}
2414 what the first derivative is (higher derivatives (@code{.diff(x,3)} for
2415 instance are then handled automatically by @code{basic::diff} and
2416 @code{ex::diff}):
2417
2418 @example
2419 static ex cos_deriv(const ex & x, unsigned diff_param)
2420 @{
2421     return -sin(x);
2422 @}
2423 @end example
2424
2425 @cindex product rule
2426 The second parameter is obligatory but uninteresting at this point.  It
2427 specifies which parameter to differentiate in a partial derivative in
2428 case the function has more than one parameter and its main application
2429 is for correct handling of the chain rule.  For Taylor expansion, it is
2430 enough to know how to differentiate.  But if the function you want to
2431 implement does have a pole somewhere in the complex plane, you need to
2432 write another method for Laurent expansion around that point.
2433
2434 Now that all the ingredients for @code{cos} have been set up, we need
2435 to tell the system about it.  This is done by a macro and we are not
2436 going to descibe how it expands, please consult your preprocessor if you
2437 are curious:
2438
2439 @example
2440 REGISTER_FUNCTION(cos, eval_func(cos_eval).
2441                        evalf_func(cos_evalf).
2442                        derivative_func(cos_deriv));
2443 @end example
2444
2445 The first argument is the function's name used for calling it and for
2446 output.  The second binds the corresponding methods as options to this
2447 object.  Options are separated by a dot and can be given in an arbitrary
2448 order.  GiNaC functions understand several more options which are always
2449 specified as @code{.option(params)}, for example a method for series
2450 expansion @code{.series_func(cos_series)}.  Again, if no series
2451 expansion method is given, GiNaC defaults to simple Taylor expansion,
2452 which is correct if there are no poles involved as is the case for the
2453 @code{cos} function.  The way GiNaC handles poles in case there are any
2454 is best understood by studying one of the examples, like the Gamma
2455 (@code{tgamma}) function for instance.  (In essence the function first
2456 checks if there is a pole at the evaluation point and falls back to
2457 Taylor expansion if there isn't.  Then, the pole is regularized by some
2458 suitable transformation.)  Also, the new function needs to be declared
2459 somewhere.  This may also be done by a convenient preprocessor macro:
2460
2461 @example
2462 DECLARE_FUNCTION_1P(cos)
2463 @end example
2464
2465 The suffix @code{_1P} stands for @emph{one parameter}.  Of course, this
2466 implementation of @code{cos} is very incomplete and lacks several safety
2467 mechanisms.  Please, have a look at the real implementation in GiNaC.
2468 (By the way: in case you are worrying about all the macros above we can
2469 assure you that functions are GiNaC's most macro-intense classes.  We
2470 have done our best to avoid macros where we can.)
2471
2472
2473 @node Adding classes, A Comparison With Other CAS, Symbolic functions, Extending GiNaC
2474 @c    node-name, next, previous, up
2475 @section Adding classes
2476
2477 If you are doing some very specialized things with GiNaC you may find that
2478 you have to implement your own algebraic classes to fit your needs. This
2479 section will explain how to do this by giving the example of a simple
2480 'string' class. After reading this section you will know how to properly
2481 declare a GiNaC class and what the minimum required member functions are
2482 that you have to implement. We only cover the implementation of a 'leaf'
2483 class here (i.e. one that doesn't contain subexpressions). Creating a
2484 container class like, for example, a class representing tensor products is
2485 more involved but this section should give you enough information so you can
2486 consult the source to GiNaC's predefined classes if you want to implement
2487 something more complicated.
2488
2489 @subsection GiNaC's run-time type information system
2490
2491 @cindex hierarchy of classes
2492 @cindex RTTI
2493 All algebraic classes (that is, all classes that can appear in expressions)
2494 in GiNaC are direct or indirect subclasses of the class @code{basic}. So a
2495 @code{basic *} (which is essentially what an @code{ex} is) represents a
2496 generic pointer to an algebraic class. Occasionally it is necessary to find
2497 out what the class of an object pointed to by a @code{basic *} really is.
2498 Also, for the unarchiving of expressions it must be possible to find the
2499 @code{unarchive()} function of a class given the class name (as a string). A
2500 system that provides this kind of information is called a run-time type
2501 information (RTTI) system. The C++ language provides such a thing (see the
2502 standard header file @file{<typeinfo>}) but for efficiency reasons GiNaC
2503 implements its own, simpler RTTI.
2504
2505 The RTTI in GiNaC is based on two mechanisms:
2506
2507 @itemize @bullet
2508
2509 @item
2510 The @code{basic} class declares a member variable @code{tinfo_key} which
2511 holds an unsigned integer that identifies the object's class. These numbers
2512 are defined in the @file{tinfos.h} header file for the built-in GiNaC
2513 classes. They all start with @code{TINFO_}.
2514
2515 @item
2516 By means of some clever tricks with static members, GiNaC maintains a list
2517 of information for all classes derived from @code{basic}. The information
2518 available includes the class names, the @code{tinfo_key}s, and pointers
2519 to the unarchiving functions. This class registry is defined in the
2520 @file{registrar.h} header file.
2521
2522 @end itemize
2523
2524 The disadvantage of this proprietary RTTI implementation is that there's
2525 a little more to do when implementing new classes (C++'s RTTI works more
2526 or less automatic) but don't worry, most of the work is simplified by
2527 macros.
2528
2529 @subsection A minimalistic example
2530
2531 Now we will start implementing a new class @code{mystring} that allows
2532 placing character strings in algebraic expressions (this is not very useful,
2533 but it's just an example). This class will be a direct subclass of
2534 @code{basic}. You can use this sample implementation as a starting point
2535 for your own classes.
2536
2537 The code snippets given here assume that you have included some header files
2538 as follows:
2539
2540 @example
2541 #include <iostream>
2542 #include <string>   
2543 #include <stdexcept>
2544 using namespace std;
2545
2546 #include <ginac/ginac.h>
2547 using namespace GiNaC;
2548 @end example
2549
2550 The first thing we have to do is to define a @code{tinfo_key} for our new
2551 class. This can be any arbitrary unsigned number that is not already taken
2552 by one of the existing classes but it's better to come up with something
2553 that is unlikely to clash with keys that might be added in the future. The
2554 numbers in @file{tinfos.h} are modeled somewhat after the class hierarchy
2555 which is not a requirement but we are going to stick with this scheme:
2556
2557 @example
2558 const unsigned TINFO_mystring = 0x42420001U;
2559 @end example
2560
2561 Now we can write down the class declaration. The class stores a C++
2562 @code{string} and the user shall be able to construct a @code{mystring}
2563 object from a C or C++ string:
2564
2565 @example
2566 class mystring : public basic
2567 @{
2568     GINAC_DECLARE_REGISTERED_CLASS(mystring, basic)
2569   
2570 public:
2571     mystring(const string &s);
2572     mystring(const char *s);
2573
2574 private:
2575     string str;
2576 @};
2577
2578 GIANC_IMPLEMENT_REGISTERED_CLASS(mystring, basic)
2579 @end example
2580
2581 The @code{GINAC_DECLARE_REGISTERED_CLASS} and @code{GINAC_IMPLEMENT_REGISTERED_CLASS}
2582 macros are defined in @file{registrar.h}. They take the name of the class
2583 and its direct superclass as arguments and insert all required declarations
2584 for the RTTI system. The @code{GINAC_DECLARE_REGISTERED_CLASS} should be
2585 the first line after the opening brace of the class definition. The
2586 @code{GINAC_IMPLEMENT_REGISTERED_CLASS} may appear anywhere else in the
2587 source (at global scope, of course, not inside a function).
2588
2589 @code{GINAC_DECLARE_REGISTERED_CLASS} contains, among other things the
2590 declarations of the default and copy constructor, the destructor, the
2591 assignment operator and a couple of other functions that are required. It
2592 also defines a type @code{inherited} which refers to the superclass so you
2593 don't have to modify your code every time you shuffle around the class
2594 hierarchy. @code{GINAC_IMPLEMENT_REGISTERED_CLASS} implements the copy
2595 constructor, the destructor and the assignment operator.
2596
2597 Now there are nine member functions we have to implement to get a working
2598 class:
2599
2600 @itemize
2601
2602 @item
2603 @code{mystring()}, the default constructor.
2604
2605 @item
2606 @code{void destroy(bool call_parent)}, which is used in the destructor and the
2607 assignment operator to free dynamically allocated members. The @code{call_parent}
2608 specifies whether the @code{destroy()} function of the superclass is to be
2609 called also.
2610
2611 @item
2612 @code{void copy(const mystring &other)}, which is used in the copy constructor
2613 and assignment operator to copy the member variables over from another
2614 object of the same class.
2615
2616 @item
2617 @code{void archive(archive_node &n)}, the archiving function. This stores all
2618 information needed to reconstruct an object of this class inside an
2619 @code{archive_node}.
2620
2621 @item
2622 @code{mystring(const archive_node &n, const lst &sym_lst)}, the unarchiving
2623 constructor. This constructs an instance of the class from the information
2624 found in an @code{archive_node}.
2625
2626 @item
2627 @code{ex unarchive(const archive_node &n, const lst &sym_lst)}, the static
2628 unarchiving function. It constructs a new instance by calling the unarchiving
2629 constructor.
2630
2631 @item
2632 @code{int compare_same_type(const basic &other)}, which is used internally
2633 by GiNaC to establish a canonical sort order for terms. It returns 0, +1 or
2634 -1, depending on the relative order of this object and the @code{other}
2635 object. If it returns 0, the objects are considered equal.
2636 @strong{Note:} This has nothing to do with the (numeric) ordering
2637 relationship expressed by @code{<}, @code{>=} etc (which cannot be defined
2638 for non-numeric classes). For example, @code{numeric(1).compare_same_type(numeric(2))}
2639 may return +1 even though 1 is clearly smaller than 2. Every GiNaC class
2640 must provide a @code{compare_same_type()} function, even those representing
2641 objects for which no reasonable algebraic ordering relationship can be
2642 defined.
2643
2644 @item
2645 And, of course, @code{mystring(const string &s)} and @code{mystring(const char *s)}
2646 which are the two constructors we declared.
2647
2648 @end itemize
2649
2650 Let's proceed step-by-step. The default constructor looks like this:
2651
2652 @example
2653 mystring::mystring() : inherited(TINFO_mystring)
2654 @{
2655     // dynamically allocate resources here if required
2656 @}
2657 @end example
2658
2659 The golden rule is that in all constructors you have to set the
2660 @code{tinfo_key} member to the @code{TINFO_*} value of your class. Otherwise
2661 it will be set by the constructor of the superclass and all hell will break
2662 loose in the RTTI. For your convenience, the @code{basic} class provides
2663 a constructor that takes a @code{tinfo_key} value, which we are using here
2664 (remember that in our case @code{inherited = basic}). If the superclass
2665 didn't have such a constructor, we would have to set the @code{tinfo_key}
2666 to the right value manually.
2667
2668 In the default constructor you should set all other member variables to
2669 reasonable default values (we don't need that here since our @code{str}
2670 member gets set to an empty string automatically). The constructor(s) are of
2671 course also the right place to allocate any dynamic resources you require.
2672
2673 Next, the @code{destroy()} function:
2674
2675 @example
2676 void mystring::destroy(bool call_parent)
2677 @{
2678     // free dynamically allocated resources here if required
2679     if (call_parent)
2680         inherited::destroy(call_parent);
2681 @}
2682 @end example
2683
2684 This function is where we free all dynamically allocated resources. We don't
2685 have any so we're not doing anything here, but if we had, for example, used
2686 a C-style @code{char *} to store our string, this would be the place to
2687 @code{delete[]} the string storage. If @code{call_parent} is true, we have
2688 to call the @code{destroy()} function of the superclass after we're done
2689 (to mimic C++'s automatic invocation of superclass destructors where
2690 @code{destroy()} is called from outside a destructor).
2691
2692 The @code{copy()} function just copies over the member variables from
2693 another object:
2694
2695 @example
2696 void mystring::copy(const mystring &other)
2697 @{
2698     inherited::copy(other);
2699     str = other.str;
2700 @}
2701 @end example
2702
2703 We can simply overwrite the member variables here. There's no need to worry
2704 about dynamically allocated storage. The assignment operator (which is
2705 automatically defined by @code{GINAC_IMPLEMENT_REGISTERED_CLASS}, as you
2706 recall) calls @code{destroy()} before it calls @code{copy()}. You have to
2707 explicitly call the @code{copy()} function of the superclass here so
2708 all the member variables will get copied.
2709
2710 Next are the three functions for archiving. You have to implement them even
2711 if you don't plan to use archives, but the minimum required implementation
2712 is really simple. First, the archiving function:
2713
2714 @example
2715 void mystring::archive(archive_node &n) const
2716 @{
2717     inherited::archive(n);
2718     n.add_string("string", str);
2719 @}
2720 @end example
2721
2722 The only thing that is really required is calling the @code{archive()}
2723 function of the superclass. Optionally, you can store all information you
2724 deem necessary for representing the object into the passed
2725 @code{archive_node}. We are just storing our string here. For more
2726 information on how the archiving works, consult the @file{archive.h} header
2727 file.
2728
2729 The unarchiving constructor is basically the inverse of the archiving
2730 function:
2731
2732 @example
2733 mystring::mystring(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
2734 @{
2735     n.find_string("string", str);
2736 @}
2737 @end example
2738
2739 If you don't need archiving, just leave this function empty (but you must
2740 invoke the unarchiving constructor of the superclass). Note that we don't
2741 have to set the @code{tinfo_key} here because it is done automatically
2742 by the unarchiving constructor of the @code{basic} class.
2743
2744 Finally, the unarchiving function:
2745
2746 @example
2747 ex mystring::unarchive(const archive_node &n, const lst &sym_lst)
2748 @{
2749     return (new mystring(n, sym_lst))->setflag(status_flags::dynallocated);
2750 @}
2751 @end example
2752
2753 You don't have to understand how exactly this works. Just copy these four
2754 lines into your code literally (replacing the class name, of course). It
2755 calls the unarchiving constructor of the class and unless you are doing
2756 something very special (like matching @code{archive_node}s to global
2757 objects) you don't need a different implementation.
2758
2759 Our @code{compare_same_type()} function uses a provided function to compare
2760 the string members:
2761
2762 @example
2763 int mystring::compare_same_type(const basic &other) const
2764 @{
2765     const mystring &o = static_cast<const mystring &>(other);
2766     int cmpval = str.compare(o.str);
2767     if (cmpval == 0)
2768         return 0;
2769     else if (cmpval < 0)
2770         return -1;
2771     else
2772         return 1;
2773 @}
2774 @end example
2775
2776 Although this function takes a @code{basic &}, it will always be a reference
2777 to an object of exactly the same class (objects of different classes are not
2778 comparable), so the cast is safe. If this function returns 0, the two objects
2779 are considered equal (in the sense that @math{A-B=0}), so you should compare
2780 all relevant member variables.
2781
2782 Now the only thing missing is our two new constructors:
2783
2784 @example
2785 mystring::mystring(const string &s) : inherited(TINFO_mystring), str(s)
2786 @{
2787     // dynamically allocate resources here if required
2788 @}
2789
2790 mystring::mystring(const char *s) : inherited(TINFO_mystring), str(s)
2791 @{
2792     // dynamically allocate resources here if required
2793 @}
2794 @end example
2795
2796 No surprises here. We set the @code{str} member from the argument and
2797 remember to pass the right @code{tinfo_key} to the @code{basic} constructor.
2798
2799 That's it! We now have a minimal working GiNaC class that can store
2800 strings in algebraic expressions. Let's confirm that the RTTI works:
2801
2802 @example
2803 ex e = mystring("Hello, world!");
2804 cout << is_ex_of_type(e, mystring) << endl;
2805  // -> 1 (true)
2806
2807 cout << e.bp->class_name() << endl;
2808  // -> mystring
2809 @end example
2810
2811 Obviously it does. Let's see what the expression @code{e} looks like:
2812
2813 @example
2814 cout << e << endl;
2815  // -> [mystring object]
2816 @end example
2817
2818 Hm, not exactly what we expect, but of course the @code{mystring} class
2819 doesn't yet know how to print itself. This is done in the @code{print()}
2820 member function. Let's say that we wanted to print the string surrounded
2821 by double quotes:
2822
2823 @example
2824 class mystring : public basic
2825 @{
2826     ...
2827 public:
2828     void print(ostream &os, unsigned upper_precedence) const;
2829     ...
2830 @};
2831
2832 void mystring::print(ostream &os, unsigned upper_precedence) const
2833 @{
2834     os << '\"' << str << '\"';
2835 @}
2836 @end example
2837
2838 The @code{upper_precedence} argument is only required for container classes
2839 to correctly parenthesize the output. Let's try again to print the expression:
2840
2841 @example
2842 cout << e << endl;
2843  // -> "Hello, world!"
2844 @end example
2845
2846 Much better. The @code{mystring} class can be used in arbitrary expressions:
2847
2848 @example
2849 e += mystring("GiNaC rulez"); 
2850 cout << e << endl;
2851  // -> "GiNaC rulez"+"Hello, world!"
2852 @end example
2853
2854 (note that GiNaC's automatic term reordering is in effect here), or even
2855
2856 @example
2857 e = pow(mystring("One string"), 2*sin(Pi-mystring("Another string")));
2858 cout << e << endl;
2859  // -> "One string"^(2*sin(-"Another string"+Pi))
2860 @end example
2861
2862 Whether this makes sense is debatable but remember that this is only an
2863 example. At least it allows you to implement your own symbolic algorithms
2864 for your objects.
2865
2866 Note that GiNaC's algebraic rules remain unchanged:
2867
2868 @example
2869 e = mystring("Wow") * mystring("Wow");
2870 cout << e << endl;
2871  // -> "Wow"^2
2872
2873 e = pow(mystring("First")-mystring("Second"), 2);
2874 cout << e.expand() << endl;
2875  // -> -2*"First"*"Second"+"First"^2+"Second"^2
2876 @end example
2877
2878 There's no way to, for example, make GiNaC's @code{add} class perform string
2879 concatenation. You would have to implement this yourself.
2880
2881 @subsection Automatic evaluation
2882
2883 @cindex @code{hold()}
2884 @cindex evaluation
2885 When dealing with objects that are just a little more complicated than the
2886 simple string objects we have implemented, chances are that you will want to
2887 have some automatic simplifications or canonicalizations performed on them.
2888 This is done in the evaluation member function @code{eval()}. Let's say that
2889 we wanted all strings automatically converted to lowercase with
2890 non-alphabetic characters stripped, and empty strings removed:
2891
2892 @example
2893 class mystring : public basic
2894 @{
2895     ...
2896 public:
2897     ex eval(int level = 0) const;
2898     ...
2899 @};
2900
2901 ex mystring::eval(int level) const
2902 @{
2903     string new_str;
2904     for (int i=0; i<str.length(); i++) @{
2905         char c = str[i];
2906         if (c >= 'A' && c <= 'Z') 
2907             new_str += tolower(c);
2908         else if (c >= 'a' && c <= 'z')
2909             new_str += c;
2910     @}
2911
2912     if (new_str.length() == 0)
2913         return _ex0();
2914     else
2915         return mystring(new_str).hold();
2916 @}
2917 @end example
2918
2919 The @code{level} argument is used to limit the recursion depth of the
2920 evaluation. We don't have any subexpressions in the @code{mystring} class
2921 so we are not concerned with this. If we had, we would call the @code{eval()}
2922 functions of the subexpressions with @code{level - 1} as the argument if
2923 @code{level != 1}. The @code{hold()} member function sets a flag in the
2924 object that prevents further evaluation. Otherwise we might end up in an
2925 endless loop. When you want to return the object unmodified, use
2926 @code{return this->hold();}.
2927
2928 Let's confirm that it works:
2929
2930 @example
2931 ex e = mystring("Hello, world!") + mystring("!?#");
2932 cout << e << endl;
2933  // -> "helloworld"
2934
2935 e = mystring("Wow!") + mystring("WOW") + mystring(" W ** o ** W");  
2936 cout << e << endl;
2937  // -> 3*"wow"
2938 @end example
2939
2940 @subsection Other member functions
2941
2942 We have implemented only a small set of member functions to make the class
2943 work in the GiNaC framework. For a real algebraic class, there are probably
2944 some more functions that you will want to re-implement, such as
2945 @code{evalf()}, @code{series()} or @code{op()}. Have a look at @file{basic.h}
2946 or the header file of the class you want to make a subclass of to see
2947 what's there. You can, of course, also add your own new member functions.
2948 In this case you will probably want to define a little helper function like
2949
2950 @example
2951 inline const mystring &ex_to_mystring(const ex &e)
2952 @{
2953     return static_cast<const mystring &>(*e.bp);
2954 @}
2955 @end example
2956
2957 that let's you get at the object inside an expression (after you have verified
2958 that the type is correct) so you can call member functions that are specific
2959 to the class.
2960
2961 That's it. May the source be with you!
2962
2963
2964 @node A Comparison With Other CAS, Advantages, Adding classes, Top
2965 @c    node-name, next, previous, up
2966 @chapter A Comparison With Other CAS
2967 @cindex advocacy
2968
2969 This chapter will give you some information on how GiNaC compares to
2970 other, traditional Computer Algebra Systems, like @emph{Maple},
2971 @emph{Mathematica} or @emph{Reduce}, where it has advantages and
2972 disadvantages over these systems.
2973
2974 @menu
2975 * Advantages::                       Stengths of the GiNaC approach.
2976 * Disadvantages::                    Weaknesses of the GiNaC approach.
2977 * Why C++?::                         Attractiveness of C++.
2978 @end menu
2979
2980 @node Advantages, Disadvantages, A Comparison With Other CAS, A Comparison With Other CAS
2981 @c    node-name, next, previous, up
2982 @section Advantages
2983
2984 GiNaC has several advantages over traditional Computer
2985 Algebra Systems, like 
2986
2987 @itemize @bullet
2988
2989 @item
2990 familiar language: all common CAS implement their own proprietary
2991 grammar which you have to learn first (and maybe learn again when your
2992 vendor decides to `enhance' it).  With GiNaC you can write your program
2993 in common C++, which is standardized.
2994
2995 @cindex STL
2996 @item
2997 structured data types: you can build up structured data types using
2998 @code{struct}s or @code{class}es together with STL features instead of
2999 using unnamed lists of lists of lists.
3000
3001 @item
3002 strongly typed: in CAS, you usually have only one kind of variables
3003 which can hold contents of an arbitrary type.  This 4GL like feature is
3004 nice for novice programmers, but dangerous.
3005     
3006 @item
3007 development tools: powerful development tools exist for C++, like fancy
3008 editors (e.g. with automatic indentation and syntax highlighting),
3009 debuggers, visualization tools, documentation generators...
3010
3011 @item
3012 modularization: C++ programs can easily be split into modules by
3013 separating interface and implementation.
3014
3015 @item
3016 price: GiNaC is distributed under the GNU Public License which means
3017 that it is free and available with source code.  And there are excellent
3018 C++-compilers for free, too.
3019     
3020 @item
3021 extendable: you can add your own classes to GiNaC, thus extending it on
3022 a very low level.  Compare this to a traditional CAS that you can
3023 usually only extend on a high level by writing in the language defined
3024 by the parser.  In particular, it turns out to be almost impossible to
3025 fix bugs in a traditional system.
3026
3027 @item
3028 multiple interfaces: Though real GiNaC programs have to be written in
3029 some editor, then be compiled, linked and executed, there are more ways
3030 to work with the GiNaC engine.  Many people want to play with
3031 expressions interactively, as in traditional CASs.  Currently, two such
3032 windows into GiNaC have been implemented and many more are possible: the
3033 tiny @command{ginsh} that is part of the distribution exposes GiNaC's
3034 types to a command line and second, as a more consistent approach, an
3035 interactive interface to the @acronym{Cint} C++ interpreter has been put
3036 together (called @acronym{GiNaC-cint}) that allows an interactive
3037 scripting interface consistent with the C++ language.
3038
3039 @item
3040 seemless integration: it is somewhere between difficult and impossible
3041 to call CAS functions from within a program written in C++ or any other
3042 programming language and vice versa.  With GiNaC, your symbolic routines
3043 are part of your program.  You can easily call third party libraries,
3044 e.g. for numerical evaluation or graphical interaction.  All other
3045 approaches are much more cumbersome: they range from simply ignoring the
3046 problem (i.e. @emph{Maple}) to providing a method for `embedding' the
3047 system (i.e. @emph{Yacas}).
3048
3049 @item
3050 efficiency: often large parts of a program do not need symbolic
3051 calculations at all.  Why use large integers for loop variables or
3052 arbitrary precision arithmetics where @code{int} and @code{double} are
3053 sufficient?  For pure symbolic applications, GiNaC is comparable in
3054 speed with other CAS.
3055
3056 @end itemize
3057
3058
3059 @node Disadvantages, Why C++?, Advantages, A Comparison With Other CAS
3060 @c    node-name, next, previous, up
3061 @section Disadvantages
3062
3063 Of course it also has some disadvantages:
3064
3065 @itemize @bullet
3066
3067 @item
3068 advanced features: GiNaC cannot compete with a program like
3069 @emph{Reduce} which exists for more than 30 years now or @emph{Maple}
3070 which grows since 1981 by the work of dozens of programmers, with
3071 respect to mathematical features.  Integration, factorization,
3072 non-trivial simplifications, limits etc. are missing in GiNaC (and are
3073 not planned for the near future).
3074
3075 @item
3076 portability: While the GiNaC library itself is designed to avoid any
3077 platform dependent features (it should compile on any ANSI compliant C++
3078 compiler), the currently used version of the CLN library (fast large
3079 integer and arbitrary precision arithmetics) can be compiled only on
3080 systems with a recently new C++ compiler from the GNU Compiler
3081 Collection (@acronym{GCC}).@footnote{This is because CLN uses
3082 PROVIDE/REQUIRE like macros to let the compiler gather all static
3083 initializations, which works for GNU C++ only.}  GiNaC uses recent
3084 language features like explicit constructors, mutable members, RTTI,
3085 @code{dynamic_cast}s and STL, so ANSI compliance is meant literally.
3086 Recent @acronym{GCC} versions starting at 2.95, although itself not yet
3087 ANSI compliant, support all needed features.
3088     
3089 @end itemize
3090
3091
3092 @node Why C++?, Internal Structures, Disadvantages, A Comparison With Other CAS
3093 @c    node-name, next, previous, up
3094 @section Why C++?
3095
3096 Why did we choose to implement GiNaC in C++ instead of Java or any other
3097 language?  C++ is not perfect: type checking is not strict (casting is
3098 possible), separation between interface and implementation is not
3099 complete, object oriented design is not enforced.  The main reason is
3100 the often scolded feature of operator overloading in C++.  While it may
3101 be true that operating on classes with a @code{+} operator is rarely
3102 meaningful, it is perfectly suited for algebraic expressions.  Writing
3103 @math{3x+5y} as @code{3*x+5*y} instead of
3104 @code{x.times(3).plus(y.times(5))} looks much more natural.
3105 Furthermore, the main developers are more familiar with C++ than with
3106 any other programming language.
3107
3108
3109 @node Internal Structures, Expressions are reference counted, Why C++? , Top
3110 @c    node-name, next, previous, up
3111 @appendix Internal Structures
3112
3113 @menu
3114 * Expressions are reference counted::
3115 * Internal representation of products and sums::
3116 @end menu
3117
3118 @node Expressions are reference counted, Internal representation of products and sums, Internal Structures, Internal Structures
3119 @c    node-name, next, previous, up
3120 @appendixsection Expressions are reference counted
3121
3122 @cindex reference counting
3123 @cindex copy-on-write
3124 @cindex garbage collection
3125 An expression is extremely light-weight since internally it works like a
3126 handle to the actual representation and really holds nothing more than a
3127 pointer to some other object. What this means in practice is that
3128 whenever you create two @code{ex} and set the second equal to the first
3129 no copying process is involved. Instead, the copying takes place as soon
3130 as you try to change the second.  Consider the simple sequence of code:
3131
3132 @example
3133 #include <ginac/ginac.h>
3134 using namespace GiNaC;
3135
3136 int main()
3137 @{
3138     symbol x("x"), y("y"), z("z");
3139     ex e1, e2;
3140
3141     e1 = sin(x + 2*y) + 3*z + 41;
3142     e2 = e1;                // e2 points to same object as e1
3143     cout << e2 << endl;     // prints sin(x+2*y)+3*z+41
3144     e2 += 1;                // e2 is copied into a new object
3145     cout << e2 << endl;     // prints sin(x+2*y)+3*z+42
3146 @}
3147 @end example
3148
3149 The line @code{e2 = e1;} creates a second expression pointing to the
3150 object held already by @code{e1}.  The time involved for this operation
3151 is therefore constant, no matter how large @code{e1} was.  Actual
3152 copying, however, must take place in the line @code{e2 += 1;} because
3153 @code{e1} and @code{e2} are not handles for the same object any more.
3154 This concept is called @dfn{copy-on-write semantics}.  It increases
3155 performance considerably whenever one object occurs multiple times and
3156 represents a simple garbage collection scheme because when an @code{ex}
3157 runs out of scope its destructor checks whether other expressions handle
3158 the object it points to too and deletes the object from memory if that
3159 turns out not to be the case.  A slightly less trivial example of
3160 differentiation using the chain-rule should make clear how powerful this
3161 can be:
3162
3163 @example
3164 #include <ginac/ginac.h>
3165 using namespace GiNaC;
3166
3167 int main()
3168 @{
3169     symbol x("x"), y("y");
3170
3171     ex e1 = x + 3*y;
3172     ex e2 = pow(e1, 3);
3173     ex e3 = diff(sin(e2), x);   // first derivative of sin(e2) by x
3174     cout << e1 << endl          // prints x+3*y
3175          << e2 << endl          // prints (x+3*y)^3
3176          << e3 << endl;         // prints 3*(x+3*y)^2*cos((x+3*y)^3)
3177 @}
3178 @end example
3179
3180 Here, @code{e1} will actually be referenced three times while @code{e2}
3181 will be referenced two times.  When the power of an expression is built,
3182 that expression needs not be copied.  Likewise, since the derivative of
3183 a power of an expression can be easily expressed in terms of that
3184 expression, no copying of @code{e1} is involved when @code{e3} is
3185 constructed.  So, when @code{e3} is constructed it will print as
3186 @code{3*(x+3*y)^2*cos((x+3*y)^3)} but the argument of @code{cos()} only
3187 holds a reference to @code{e2} and the factor in front is just
3188 @code{3*e1^2}.
3189
3190 As a user of GiNaC, you cannot see this mechanism of copy-on-write
3191 semantics.  When you insert an expression into a second expression, the
3192 result behaves exactly as if the contents of the first expression were
3193 inserted.  But it may be useful to remember that this is not what
3194 happens.  Knowing this will enable you to write much more efficient
3195 code.  If you still have an uncertain feeling with copy-on-write
3196 semantics, we recommend you have a look at the
3197 @uref{http://www.cerfnet.com/~mpcline/c++-faq-lite/, C++-FAQ lite} by
3198 Marshall Cline.  Chapter 16 covers this issue and presents an
3199 implementation which is pretty close to the one in GiNaC.
3200
3201
3202 @node Internal representation of products and sums, Package Tools, Expressions are reference counted, Internal Structures
3203 @c    node-name, next, previous, up
3204 @appendixsection Internal representation of products and sums
3205
3206 @cindex representation
3207 @cindex @code{add}
3208 @cindex @code{mul}
3209 @cindex @code{power}
3210 Although it should be completely transparent for the user of
3211 GiNaC a short discussion of this topic helps to understand the sources
3212 and also explain performance to a large degree.  Consider the 
3213 unexpanded symbolic expression 
3214 @tex
3215 $2d^3 \left( 4a + 5b - 3 \right)$
3216 @end tex
3217 @ifnottex
3218 @math{2*d^3*(4*a+5*b-3)}
3219 @end ifnottex
3220 which could naively be represented by a tree of linear containers for
3221 addition and multiplication, one container for exponentiation with base
3222 and exponent and some atomic leaves of symbols and numbers in this
3223 fashion:
3224
3225 @image{repnaive}
3226
3227 @cindex pair-wise representation
3228 However, doing so results in a rather deeply nested tree which will
3229 quickly become inefficient to manipulate.  We can improve on this by
3230 representing the sum as a sequence of terms, each one being a pair of a
3231 purely numeric multiplicative coefficient and its rest.  In the same
3232 spirit we can store the multiplication as a sequence of terms, each
3233 having a numeric exponent and a possibly complicated base, the tree
3234 becomes much more flat:
3235
3236 @image{reppair}
3237
3238 The number @code{3} above the symbol @code{d} shows that @code{mul}
3239 objects are treated similarly where the coefficients are interpreted as
3240 @emph{exponents} now.  Addition of sums of terms or multiplication of
3241 products with numerical exponents can be coded to be very efficient with
3242 such a pair-wise representation.  Internally, this handling is performed
3243 by most CAS in this way.  It typically speeds up manipulations by an
3244 order of magnitude.  The overall multiplicative factor @code{2} and the
3245 additive term @code{-3} look somewhat out of place in this
3246 representation, however, since they are still carrying a trivial
3247 exponent and multiplicative factor @code{1} respectively.  Within GiNaC,
3248 this is avoided by adding a field that carries an overall numeric
3249 coefficient.  This results in the realistic picture of internal
3250 representation for
3251 @tex
3252 $2d^3 \left( 4a + 5b - 3 \right)$:
3253 @end tex
3254 @ifnottex
3255 @math{2*d^3*(4*a+5*b-3)}:
3256 @end ifnottex
3257
3258 @image{repreal}
3259
3260 @cindex radical
3261 This also allows for a better handling of numeric radicals, since
3262 @code{sqrt(2)} can now be carried along calculations.  Now it should be
3263 clear, why both classes @code{add} and @code{mul} are derived from the
3264 same abstract class: the data representation is the same, only the
3265 semantics differs.  In the class hierarchy, methods for polynomial
3266 expansion and the like are reimplemented for @code{add} and @code{mul},
3267 but the data structure is inherited from @code{expairseq}.
3268
3269
3270 @node Package Tools, ginac-config, Internal representation of products and sums, Top
3271 @c    node-name, next, previous, up
3272 @appendix Package Tools
3273
3274 If you are creating a software package that uses the GiNaC library,
3275 setting the correct command line options for the compiler and linker
3276 can be difficult. GiNaC includes two tools to make this process easier.
3277
3278 @menu
3279 * ginac-config::   A shell script to detect compiler and linker flags.
3280 * AM_PATH_GINAC::  Macro for GNU automake.
3281 @end menu
3282
3283
3284 @node ginac-config, AM_PATH_GINAC, Package Tools, Package Tools
3285 @c    node-name, next, previous, up
3286 @section @command{ginac-config}
3287 @cindex ginac-config
3288
3289 @command{ginac-config} is a shell script that you can use to determine
3290 the compiler and linker command line options required to compile and
3291 link a program with the GiNaC library.
3292
3293 @command{ginac-config} takes the following flags:
3294
3295 @table @samp
3296 @item --version
3297 Prints out the version of GiNaC installed.
3298 @item --cppflags
3299 Prints '-I' flags pointing to the installed header files.
3300 @item --libs
3301 Prints out the linker flags necessary to link a program against GiNaC.
3302 @item --prefix[=@var{PREFIX}]
3303 If @var{PREFIX} is specified, overrides the configured value of @env{$prefix}.
3304 (And of exec-prefix, unless @code{--exec-prefix} is also specified)
3305 Otherwise, prints out the configured value of @env{$prefix}.
3306 @item --exec-prefix[=@var{PREFIX}]
3307 If @var{PREFIX} is specified, overrides the configured value of @env{$exec_prefix}.
3308 Otherwise, prints out the configured value of @env{$exec_prefix}.
3309 @end table
3310
3311 Typically, @command{ginac-config} will be used within a configure
3312 script, as described below. It, however, can also be used directly from
3313 the command line using backquotes to compile a simple program. For
3314 example:
3315
3316 @example
3317 c++ -o simple `ginac-config --cppflags` simple.cpp `ginac-config --libs`
3318 @end example
3319
3320 This command line might expand to (for example):
3321
3322 @example
3323 cc -o simple -I/usr/local/include simple.cpp -L/usr/local/lib \
3324   -lginac -lcln -lstdc++
3325 @end example
3326
3327 Not only is the form using @command{ginac-config} easier to type, it will
3328 work on any system, no matter how GiNaC was configured.
3329
3330
3331 @node AM_PATH_GINAC, Configure script options, ginac-config, Package Tools
3332 @c    node-name, next, previous, up
3333 @section @samp{AM_PATH_GINAC}
3334 @cindex AM_PATH_GINAC
3335
3336 For packages configured using GNU automake, GiNaC also provides
3337 a macro to automate the process of checking for GiNaC.
3338
3339 @example
3340 AM_PATH_GINAC([@var{MINIMUM-VERSION}, [@var{ACTION-IF-FOUND} [, @var{ACTION-IF-NOT-FOUND}]]])
3341 @end example
3342
3343 This macro:
3344
3345 @itemize @bullet
3346
3347 @item
3348 Determines the location of GiNaC using @command{ginac-config}, which is
3349 either found in the user's path, or from the environment variable
3350 @env{GINACLIB_CONFIG}.
3351
3352 @item
3353 Tests the installed libraries to make sure that their version
3354 is later than @var{MINIMUM-VERSION}. (A default version will be used
3355 if not specified)
3356
3357 @item
3358 If the required version was found, sets the @env{GINACLIB_CPPFLAGS} variable
3359 to the output of @command{ginac-config --cppflags} and the @env{GINACLIB_LIBS}
3360 variable to the output of @command{ginac-config --libs}, and calls
3361 @samp{AC_SUBST()} for these variables so they can be used in generated
3362 makefiles, and then executes @var{ACTION-IF-FOUND}.
3363
3364 @item
3365 If the required version was not found, sets @env{GINACLIB_CPPFLAGS} and
3366 @env{GINACLIB_LIBS} to empty strings, and executes @var{ACTION-IF-NOT-FOUND}.
3367
3368 @end itemize
3369
3370 This macro is in file @file{ginac.m4} which is installed in
3371 @file{$datadir/aclocal}. Note that if automake was installed with a
3372 different @samp{--prefix} than GiNaC, you will either have to manually
3373 move @file{ginac.m4} to automake's @file{$datadir/aclocal}, or give
3374 aclocal the @samp{-I} option when running it.
3375
3376 @menu
3377 * Configure script options::  Configuring a package that uses AM_PATH_GINAC.
3378 * Example package::           Example of a package using AM_PATH_GINAC.
3379 @end menu
3380
3381
3382 @node Configure script options, Example package, AM_PATH_GINAC, AM_PATH_GINAC
3383 @c    node-name, next, previous, up
3384 @subsection Configuring a package that uses @samp{AM_PATH_GINAC}
3385
3386 Simply make sure that @command{ginac-config} is in your path, and run
3387 the configure script.
3388
3389 Notes:
3390
3391 @itemize @bullet
3392
3393 @item
3394 The directory where the GiNaC libraries are installed needs
3395 to be found by your system's dynamic linker.
3396   
3397 This is generally done by
3398
3399 @display
3400 editing @file{/etc/ld.so.conf} and running @command{ldconfig}
3401 @end display
3402
3403 or by
3404    
3405 @display
3406 setting the environment variable @env{LD_LIBRARY_PATH},
3407 @end display
3408
3409 or, as a last resort, 
3410  
3411 @display
3412 giving a @samp{-R} or @samp{-rpath} flag (depending on your linker) when
3413 running configure, for instance:
3414
3415 @example
3416 LDFLAGS=-R/home/cbauer/lib ./configure
3417 @end example
3418 @end display
3419
3420 @item
3421 You can also specify a @command{ginac-config} not in your path by
3422 setting the @env{GINACLIB_CONFIG} environment variable to the
3423 name of the executable
3424
3425 @item
3426 If you move the GiNaC package from its installed location,
3427 you will either need to modify @command{ginac-config} script
3428 manually to point to the new location or rebuild GiNaC.
3429
3430 @end itemize
3431
3432 Advanced note:
3433
3434 @itemize @bullet
3435 @item
3436 configure flags
3437   
3438 @example
3439 --with-ginac-prefix=@var{PREFIX}
3440 --with-ginac-exec-prefix=@var{PREFIX}
3441 @end example
3442
3443 are provided to override the prefix and exec-prefix that were stored
3444 in the @command{ginac-config} shell script by GiNaC's configure. You are
3445 generally better off configuring GiNaC with the right path to begin with.
3446 @end itemize
3447
3448
3449 @node Example package, Bibliography, Configure script options, AM_PATH_GINAC
3450 @c    node-name, next, previous, up
3451 @subsection Example of a package using @samp{AM_PATH_GINAC}
3452
3453 The following shows how to build a simple package using automake
3454 and the @samp{AM_PATH_GINAC} macro. The program used here is @file{simple.cpp}:
3455
3456 @example
3457 #include <ginac/ginac.h>
3458 using namespace GiNaC;
3459
3460 int main(void)
3461 @{
3462     symbol x("x");
3463     ex a = sin(x); 
3464     cout << "Derivative of " << a << " is " << a.diff(x) << endl;
3465     return 0;
3466 @}
3467 @end example
3468
3469 You should first read the introductory portions of the automake
3470 Manual, if you are not already familiar with it.
3471
3472 Two files are needed, @file{configure.in}, which is used to build the
3473 configure script:
3474
3475 @example
3476 dnl Process this file with autoconf to produce a configure script.
3477 AC_INIT(simple.cpp)
3478 AM_INIT_AUTOMAKE(simple.cpp, 1.0.0)
3479
3480 AC_PROG_CXX
3481 AC_PROG_INSTALL
3482 AC_LANG_CPLUSPLUS
3483
3484 AM_PATH_GINAC(0.7.0, [
3485   LIBS="$LIBS $GINACLIB_LIBS"
3486   CPPFLAGS="$CPPFLAGS $GINACLIB_CPPFLAGS"  
3487 ], AC_MSG_ERROR([need to have GiNaC installed]))
3488
3489 AC_OUTPUT(Makefile)
3490 @end example
3491
3492 The only command in this which is not standard for automake
3493 is the @samp{AM_PATH_GINAC} macro.
3494
3495 That command does the following: If a GiNaC version greater or equal
3496 than 0.7.0 is found, then it adds @env{$GINACLIB_LIBS} to @env{$LIBS}
3497 and @env{$GINACLIB_CPPFLAGS} to @env{$CPPFLAGS}. Otherwise, it dies with
3498 the error message `need to have GiNaC installed'
3499
3500 And the @file{Makefile.am}, which will be used to build the Makefile.
3501
3502 @example
3503 ## Process this file with automake to produce Makefile.in
3504 bin_PROGRAMS = simple
3505 simple_SOURCES = simple.cpp
3506 @end example
3507
3508 This @file{Makefile.am}, says that we are building a single executable,
3509 from a single sourcefile @file{simple.cpp}. Since every program
3510 we are building uses GiNaC we simply added the GiNaC options
3511 to @env{$LIBS} and @env{$CPPFLAGS}, but in other circumstances, we might
3512 want to specify them on a per-program basis: for instance by
3513 adding the lines:
3514
3515 @example
3516 simple_LDADD = $(GINACLIB_LIBS)
3517 INCLUDES = $(GINACLIB_CPPFLAGS)
3518 @end example
3519
3520 to the @file{Makefile.am}.
3521
3522 To try this example out, create a new directory and add the three
3523 files above to it.
3524
3525 Now execute the following commands:
3526
3527 @example
3528 $ automake --add-missing
3529 $ aclocal
3530 $ autoconf
3531 @end example
3532
3533 You now have a package that can be built in the normal fashion
3534
3535 @example
3536 $ ./configure
3537 $ make
3538 $ make install
3539 @end example
3540
3541
3542 @node Bibliography, Concept Index, Example package, Top
3543 @c    node-name, next, previous, up
3544 @appendix Bibliography
3545
3546 @itemize @minus{}
3547
3548 @item
3549 @cite{ISO/IEC 14882:1998: Programming Languages: C++}
3550
3551 @item
3552 @cite{CLN: A Class Library for Numbers}, @email{haible@@ilog.fr, Bruno Haible}
3553
3554 @item
3555 @cite{The C++ Programming Language}, Bjarne Stroustrup, 3rd Edition, ISBN 0-201-88954-4, Addison Wesley
3556
3557 @item
3558 @cite{C++ FAQs}, Marshall Cline, ISBN 0-201-58958-3, 1995, Addison Wesley
3559
3560 @item
3561 @cite{Algorithms for Computer Algebra}, Keith O. Geddes, Stephen R. Czapor,
3562 and George Labahn, ISBN 0-7923-9259-0, 1992, Kluwer Academic Publishers, Norwell, Massachusetts
3563
3564 @item
3565 @cite{Computer Algebra: Systems and Algorithms for Algebraic Computation},
3566 J.H. Davenport, Y. Siret, and E. Tournier, ISBN 0-12-204230-1, 1988, 
3567 Academic Press, London
3568
3569 @end itemize
3570
3571
3572 @node Concept Index, , Bibliography, Top
3573 @c    node-name, next, previous, up
3574 @unnumbered Concept Index
3575
3576 @printindex cp
3577
3578 @bye