degree(), ldegree(), coeff(), lcoeff(), tcoeff() and collect() can now
[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 std;
184 using namespace GiNaC;
185
186 int main()
187 @{
188     symbol x("x"), y("y");
189     ex poly;
190
191     for (int i=0; i<3; ++i)
192         poly += factorial(i+16)*pow(x,i)*pow(y,2-i);
193
194     cout << poly << endl;
195     return 0;
196 @}
197 @end example
198
199 Assuming the file is called @file{hello.cc}, on our system we can compile
200 and run it like this:
201
202 @example
203 $ c++ hello.cc -o hello -lcln -lginac
204 $ ./hello
205 355687428096000*x*y+20922789888000*y^2+6402373705728000*x^2
206 @end example
207
208 (@xref{Package Tools}, for tools that help you when creating a software
209 package that uses GiNaC.)
210
211 @cindex Hermite polynomial
212 Next, there is a more meaningful C++ program that calls a function which
213 generates Hermite polynomials in a specified free variable.
214
215 @example
216 #include <ginac/ginac.h>
217 using namespace std;
218 using namespace GiNaC;
219
220 ex HermitePoly(const symbol & x, int n)
221 @{
222     ex HKer=exp(-pow(x, 2));
223     // uses the identity H_n(x) == (-1)^n exp(x^2) (d/dx)^n exp(-x^2)
224     return normal(pow(-1, n) * diff(HKer, x, n) / HKer);
225 @}
226
227 int main()
228 @{
229     symbol z("z");
230
231     for (int i=0; i<6; ++i)
232         cout << "H_" << i << "(z) == " << HermitePoly(z,i) << endl;
233
234     return 0;
235 @}
236 @end example
237
238 When run, this will type out
239
240 @example
241 H_0(z) == 1
242 H_1(z) == 2*z
243 H_2(z) == 4*z^2-2
244 H_3(z) == -12*z+8*z^3
245 H_4(z) == -48*z^2+16*z^4+12
246 H_5(z) == 120*z-160*z^3+32*z^5
247 @end example
248
249 This method of generating the coefficients is of course far from optimal
250 for production purposes.
251
252 In order to show some more examples of what GiNaC can do we will now use
253 the @command{ginsh}, a simple GiNaC interactive shell that provides a
254 convenient window into GiNaC's capabilities.
255
256
257 @node What it can do for you, Installation, How to use it from within C++, A Tour of GiNaC
258 @c    node-name, next, previous, up
259 @section What it can do for you
260
261 @cindex @command{ginsh}
262 After invoking @command{ginsh} one can test and experiment with GiNaC's
263 features much like in other Computer Algebra Systems except that it does
264 not provide programming constructs like loops or conditionals.  For a
265 concise description of the @command{ginsh} syntax we refer to its
266 accompanied man page. Suffice to say that assignments and comparisons in
267 @command{ginsh} are written as they are in C, i.e. @code{=} assigns and
268 @code{==} compares.
269
270 It can manipulate arbitrary precision integers in a very fast way.
271 Rational numbers are automatically converted to fractions of coprime
272 integers:
273
274 @example
275 > x=3^150;
276 369988485035126972924700782451696644186473100389722973815184405301748249
277 > y=3^149;
278 123329495011708990974900260817232214728824366796574324605061468433916083
279 > x/y;
280 3
281 > y/x;
282 1/3
283 @end example
284
285 Exact numbers are always retained as exact numbers and only evaluated as
286 floating point numbers if requested.  For instance, with numeric
287 radicals is dealt pretty much as with symbols.  Products of sums of them
288 can be expanded:
289
290 @example
291 > expand((1+a^(1/5)-a^(2/5))^3);
292 1+3*a+3*a^(1/5)-5*a^(3/5)-a^(6/5)
293 > expand((1+3^(1/5)-3^(2/5))^3);
294 10-5*3^(3/5)
295 > evalf((1+3^(1/5)-3^(2/5))^3);
296 0.33408977534118624228
297 @end example
298
299 The function @code{evalf} that was used above converts any number in
300 GiNaC's expressions into floating point numbers.  This can be done to
301 arbitrary predefined accuracy:
302
303 @example
304 > evalf(1/7);
305 0.14285714285714285714
306 > Digits=150;
307 150
308 > evalf(1/7);
309 0.1428571428571428571428571428571428571428571428571428571428571428571428
310 5714285714285714285714285714285714285
311 @end example
312
313 Exact numbers other than rationals that can be manipulated in GiNaC
314 include predefined constants like Archimedes' @code{Pi}.  They can both
315 be used in symbolic manipulations (as an exact number) as well as in
316 numeric expressions (as an inexact number):
317
318 @example
319 > a=Pi^2+x;
320 x+Pi^2
321 > evalf(a);
322 9.869604401089358619+x
323 > x=2;
324 2
325 > evalf(a);
326 11.869604401089358619
327 @end example
328
329 Built-in functions evaluate immediately to exact numbers if
330 this is possible.  Conversions that can be safely performed are done
331 immediately; conversions that are not generally valid are not done:
332
333 @example
334 > cos(42*Pi);
335 1
336 > cos(acos(x));
337 x
338 > acos(cos(x));
339 acos(cos(x))
340 @end example
341
342 (Note that converting the last input to @code{x} would allow one to
343 conclude that @code{42*Pi} is equal to @code{0}.)
344
345 Linear equation systems can be solved along with basic linear
346 algebra manipulations over symbolic expressions.  In C++ GiNaC offers
347 a matrix class for this purpose but we can see what it can do using
348 @command{ginsh}'s notation of double brackets to type them in:
349
350 @example
351 > lsolve(a+x*y==z,x);
352 y^(-1)*(z-a);
353 > lsolve([3*x+5*y == 7, -2*x+10*y == -5], [x, y]);
354 [x==19/8,y==-1/40]
355 > M = [[ [[1, 3]], [[-3, 2]] ]];
356 [[ [[1,3]], [[-3,2]] ]]
357 > determinant(M);
358 11
359 > charpoly(M,lambda);
360 lambda^2-3*lambda+11
361 @end example
362
363 Multivariate polynomials and rational functions may be expanded,
364 collected and normalized (i.e. converted to a ratio of two coprime 
365 polynomials):
366
367 @example
368 > a = x^4 + 2*x^2*y^2 + 4*x^3*y + 12*x*y^3 - 3*y^4;
369 -3*y^4+x^4+12*x*y^3+2*x^2*y^2+4*x^3*y
370 > b = x^2 + 4*x*y - y^2;
371 -y^2+x^2+4*x*y
372 > expand(a*b);
373 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
374 > collect(a*b,x);
375 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)
376 > normal(a/b);
377 3*y^2+x^2
378 @end example
379
380 You can differentiate functions and expand them as Taylor or Laurent
381 series in a very natural syntax (the second argument of @code{series} is
382 a relation defining the evaluation point, the third specifies the
383 order):
384
385 @cindex Zeta function
386 @example
387 > diff(tan(x),x);
388 tan(x)^2+1
389 > series(sin(x),x==0,4);
390 x-1/6*x^3+Order(x^4)
391 > series(1/tan(x),x==0,4);
392 x^(-1)-1/3*x+Order(x^2)
393 > series(tgamma(x),x==0,3);
394 x^(-1)-Euler+(1/12*Pi^2+1/2*Euler^2)*x+
395 (-1/3*zeta(3)-1/12*Pi^2*Euler-1/6*Euler^3)*x^2+Order(x^3)
396 > evalf(");
397 x^(-1)-0.5772156649015328606+(0.9890559953279725555)*x
398 -(0.90747907608088628905)*x^2+Order(x^3)
399 > series(tgamma(2*sin(x)-2),x==Pi/2,6);
400 -(x-1/2*Pi)^(-2)+(-1/12*Pi^2-1/2*Euler^2-1/240)*(x-1/2*Pi)^2
401 -Euler-1/12+Order((x-1/2*Pi)^3)
402 @end example
403
404 Here we have made use of the @command{ginsh}-command @code{"} to pop the
405 previously evaluated element from @command{ginsh}'s internal stack.
406
407 If you ever wanted to convert units in C or C++ and found this is
408 cumbersome, here is the solution.  Symbolic types can always be used as
409 tags for different types of objects.  Converting from wrong units to the
410 metric system is now easy:
411
412 @example
413 > in=.0254*m;
414 0.0254*m
415 > lb=.45359237*kg;
416 0.45359237*kg
417 > 200*lb/in^2;
418 140613.91592783185568*kg*m^(-2)
419 @end example
420
421
422 @node Installation, Prerequisites, What it can do for you, Top
423 @c    node-name, next, previous, up
424 @chapter Installation
425
426 @cindex CLN
427 GiNaC's installation follows the spirit of most GNU software. It is
428 easily installed on your system by three steps: configuration, build,
429 installation.
430
431 @menu
432 * Prerequisites::                Packages upon which GiNaC depends.
433 * Configuration::                How to configure GiNaC.
434 * Building GiNaC::               How to compile GiNaC.
435 * Installing GiNaC::             How to install GiNaC on your system.
436 @end menu
437
438
439 @node Prerequisites, Configuration, Installation, Installation
440 @c    node-name, next, previous, up
441 @section Prerequisites
442
443 In order to install GiNaC on your system, some prerequisites need to be
444 met.  First of all, you need to have a C++-compiler adhering to the
445 ANSI-standard @cite{ISO/IEC 14882:1998(E)}.  We used @acronym{GCC} for
446 development so if you have a different compiler you are on your own.
447 For the configuration to succeed you need a Posix compliant shell
448 installed in @file{/bin/sh}, GNU @command{bash} is fine.  Perl is needed
449 by the built process as well, since some of the source files are
450 automatically generated by Perl scripts.  Last but not least, Bruno
451 Haible's library @acronym{CLN} is extensively used and needs to be
452 installed on your system.  Please get it either from
453 @uref{ftp://ftp.santafe.edu/pub/gnu/}, from
454 @uref{ftp://ftpthep.physik.uni-mainz.de/pub/gnu/, GiNaC's FTP site} or
455 from @uref{ftp://ftp.ilog.fr/pub/Users/haible/gnu/, Bruno Haible's FTP
456 site} (it is covered by GPL) and install it prior to trying to install
457 GiNaC.  The configure script checks if it can find it and if it cannot
458 it will refuse to continue.
459
460
461 @node Configuration, Building GiNaC, Prerequisites, Installation
462 @c    node-name, next, previous, up
463 @section Configuration
464 @cindex configuration
465 @cindex Autoconf
466
467 To configure GiNaC means to prepare the source distribution for
468 building.  It is done via a shell script called @command{configure} that
469 is shipped with the sources and was originally generated by GNU
470 Autoconf.  Since a configure script generated by GNU Autoconf never
471 prompts, all customization must be done either via command line
472 parameters or environment variables.  It accepts a list of parameters,
473 the complete set of which can be listed by calling it with the
474 @option{--help} option.  The most important ones will be shortly
475 described in what follows:
476
477 @itemize @bullet
478
479 @item
480 @option{--disable-shared}: When given, this option switches off the
481 build of a shared library, i.e. a @file{.so} file.  This may be convenient
482 when developing because it considerably speeds up compilation.
483
484 @item
485 @option{--prefix=@var{PREFIX}}: The directory where the compiled library
486 and headers are installed. It defaults to @file{/usr/local} which means
487 that the library is installed in the directory @file{/usr/local/lib},
488 the header files in @file{/usr/local/include/ginac} and the documentation
489 (like this one) into @file{/usr/local/share/doc/GiNaC}.
490
491 @item
492 @option{--libdir=@var{LIBDIR}}: Use this option in case you want to have
493 the library installed in some other directory than
494 @file{@var{PREFIX}/lib/}.
495
496 @item
497 @option{--includedir=@var{INCLUDEDIR}}: Use this option in case you want
498 to have the header files installed in some other directory than
499 @file{@var{PREFIX}/include/ginac/}. For instance, if you specify
500 @option{--includedir=/usr/include} you will end up with the header files
501 sitting in the directory @file{/usr/include/ginac/}. Note that the
502 subdirectory @file{ginac} is enforced by this process in order to
503 keep the header files separated from others.  This avoids some
504 clashes and allows for an easier deinstallation of GiNaC. This ought
505 to be considered A Good Thing (tm).
506
507 @item
508 @option{--datadir=@var{DATADIR}}: This option may be given in case you
509 want to have the documentation installed in some other directory than
510 @file{@var{PREFIX}/share/doc/GiNaC/}.
511
512 @end itemize
513
514 In addition, you may specify some environment variables.
515 @env{CXX} holds the path and the name of the C++ compiler
516 in case you want to override the default in your path.  (The
517 @command{configure} script searches your path for @command{c++},
518 @command{g++}, @command{gcc}, @command{CC}, @command{cxx}
519 and @command{cc++} in that order.)  It may be very useful to
520 define some compiler flags with the @env{CXXFLAGS} environment
521 variable, like optimization, debugging information and warning
522 levels.  If omitted, it defaults to @option{-g -O2}.
523
524 The whole process is illustrated in the following two
525 examples. (Substitute @command{setenv @var{VARIABLE} @var{value}} for
526 @command{export @var{VARIABLE}=@var{value}} if the Berkeley C shell is
527 your login shell.)
528
529 Here is a simple configuration for a site-wide GiNaC library assuming
530 everything is in default paths:
531
532 @example
533 $ export CXXFLAGS="-Wall -O2"
534 $ ./configure
535 @end example
536
537 And here is a configuration for a private static GiNaC library with
538 several components sitting in custom places (site-wide @acronym{GCC} and
539 private @acronym{CLN}).  The compiler is pursuaded to be picky and full
540 assertions and debugging information are switched on:
541
542 @example
543 $ export CXX=/usr/local/gnu/bin/c++
544 $ export CPPFLAGS="$(CPPFLAGS) -I$(HOME)/include"
545 $ export CXXFLAGS="$(CXXFLAGS) -DDO_GINAC_ASSERT -ggdb -Wall -ansi -pedantic"
546 $ export LDFLAGS="$(LDFLAGS) -L$(HOME)/lib"
547 $ ./configure --disable-shared --prefix=$(HOME)
548 @end example
549
550
551 @node Building GiNaC, Installing GiNaC, Configuration, Installation
552 @c    node-name, next, previous, up
553 @section Building GiNaC
554 @cindex building GiNaC
555
556 After proper configuration you should just build the whole
557 library by typing
558 @example
559 $ make
560 @end example
561 at the command prompt and go for a cup of coffee.  The exact time it
562 takes to compile GiNaC depends not only on the speed of your machines
563 but also on other parameters, for instance what value for @env{CXXFLAGS}
564 you entered.  Optimization may be very time-consuming.
565
566 Just to make sure GiNaC works properly you may run a collection of
567 regression tests by typing
568
569 @example
570 $ make check
571 @end example
572
573 This will compile some sample programs, run them and check the output
574 for correctness.  The regression tests fall in three categories.  First,
575 the so called @emph{exams} are performed, simple tests where some
576 predefined input is evaluated (like a pupils' exam).  Second, the
577 @emph{checks} test the coherence of results among each other with
578 possible random input.  Third, some @emph{timings} are performed, which
579 benchmark some predefined problems with different sizes and display the
580 CPU time used in seconds.  Each individual test should return a message
581 @samp{passed}.  This is mostly intended to be a QA-check if something
582 was broken during development, not a sanity check of your system.  Some
583 of the tests in sections @emph{checks} and @emph{timings} may require
584 insane amounts of memory and CPU time.  Feel free to kill them if your
585 machine catches fire.  Another quite important intent is to allow people
586 to fiddle around with optimization.
587
588 Generally, the top-level Makefile runs recursively to the
589 subdirectories.  It is therfore safe to go into any subdirectory
590 (@code{doc/}, @code{ginsh/}, ...) and simply type @code{make}
591 @var{target} there in case something went wrong.
592
593
594 @node Installing GiNaC, Basic Concepts, Building GiNaC, Installation
595 @c    node-name, next, previous, up
596 @section Installing GiNaC
597 @cindex installation
598
599 To install GiNaC on your system, simply type
600
601 @example
602 $ make install
603 @end example
604
605 As described in the section about configuration the files will be
606 installed in the following directories (the directories will be created
607 if they don't already exist):
608
609 @itemize @bullet
610
611 @item
612 @file{libginac.a} will go into @file{@var{PREFIX}/lib/} (or
613 @file{@var{LIBDIR}}) which defaults to @file{/usr/local/lib/}.
614 So will @file{libginac.so} unless the configure script was
615 given the option @option{--disable-shared}.  The proper symlinks
616 will be established as well.
617
618 @item
619 All the header files will be installed into @file{@var{PREFIX}/include/ginac/}
620 (or @file{@var{INCLUDEDIR}/ginac/}, if specified).
621
622 @item
623 All documentation (HTML and Postscript) will be stuffed into
624 @file{@var{PREFIX}/share/doc/GiNaC/} (or
625 @file{@var{DATADIR}/doc/GiNaC/}, if @var{DATADIR} was specified).
626
627 @end itemize
628
629 For the sake of completeness we will list some other useful make
630 targets: @command{make clean} deletes all files generated by
631 @command{make}, i.e. all the object files.  In addition @command{make
632 distclean} removes all files generated by the configuration and
633 @command{make maintainer-clean} goes one step further and deletes files
634 that may require special tools to rebuild (like the @command{libtool}
635 for instance).  Finally @command{make uninstall} removes the installed
636 library, header files and documentation@footnote{Uninstallation does not
637 work after you have called @command{make distclean} since the
638 @file{Makefile} is itself generated by the configuration from
639 @file{Makefile.in} and hence deleted by @command{make distclean}.  There
640 are two obvious ways out of this dilemma.  First, you can run the
641 configuration again with the same @var{PREFIX} thus creating a
642 @file{Makefile} with a working @samp{uninstall} target.  Second, you can
643 do it by hand since you now know where all the files went during
644 installation.}.
645
646
647 @node Basic Concepts, Expressions, Installing GiNaC, Top
648 @c    node-name, next, previous, up
649 @chapter Basic Concepts
650
651 This chapter will describe the different fundamental objects that can be
652 handled by GiNaC.  But before doing so, it is worthwhile introducing you
653 to the more commonly used class of expressions, representing a flexible
654 meta-class for storing all mathematical objects.
655
656 @menu
657 * Expressions::                  The fundamental GiNaC class.
658 * The Class Hierarchy::          Overview of GiNaC's classes.
659 * Symbols::                      Symbolic objects.
660 * Numbers::                      Numerical objects.
661 * Constants::                    Pre-defined constants.
662 * Fundamental containers::       The power, add and mul classes.
663 * Lists::                        Lists of expressions.
664 * Mathematical functions::       Mathematical functions.
665 * Relations::                    Equality, Inequality and all that.
666 * Indexed objects::              Handling indexed quantities.
667 @end menu
668
669
670 @node Expressions, The Class Hierarchy, Basic Concepts, Basic Concepts
671 @c    node-name, next, previous, up
672 @section Expressions
673 @cindex expression (class @code{ex})
674 @cindex @code{has()}
675
676 The most common class of objects a user deals with is the expression
677 @code{ex}, representing a mathematical object like a variable, number,
678 function, sum, product, etc...  Expressions may be put together to form
679 new expressions, passed as arguments to functions, and so on.  Here is a
680 little collection of valid expressions:
681
682 @example
683 ex MyEx1 = 5;                       // simple number
684 ex MyEx2 = x + 2*y;                 // polynomial in x and y
685 ex MyEx3 = (x + 1)/(x - 1);         // rational expression
686 ex MyEx4 = sin(x + 2*y) + 3*z + 41; // containing a function
687 ex MyEx5 = MyEx4 + 1;               // similar to above
688 @end example
689
690 Expressions are handles to other more fundamental objects, that often
691 contain other expressions thus creating a tree of expressions
692 (@xref{Internal Structures}, for particular examples).  Most methods on
693 @code{ex} therefore run top-down through such an expression tree.  For
694 example, the method @code{has()} scans recursively for occurrences of
695 something inside an expression.  Thus, if you have declared @code{MyEx4}
696 as in the example above @code{MyEx4.has(y)} will find @code{y} inside
697 the argument of @code{sin} and hence return @code{true}.
698
699 The next sections will outline the general picture of GiNaC's class
700 hierarchy and describe the classes of objects that are handled by
701 @code{ex}.
702
703
704 @node The Class Hierarchy, Symbols, Expressions, Basic Concepts
705 @c    node-name, next, previous, up
706 @section The Class Hierarchy
707
708 GiNaC's class hierarchy consists of several classes representing
709 mathematical objects, all of which (except for @code{ex} and some
710 helpers) are internally derived from one abstract base class called
711 @code{basic}.  You do not have to deal with objects of class
712 @code{basic}, instead you'll be dealing with symbols, numbers,
713 containers of expressions and so on.
714
715 @cindex container
716 @cindex atom
717 To get an idea about what kinds of symbolic composits may be built we
718 have a look at the most important classes in the class hierarchy and
719 some of the relations among the classes:
720
721 @image{classhierarchy}
722
723 The abstract classes shown here (the ones without drop-shadow) are of no
724 interest for the user.  They are used internally in order to avoid code
725 duplication if two or more classes derived from them share certain
726 features.  An example is @code{expairseq}, a container for a sequence of
727 pairs each consisting of one expression and a number (@code{numeric}).
728 What @emph{is} visible to the user are the derived classes @code{add}
729 and @code{mul}, representing sums and products.  @xref{Internal
730 Structures}, where these two classes are described in more detail.  The
731 following table shortly summarizes what kinds of mathematical objects
732 are stored in the different classes:
733
734 @cartouche
735 @multitable @columnfractions .22 .78
736 @item @code{symbol} @tab Algebraic symbols @math{a}, @math{x}, @math{y}@dots{}
737 @item @code{constant} @tab Constants like 
738 @tex
739 $\pi$
740 @end tex
741 @ifnottex
742 @math{Pi}
743 @end ifnottex
744 @item @code{numeric} @tab All kinds of numbers, @math{42}, @math{7/3*I}, @math{3.14159}@dots{}
745 @item @code{add} @tab Sums like @math{x+y} or @math{a-(2*b)+3}
746 @item @code{mul} @tab Products like @math{x*y} or @math{2*a^2*(x+y+z)/b}
747 @item @code{power} @tab Exponentials such as @math{x^2}, @math{a^b}, 
748 @tex
749 $\sqrt{2}$
750 @end tex
751 @ifnottex
752 @code{sqrt(}@math{2}@code{)}
753 @end ifnottex
754 @dots{}
755 @item @code{pseries} @tab Power Series, e.g. @math{x-1/6*x^3+1/120*x^5+O(x^7)}
756 @item @code{function} @tab A symbolic function like @math{sin(2*x)}
757 @item @code{lst} @tab Lists of expressions [@math{x}, @math{2*y}, @math{3+z}]
758 @item @code{matrix} @tab @math{n}x@math{m} matrices of expressions
759 @item @code{relational} @tab A relation like the identity @math{x}@code{==}@math{y}
760 @item @code{indexed} @tab Indexed object like @math{A_ij}
761 @item @code{tensor} @tab Special tensor like the delta and metric tensors
762 @item @code{idx} @tab Index of an indexed object
763 @item @code{varidx} @tab Index with variance
764 @end multitable
765 @end cartouche
766
767 @node Symbols, Numbers, The Class Hierarchy, Basic Concepts
768 @c    node-name, next, previous, up
769 @section Symbols
770 @cindex @code{symbol} (class)
771 @cindex hierarchy of classes
772
773 @cindex atom
774 Symbols are for symbolic manipulation what atoms are for chemistry.  You
775 can declare objects of class @code{symbol} as any other object simply by
776 saying @code{symbol x,y;}.  There is, however, a catch in here having to
777 do with the fact that C++ is a compiled language.  The information about
778 the symbol's name is thrown away by the compiler but at a later stage
779 you may want to print expressions holding your symbols.  In order to
780 avoid confusion GiNaC's symbols are able to know their own name.  This
781 is accomplished by declaring its name for output at construction time in
782 the fashion @code{symbol x("x");}.  If you declare a symbol using the
783 default constructor (i.e. without string argument) the system will deal
784 out a unique name.  That name may not be suitable for printing but for
785 internal routines when no output is desired it is often enough.  We'll
786 come across examples of such symbols later in this tutorial.
787
788 This implies that the strings passed to symbols at construction time may
789 not be used for comparing two of them.  It is perfectly legitimate to
790 write @code{symbol x("x"),y("x");} but it is likely to lead into
791 trouble.  Here, @code{x} and @code{y} are different symbols and
792 statements like @code{x-y} will not be simplified to zero although the
793 output @code{x-x} looks funny.  Such output may also occur when there
794 are two different symbols in two scopes, for instance when you call a
795 function that declares a symbol with a name already existent in a symbol
796 in the calling function.  Again, comparing them (using @code{operator==}
797 for instance) will always reveal their difference.  Watch out, please.
798
799 @cindex @code{subs()}
800 Although symbols can be assigned expressions for internal reasons, you
801 should not do it (and we are not going to tell you how it is done).  If
802 you want to replace a symbol with something else in an expression, you
803 can use the expression's @code{.subs()} method (@xref{Substituting Symbols},
804 for more information).
805
806
807 @node Numbers, Constants, Symbols, Basic Concepts
808 @c    node-name, next, previous, up
809 @section Numbers
810 @cindex @code{numeric} (class)
811
812 @cindex GMP
813 @cindex CLN
814 @cindex rational
815 @cindex fraction
816 For storing numerical things, GiNaC uses Bruno Haible's library
817 @acronym{CLN}.  The classes therein serve as foundation classes for
818 GiNaC.  @acronym{CLN} stands for Class Library for Numbers or
819 alternatively for Common Lisp Numbers.  In order to find out more about
820 @acronym{CLN}'s internals the reader is refered to the documentation of
821 that library.  @inforef{Introduction, , cln}, for more
822 information. Suffice to say that it is by itself build on top of another
823 library, the GNU Multiple Precision library @acronym{GMP}, which is an
824 extremely fast library for arbitrary long integers and rationals as well
825 as arbitrary precision floating point numbers.  It is very commonly used
826 by several popular cryptographic applications.  @acronym{CLN} extends
827 @acronym{GMP} by several useful things: First, it introduces the complex
828 number field over either reals (i.e. floating point numbers with
829 arbitrary precision) or rationals.  Second, it automatically converts
830 rationals to integers if the denominator is unity and complex numbers to
831 real numbers if the imaginary part vanishes and also correctly treats
832 algebraic functions.  Third it provides good implementations of
833 state-of-the-art algorithms for all trigonometric and hyperbolic
834 functions as well as for calculation of some useful constants.
835
836 The user can construct an object of class @code{numeric} in several
837 ways.  The following example shows the four most important constructors.
838 It uses construction from C-integer, construction of fractions from two
839 integers, construction from C-float and construction from a string:
840
841 @example
842 #include <ginac/ginac.h>
843 using namespace GiNaC;
844
845 int main()
846 @{
847     numeric two(2);                       // exact integer 2
848     numeric r(2,3);                       // exact fraction 2/3
849     numeric e(2.71828);                   // floating point number
850     numeric p("3.1415926535897932385");   // floating point number
851     // Trott's constant in scientific notation:
852     numeric trott("1.0841015122311136151E-2");
853     
854     std::cout << two*p << std::endl;  // floating point 6.283...
855 @}
856 @end example
857
858 Note that all those constructors are @emph{explicit} which means you are
859 not allowed to write @code{numeric two=2;}.  This is because the basic
860 objects to be handled by GiNaC are the expressions @code{ex} and we want
861 to keep things simple and wish objects like @code{pow(x,2)} to be
862 handled the same way as @code{pow(x,a)}, which means that we need to
863 allow a general @code{ex} as base and exponent.  Therefore there is an
864 implicit constructor from C-integers directly to expressions handling
865 numerics at work in most of our examples.  This design really becomes
866 convenient when one declares own functions having more than one
867 parameter but it forbids using implicit constructors because that would
868 lead to compile-time ambiguities.
869
870 It may be tempting to construct numbers writing @code{numeric r(3/2)}.
871 This would, however, call C's built-in operator @code{/} for integers
872 first and result in a numeric holding a plain integer 1.  @strong{Never
873 use the operator @code{/} on integers} unless you know exactly what you
874 are doing!  Use the constructor from two integers instead, as shown in
875 the example above.  Writing @code{numeric(1)/2} may look funny but works
876 also.
877
878 @cindex @code{Digits}
879 @cindex accuracy
880 We have seen now the distinction between exact numbers and floating
881 point numbers.  Clearly, the user should never have to worry about
882 dynamically created exact numbers, since their `exactness' always
883 determines how they ought to be handled, i.e. how `long' they are.  The
884 situation is different for floating point numbers.  Their accuracy is
885 controlled by one @emph{global} variable, called @code{Digits}.  (For
886 those readers who know about Maple: it behaves very much like Maple's
887 @code{Digits}).  All objects of class numeric that are constructed from
888 then on will be stored with a precision matching that number of decimal
889 digits:
890
891 @example
892 #include <ginac/ginac.h>
893 using namespace std;
894 using namespace GiNaC;
895
896 void foo()
897 @{
898     numeric three(3.0), one(1.0);
899     numeric x = one/three;
900
901     cout << "in " << Digits << " digits:" << endl;
902     cout << x << endl;
903     cout << Pi.evalf() << endl;
904 @}
905
906 int main()
907 @{
908     foo();
909     Digits = 60;
910     foo();
911     return 0;
912 @}
913 @end example
914
915 The above example prints the following output to screen:
916
917 @example
918 in 17 digits:
919 0.333333333333333333
920 3.14159265358979324
921 in 60 digits:
922 0.333333333333333333333333333333333333333333333333333333333333333333
923 3.14159265358979323846264338327950288419716939937510582097494459231
924 @end example
925
926 It should be clear that objects of class @code{numeric} should be used
927 for constructing numbers or for doing arithmetic with them.  The objects
928 one deals with most of the time are the polymorphic expressions @code{ex}.
929
930 @subsection Tests on numbers
931
932 Once you have declared some numbers, assigned them to expressions and
933 done some arithmetic with them it is frequently desired to retrieve some
934 kind of information from them like asking whether that number is
935 integer, rational, real or complex.  For those cases GiNaC provides
936 several useful methods.  (Internally, they fall back to invocations of
937 certain CLN functions.)
938
939 As an example, let's construct some rational number, multiply it with
940 some multiple of its denominator and test what comes out:
941
942 @example
943 #include <ginac/ginac.h>
944 using namespace std;
945 using namespace GiNaC;
946
947 // some very important constants:
948 const numeric twentyone(21);
949 const numeric ten(10);
950 const numeric five(5);
951
952 int main()
953 @{
954     numeric answer = twentyone;
955
956     answer /= five;
957     cout << answer.is_integer() << endl;  // false, it's 21/5
958     answer *= ten;
959     cout << answer.is_integer() << endl;  // true, it's 42 now!
960 @}
961 @end example
962
963 Note that the variable @code{answer} is constructed here as an integer
964 by @code{numeric}'s copy constructor but in an intermediate step it
965 holds a rational number represented as integer numerator and integer
966 denominator.  When multiplied by 10, the denominator becomes unity and
967 the result is automatically converted to a pure integer again.
968 Internally, the underlying @acronym{CLN} is responsible for this
969 behaviour and we refer the reader to @acronym{CLN}'s documentation.
970 Suffice to say that the same behaviour applies to complex numbers as
971 well as return values of certain functions.  Complex numbers are
972 automatically converted to real numbers if the imaginary part becomes
973 zero.  The full set of tests that can be applied is listed in the
974 following table.
975
976 @cartouche
977 @multitable @columnfractions .30 .70
978 @item @strong{Method} @tab @strong{Returns true if the object is@dots{}}
979 @item @code{.is_zero()}
980 @tab @dots{}equal to zero
981 @item @code{.is_positive()}
982 @tab @dots{}not complex and greater than 0
983 @item @code{.is_integer()}
984 @tab @dots{}a (non-complex) integer
985 @item @code{.is_pos_integer()}
986 @tab @dots{}an integer and greater than 0
987 @item @code{.is_nonneg_integer()}
988 @tab @dots{}an integer and greater equal 0
989 @item @code{.is_even()}
990 @tab @dots{}an even integer
991 @item @code{.is_odd()}
992 @tab @dots{}an odd integer
993 @item @code{.is_prime()}
994 @tab @dots{}a prime integer (probabilistic primality test)
995 @item @code{.is_rational()}
996 @tab @dots{}an exact rational number (integers are rational, too)
997 @item @code{.is_real()}
998 @tab @dots{}a real integer, rational or float (i.e. is not complex)
999 @item @code{.is_cinteger()}
1000 @tab @dots{}a (complex) integer (such as @math{2-3*I})
1001 @item @code{.is_crational()}
1002 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
1003 @end multitable
1004 @end cartouche
1005
1006
1007 @node Constants, Fundamental containers, Numbers, Basic Concepts
1008 @c    node-name, next, previous, up
1009 @section Constants
1010 @cindex @code{constant} (class)
1011
1012 @cindex @code{Pi}
1013 @cindex @code{Catalan}
1014 @cindex @code{Euler}
1015 @cindex @code{evalf()}
1016 Constants behave pretty much like symbols except that they return some
1017 specific number when the method @code{.evalf()} is called.
1018
1019 The predefined known constants are:
1020
1021 @cartouche
1022 @multitable @columnfractions .14 .30 .56
1023 @item @strong{Name} @tab @strong{Common Name} @tab @strong{Numerical Value (to 35 digits)}
1024 @item @code{Pi}
1025 @tab Archimedes' constant
1026 @tab 3.14159265358979323846264338327950288
1027 @item @code{Catalan}
1028 @tab Catalan's constant
1029 @tab 0.91596559417721901505460351493238411
1030 @item @code{Euler}
1031 @tab Euler's (or Euler-Mascheroni) constant
1032 @tab 0.57721566490153286060651209008240243
1033 @end multitable
1034 @end cartouche
1035
1036
1037 @node Fundamental containers, Lists, Constants, Basic Concepts
1038 @c    node-name, next, previous, up
1039 @section Fundamental containers: the @code{power}, @code{add} and @code{mul} classes
1040 @cindex polynomial
1041 @cindex @code{add}
1042 @cindex @code{mul}
1043 @cindex @code{power}
1044
1045 Simple polynomial expressions are written down in GiNaC pretty much like
1046 in other CAS or like expressions involving numerical variables in C.
1047 The necessary operators @code{+}, @code{-}, @code{*} and @code{/} have
1048 been overloaded to achieve this goal.  When you run the following
1049 code snippet, the constructor for an object of type @code{mul} is
1050 automatically called to hold the product of @code{a} and @code{b} and
1051 then the constructor for an object of type @code{add} is called to hold
1052 the sum of that @code{mul} object and the number one:
1053
1054 @example
1055     ...
1056     symbol a("a"), b("b");
1057     ex MyTerm = 1+a*b;
1058     ...
1059 @end example
1060
1061 @cindex @code{pow()}
1062 For exponentiation, you have already seen the somewhat clumsy (though C-ish)
1063 statement @code{pow(x,2);} to represent @code{x} squared.  This direct
1064 construction is necessary since we cannot safely overload the constructor
1065 @code{^} in C++ to construct a @code{power} object.  If we did, it would
1066 have several counterintuitive and undesired effects:
1067
1068 @itemize @bullet
1069 @item
1070 Due to C's operator precedence, @code{2*x^2} would be parsed as @code{(2*x)^2}.
1071 @item
1072 Due to the binding of the operator @code{^}, @code{x^a^b} would result in
1073 @code{(x^a)^b}. This would be confusing since most (though not all) other CAS
1074 interpret this as @code{x^(a^b)}.
1075 @item
1076 Also, expressions involving integer exponents are very frequently used,
1077 which makes it even more dangerous to overload @code{^} since it is then
1078 hard to distinguish between the semantics as exponentiation and the one
1079 for exclusive or.  (It would be embarassing to return @code{1} where one
1080 has requested @code{2^3}.)
1081 @end itemize
1082
1083 @cindex @command{ginsh}
1084 All effects are contrary to mathematical notation and differ from the
1085 way most other CAS handle exponentiation, therefore overloading @code{^}
1086 is ruled out for GiNaC's C++ part.  The situation is different in
1087 @command{ginsh}, there the exponentiation-@code{^} exists.  (Also note
1088 that the other frequently used exponentiation operator @code{**} does
1089 not exist at all in C++).
1090
1091 To be somewhat more precise, objects of the three classes described
1092 here, are all containers for other expressions.  An object of class
1093 @code{power} is best viewed as a container with two slots, one for the
1094 basis, one for the exponent.  All valid GiNaC expressions can be
1095 inserted.  However, basic transformations like simplifying
1096 @code{pow(pow(x,2),3)} to @code{x^6} automatically are only performed
1097 when this is mathematically possible.  If we replace the outer exponent
1098 three in the example by some symbols @code{a}, the simplification is not
1099 safe and will not be performed, since @code{a} might be @code{1/2} and
1100 @code{x} negative.
1101
1102 Objects of type @code{add} and @code{mul} are containers with an
1103 arbitrary number of slots for expressions to be inserted.  Again, simple
1104 and safe simplifications are carried out like transforming
1105 @code{3*x+4-x} to @code{2*x+4}.
1106
1107 The general rule is that when you construct such objects, GiNaC
1108 automatically creates them in canonical form, which might differ from
1109 the form you typed in your program.  This allows for rapid comparison of
1110 expressions, since after all @code{a-a} is simply zero.  Note, that the
1111 canonical form is not necessarily lexicographical ordering or in any way
1112 easily guessable.  It is only guaranteed that constructing the same
1113 expression twice, either implicitly or explicitly, results in the same
1114 canonical form.
1115
1116
1117 @node Lists, Mathematical functions, Fundamental containers, Basic Concepts
1118 @c    node-name, next, previous, up
1119 @section Lists of expressions
1120 @cindex @code{lst} (class)
1121 @cindex lists
1122 @cindex @code{nops()}
1123 @cindex @code{op()}
1124 @cindex @code{append()}
1125 @cindex @code{prepend()}
1126
1127 The GiNaC class @code{lst} serves for holding a list of arbitrary expressions.
1128 These are sometimes used to supply a variable number of arguments of the same
1129 type to GiNaC methods such as @code{subs()} and @code{to_rational()}, so you
1130 should have a basic understanding about them.
1131
1132 Lists of up to 15 expressions can be directly constructed from single
1133 expressions:
1134
1135 @example
1136 @{
1137     symbol x("x"), y("y");
1138     lst l(x, 2, y, x+y);
1139     // now, l is a list holding the expressions 'x', '2', 'y', and 'x+y'
1140     // ...
1141 @end example
1142
1143 Use the @code{nops()} method to determine the size (number of expressions) of
1144 a list and the @code{op()} method to access individual elements:
1145
1146 @example
1147     // ...
1148     cout << l.nops() << endl;                   // prints '4'
1149     cout << l.op(2) << " " << l.op(0) << endl;  // prints 'y x'
1150     // ...
1151 @end example
1152
1153 Finally you can append or prepend an expression to a list with the
1154 @code{append()} and @code{prepend()} methods:
1155
1156 @example
1157     // ...
1158     l.append(4*x);   // l is now [x, 2, y, x+y, 4*x]
1159     l.prepend(0);    // l is now [0, x, 2, y, x+y, 4*x]
1160 @}
1161 @end example
1162
1163
1164 @node Mathematical functions, Relations, Lists, Basic Concepts
1165 @c    node-name, next, previous, up
1166 @section Mathematical functions
1167 @cindex @code{function} (class)
1168 @cindex trigonometric function
1169 @cindex hyperbolic function
1170
1171 There are quite a number of useful functions hard-wired into GiNaC.  For
1172 instance, all trigonometric and hyperbolic functions are implemented
1173 (@xref{Built-in Functions}, for a complete list).
1174
1175 These functions are all objects of class @code{function}.  They accept
1176 one or more expressions as arguments and return one expression.  If the
1177 arguments are not numerical, the evaluation of the function may be
1178 halted, as it does in the next example, showing how a function returns
1179 itself twice and finally an expression that may be really useful:
1180
1181 @cindex Gamma function
1182 @cindex @code{subs()}
1183 @example
1184     ...
1185     symbol x("x"), y("y");    
1186     ex foo = x+y/2;
1187     cout << tgamma(foo) << endl;
1188      // -> tgamma(x+(1/2)*y)
1189     ex bar = foo.subs(y==1);
1190     cout << tgamma(bar) << endl;
1191      // -> tgamma(x+1/2)
1192     ex foobar = bar.subs(x==7);
1193     cout << tgamma(foobar) << endl;
1194      // -> (135135/128)*Pi^(1/2)
1195     ...
1196 @end example
1197
1198 Besides evaluation most of these functions allow differentiation, series
1199 expansion and so on.  Read the next chapter in order to learn more about
1200 this.
1201
1202
1203 @node Relations, Indexed objects, Mathematical functions, Basic Concepts
1204 @c    node-name, next, previous, up
1205 @section Relations
1206 @cindex @code{relational} (class)
1207
1208 Sometimes, a relation holding between two expressions must be stored
1209 somehow.  The class @code{relational} is a convenient container for such
1210 purposes.  A relation is by definition a container for two @code{ex} and
1211 a relation between them that signals equality, inequality and so on.
1212 They are created by simply using the C++ operators @code{==}, @code{!=},
1213 @code{<}, @code{<=}, @code{>} and @code{>=} between two expressions.
1214
1215 @xref{Mathematical functions}, for examples where various applications
1216 of the @code{.subs()} method show how objects of class relational are
1217 used as arguments.  There they provide an intuitive syntax for
1218 substitutions.  They are also used as arguments to the @code{ex::series}
1219 method, where the left hand side of the relation specifies the variable
1220 to expand in and the right hand side the expansion point.  They can also
1221 be used for creating systems of equations that are to be solved for
1222 unknown variables.  But the most common usage of objects of this class
1223 is rather inconspicuous in statements of the form @code{if
1224 (expand(pow(a+b,2))==a*a+2*a*b+b*b) @{...@}}.  Here, an implicit
1225 conversion from @code{relational} to @code{bool} takes place.  Note,
1226 however, that @code{==} here does not perform any simplifications, hence
1227 @code{expand()} must be called explicitly.
1228
1229
1230 @node Indexed objects, Methods and Functions, Relations, Basic Concepts
1231 @c    node-name, next, previous, up
1232 @section Indexed objects
1233
1234 GiNaC allows you to handle expressions containing general indexed objects in
1235 arbitrary spaces. It is also able to canonicalize and simplify such
1236 expressions and perform symbolic dummy index summations. There are a number
1237 of predefined indexed objects provided, like delta and metric tensors.
1238
1239 There are few restrictions placed on indexed objects and their indices and
1240 it is easy to construct nonsense expressions, but our intention is to
1241 provide a general framework that allows you to implement algorithms with
1242 indexed quantities, getting in the way as little as possible.
1243
1244 @cindex @code{idx} (class)
1245 @cindex @code{indexed} (class)
1246 @subsection Indexed quantities and their indices
1247
1248 Indexed expressions in GiNaC are constructed of two special types of objects,
1249 @dfn{index objects} and @dfn{indexed objects}.
1250
1251 @itemize @bullet
1252
1253 @cindex contravariant
1254 @cindex covariant
1255 @cindex variance
1256 @item Index objects are of class @code{idx} or a subclass. Every index has
1257 a @dfn{value} and a @dfn{dimension} (which is the dimension of the space
1258 the index lives in) which can both be arbitrary expressions but are usually
1259 a number or a simple symbol. In addition, indices of class @code{varidx} have
1260 a @dfn{variance} (they can be co- or contravariant).
1261
1262 @item Indexed objects are of class @code{indexed} or a subclass. They
1263 contain a @dfn{base expression} (which is the expression being indexed), and
1264 one or more indices.
1265
1266 @end itemize
1267
1268 @strong{Note:} when printing expressions, covariant indices and indices
1269 without variance are denoted @samp{.i} while contravariant indices are denoted
1270 @samp{~i}. In the following, we are going to use that notation in the text
1271 so instead of @math{A^i_jk} we will write @samp{A~i.j.k}. Index dimensions
1272 are not visible in the output.
1273
1274 A simple example shall illustrate the concepts:
1275
1276 @example
1277 #include <ginac/ginac.h>
1278 using namespace std;
1279 using namespace GiNaC;
1280
1281 int main()
1282 @{
1283     symbol i_sym("i"), j_sym("j");
1284     idx i(i_sym, 3), j(j_sym, 3);
1285
1286     symbol A("A");
1287     cout << indexed(A, i, j) << endl;
1288      // -> A.i.j
1289     ...
1290 @end example
1291
1292 The @code{idx} constructor takes two arguments, the index value and the
1293 index dimension. First we define two index objects, @code{i} and @code{j},
1294 both with the numeric dimension 3. The value of the index @code{i} is the
1295 symbol @code{i_sym} (which prints as @samp{i}) and the value of the index
1296 @code{j} is the symbol @code{j_sym} (which prints as @samp{j}). Next we
1297 construct an expression containing one indexed object, @samp{A.i.j}. It has
1298 the symbol @code{A} as its base expression and the two indices @code{i} and
1299 @code{j}.
1300
1301 Note the difference between the indices @code{i} and @code{j} which are of
1302 class @code{idx}, and the index values which are the sybols @code{i_sym}
1303 and @code{j_sym}. The indices of indexed objects cannot directly be symbols
1304 or numbers but must be index objects. For example, the following is not
1305 correct and will raise an exception:
1306
1307 @example
1308 symbol i("i"), j("j");
1309 e = indexed(A, i, j); // ERROR: indices must be of type idx
1310 @end example
1311
1312 You can have multiple indexed objects in an expression, index values can
1313 be numeric, and index dimensions symbolic:
1314
1315 @example
1316     ...
1317     symbol B("B"), dim("dim");
1318     cout << 4 * indexed(A, i)
1319           + indexed(B, idx(j_sym, 4), idx(2, 3), idx(i_sym, dim)) << endl;
1320      // -> B.j.2.i+4*A.i
1321     ...
1322 @end example
1323
1324 @code{B} has a 4-dimensional symbolic index @samp{k}, a 3-dimensional numeric
1325 index of value 2, and a symbolic index @samp{i} with the symbolic dimension
1326 @samp{dim}. Note that GiNaC doesn't automatically notify you that the free
1327 indices of @samp{A} and @samp{B} in the sum don't match (you have to call
1328 @code{simplify_indexed()} for that, see below).
1329
1330 In fact, base expressions, index values and index dimensions can be
1331 arbitrary expressions:
1332
1333 @example
1334     ...
1335     cout << indexed(A+B, idx(2*i_sym+1, dim/2)) << endl;
1336      // -> (B+A).(1+2*i)
1337     ...
1338 @end example
1339
1340 It's also possible to construct nonsense like @samp{Pi.sin(x)}. You will not
1341 get an error message from this but you will probably not be able to do
1342 anything useful with it.
1343
1344 @cindex @code{get_value()}
1345 @cindex @code{get_dimension()}
1346 The methods
1347
1348 @example
1349 ex idx::get_value(void);
1350 ex idx::get_dimension(void);
1351 @end example
1352
1353 return the value and dimension of an @code{idx} object. If you have an index
1354 in an expression, such as returned by calling @code{.op()} on an indexed
1355 object, you can get a reference to the @code{idx} object with the function
1356 @code{ex_to_idx()} on the expression.
1357
1358 There are also the methods
1359
1360 @example
1361 bool idx::is_numeric(void);
1362 bool idx::is_symbolic(void);
1363 bool idx::is_dim_numeric(void);
1364 bool idx::is_dim_symbolic(void);
1365 @end example
1366
1367 for checking whether the value and dimension are numeric or symbolic
1368 (non-numeric). Using the @code{info()} method of an index (see @ref{Information
1369 About Expressions}) returns information about the index value.
1370
1371 @cindex @code{varidx} (class)
1372 If you need co- and contravariant indices, use the @code{varidx} class:
1373
1374 @example
1375     ...
1376     symbol mu_sym("mu"), nu_sym("nu");
1377     varidx mu(mu_sym, 4), nu(nu_sym, 4); // default is contravariant ~mu, ~nu
1378     varidx mu_co(mu_sym, 4, true);       // covariant index .mu
1379
1380     cout << indexed(A, mu, nu) << endl;
1381      // -> A~mu~nu
1382     cout << indexed(A, mu_co, nu) << endl;
1383      // -> A.mu~nu
1384     cout << indexed(A, mu.toggle_variance(), nu) << endl;
1385      // -> A.mu~nu
1386     ...
1387 @end example
1388
1389 A @code{varidx} is an @code{idx} with an additional flag that marks it as
1390 co- or contravariant. The default is a contravariant (upper) index, but
1391 this can be overridden by supplying a third argument to the @code{varidx}
1392 constructor. The two methods
1393
1394 @example
1395 bool varidx::is_covariant(void);
1396 bool varidx::is_contravariant(void);
1397 @end example
1398
1399 allow you to check the variance of a @code{varidx} object (use @code{ex_to_varidx()}
1400 to get the object reference from an expression). There's also the very useful
1401 method
1402
1403 @example
1404 ex varidx::toggle_variance(void);
1405 @end example
1406
1407 which makes a new index with the same value and dimension but the opposite
1408 variance. By using it you only have to define the index once.
1409
1410 @subsection Substituting indices
1411
1412 @cindex @code{subs()}
1413 Sometimes you will want to substitute one symbolic index with another
1414 symbolic or numeric index, for example when calculating one specific element
1415 of a tensor expression. This is done with the @code{.subs()} method, as it
1416 is done for symbols (see @ref{Substituting Symbols}).
1417
1418 You have two possibilities here. You can either substitute the whole index
1419 by another index or expression:
1420
1421 @example
1422     ...
1423     ex e = indexed(A, mu_co);
1424     cout << e << " becomes " << e.subs(mu_co == nu) << endl;
1425      // -> A.mu becomes A~nu
1426     cout << e << " becomes " << e.subs(mu_co == varidx(0, 4)) << endl;
1427      // -> A.mu becomes A~0
1428     cout << e << " becomes " << e.subs(mu_co == 0) << endl;
1429      // -> A.mu becomes A.0
1430     ...
1431 @end example
1432
1433 The third example shows that trying to replace an index with something that
1434 is not an index will substitute the index value instead.
1435
1436 Alternatively, you can substitute the @emph{symbol} of a symbolic index by
1437 another expression:
1438
1439 @example
1440     ...
1441     ex e = indexed(A, mu_co);
1442     cout << e << " becomes " << e.subs(mu_sym == nu_sym) << endl;
1443      // -> A.mu becomes A.nu
1444     cout << e << " becomes " << e.subs(mu_sym == 0) << endl;
1445      // -> A.mu becomes A.0
1446     ...
1447 @end example
1448
1449 As you see, with the second method only the value of the index will get
1450 substituted. Its other properties, including its dimension, remain unchanged.
1451 If you want to change the dimension of an index you have to substitute the
1452 whole index by another one with the new dimension.
1453
1454 Finally, substituting the base expression of an indexed object works as
1455 expected:
1456
1457 @example
1458     ...
1459     ex e = indexed(A, mu_co);
1460     cout << e << " becomes " << e.subs(A == A+B) << endl;
1461      // -> A.mu becomes (B+A).mu
1462     ...
1463 @end example
1464
1465 @subsection Symmetries
1466
1467 Indexed objects can be declared as being totally symmetric or antisymmetric
1468 with respect to their indices. In this case, GiNaC will automatically bring
1469 the indices into a canonical order which allows for some immediate
1470 simplifications:
1471
1472 @example
1473     ...
1474     cout << indexed(A, indexed::symmetric, i, j)
1475           + indexed(A, indexed::symmetric, j, i) << endl;
1476      // -> 2*A.j.i
1477     cout << indexed(B, indexed::antisymmetric, i, j)
1478           + indexed(B, indexed::antisymmetric, j, j) << endl;
1479      // -> -B.j.i
1480     cout << indexed(B, indexed::antisymmetric, i, j)
1481           + indexed(B, indexed::antisymmetric, j, i) << endl;
1482      // -> 0
1483     ...
1484 @end example
1485
1486 @cindex @code{get_free_indices()}
1487 @cindex Dummy index
1488 @subsection Dummy indices
1489
1490 GiNaC treats certain symbolic index pairs as @dfn{dummy indices} meaning
1491 that a summation over the index range is implied. Symbolic indices which are
1492 not dummy indices are called @dfn{free indices}. Numeric indices are neither
1493 dummy nor free indices.
1494
1495 To be recognized as a dummy index pair, the two indices must be of the same
1496 class and dimension and their value must be the same single symbol (an index
1497 like @samp{2*n+1} is never a dummy index). If the indices are of class
1498 @code{varidx}, they must also be of opposite variance.
1499
1500 The method @code{.get_free_indices()} returns a vector containing the free
1501 indices of an expression. It also checks that the free indices of the terms
1502 of a sum are consistent:
1503
1504 @example
1505 @{
1506     symbol A("A"), B("B"), C("C");
1507
1508     symbol i_sym("i"), j_sym("j"), k_sym("k"), l_sym("l");
1509     idx i(i_sym, 3), j(j_sym, 3), k(k_sym, 3), l(l_sym, 3);
1510
1511     ex e = indexed(A, i, j) * indexed(B, j, k) + indexed(C, k, l, i, l);
1512     cout << exprseq(e.get_free_indices()) << endl;
1513      // -> (.i,.k)
1514      // 'j' and 'l' are dummy indices
1515
1516     symbol mu_sym("mu"), nu_sym("nu"), rho_sym("rho"), sigma_sym("sigma");
1517     varidx mu(mu_sym, 4), nu(nu_sym, 4), rho(rho_sym, 4), sigma(sigma_sym, 4);
1518
1519     e = indexed(A, mu, nu) * indexed(B, nu.toggle_variance(), rho)
1520       + indexed(C, mu, sigma, rho, sigma.toggle_variance());
1521     cout << exprseq(e.get_free_indices()) << endl;
1522      // -> (~mu,~rho)
1523      // 'nu' is a dummy index, but 'sigma' is not
1524
1525     e = indexed(A, mu, mu);
1526     cout << exprseq(e.get_free_indices()) << endl;
1527      // -> (~mu)
1528      // 'mu' is not a dummy index because it appears twice with the same
1529      // variance
1530
1531     e = indexed(A, mu, nu) + 42;
1532     cout << exprseq(e.get_free_indices()) << endl; // ERROR
1533      // this will throw an exception:
1534      // "add::get_free_indices: inconsistent indices in sum"
1535 @}
1536 @end example
1537
1538 @cindex @code{simplify_indexed()}
1539 @subsection Simplifying indexed expressions
1540
1541 In addition to the few automatic simplifications that GiNaC performs on
1542 indexed expressions (such as re-ordering the indices of symmetric tensors
1543 and calculating traces and convolutions of matrices and predefined tensors)
1544 there is the method
1545
1546 @example
1547 ex ex::simplify_indexed(void);
1548 ex ex::simplify_indexed(const scalar_products & sp);
1549 @end example
1550
1551 that performs some more expensive operations:
1552
1553 @itemize
1554 @item it checks the consistency of free indices in sums in the same way
1555   @code{get_free_indices()} does
1556 @item it (symbolically) calculates all possible dummy index summations/contractions
1557   with the predefined tensors (this will be explained in more detail in the
1558   next section)
1559 @item as a special case of dummy index summation, it can replace scalar products
1560   of two tensors with a user-defined value
1561 @end itemize
1562
1563 The last point is done with the help of the @code{scalar_products} class
1564 which is used to store scalar products with known values (this is not an
1565 arithmetic class, you just pass it to @code{simplify_indexed()}):
1566
1567 @example
1568 @{
1569     symbol A("A"), B("B"), C("C"), i_sym("i");
1570     idx i(i_sym, 3);
1571
1572     scalar_products sp;
1573     sp.add(A, B, 0); // A and B are orthogonal
1574     sp.add(A, C, 0); // A and C are orthogonal
1575     sp.add(A, A, 4); // A^2 = 4 (A has length 2)
1576
1577     e = indexed(A + B, i) * indexed(A + C, i);
1578     cout << e << endl;
1579      // -> (B+A).i*(A+C).i
1580
1581     cout << e.expand(expand_options::expand_indexed).simplify_indexed(sp)
1582          << endl;
1583      // -> 4+C.i*B.i
1584 @}
1585 @end example
1586
1587 The @code{scalar_products} object @code{sp} acts as a storage for the
1588 scalar products added to it with the @code{.add()} method. This method
1589 takes three arguments: the two expressions of which the scalar product is
1590 taken, and the expression to replace it with. After @code{sp.add(A, B, 0)},
1591 @code{simplify_indexed()} will replace all scalar products of indexed
1592 objects that have the symbols @code{A} and @code{B} as base expressions
1593 with the single value 0. The number, type and dimension of the indices
1594 doesn't matter; @samp{A~mu~nu*B.mu.nu} would also be replaced by 0.
1595
1596 @cindex @code{expand()}
1597 The example above also illustrates a feature of the @code{expand()} method:
1598 if passed the @code{expand_indexed} option it will distribute indices
1599 over sums, so @samp{(A+B).i} becomes @samp{A.i+B.i}.
1600
1601 @cindex @code{tensor} (class)
1602 @subsection Predefined tensors
1603
1604 Some frequently used special tensors such as the delta, epsilon and metric
1605 tensors are predefined in GiNaC. They have special properties when
1606 contracted with other tensor expressions and some of them have constant
1607 matrix representations (they will evaluate to a number when numeric
1608 indices are specified).
1609
1610 @cindex @code{delta_tensor()}
1611 @subsubsection Delta tensor
1612
1613 The delta tensor takes two indices, is symmetric and has the matrix
1614 representation @code{diag(1,1,1,...)}. It is constructed by the function
1615 @code{delta_tensor()}:
1616
1617 @example
1618 @{
1619     symbol A("A"), B("B");
1620
1621     idx i(symbol("i"), 3), j(symbol("j"), 3),
1622         k(symbol("k"), 3), l(symbol("l"), 3);
1623
1624     ex e = indexed(A, i, j) * indexed(B, k, l)
1625          * delta_tensor(i, k) * delta_tensor(j, l) << endl;
1626     cout << e.simplify_indexed() << endl;
1627      // -> B.i.j*A.i.j
1628
1629     cout << delta_tensor(i, i) << endl;
1630      // -> 3
1631 @}
1632 @end example
1633
1634 @cindex @code{metric_tensor()}
1635 @subsubsection General metric tensor
1636
1637 The function @code{metric_tensor()} creates a general symmetric metric
1638 tensor with two indices that can be used to raise/lower tensor indices. The
1639 metric tensor is denoted as @samp{g} in the output and if its indices are of
1640 mixed variance it is automatically replaced by a delta tensor:
1641
1642 @example
1643 @{
1644     symbol A("A");
1645
1646     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
1647
1648     ex e = metric_tensor(mu, nu) * indexed(A, nu.toggle_variance(), rho);
1649     cout << e.simplify_indexed() << endl;
1650      // -> A~mu~rho
1651
1652     e = delta_tensor(mu, nu.toggle_variance()) * metric_tensor(nu, rho);
1653     cout << e.simplify_indexed() << endl;
1654      // -> g~mu~rho
1655
1656     e = metric_tensor(mu.toggle_variance(), nu.toggle_variance())
1657       * metric_tensor(nu, rho);
1658     cout << e.simplify_indexed() << endl;
1659      // -> delta.mu~rho
1660
1661     e = metric_tensor(nu.toggle_variance(), rho.toggle_variance())
1662       * metric_tensor(mu, nu) * (delta_tensor(mu.toggle_variance(), rho)
1663         + indexed(A, mu.toggle_variance(), rho));
1664     cout << e.simplify_indexed() << endl;
1665      // -> 4+A.rho~rho
1666 @}
1667 @end example
1668
1669 @cindex @code{lorentz_g()}
1670 @subsubsection Minkowski metric tensor
1671
1672 The Minkowski metric tensor is a special metric tensor with a constant
1673 matrix representation which is either @code{diag(1, -1, -1, ...)} (negative
1674 signature, the default) or @code{diag(-1, 1, 1, ...)} (positive signature).
1675 It is created with the function @code{lorentz_g()} (although it is output as
1676 @samp{eta}):
1677
1678 @example
1679 @{
1680     varidx mu(symbol("mu"), 4);
1681
1682     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
1683       * lorentz_g(mu, varidx(0, 4));       // negative signature
1684     cout << e.simplify_indexed() << endl;
1685      // -> 1
1686
1687     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
1688       * lorentz_g(mu, varidx(0, 4), true); // positive signature
1689     cout << e.simplify_indexed() << endl;
1690      // -> -1
1691 @}
1692 @end example
1693
1694 @subsubsection Epsilon tensor
1695
1696 The epsilon tensor is totally antisymmetric, its number of indices is equal
1697 to the dimension of the index space (the indices must all be of the same
1698 numeric dimension), and @samp{eps.1.2.3...} (resp. @samp{eps~0~1~2...}) is
1699 defined to be 1. Its behaviour with indices that have a variance also
1700 depends on the signature of the metric. Epsilon tensors are output as
1701 @samp{eps}.
1702
1703 There are three functions defined to create epsilon tensors in 2, 3 and 4
1704 dimensions:
1705
1706 @example
1707 ex epsilon_tensor(const ex & i1, const ex & i2);
1708 ex epsilon_tensor(const ex & i1, const ex & i2, const ex & i3);
1709 ex lorentz_eps(const ex & i1, const ex & i2, const ex & i3, const ex & i4, bool pos_sig = false);
1710 @end example
1711
1712 The first two functions create an epsilon tensor in 2 or 3 Euclidean
1713 dimensions, the last function creates an epsilon tensor in a 4-dimensional
1714 Minkowski space (the last @code{bool} argument specifies whether the metric
1715 has negative or positive signature, as in the case of the Minkowski metric
1716 tensor).
1717
1718 @subsection Linear algebra
1719
1720 The @code{matrix} class can be used with indices to do some simple linear
1721 algebra (linear combinations and products of vectors and matrices, traces
1722 and scalar products):
1723
1724 @example
1725 @{
1726     idx i(symbol("i"), 2), j(symbol("j"), 2);
1727     symbol x("x"), y("y");
1728
1729     matrix A(2, 2, lst(1, 2, 3, 4)), X(2, 1, lst(x, y));
1730
1731     cout << indexed(A, i, i) << endl;
1732      // -> 5
1733
1734     ex e = indexed(A, i, j) * indexed(X, j);
1735     cout << e.simplify_indexed() << endl;
1736      // -> [[ [[2*y+x]], [[4*y+3*x]] ]].i
1737
1738     e = indexed(A, i, j) * indexed(X, i) + indexed(X, j) * 2;
1739     cout << e.simplify_indexed() << endl;
1740      // -> [[ [[3*y+3*x,6*y+2*x]] ]].j
1741 @}
1742 @end example
1743
1744 You can of course obtain the same results with the @code{matrix::add()},
1745 @code{matrix::mul()} and @code{matrix::trace()} methods but with indices you
1746 don't have to worry about transposing matrices.
1747
1748 Matrix indices always start at 0 and their dimension must match the number
1749 of rows/columns of the matrix. Matrices with one row or one column are
1750 vectors and can have one or two indices (it doesn't matter whether it's a
1751 row or a column vector). Other matrices must have two indices.
1752
1753 You should be careful when using indices with variance on matrices. GiNaC
1754 doesn't look at the variance and doesn't know that @samp{F~mu~nu} and
1755 @samp{F.mu.nu} are different matrices. In this case you should use only
1756 one form for @samp{F} and explicitly multiply it with a matrix representation
1757 of the metric tensor.
1758
1759
1760 @node Methods and Functions, Information About Expressions, Indexed objects, Top
1761 @c    node-name, next, previous, up
1762 @chapter Methods and Functions
1763 @cindex polynomial
1764
1765 In this chapter the most important algorithms provided by GiNaC will be
1766 described.  Some of them are implemented as functions on expressions,
1767 others are implemented as methods provided by expression objects.  If
1768 they are methods, there exists a wrapper function around it, so you can
1769 alternatively call it in a functional way as shown in the simple
1770 example:
1771
1772 @example
1773     ...
1774     cout << "As method:   " << sin(1).evalf() << endl;
1775     cout << "As function: " << evalf(sin(1)) << endl;
1776     ...
1777 @end example
1778
1779 @cindex @code{subs()}
1780 The general rule is that wherever methods accept one or more parameters
1781 (@var{arg1}, @var{arg2}, @dots{}) the order of arguments the function
1782 wrapper accepts is the same but preceded by the object to act on
1783 (@var{object}, @var{arg1}, @var{arg2}, @dots{}).  This approach is the
1784 most natural one in an OO model but it may lead to confusion for MapleV
1785 users because where they would type @code{A:=x+1; subs(x=2,A);} GiNaC
1786 would require @code{A=x+1; subs(A,x==2);} (after proper declaration of
1787 @code{A} and @code{x}).  On the other hand, since MapleV returns 3 on
1788 @code{A:=x^2+3; coeff(A,x,0);} (GiNaC: @code{A=pow(x,2)+3;
1789 coeff(A,x,0);}) it is clear that MapleV is not trying to be consistent
1790 here.  Also, users of MuPAD will in most cases feel more comfortable
1791 with GiNaC's convention.  All function wrappers are implemented
1792 as simple inline functions which just call the corresponding method and
1793 are only provided for users uncomfortable with OO who are dead set to
1794 avoid method invocations.  Generally, nested function wrappers are much
1795 harder to read than a sequence of methods and should therefore be
1796 avoided if possible.  On the other hand, not everything in GiNaC is a
1797 method on class @code{ex} and sometimes calling a function cannot be
1798 avoided.
1799
1800 @menu
1801 * Information About Expressions::
1802 * Substituting Symbols::
1803 * Polynomial Arithmetic::           Working with polynomials.
1804 * Rational Expressions::            Working with rational functions.
1805 * Symbolic Differentiation::
1806 * Series Expansion::                Taylor and Laurent expansion.
1807 * Built-in Functions::              List of predefined mathematical functions.
1808 * Input/Output::                    Input and output of expressions.
1809 @end menu
1810
1811
1812 @node Information About Expressions, Substituting Symbols, Methods and Functions, Methods and Functions
1813 @c    node-name, next, previous, up
1814 @section Getting information about expressions
1815
1816 @subsection Checking expression types
1817 @cindex @code{is_ex_of_type()}
1818 @cindex @code{ex_to_numeric()}
1819 @cindex @code{ex_to_@dots{}}
1820 @cindex @code{Converting ex to other classes}
1821 @cindex @code{info()}
1822
1823 Sometimes it's useful to check whether a given expression is a plain number,
1824 a sum, a polynomial with integer coefficients, or of some other specific type.
1825 GiNaC provides two functions for this (the first one is actually a macro):
1826
1827 @example
1828 bool is_ex_of_type(const ex & e, TYPENAME t);
1829 bool ex::info(unsigned flag);
1830 @end example
1831
1832 When the test made by @code{is_ex_of_type()} returns true, it is safe to
1833 call one of the functions @code{ex_to_@dots{}}, where @code{@dots{}} is
1834 one of the class names (@xref{The Class Hierarchy}, for a list of all
1835 classes). For example, assuming @code{e} is an @code{ex}:
1836
1837 @example
1838 @{
1839     @dots{}
1840     if (is_ex_of_type(e, numeric))
1841         numeric n = ex_to_numeric(e);
1842     @dots{}
1843 @}
1844 @end example
1845
1846 @code{is_ex_of_type()} allows you to check whether the top-level object of
1847 an expression @samp{e} is an instance of the GiNaC class @samp{t}
1848 (@xref{The Class Hierarchy}, for a list of all classes). This is most useful,
1849 e.g., for checking whether an expression is a number, a sum, or a product:
1850
1851 @example
1852 @{
1853     symbol x("x");
1854     ex e1 = 42;
1855     ex e2 = 4*x - 3;
1856     is_ex_of_type(e1, numeric);  // true
1857     is_ex_of_type(e2, numeric);  // false
1858     is_ex_of_type(e1, add);      // false
1859     is_ex_of_type(e2, add);      // true
1860     is_ex_of_type(e1, mul);      // false
1861     is_ex_of_type(e2, mul);      // false
1862 @}
1863 @end example
1864
1865 The @code{info()} method is used for checking certain attributes of
1866 expressions. The possible values for the @code{flag} argument are defined
1867 in @file{ginac/flags.h}, the most important being explained in the following
1868 table:
1869
1870 @cartouche
1871 @multitable @columnfractions .30 .70
1872 @item @strong{Flag} @tab @strong{Returns true if the object is@dots{}}
1873 @item @code{numeric}
1874 @tab @dots{}a number (same as @code{is_ex_of_type(..., numeric)})
1875 @item @code{real}
1876 @tab @dots{}a real integer, rational or float (i.e. is not complex)
1877 @item @code{rational}
1878 @tab @dots{}an exact rational number (integers are rational, too)
1879 @item @code{integer}
1880 @tab @dots{}a (non-complex) integer
1881 @item @code{crational}
1882 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
1883 @item @code{cinteger}
1884 @tab @dots{}a (complex) integer (such as @math{2-3*I})
1885 @item @code{positive}
1886 @tab @dots{}not complex and greater than 0
1887 @item @code{negative}
1888 @tab @dots{}not complex and less than 0
1889 @item @code{nonnegative}
1890 @tab @dots{}not complex and greater than or equal to 0
1891 @item @code{posint}
1892 @tab @dots{}an integer greater than 0
1893 @item @code{negint}
1894 @tab @dots{}an integer less than 0
1895 @item @code{nonnegint}
1896 @tab @dots{}an integer greater than or equal to 0
1897 @item @code{even}
1898 @tab @dots{}an even integer
1899 @item @code{odd}
1900 @tab @dots{}an odd integer
1901 @item @code{prime}
1902 @tab @dots{}a prime integer (probabilistic primality test)
1903 @item @code{relation}
1904 @tab @dots{}a relation (same as @code{is_ex_of_type(..., relational)})
1905 @item @code{relation_equal}
1906 @tab @dots{}a @code{==} relation
1907 @item @code{relation_not_equal}
1908 @tab @dots{}a @code{!=} relation
1909 @item @code{relation_less}
1910 @tab @dots{}a @code{<} relation
1911 @item @code{relation_less_or_equal}
1912 @tab @dots{}a @code{<=} relation
1913 @item @code{relation_greater}
1914 @tab @dots{}a @code{>} relation
1915 @item @code{relation_greater_or_equal}
1916 @tab @dots{}a @code{>=} relation
1917 @item @code{symbol}
1918 @tab @dots{}a symbol (same as @code{is_ex_of_type(..., symbol)})
1919 @item @code{list}
1920 @tab @dots{}a list (same as @code{is_ex_of_type(..., lst)})
1921 @item @code{polynomial}
1922 @tab @dots{}a polynomial (i.e. only consists of sums and products of numbers and symbols with positive integer powers)
1923 @item @code{integer_polynomial}
1924 @tab @dots{}a polynomial with (non-complex) integer coefficients
1925 @item @code{cinteger_polynomial}
1926 @tab @dots{}a polynomial with (possibly complex) integer coefficients (such as @math{2-3*I})
1927 @item @code{rational_polynomial}
1928 @tab @dots{}a polynomial with (non-complex) rational coefficients
1929 @item @code{crational_polynomial}
1930 @tab @dots{}a polynomial with (possibly complex) rational coefficients (such as @math{2/3+7/2*I})
1931 @item @code{rational_function}
1932 @tab @dots{}a rational function (@math{x+y}, @math{z/(x+y)})
1933 @item @code{algebraic}
1934 @tab @dots{}an algebraic object (@math{sqrt(2)}, @math{sqrt(x)-1})
1935 @end multitable
1936 @end cartouche
1937
1938
1939 @subsection Accessing subexpressions
1940 @cindex @code{nops()}
1941 @cindex @code{op()}
1942 @cindex @code{has()}
1943 @cindex container
1944 @cindex @code{relational} (class)
1945
1946 GiNaC provides the two methods
1947
1948 @example
1949 unsigned ex::nops();
1950 ex ex::op(unsigned i);
1951 @end example
1952
1953 for accessing the subexpressions in the container-like GiNaC classes like
1954 @code{add}, @code{mul}, @code{lst}, and @code{function}. @code{nops()}
1955 determines the number of subexpressions (@samp{operands}) contained, while
1956 @code{op()} returns the @code{i}-th (0..@code{nops()-1}) subexpression.
1957 In the case of a @code{power} object, @code{op(0)} will return the basis
1958 and @code{op(1)} the exponent. For @code{indexed} objects, @code{op(0)}
1959 is the base expression and @code{op(i)}, @math{i>0} are the indices.
1960
1961 The left-hand and right-hand side expressions of objects of class
1962 @code{relational} (and only of these) can also be accessed with the methods
1963
1964 @example
1965 ex ex::lhs();
1966 ex ex::rhs();
1967 @end example
1968
1969 Finally, the method
1970
1971 @example
1972 bool ex::has(const ex & other);
1973 @end example
1974
1975 checks whether an expression contains the given subexpression @code{other}.
1976 This only works reliably if @code{other} is of an atomic class such as a
1977 @code{numeric} or a @code{symbol}. It is, e.g., not possible to verify that
1978 @code{a+b+c} contains @code{a+c} (or @code{a+b}) as a subexpression.
1979
1980
1981 @subsection Comparing expressions
1982 @cindex @code{is_equal()}
1983 @cindex @code{is_zero()}
1984
1985 Expressions can be compared with the usual C++ relational operators like
1986 @code{==}, @code{>}, and @code{<} but if the expressions contain symbols,
1987 the result is usually not determinable and the result will be @code{false},
1988 except in the case of the @code{!=} operator. You should also be aware that
1989 GiNaC will only do the most trivial test for equality (subtracting both
1990 expressions), so something like @code{(pow(x,2)+x)/x==x+1} will return
1991 @code{false}.
1992
1993 Actually, if you construct an expression like @code{a == b}, this will be
1994 represented by an object of the @code{relational} class (@xref{Relations}.)
1995 which is not evaluated until (explicitly or implicitely) cast to a @code{bool}.
1996
1997 There are also two methods
1998
1999 @example
2000 bool ex::is_equal(const ex & other);
2001 bool ex::is_zero();
2002 @end example
2003
2004 for checking whether one expression is equal to another, or equal to zero,
2005 respectively.
2006
2007 @strong{Warning:} You will also find an @code{ex::compare()} method in the
2008 GiNaC header files. This method is however only to be used internally by
2009 GiNaC to establish a canonical sort order for terms, and using it to compare
2010 expressions will give very surprising results.
2011
2012
2013 @node Substituting Symbols, Polynomial Arithmetic, Information About Expressions, Methods and Functions
2014 @c    node-name, next, previous, up
2015 @section Substituting symbols
2016 @cindex @code{subs()}
2017
2018 Symbols can be replaced with expressions via the @code{.subs()} method:
2019
2020 @example
2021 ex ex::subs(const ex & e);
2022 ex ex::subs(const lst & syms, const lst & repls);
2023 @end example
2024
2025 In the first form, @code{subs()} accepts a relational of the form
2026 @samp{symbol == expression} or a @code{lst} of such relationals. E.g.
2027
2028 @example
2029 @{
2030     symbol x("x"), y("y");
2031     ex e1 = 2*x^2-4*x+3;
2032     cout << "e1(7) = " << e1.subs(x == 7) << endl;
2033     ex e2 = x*y + x;
2034     cout << "e2(-2, 4) = " << e2.subs(lst(x == -2, y == 4)) << endl;
2035 @}
2036 @end example
2037
2038 will print @samp{73} and @samp{-10}, respectively.
2039
2040 If you specify multiple substitutions, they are performed in parallel, so e.g.
2041 @code{subs(lst(x == y, y == x))} exchanges @samp{x} and @samp{y}.
2042
2043 The second form of @code{subs()} takes two lists, one for the symbols and
2044 one for the expressions to be substituted (both lists must contain the same
2045 number of elements). Using this form, you would write @code{subs(lst(x, y), lst(y, x))}
2046 to exchange @samp{x} and @samp{y}.
2047
2048
2049 @node Polynomial Arithmetic, Rational Expressions, Substituting Symbols, Methods and Functions
2050 @c    node-name, next, previous, up
2051 @section Polynomial arithmetic
2052
2053 @subsection Expanding and collecting
2054 @cindex @code{expand()}
2055 @cindex @code{collect()}
2056
2057 A polynomial in one or more variables has many equivalent
2058 representations.  Some useful ones serve a specific purpose.  Consider
2059 for example the trivariate polynomial @math{4*x*y + x*z + 20*y^2 +
2060 21*y*z + 4*z^2} (written down here in output-style).  It is equivalent
2061 to the factorized polynomial @math{(x + 5*y + 4*z)*(4*y + z)}.  Other
2062 representations are the recursive ones where one collects for exponents
2063 in one of the three variable.  Since the factors are themselves
2064 polynomials in the remaining two variables the procedure can be
2065 repeated.  In our expample, two possibilities would be @math{(4*y + z)*x
2066 + 20*y^2 + 21*y*z + 4*z^2} and @math{20*y^2 + (21*z + 4*x)*y + 4*z^2 +
2067 x*z}.
2068
2069 To bring an expression into expanded form, its method
2070
2071 @example
2072 ex ex::expand();
2073 @end example
2074
2075 may be called.  In our example above, this corresponds to @math{4*x*y +
2076 x*z + 20*y^2 + 21*y*z + 4*z^2}.  Again, since the canonical form in
2077 GiNaC is not easily guessable you should be prepared to see different
2078 orderings of terms in such sums!
2079
2080 Another useful representation of multivariate polynomials is as a
2081 univariate polynomial in one of the variables with the coefficients
2082 being polynomials in the remaining variables.  The method
2083 @code{collect()} accomplishes this task:
2084
2085 @example
2086 ex ex::collect(const ex & s);
2087 @end example
2088
2089 Note that the original polynomial needs to be in expanded form in order
2090 to be able to find the coefficients properly.
2091
2092 @subsection Degree and coefficients
2093 @cindex @code{degree()}
2094 @cindex @code{ldegree()}
2095 @cindex @code{coeff()}
2096
2097 The degree and low degree of a polynomial can be obtained using the two
2098 methods
2099
2100 @example
2101 int ex::degree(const ex & s);
2102 int ex::ldegree(const ex & s);
2103 @end example
2104
2105 which also work reliably on non-expanded input polynomials (they even work
2106 on rational functions, returning the asymptotic degree). To extract
2107 a coefficient with a certain power from an expanded polynomial you use
2108
2109 @example
2110 ex ex::coeff(const ex & s, int n);
2111 @end example
2112
2113 You can also obtain the leading and trailing coefficients with the methods
2114
2115 @example
2116 ex ex::lcoeff(const ex & s);
2117 ex ex::tcoeff(const ex & s);
2118 @end example
2119
2120 which are equivalent to @code{coeff(s, degree(s))} and @code{coeff(s, ldegree(s))},
2121 respectively.
2122
2123 An application is illustrated in the next example, where a multivariate
2124 polynomial is analyzed:
2125
2126 @example
2127 #include <ginac/ginac.h>
2128 using namespace std;
2129 using namespace GiNaC;
2130
2131 int main()
2132 @{
2133     symbol x("x"), y("y");
2134     ex PolyInp = 4*pow(x,3)*y + 5*x*pow(y,2) + 3*y
2135                  - pow(x+y,2) + 2*pow(y+2,2) - 8;
2136     ex Poly = PolyInp.expand();
2137     
2138     for (int i=Poly.ldegree(x); i<=Poly.degree(x); ++i) @{
2139         cout << "The x^" << i << "-coefficient is "
2140              << Poly.coeff(x,i) << endl;
2141     @}
2142     cout << "As polynomial in y: " 
2143          << Poly.collect(y) << endl;
2144 @}
2145 @end example
2146
2147 When run, it returns an output in the following fashion:
2148
2149 @example
2150 The x^0-coefficient is y^2+11*y
2151 The x^1-coefficient is 5*y^2-2*y
2152 The x^2-coefficient is -1
2153 The x^3-coefficient is 4*y
2154 As polynomial in y: -x^2+(5*x+1)*y^2+(-2*x+4*x^3+11)*y
2155 @end example
2156
2157 As always, the exact output may vary between different versions of GiNaC
2158 or even from run to run since the internal canonical ordering is not
2159 within the user's sphere of influence.
2160
2161
2162 @subsection Polynomial division
2163 @cindex polynomial division
2164 @cindex quotient
2165 @cindex remainder
2166 @cindex pseudo-remainder
2167 @cindex @code{quo()}
2168 @cindex @code{rem()}
2169 @cindex @code{prem()}
2170 @cindex @code{divide()}
2171
2172 The two functions
2173
2174 @example
2175 ex quo(const ex & a, const ex & b, const symbol & x);
2176 ex rem(const ex & a, const ex & b, const symbol & x);
2177 @end example
2178
2179 compute the quotient and remainder of univariate polynomials in the variable
2180 @samp{x}. The results satisfy @math{a = b*quo(a, b, x) + rem(a, b, x)}.
2181
2182 The additional function
2183
2184 @example
2185 ex prem(const ex & a, const ex & b, const symbol & x);
2186 @end example
2187
2188 computes the pseudo-remainder of @samp{a} and @samp{b} which satisfies
2189 @math{c*a = b*q + prem(a, b, x)}, where @math{c = b.lcoeff(x) ^ (a.degree(x) - b.degree(x) + 1)}.
2190
2191 Exact division of multivariate polynomials is performed by the function
2192
2193 @example
2194 bool divide(const ex & a, const ex & b, ex & q);
2195 @end example
2196
2197 If @samp{b} divides @samp{a} over the rationals, this function returns @code{true}
2198 and returns the quotient in the variable @code{q}. Otherwise it returns @code{false}
2199 in which case the value of @code{q} is undefined.
2200
2201
2202 @subsection Unit, content and primitive part
2203 @cindex @code{unit()}
2204 @cindex @code{content()}
2205 @cindex @code{primpart()}
2206
2207 The methods
2208
2209 @example
2210 ex ex::unit(const symbol & x);
2211 ex ex::content(const symbol & x);
2212 ex ex::primpart(const symbol & x);
2213 @end example
2214
2215 return the unit part, content part, and primitive polynomial of a multivariate
2216 polynomial with respect to the variable @samp{x} (the unit part being the sign
2217 of the leading coefficient, the content part being the GCD of the coefficients,
2218 and the primitive polynomial being the input polynomial divided by the unit and
2219 content parts). The product of unit, content, and primitive part is the
2220 original polynomial.
2221
2222
2223 @subsection GCD and LCM
2224 @cindex GCD
2225 @cindex LCM
2226 @cindex @code{gcd()}
2227 @cindex @code{lcm()}
2228
2229 The functions for polynomial greatest common divisor and least common
2230 multiple have the synopsis
2231
2232 @example
2233 ex gcd(const ex & a, const ex & b);
2234 ex lcm(const ex & a, const ex & b);
2235 @end example
2236
2237 The functions @code{gcd()} and @code{lcm()} accept two expressions
2238 @code{a} and @code{b} as arguments and return a new expression, their
2239 greatest common divisor or least common multiple, respectively.  If the
2240 polynomials @code{a} and @code{b} are coprime @code{gcd(a,b)} returns 1
2241 and @code{lcm(a,b)} returns the product of @code{a} and @code{b}.
2242
2243 @example
2244 #include <ginac/ginac.h>
2245 using namespace GiNaC;
2246
2247 int main()
2248 @{
2249     symbol x("x"), y("y"), z("z");
2250     ex P_a = 4*x*y + x*z + 20*pow(y, 2) + 21*y*z + 4*pow(z, 2);
2251     ex P_b = x*y + 3*x*z + 5*pow(y, 2) + 19*y*z + 12*pow(z, 2);
2252
2253     ex P_gcd = gcd(P_a, P_b);
2254     // x + 5*y + 4*z
2255     ex P_lcm = lcm(P_a, P_b);
2256     // 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
2257 @}
2258 @end example
2259
2260
2261 @subsection Square-free decomposition
2262 @cindex square-free decomposition
2263 @cindex factorization
2264 @cindex @code{sqrfree()}
2265
2266 GiNaC still lacks proper factorization support.  Some form of
2267 factorization is, however, easily implemented by noting that factors
2268 appearing in a polynomial with power two or more also appear in the
2269 derivative and hence can easily be found by computing the GCD of the
2270 original polynomial and its derivatives.  Any system has an interface
2271 for this so called square-free factorization.  So we provide one, too:
2272 @example
2273 ex sqrfree(const ex & a, const lst & l = lst());
2274 @end example
2275 Here is an example that by the way illustrates how the result may depend
2276 on the order of differentiation:
2277 @example
2278     ...
2279     symbol x("x"), y("y");
2280     ex BiVarPol = expand(pow(x-2*y*x,3) * pow(x+y,2) * (x-y));
2281
2282     cout << sqrfree(BiVarPol, lst(x,y)) << endl;
2283      // -> (y+x)^2*(-1+6*y+8*y^3-12*y^2)*(y-x)*x^3
2284
2285     cout << sqrfree(BiVarPol, lst(y,x)) << endl;
2286      // -> (1-2*y)^3*(y+x)^2*(-y+x)*x^3
2287
2288     cout << sqrfree(BiVarPol) << endl;
2289      // -> depending on luck, any of the above
2290     ...
2291 @end example
2292
2293
2294 @node Rational Expressions, Symbolic Differentiation, Polynomial Arithmetic, Methods and Functions
2295 @c    node-name, next, previous, up
2296 @section Rational expressions
2297
2298 @subsection The @code{normal} method
2299 @cindex @code{normal()}
2300 @cindex simplification
2301 @cindex temporary replacement
2302
2303 Some basic form of simplification of expressions is called for frequently.
2304 GiNaC provides the method @code{.normal()}, which converts a rational function
2305 into an equivalent rational function of the form @samp{numerator/denominator}
2306 where numerator and denominator are coprime.  If the input expression is already
2307 a fraction, it just finds the GCD of numerator and denominator and cancels it,
2308 otherwise it performs fraction addition and multiplication.
2309
2310 @code{.normal()} can also be used on expressions which are not rational functions
2311 as it will replace all non-rational objects (like functions or non-integer
2312 powers) by temporary symbols to bring the expression to the domain of rational
2313 functions before performing the normalization, and re-substituting these
2314 symbols afterwards. This algorithm is also available as a separate method
2315 @code{.to_rational()}, described below.
2316
2317 This means that both expressions @code{t1} and @code{t2} are indeed
2318 simplified in this little program:
2319
2320 @example
2321 #include <ginac/ginac.h>
2322 using namespace GiNaC;
2323
2324 int main()
2325 @{
2326     symbol x("x");
2327     ex t1 = (pow(x,2) + 2*x + 1)/(x + 1);
2328     ex t2 = (pow(sin(x),2) + 2*sin(x) + 1)/(sin(x) + 1);
2329     std::cout << "t1 is " << t1.normal() << std::endl;
2330     std::cout << "t2 is " << t2.normal() << std::endl;
2331 @}
2332 @end example
2333
2334 Of course this works for multivariate polynomials too, so the ratio of
2335 the sample-polynomials from the section about GCD and LCM above would be
2336 normalized to @code{P_a/P_b} = @code{(4*y+z)/(y+3*z)}.
2337
2338
2339 @subsection Numerator and denominator
2340 @cindex numerator
2341 @cindex denominator
2342 @cindex @code{numer()}
2343 @cindex @code{denom()}
2344
2345 The numerator and denominator of an expression can be obtained with
2346
2347 @example
2348 ex ex::numer();
2349 ex ex::denom();
2350 @end example
2351
2352 These functions will first normalize the expression as described above and
2353 then return the numerator or denominator, respectively.
2354
2355
2356 @subsection Converting to a rational expression
2357 @cindex @code{to_rational()}
2358
2359 Some of the methods described so far only work on polynomials or rational
2360 functions. GiNaC provides a way to extend the domain of these functions to
2361 general expressions by using the temporary replacement algorithm described
2362 above. You do this by calling
2363
2364 @example
2365 ex ex::to_rational(lst &l);
2366 @end example
2367
2368 on the expression to be converted. The supplied @code{lst} will be filled
2369 with the generated temporary symbols and their replacement expressions in
2370 a format that can be used directly for the @code{subs()} method. It can also
2371 already contain a list of replacements from an earlier application of
2372 @code{.to_rational()}, so it's possible to use it on multiple expressions
2373 and get consistent results.
2374
2375 For example,
2376
2377 @example
2378 @{
2379     symbol x("x");
2380     ex a = pow(sin(x), 2) - pow(cos(x), 2);
2381     ex b = sin(x) + cos(x);
2382     ex q;
2383     lst l;
2384     divide(a.to_rational(l), b.to_rational(l), q);
2385     cout << q.subs(l) << endl;
2386 @}
2387 @end example
2388
2389 will print @samp{sin(x)-cos(x)}.
2390
2391
2392 @node Symbolic Differentiation, Series Expansion, Rational Expressions, Methods and Functions
2393 @c    node-name, next, previous, up
2394 @section Symbolic differentiation
2395 @cindex differentiation
2396 @cindex @code{diff()}
2397 @cindex chain rule
2398 @cindex product rule
2399
2400 GiNaC's objects know how to differentiate themselves.  Thus, a
2401 polynomial (class @code{add}) knows that its derivative is the sum of
2402 the derivatives of all the monomials:
2403
2404 @example
2405 #include <ginac/ginac.h>
2406 using namespace GiNaC;
2407
2408 int main()
2409 @{
2410     symbol x("x"), y("y"), z("z");
2411     ex P = pow(x, 5) + pow(x, 2) + y;
2412
2413     cout << P.diff(x,2) << endl;  // 20*x^3 + 2
2414     cout << P.diff(y) << endl;    // 1
2415     cout << P.diff(z) << endl;    // 0
2416 @}
2417 @end example
2418
2419 If a second integer parameter @var{n} is given, the @code{diff} method
2420 returns the @var{n}th derivative.
2421
2422 If @emph{every} object and every function is told what its derivative
2423 is, all derivatives of composed objects can be calculated using the
2424 chain rule and the product rule.  Consider, for instance the expression
2425 @code{1/cosh(x)}.  Since the derivative of @code{cosh(x)} is
2426 @code{sinh(x)} and the derivative of @code{pow(x,-1)} is
2427 @code{-pow(x,-2)}, GiNaC can readily compute the composition.  It turns
2428 out that the composition is the generating function for Euler Numbers,
2429 i.e. the so called @var{n}th Euler number is the coefficient of
2430 @code{x^n/n!} in the expansion of @code{1/cosh(x)}.  We may use this
2431 identity to code a function that generates Euler numbers in just three
2432 lines:
2433
2434 @cindex Euler numbers
2435 @example
2436 #include <ginac/ginac.h>
2437 using namespace GiNaC;
2438
2439 ex EulerNumber(unsigned n)
2440 @{
2441     symbol x;
2442     const ex generator = pow(cosh(x),-1);
2443     return generator.diff(x,n).subs(x==0);
2444 @}
2445
2446 int main()
2447 @{
2448     for (unsigned i=0; i<11; i+=2)
2449         std::cout << EulerNumber(i) << std::endl;
2450     return 0;
2451 @}
2452 @end example
2453
2454 When you run it, it produces the sequence @code{1}, @code{-1}, @code{5},
2455 @code{-61}, @code{1385}, @code{-50521}.  We increment the loop variable
2456 @code{i} by two since all odd Euler numbers vanish anyways.
2457
2458
2459 @node Series Expansion, Built-in Functions, Symbolic Differentiation, Methods and Functions
2460 @c    node-name, next, previous, up
2461 @section Series expansion
2462 @cindex @code{series()}
2463 @cindex Taylor expansion
2464 @cindex Laurent expansion
2465 @cindex @code{pseries} (class)
2466
2467 Expressions know how to expand themselves as a Taylor series or (more
2468 generally) a Laurent series.  As in most conventional Computer Algebra
2469 Systems, no distinction is made between those two.  There is a class of
2470 its own for storing such series (@code{class pseries}) and a built-in
2471 function (called @code{Order}) for storing the order term of the series.
2472 As a consequence, if you want to work with series, i.e. multiply two
2473 series, you need to call the method @code{ex::series} again to convert
2474 it to a series object with the usual structure (expansion plus order
2475 term).  A sample application from special relativity could read:
2476
2477 @example
2478 #include <ginac/ginac.h>
2479 using namespace std;
2480 using namespace GiNaC;
2481
2482 int main()
2483 @{
2484     symbol v("v"), c("c");
2485     
2486     ex gamma = 1/sqrt(1 - pow(v/c,2));
2487     ex mass_nonrel = gamma.series(v==0, 10);
2488     
2489     cout << "the relativistic mass increase with v is " << endl
2490          << mass_nonrel << endl;
2491     
2492     cout << "the inverse square of this series is " << endl
2493          << pow(mass_nonrel,-2).series(v==0, 10) << endl;
2494 @}
2495 @end example
2496
2497 Only calling the series method makes the last output simplify to
2498 @math{1-v^2/c^2+O(v^10)}, without that call we would just have a long
2499 series raised to the power @math{-2}.
2500
2501 @cindex M@'echain's formula
2502 As another instructive application, let us calculate the numerical 
2503 value of Archimedes' constant
2504 @tex
2505 $\pi$
2506 @end tex
2507 (for which there already exists the built-in constant @code{Pi}) 
2508 using M@'echain's amazing formula
2509 @tex
2510 $\pi=16$~atan~$\!\left(1 \over 5 \right)-4$~atan~$\!\left(1 \over 239 \right)$.
2511 @end tex
2512 @ifnottex
2513 @math{Pi==16*atan(1/5)-4*atan(1/239)}.
2514 @end ifnottex
2515 We may expand the arcus tangent around @code{0} and insert the fractions
2516 @code{1/5} and @code{1/239}.  But, as we have seen, a series in GiNaC
2517 carries an order term with it and the question arises what the system is
2518 supposed to do when the fractions are plugged into that order term.  The
2519 solution is to use the function @code{series_to_poly()} to simply strip
2520 the order term off:
2521
2522 @example
2523 #include <ginac/ginac.h>
2524 using namespace GiNaC;
2525
2526 ex mechain_pi(int degr)
2527 @{
2528     symbol x;
2529     ex pi_expansion = series_to_poly(atan(x).series(x,degr));
2530     ex pi_approx = 16*pi_expansion.subs(x==numeric(1,5))
2531                    -4*pi_expansion.subs(x==numeric(1,239));
2532     return pi_approx;
2533 @}
2534
2535 int main()
2536 @{
2537     using std::cout;  // just for fun, another way of...
2538     using std::endl;  // ...dealing with this namespace std.
2539     ex pi_frac;
2540     for (int i=2; i<12; i+=2) @{
2541         pi_frac = mechain_pi(i);
2542         cout << i << ":\t" << pi_frac << endl
2543              << "\t" << pi_frac.evalf() << endl;
2544     @}
2545     return 0;
2546 @}
2547 @end example
2548
2549 Note how we just called @code{.series(x,degr)} instead of
2550 @code{.series(x==0,degr)}.  This is a simple shortcut for @code{ex}'s
2551 method @code{series()}: if the first argument is a symbol the expression
2552 is expanded in that symbol around point @code{0}.  When you run this
2553 program, it will type out:
2554
2555 @example
2556 2:      3804/1195
2557         3.1832635983263598326
2558 4:      5359397032/1706489875
2559         3.1405970293260603143
2560 6:      38279241713339684/12184551018734375
2561         3.141621029325034425
2562 8:      76528487109180192540976/24359780855939418203125
2563         3.141591772182177295
2564 10:     327853873402258685803048818236/104359128170408663038552734375
2565         3.1415926824043995174
2566 @end example
2567
2568
2569 @node Built-in Functions, Input/Output, Series Expansion, Methods and Functions
2570 @c    node-name, next, previous, up
2571 @section Predefined mathematical functions
2572
2573 GiNaC contains the following predefined mathematical functions:
2574
2575 @cartouche
2576 @multitable @columnfractions .30 .70
2577 @item @strong{Name} @tab @strong{Function}
2578 @item @code{abs(x)}
2579 @tab absolute value
2580 @item @code{csgn(x)}
2581 @tab complex sign
2582 @item @code{sqrt(x)}
2583 @tab square root (not a GiNaC function proper but equivalent to @code{pow(x, numeric(1, 2)})
2584 @item @code{sin(x)}
2585 @tab sine
2586 @item @code{cos(x)}
2587 @tab cosine
2588 @item @code{tan(x)}
2589 @tab tangent
2590 @item @code{asin(x)}
2591 @tab inverse sine
2592 @item @code{acos(x)}
2593 @tab inverse cosine
2594 @item @code{atan(x)}
2595 @tab inverse tangent
2596 @item @code{atan2(y, x)}
2597 @tab inverse tangent with two arguments
2598 @item @code{sinh(x)}
2599 @tab hyperbolic sine
2600 @item @code{cosh(x)}
2601 @tab hyperbolic cosine
2602 @item @code{tanh(x)}
2603 @tab hyperbolic tangent
2604 @item @code{asinh(x)}
2605 @tab inverse hyperbolic sine
2606 @item @code{acosh(x)}
2607 @tab inverse hyperbolic cosine
2608 @item @code{atanh(x)}
2609 @tab inverse hyperbolic tangent
2610 @item @code{exp(x)}
2611 @tab exponential function
2612 @item @code{log(x)}
2613 @tab natural logarithm
2614 @item @code{Li2(x)}
2615 @tab Dilogarithm
2616 @item @code{zeta(x)}
2617 @tab Riemann's zeta function
2618 @item @code{zeta(n, x)}
2619 @tab derivatives of Riemann's zeta function
2620 @item @code{tgamma(x)}
2621 @tab Gamma function
2622 @item @code{lgamma(x)}
2623 @tab logarithm of Gamma function
2624 @item @code{beta(x, y)}
2625 @tab Beta function (@code{tgamma(x)*tgamma(y)/tgamma(x+y)})
2626 @item @code{psi(x)}
2627 @tab psi (digamma) function
2628 @item @code{psi(n, x)}
2629 @tab derivatives of psi function (polygamma functions)
2630 @item @code{factorial(n)}
2631 @tab factorial function
2632 @item @code{binomial(n, m)}
2633 @tab binomial coefficients
2634 @item @code{Order(x)}
2635 @tab order term function in truncated power series
2636 @item @code{Derivative(x, l)}
2637 @tab inert partial differentiation operator (used internally)
2638 @end multitable
2639 @end cartouche
2640
2641 @cindex branch cut
2642 For functions that have a branch cut in the complex plane GiNaC follows
2643 the conventions for C++ as defined in the ANSI standard as far as
2644 possible.  In particular: the natural logarithm (@code{log}) and the
2645 square root (@code{sqrt}) both have their branch cuts running along the
2646 negative real axis where the points on the axis itself belong to the
2647 upper part (i.e. continuous with quadrant II).  The inverse
2648 trigonometric and hyperbolic functions are not defined for complex
2649 arguments by the C++ standard, however.  In GiNaC we follow the
2650 conventions used by CLN, which in turn follow the carefully designed
2651 definitions in the Common Lisp standard.  It should be noted that this
2652 convention is identical to the one used by the C99 standard and by most
2653 serious CAS.  It is to be expected that future revisions of the C++
2654 standard incorporate these functions in the complex domain in a manner
2655 compatible with C99.
2656
2657
2658 @node Input/Output, Extending GiNaC, Built-in Functions, Methods and Functions
2659 @c    node-name, next, previous, up
2660 @section Input and output of expressions
2661 @cindex I/O
2662
2663 @subsection Expression output
2664 @cindex printing
2665 @cindex output of expressions
2666
2667 The easiest way to print an expression is to write it to a stream:
2668
2669 @example
2670 @{
2671     symbol x("x");
2672     ex e = 4.5+pow(x,2)*3/2;
2673     cout << e << endl;    // prints '4.5+3/2*x^2'
2674     // ...
2675 @end example
2676
2677 The output format is identical to the @command{ginsh} input syntax and
2678 to that used by most computer algebra systems, but not directly pastable
2679 into a GiNaC C++ program (note that in the above example, @code{pow(x,2)}
2680 is printed as @samp{x^2}).
2681
2682 To print an expression in a way that can be directly used in a C or C++
2683 program, you use the method
2684
2685 @example
2686 void ex::printcsrc(ostream & os, unsigned type, const char *name);
2687 @end example
2688
2689 This outputs a line in the form of a variable definition @code{<type> <name> = <expression>}.
2690 The possible types are defined in @file{ginac/flags.h} (@code{csrc_types})
2691 and mostly affect the way in which floating point numbers are written:
2692
2693 @example
2694     // ...
2695     e.printcsrc(cout, csrc_types::ctype_float, "f");
2696     e.printcsrc(cout, csrc_types::ctype_double, "d");
2697     e.printcsrc(cout, csrc_types::ctype_cl_N, "n");
2698     // ...
2699 @end example
2700
2701 The above example will produce (note the @code{x^2} being converted to @code{x*x}):
2702
2703 @example
2704 float f = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
2705 double d = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
2706 cl_N n = (cl_F("3.0")/cl_F("2.0"))*(x*x)+cl_F("4.5");
2707 @end example
2708
2709 Finally, there are the two methods @code{printraw()} and @code{printtree()} intended for GiNaC
2710 developers, that provide a dump of the internal structure of an expression for
2711 debugging purposes:
2712
2713 @example
2714     // ...
2715     e.printraw(cout); cout << endl << endl;
2716     e.printtree(cout);
2717 @}
2718 @end example
2719
2720 produces
2721
2722 @example
2723 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))
2724
2725 type=Q25GiNaC3add, hash=0 (0x0), flags=3, nops=2
2726     power: hash=2 (0x2), flags=3
2727         x (symbol): serial=1, hash=150875740 (0x8fe2e5c), flags=11
2728         2 (numeric): hash=2147483714 (0x80000042), flags=11
2729     3/2 (numeric): hash=2147483745 (0x80000061), flags=11
2730     -----
2731     overall_coeff
2732     4.5L0 (numeric): hash=2147483723 (0x8000004b), flags=11
2733     =====
2734 @end example
2735
2736 The @code{printtree()} method is also available in @command{ginsh} as the
2737 @code{print()} function.
2738
2739
2740 @subsection Expression input
2741 @cindex input of expressions
2742
2743 GiNaC provides no way to directly read an expression from a stream because
2744 you will usually want the user to be able to enter something like @samp{2*x+sin(y)}
2745 and have the @samp{x} and @samp{y} correspond to the symbols @code{x} and
2746 @code{y} you defined in your program and there is no way to specify the
2747 desired symbols to the @code{>>} stream input operator.
2748
2749 Instead, GiNaC lets you construct an expression from a string, specifying the
2750 list of symbols to be used:
2751
2752 @example
2753 @{
2754     symbol x("x"), y("y");
2755     ex e("2*x+sin(y)", lst(x, y));
2756 @}
2757 @end example
2758
2759 The input syntax is the same as that used by @command{ginsh} and the stream
2760 output operator @code{<<}. The symbols in the string are matched by name to
2761 the symbols in the list and if GiNaC encounters a symbol not specified in
2762 the list it will throw an exception.
2763
2764 With this constructor, it's also easy to implement interactive GiNaC programs:
2765
2766 @example
2767 #include <iostream>
2768 #include <string>
2769 #include <stdexcept>
2770 #include <ginac/ginac.h>
2771 using namespace std;
2772 using namespace GiNaC;
2773
2774 int main()
2775 @{
2776      symbol x("x");
2777      string s;
2778
2779      cout << "Enter an expression containing 'x': ";
2780      getline(cin, s);
2781
2782      try @{
2783          ex e(s, lst(x));
2784          cout << "The derivative of " << e << " with respect to x is ";
2785          cout << e.diff(x) << ".\n";
2786      @} catch (exception &p) @{
2787          cerr << p.what() << endl;
2788      @}
2789 @}
2790 @end example
2791
2792
2793 @subsection Archiving
2794 @cindex @code{archive} (class)
2795 @cindex archiving
2796
2797 GiNaC allows creating @dfn{archives} of expressions which can be stored
2798 to or retrieved from files. To create an archive, you declare an object
2799 of class @code{archive} and archive expressions in it, giving each
2800 expression a unique name:
2801
2802 @example
2803 #include <fstream>
2804 using namespace std;
2805 #include <ginac/ginac.h>
2806 using namespace GiNaC;
2807
2808 int main()
2809 @{
2810     symbol x("x"), y("y"), z("z");
2811
2812     ex foo = sin(x + 2*y) + 3*z + 41;
2813     ex bar = foo + 1;
2814
2815     archive a;
2816     a.archive_ex(foo, "foo");
2817     a.archive_ex(bar, "the second one");
2818     // ...
2819 @end example
2820
2821 The archive can then be written to a file:
2822
2823 @example
2824     // ...
2825     ofstream out("foobar.gar");
2826     out << a;
2827     out.close();
2828     // ...
2829 @end example
2830
2831 The file @file{foobar.gar} contains all information that is needed to
2832 reconstruct the expressions @code{foo} and @code{bar}.
2833
2834 @cindex @command{viewgar}
2835 The tool @command{viewgar} that comes with GiNaC can be used to view
2836 the contents of GiNaC archive files:
2837
2838 @example
2839 $ viewgar foobar.gar
2840 foo = 41+sin(x+2*y)+3*z
2841 the second one = 42+sin(x+2*y)+3*z
2842 @end example
2843
2844 The point of writing archive files is of course that they can later be
2845 read in again:
2846
2847 @example
2848     // ...
2849     archive a2;
2850     ifstream in("foobar.gar");
2851     in >> a2;
2852     // ...
2853 @end example
2854
2855 And the stored expressions can be retrieved by their name:
2856
2857 @example
2858     // ...
2859     lst syms(x, y);
2860
2861     ex ex1 = a2.unarchive_ex(syms, "foo");
2862     ex ex2 = a2.unarchive_ex(syms, "the second one");
2863
2864     cout << ex1 << endl;              // prints "41+sin(x+2*y)+3*z"
2865     cout << ex2 << endl;              // prints "42+sin(x+2*y)+3*z"
2866     cout << ex1.subs(x == 2) << endl; // prints "41+sin(2+2*y)+3*z"
2867 @}
2868 @end example
2869
2870 Note that you have to supply a list of the symbols which are to be inserted
2871 in the expressions. Symbols in archives are stored by their name only and
2872 if you don't specify which symbols you have, unarchiving the expression will
2873 create new symbols with that name. E.g. if you hadn't included @code{x} in
2874 the @code{syms} list above, the @code{ex1.subs(x == 2)} statement would
2875 have had no effect because the @code{x} in @code{ex1} would have been a
2876 different symbol than the @code{x} which was defined at the beginning of
2877 the program, altough both would appear as @samp{x} when printed.
2878
2879
2880
2881 @node Extending GiNaC, What does not belong into GiNaC, Input/Output, Top
2882 @c    node-name, next, previous, up
2883 @chapter Extending GiNaC
2884
2885 By reading so far you should have gotten a fairly good understanding of
2886 GiNaC's design-patterns.  From here on you should start reading the
2887 sources.  All we can do now is issue some recommendations how to tackle
2888 GiNaC's many loose ends in order to fulfill everybody's dreams.  If you
2889 develop some useful extension please don't hesitate to contact the GiNaC
2890 authors---they will happily incorporate them into future versions.
2891
2892 @menu
2893 * What does not belong into GiNaC::  What to avoid.
2894 * Symbolic functions::               Implementing symbolic functions.
2895 * Adding classes::                   Defining new algebraic classes.
2896 @end menu
2897
2898
2899 @node What does not belong into GiNaC, Symbolic functions, Extending GiNaC, Extending GiNaC
2900 @c    node-name, next, previous, up
2901 @section What doesn't belong into GiNaC
2902
2903 @cindex @command{ginsh}
2904 First of all, GiNaC's name must be read literally.  It is designed to be
2905 a library for use within C++.  The tiny @command{ginsh} accompanying
2906 GiNaC makes this even more clear: it doesn't even attempt to provide a
2907 language.  There are no loops or conditional expressions in
2908 @command{ginsh}, it is merely a window into the library for the
2909 programmer to test stuff (or to show off).  Still, the design of a
2910 complete CAS with a language of its own, graphical capabilites and all
2911 this on top of GiNaC is possible and is without doubt a nice project for
2912 the future.
2913
2914 There are many built-in functions in GiNaC that do not know how to
2915 evaluate themselves numerically to a precision declared at runtime
2916 (using @code{Digits}).  Some may be evaluated at certain points, but not
2917 generally.  This ought to be fixed.  However, doing numerical
2918 computations with GiNaC's quite abstract classes is doomed to be
2919 inefficient.  For this purpose, the underlying foundation classes
2920 provided by @acronym{CLN} are much better suited.
2921
2922
2923 @node Symbolic functions, Adding classes, What does not belong into GiNaC, Extending GiNaC
2924 @c    node-name, next, previous, up
2925 @section Symbolic functions
2926
2927 The easiest and most instructive way to start with is probably to
2928 implement your own function.  GiNaC's functions are objects of class
2929 @code{function}.  The preprocessor is then used to convert the function
2930 names to objects with a corresponding serial number that is used
2931 internally to identify them.  You usually need not worry about this
2932 number.  New functions may be inserted into the system via a kind of
2933 `registry'.  It is your responsibility to care for some functions that
2934 are called when the user invokes certain methods.  These are usual
2935 C++-functions accepting a number of @code{ex} as arguments and returning
2936 one @code{ex}.  As an example, if we have a look at a simplified
2937 implementation of the cosine trigonometric function, we first need a
2938 function that is called when one wishes to @code{eval} it.  It could
2939 look something like this:
2940
2941 @example
2942 static ex cos_eval_method(const ex & x)
2943 @{
2944     // if (!x%(2*Pi)) return 1
2945     // if (!x%Pi) return -1
2946     // if (!x%Pi/2) return 0
2947     // care for other cases...
2948     return cos(x).hold();
2949 @}
2950 @end example
2951
2952 @cindex @code{hold()}
2953 @cindex evaluation
2954 The last line returns @code{cos(x)} if we don't know what else to do and
2955 stops a potential recursive evaluation by saying @code{.hold()}, which
2956 sets a flag to the expression signaling that it has been evaluated.  We
2957 should also implement a method for numerical evaluation and since we are
2958 lazy we sweep the problem under the rug by calling someone else's
2959 function that does so, in this case the one in class @code{numeric}:
2960
2961 @example
2962 static ex cos_evalf(const ex & x)
2963 @{
2964     return cos(ex_to_numeric(x));
2965 @}
2966 @end example
2967
2968 Differentiation will surely turn up and so we need to tell @code{cos}
2969 what the first derivative is (higher derivatives (@code{.diff(x,3)} for
2970 instance are then handled automatically by @code{basic::diff} and
2971 @code{ex::diff}):
2972
2973 @example
2974 static ex cos_deriv(const ex & x, unsigned diff_param)
2975 @{
2976     return -sin(x);
2977 @}
2978 @end example
2979
2980 @cindex product rule
2981 The second parameter is obligatory but uninteresting at this point.  It
2982 specifies which parameter to differentiate in a partial derivative in
2983 case the function has more than one parameter and its main application
2984 is for correct handling of the chain rule.  For Taylor expansion, it is
2985 enough to know how to differentiate.  But if the function you want to
2986 implement does have a pole somewhere in the complex plane, you need to
2987 write another method for Laurent expansion around that point.
2988
2989 Now that all the ingredients for @code{cos} have been set up, we need
2990 to tell the system about it.  This is done by a macro and we are not
2991 going to descibe how it expands, please consult your preprocessor if you
2992 are curious:
2993
2994 @example
2995 REGISTER_FUNCTION(cos, eval_func(cos_eval).
2996                        evalf_func(cos_evalf).
2997                        derivative_func(cos_deriv));
2998 @end example
2999
3000 The first argument is the function's name used for calling it and for
3001 output.  The second binds the corresponding methods as options to this
3002 object.  Options are separated by a dot and can be given in an arbitrary
3003 order.  GiNaC functions understand several more options which are always
3004 specified as @code{.option(params)}, for example a method for series
3005 expansion @code{.series_func(cos_series)}.  Again, if no series
3006 expansion method is given, GiNaC defaults to simple Taylor expansion,
3007 which is correct if there are no poles involved as is the case for the
3008 @code{cos} function.  The way GiNaC handles poles in case there are any
3009 is best understood by studying one of the examples, like the Gamma
3010 (@code{tgamma}) function for instance.  (In essence the function first
3011 checks if there is a pole at the evaluation point and falls back to
3012 Taylor expansion if there isn't.  Then, the pole is regularized by some
3013 suitable transformation.)  Also, the new function needs to be declared
3014 somewhere.  This may also be done by a convenient preprocessor macro:
3015
3016 @example
3017 DECLARE_FUNCTION_1P(cos)
3018 @end example
3019
3020 The suffix @code{_1P} stands for @emph{one parameter}.  Of course, this
3021 implementation of @code{cos} is very incomplete and lacks several safety
3022 mechanisms.  Please, have a look at the real implementation in GiNaC.
3023 (By the way: in case you are worrying about all the macros above we can
3024 assure you that functions are GiNaC's most macro-intense classes.  We
3025 have done our best to avoid macros where we can.)
3026
3027
3028 @node Adding classes, A Comparison With Other CAS, Symbolic functions, Extending GiNaC
3029 @c    node-name, next, previous, up
3030 @section Adding classes
3031
3032 If you are doing some very specialized things with GiNaC you may find that
3033 you have to implement your own algebraic classes to fit your needs. This
3034 section will explain how to do this by giving the example of a simple
3035 'string' class. After reading this section you will know how to properly
3036 declare a GiNaC class and what the minimum required member functions are
3037 that you have to implement. We only cover the implementation of a 'leaf'
3038 class here (i.e. one that doesn't contain subexpressions). Creating a
3039 container class like, for example, a class representing tensor products is
3040 more involved but this section should give you enough information so you can
3041 consult the source to GiNaC's predefined classes if you want to implement
3042 something more complicated.
3043
3044 @subsection GiNaC's run-time type information system
3045
3046 @cindex hierarchy of classes
3047 @cindex RTTI
3048 All algebraic classes (that is, all classes that can appear in expressions)
3049 in GiNaC are direct or indirect subclasses of the class @code{basic}. So a
3050 @code{basic *} (which is essentially what an @code{ex} is) represents a
3051 generic pointer to an algebraic class. Occasionally it is necessary to find
3052 out what the class of an object pointed to by a @code{basic *} really is.
3053 Also, for the unarchiving of expressions it must be possible to find the
3054 @code{unarchive()} function of a class given the class name (as a string). A
3055 system that provides this kind of information is called a run-time type
3056 information (RTTI) system. The C++ language provides such a thing (see the
3057 standard header file @file{<typeinfo>}) but for efficiency reasons GiNaC
3058 implements its own, simpler RTTI.
3059
3060 The RTTI in GiNaC is based on two mechanisms:
3061
3062 @itemize @bullet
3063
3064 @item
3065 The @code{basic} class declares a member variable @code{tinfo_key} which
3066 holds an unsigned integer that identifies the object's class. These numbers
3067 are defined in the @file{tinfos.h} header file for the built-in GiNaC
3068 classes. They all start with @code{TINFO_}.
3069
3070 @item
3071 By means of some clever tricks with static members, GiNaC maintains a list
3072 of information for all classes derived from @code{basic}. The information
3073 available includes the class names, the @code{tinfo_key}s, and pointers
3074 to the unarchiving functions. This class registry is defined in the
3075 @file{registrar.h} header file.
3076
3077 @end itemize
3078
3079 The disadvantage of this proprietary RTTI implementation is that there's
3080 a little more to do when implementing new classes (C++'s RTTI works more
3081 or less automatic) but don't worry, most of the work is simplified by
3082 macros.
3083
3084 @subsection A minimalistic example
3085
3086 Now we will start implementing a new class @code{mystring} that allows
3087 placing character strings in algebraic expressions (this is not very useful,
3088 but it's just an example). This class will be a direct subclass of
3089 @code{basic}. You can use this sample implementation as a starting point
3090 for your own classes.
3091
3092 The code snippets given here assume that you have included some header files
3093 as follows:
3094
3095 @example
3096 #include <iostream>
3097 #include <string>   
3098 #include <stdexcept>
3099 using namespace std;
3100
3101 #include <ginac/ginac.h>
3102 using namespace GiNaC;
3103 @end example
3104
3105 The first thing we have to do is to define a @code{tinfo_key} for our new
3106 class. This can be any arbitrary unsigned number that is not already taken
3107 by one of the existing classes but it's better to come up with something
3108 that is unlikely to clash with keys that might be added in the future. The
3109 numbers in @file{tinfos.h} are modeled somewhat after the class hierarchy
3110 which is not a requirement but we are going to stick with this scheme:
3111
3112 @example
3113 const unsigned TINFO_mystring = 0x42420001U;
3114 @end example
3115
3116 Now we can write down the class declaration. The class stores a C++
3117 @code{string} and the user shall be able to construct a @code{mystring}
3118 object from a C or C++ string:
3119
3120 @example
3121 class mystring : public basic
3122 @{
3123     GINAC_DECLARE_REGISTERED_CLASS(mystring, basic)
3124   
3125 public:
3126     mystring(const string &s);
3127     mystring(const char *s);
3128
3129 private:
3130     string str;
3131 @};
3132
3133 GIANC_IMPLEMENT_REGISTERED_CLASS(mystring, basic)
3134 @end example
3135
3136 The @code{GINAC_DECLARE_REGISTERED_CLASS} and @code{GINAC_IMPLEMENT_REGISTERED_CLASS}
3137 macros are defined in @file{registrar.h}. They take the name of the class
3138 and its direct superclass as arguments and insert all required declarations
3139 for the RTTI system. The @code{GINAC_DECLARE_REGISTERED_CLASS} should be
3140 the first line after the opening brace of the class definition. The
3141 @code{GINAC_IMPLEMENT_REGISTERED_CLASS} may appear anywhere else in the
3142 source (at global scope, of course, not inside a function).
3143
3144 @code{GINAC_DECLARE_REGISTERED_CLASS} contains, among other things the
3145 declarations of the default and copy constructor, the destructor, the
3146 assignment operator and a couple of other functions that are required. It
3147 also defines a type @code{inherited} which refers to the superclass so you
3148 don't have to modify your code every time you shuffle around the class
3149 hierarchy. @code{GINAC_IMPLEMENT_REGISTERED_CLASS} implements the copy
3150 constructor, the destructor and the assignment operator.
3151
3152 Now there are nine member functions we have to implement to get a working
3153 class:
3154
3155 @itemize
3156
3157 @item
3158 @code{mystring()}, the default constructor.
3159
3160 @item
3161 @code{void destroy(bool call_parent)}, which is used in the destructor and the
3162 assignment operator to free dynamically allocated members. The @code{call_parent}
3163 specifies whether the @code{destroy()} function of the superclass is to be
3164 called also.
3165
3166 @item
3167 @code{void copy(const mystring &other)}, which is used in the copy constructor
3168 and assignment operator to copy the member variables over from another
3169 object of the same class.
3170
3171 @item
3172 @code{void archive(archive_node &n)}, the archiving function. This stores all
3173 information needed to reconstruct an object of this class inside an
3174 @code{archive_node}.
3175
3176 @item
3177 @code{mystring(const archive_node &n, const lst &sym_lst)}, the unarchiving
3178 constructor. This constructs an instance of the class from the information
3179 found in an @code{archive_node}.
3180
3181 @item
3182 @code{ex unarchive(const archive_node &n, const lst &sym_lst)}, the static
3183 unarchiving function. It constructs a new instance by calling the unarchiving
3184 constructor.
3185
3186 @item
3187 @code{int compare_same_type(const basic &other)}, which is used internally
3188 by GiNaC to establish a canonical sort order for terms. It returns 0, +1 or
3189 -1, depending on the relative order of this object and the @code{other}
3190 object. If it returns 0, the objects are considered equal.
3191 @strong{Note:} This has nothing to do with the (numeric) ordering
3192 relationship expressed by @code{<}, @code{>=} etc (which cannot be defined
3193 for non-numeric classes). For example, @code{numeric(1).compare_same_type(numeric(2))}
3194 may return +1 even though 1 is clearly smaller than 2. Every GiNaC class
3195 must provide a @code{compare_same_type()} function, even those representing
3196 objects for which no reasonable algebraic ordering relationship can be
3197 defined.
3198
3199 @item
3200 And, of course, @code{mystring(const string &s)} and @code{mystring(const char *s)}
3201 which are the two constructors we declared.
3202
3203 @end itemize
3204
3205 Let's proceed step-by-step. The default constructor looks like this:
3206
3207 @example
3208 mystring::mystring() : inherited(TINFO_mystring)
3209 @{
3210     // dynamically allocate resources here if required
3211 @}
3212 @end example
3213
3214 The golden rule is that in all constructors you have to set the
3215 @code{tinfo_key} member to the @code{TINFO_*} value of your class. Otherwise
3216 it will be set by the constructor of the superclass and all hell will break
3217 loose in the RTTI. For your convenience, the @code{basic} class provides
3218 a constructor that takes a @code{tinfo_key} value, which we are using here
3219 (remember that in our case @code{inherited = basic}). If the superclass
3220 didn't have such a constructor, we would have to set the @code{tinfo_key}
3221 to the right value manually.
3222
3223 In the default constructor you should set all other member variables to
3224 reasonable default values (we don't need that here since our @code{str}
3225 member gets set to an empty string automatically). The constructor(s) are of
3226 course also the right place to allocate any dynamic resources you require.
3227
3228 Next, the @code{destroy()} function:
3229
3230 @example
3231 void mystring::destroy(bool call_parent)
3232 @{
3233     // free dynamically allocated resources here if required
3234     if (call_parent)
3235         inherited::destroy(call_parent);
3236 @}
3237 @end example
3238
3239 This function is where we free all dynamically allocated resources. We don't
3240 have any so we're not doing anything here, but if we had, for example, used
3241 a C-style @code{char *} to store our string, this would be the place to
3242 @code{delete[]} the string storage. If @code{call_parent} is true, we have
3243 to call the @code{destroy()} function of the superclass after we're done
3244 (to mimic C++'s automatic invocation of superclass destructors where
3245 @code{destroy()} is called from outside a destructor).
3246
3247 The @code{copy()} function just copies over the member variables from
3248 another object:
3249
3250 @example
3251 void mystring::copy(const mystring &other)
3252 @{
3253     inherited::copy(other);
3254     str = other.str;
3255 @}
3256 @end example
3257
3258 We can simply overwrite the member variables here. There's no need to worry
3259 about dynamically allocated storage. The assignment operator (which is
3260 automatically defined by @code{GINAC_IMPLEMENT_REGISTERED_CLASS}, as you
3261 recall) calls @code{destroy()} before it calls @code{copy()}. You have to
3262 explicitly call the @code{copy()} function of the superclass here so
3263 all the member variables will get copied.
3264
3265 Next are the three functions for archiving. You have to implement them even
3266 if you don't plan to use archives, but the minimum required implementation
3267 is really simple. First, the archiving function:
3268
3269 @example
3270 void mystring::archive(archive_node &n) const
3271 @{
3272     inherited::archive(n);
3273     n.add_string("string", str);
3274 @}
3275 @end example
3276
3277 The only thing that is really required is calling the @code{archive()}
3278 function of the superclass. Optionally, you can store all information you
3279 deem necessary for representing the object into the passed
3280 @code{archive_node}. We are just storing our string here. For more
3281 information on how the archiving works, consult the @file{archive.h} header
3282 file.
3283
3284 The unarchiving constructor is basically the inverse of the archiving
3285 function:
3286
3287 @example
3288 mystring::mystring(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
3289 @{
3290     n.find_string("string", str);
3291 @}
3292 @end example
3293
3294 If you don't need archiving, just leave this function empty (but you must
3295 invoke the unarchiving constructor of the superclass). Note that we don't
3296 have to set the @code{tinfo_key} here because it is done automatically
3297 by the unarchiving constructor of the @code{basic} class.
3298
3299 Finally, the unarchiving function:
3300
3301 @example
3302 ex mystring::unarchive(const archive_node &n, const lst &sym_lst)
3303 @{
3304     return (new mystring(n, sym_lst))->setflag(status_flags::dynallocated);
3305 @}
3306 @end example
3307
3308 You don't have to understand how exactly this works. Just copy these four
3309 lines into your code literally (replacing the class name, of course). It
3310 calls the unarchiving constructor of the class and unless you are doing
3311 something very special (like matching @code{archive_node}s to global
3312 objects) you don't need a different implementation. For those who are
3313 interested: setting the @code{dynallocated} flag puts the object under
3314 the control of GiNaC's garbage collection. It will get deleted automatically
3315 once it is no longer referenced.
3316
3317 Our @code{compare_same_type()} function uses a provided function to compare
3318 the string members:
3319
3320 @example
3321 int mystring::compare_same_type(const basic &other) const
3322 @{
3323     const mystring &o = static_cast<const mystring &>(other);
3324     int cmpval = str.compare(o.str);
3325     if (cmpval == 0)
3326         return 0;
3327     else if (cmpval < 0)
3328         return -1;
3329     else
3330         return 1;
3331 @}
3332 @end example
3333
3334 Although this function takes a @code{basic &}, it will always be a reference
3335 to an object of exactly the same class (objects of different classes are not
3336 comparable), so the cast is safe. If this function returns 0, the two objects
3337 are considered equal (in the sense that @math{A-B=0}), so you should compare
3338 all relevant member variables.
3339
3340 Now the only thing missing is our two new constructors:
3341
3342 @example
3343 mystring::mystring(const string &s) : inherited(TINFO_mystring), str(s)
3344 @{
3345     // dynamically allocate resources here if required
3346 @}
3347
3348 mystring::mystring(const char *s) : inherited(TINFO_mystring), str(s)
3349 @{
3350     // dynamically allocate resources here if required
3351 @}
3352 @end example
3353
3354 No surprises here. We set the @code{str} member from the argument and
3355 remember to pass the right @code{tinfo_key} to the @code{basic} constructor.
3356
3357 That's it! We now have a minimal working GiNaC class that can store
3358 strings in algebraic expressions. Let's confirm that the RTTI works:
3359
3360 @example
3361 ex e = mystring("Hello, world!");
3362 cout << is_ex_of_type(e, mystring) << endl;
3363  // -> 1 (true)
3364
3365 cout << e.bp->class_name() << endl;
3366  // -> mystring
3367 @end example
3368
3369 Obviously it does. Let's see what the expression @code{e} looks like:
3370
3371 @example
3372 cout << e << endl;
3373  // -> [mystring object]
3374 @end example
3375
3376 Hm, not exactly what we expect, but of course the @code{mystring} class
3377 doesn't yet know how to print itself. This is done in the @code{print()}
3378 member function. Let's say that we wanted to print the string surrounded
3379 by double quotes:
3380
3381 @example
3382 class mystring : public basic
3383 @{
3384     ...
3385 public:
3386     void print(ostream &os, unsigned upper_precedence) const;
3387     ...
3388 @};
3389
3390 void mystring::print(ostream &os, unsigned upper_precedence) const
3391 @{
3392     os << '\"' << str << '\"';
3393 @}
3394 @end example
3395
3396 The @code{upper_precedence} argument is only required for container classes
3397 to correctly parenthesize the output. Let's try again to print the expression:
3398
3399 @example
3400 cout << e << endl;
3401  // -> "Hello, world!"
3402 @end example
3403
3404 Much better. The @code{mystring} class can be used in arbitrary expressions:
3405
3406 @example
3407 e += mystring("GiNaC rulez"); 
3408 cout << e << endl;
3409  // -> "GiNaC rulez"+"Hello, world!"
3410 @end example
3411
3412 (note that GiNaC's automatic term reordering is in effect here), or even
3413
3414 @example
3415 e = pow(mystring("One string"), 2*sin(Pi-mystring("Another string")));
3416 cout << e << endl;
3417  // -> "One string"^(2*sin(-"Another string"+Pi))
3418 @end example
3419
3420 Whether this makes sense is debatable but remember that this is only an
3421 example. At least it allows you to implement your own symbolic algorithms
3422 for your objects.
3423
3424 Note that GiNaC's algebraic rules remain unchanged:
3425
3426 @example
3427 e = mystring("Wow") * mystring("Wow");
3428 cout << e << endl;
3429  // -> "Wow"^2
3430
3431 e = pow(mystring("First")-mystring("Second"), 2);
3432 cout << e.expand() << endl;
3433  // -> -2*"First"*"Second"+"First"^2+"Second"^2
3434 @end example
3435
3436 There's no way to, for example, make GiNaC's @code{add} class perform string
3437 concatenation. You would have to implement this yourself.
3438
3439 @subsection Automatic evaluation
3440
3441 @cindex @code{hold()}
3442 @cindex evaluation
3443 When dealing with objects that are just a little more complicated than the
3444 simple string objects we have implemented, chances are that you will want to
3445 have some automatic simplifications or canonicalizations performed on them.
3446 This is done in the evaluation member function @code{eval()}. Let's say that
3447 we wanted all strings automatically converted to lowercase with
3448 non-alphabetic characters stripped, and empty strings removed:
3449
3450 @example
3451 class mystring : public basic
3452 @{
3453     ...
3454 public:
3455     ex eval(int level = 0) const;
3456     ...
3457 @};
3458
3459 ex mystring::eval(int level) const
3460 @{
3461     string new_str;
3462     for (int i=0; i<str.length(); i++) @{
3463         char c = str[i];
3464         if (c >= 'A' && c <= 'Z') 
3465             new_str += tolower(c);
3466         else if (c >= 'a' && c <= 'z')
3467             new_str += c;
3468     @}
3469
3470     if (new_str.length() == 0)
3471         return _ex0();
3472     else
3473         return mystring(new_str).hold();
3474 @}
3475 @end example
3476
3477 The @code{level} argument is used to limit the recursion depth of the
3478 evaluation. We don't have any subexpressions in the @code{mystring} class
3479 so we are not concerned with this. If we had, we would call the @code{eval()}
3480 functions of the subexpressions with @code{level - 1} as the argument if
3481 @code{level != 1}. The @code{hold()} member function sets a flag in the
3482 object that prevents further evaluation. Otherwise we might end up in an
3483 endless loop. When you want to return the object unmodified, use
3484 @code{return this->hold();}.
3485
3486 Let's confirm that it works:
3487
3488 @example
3489 ex e = mystring("Hello, world!") + mystring("!?#");
3490 cout << e << endl;
3491  // -> "helloworld"
3492
3493 e = mystring("Wow!") + mystring("WOW") + mystring(" W ** o ** W");  
3494 cout << e << endl;
3495  // -> 3*"wow"
3496 @end example
3497
3498 @subsection Other member functions
3499
3500 We have implemented only a small set of member functions to make the class
3501 work in the GiNaC framework. For a real algebraic class, there are probably
3502 some more functions that you will want to re-implement, such as
3503 @code{evalf()}, @code{series()} or @code{op()}. Have a look at @file{basic.h}
3504 or the header file of the class you want to make a subclass of to see
3505 what's there. You can, of course, also add your own new member functions.
3506 In this case you will probably want to define a little helper function like
3507
3508 @example
3509 inline const mystring &ex_to_mystring(const ex &e)
3510 @{
3511     return static_cast<const mystring &>(*e.bp);
3512 @}
3513 @end example
3514
3515 that let's you get at the object inside an expression (after you have verified
3516 that the type is correct) so you can call member functions that are specific
3517 to the class.
3518
3519 That's it. May the source be with you!
3520
3521
3522 @node A Comparison With Other CAS, Advantages, Adding classes, Top
3523 @c    node-name, next, previous, up
3524 @chapter A Comparison With Other CAS
3525 @cindex advocacy
3526
3527 This chapter will give you some information on how GiNaC compares to
3528 other, traditional Computer Algebra Systems, like @emph{Maple},
3529 @emph{Mathematica} or @emph{Reduce}, where it has advantages and
3530 disadvantages over these systems.
3531
3532 @menu
3533 * Advantages::                       Stengths of the GiNaC approach.
3534 * Disadvantages::                    Weaknesses of the GiNaC approach.
3535 * Why C++?::                         Attractiveness of C++.
3536 @end menu
3537
3538 @node Advantages, Disadvantages, A Comparison With Other CAS, A Comparison With Other CAS
3539 @c    node-name, next, previous, up
3540 @section Advantages
3541
3542 GiNaC has several advantages over traditional Computer
3543 Algebra Systems, like 
3544
3545 @itemize @bullet
3546
3547 @item
3548 familiar language: all common CAS implement their own proprietary
3549 grammar which you have to learn first (and maybe learn again when your
3550 vendor decides to `enhance' it).  With GiNaC you can write your program
3551 in common C++, which is standardized.
3552
3553 @cindex STL
3554 @item
3555 structured data types: you can build up structured data types using
3556 @code{struct}s or @code{class}es together with STL features instead of
3557 using unnamed lists of lists of lists.
3558
3559 @item
3560 strongly typed: in CAS, you usually have only one kind of variables
3561 which can hold contents of an arbitrary type.  This 4GL like feature is
3562 nice for novice programmers, but dangerous.
3563     
3564 @item
3565 development tools: powerful development tools exist for C++, like fancy
3566 editors (e.g. with automatic indentation and syntax highlighting),
3567 debuggers, visualization tools, documentation generators...
3568
3569 @item
3570 modularization: C++ programs can easily be split into modules by
3571 separating interface and implementation.
3572
3573 @item
3574 price: GiNaC is distributed under the GNU Public License which means
3575 that it is free and available with source code.  And there are excellent
3576 C++-compilers for free, too.
3577     
3578 @item
3579 extendable: you can add your own classes to GiNaC, thus extending it on
3580 a very low level.  Compare this to a traditional CAS that you can
3581 usually only extend on a high level by writing in the language defined
3582 by the parser.  In particular, it turns out to be almost impossible to
3583 fix bugs in a traditional system.
3584
3585 @item
3586 multiple interfaces: Though real GiNaC programs have to be written in
3587 some editor, then be compiled, linked and executed, there are more ways
3588 to work with the GiNaC engine.  Many people want to play with
3589 expressions interactively, as in traditional CASs.  Currently, two such
3590 windows into GiNaC have been implemented and many more are possible: the
3591 tiny @command{ginsh} that is part of the distribution exposes GiNaC's
3592 types to a command line and second, as a more consistent approach, an
3593 interactive interface to the @acronym{Cint} C++ interpreter has been put
3594 together (called @acronym{GiNaC-cint}) that allows an interactive
3595 scripting interface consistent with the C++ language.
3596
3597 @item
3598 seemless integration: it is somewhere between difficult and impossible
3599 to call CAS functions from within a program written in C++ or any other
3600 programming language and vice versa.  With GiNaC, your symbolic routines
3601 are part of your program.  You can easily call third party libraries,
3602 e.g. for numerical evaluation or graphical interaction.  All other
3603 approaches are much more cumbersome: they range from simply ignoring the
3604 problem (i.e. @emph{Maple}) to providing a method for `embedding' the
3605 system (i.e. @emph{Yacas}).
3606
3607 @item
3608 efficiency: often large parts of a program do not need symbolic
3609 calculations at all.  Why use large integers for loop variables or
3610 arbitrary precision arithmetics where @code{int} and @code{double} are
3611 sufficient?  For pure symbolic applications, GiNaC is comparable in
3612 speed with other CAS.
3613
3614 @end itemize
3615
3616
3617 @node Disadvantages, Why C++?, Advantages, A Comparison With Other CAS
3618 @c    node-name, next, previous, up
3619 @section Disadvantages
3620
3621 Of course it also has some disadvantages:
3622
3623 @itemize @bullet
3624
3625 @item
3626 advanced features: GiNaC cannot compete with a program like
3627 @emph{Reduce} which exists for more than 30 years now or @emph{Maple}
3628 which grows since 1981 by the work of dozens of programmers, with
3629 respect to mathematical features.  Integration, factorization,
3630 non-trivial simplifications, limits etc. are missing in GiNaC (and are
3631 not planned for the near future).
3632
3633 @item
3634 portability: While the GiNaC library itself is designed to avoid any
3635 platform dependent features (it should compile on any ANSI compliant C++
3636 compiler), the currently used version of the CLN library (fast large
3637 integer and arbitrary precision arithmetics) can be compiled only on
3638 systems with a recently new C++ compiler from the GNU Compiler
3639 Collection (@acronym{GCC}).@footnote{This is because CLN uses
3640 PROVIDE/REQUIRE like macros to let the compiler gather all static
3641 initializations, which works for GNU C++ only.}  GiNaC uses recent
3642 language features like explicit constructors, mutable members, RTTI,
3643 @code{dynamic_cast}s and STL, so ANSI compliance is meant literally.
3644 Recent @acronym{GCC} versions starting at 2.95, although itself not yet
3645 ANSI compliant, support all needed features.
3646     
3647 @end itemize
3648
3649
3650 @node Why C++?, Internal Structures, Disadvantages, A Comparison With Other CAS
3651 @c    node-name, next, previous, up
3652 @section Why C++?
3653
3654 Why did we choose to implement GiNaC in C++ instead of Java or any other
3655 language?  C++ is not perfect: type checking is not strict (casting is
3656 possible), separation between interface and implementation is not
3657 complete, object oriented design is not enforced.  The main reason is
3658 the often scolded feature of operator overloading in C++.  While it may
3659 be true that operating on classes with a @code{+} operator is rarely
3660 meaningful, it is perfectly suited for algebraic expressions.  Writing
3661 @math{3x+5y} as @code{3*x+5*y} instead of
3662 @code{x.times(3).plus(y.times(5))} looks much more natural.
3663 Furthermore, the main developers are more familiar with C++ than with
3664 any other programming language.
3665
3666
3667 @node Internal Structures, Expressions are reference counted, Why C++? , Top
3668 @c    node-name, next, previous, up
3669 @appendix Internal Structures
3670
3671 @menu
3672 * Expressions are reference counted::
3673 * Internal representation of products and sums::
3674 @end menu
3675
3676 @node Expressions are reference counted, Internal representation of products and sums, Internal Structures, Internal Structures
3677 @c    node-name, next, previous, up
3678 @appendixsection Expressions are reference counted
3679
3680 @cindex reference counting
3681 @cindex copy-on-write
3682 @cindex garbage collection
3683 An expression is extremely light-weight since internally it works like a
3684 handle to the actual representation and really holds nothing more than a
3685 pointer to some other object. What this means in practice is that
3686 whenever you create two @code{ex} and set the second equal to the first
3687 no copying process is involved. Instead, the copying takes place as soon
3688 as you try to change the second.  Consider the simple sequence of code:
3689
3690 @example
3691 #include <ginac/ginac.h>
3692 using namespace std;
3693 using namespace GiNaC;
3694
3695 int main()
3696 @{
3697     symbol x("x"), y("y"), z("z");
3698     ex e1, e2;
3699
3700     e1 = sin(x + 2*y) + 3*z + 41;
3701     e2 = e1;                // e2 points to same object as e1
3702     cout << e2 << endl;     // prints sin(x+2*y)+3*z+41
3703     e2 += 1;                // e2 is copied into a new object
3704     cout << e2 << endl;     // prints sin(x+2*y)+3*z+42
3705 @}
3706 @end example
3707
3708 The line @code{e2 = e1;} creates a second expression pointing to the
3709 object held already by @code{e1}.  The time involved for this operation
3710 is therefore constant, no matter how large @code{e1} was.  Actual
3711 copying, however, must take place in the line @code{e2 += 1;} because
3712 @code{e1} and @code{e2} are not handles for the same object any more.
3713 This concept is called @dfn{copy-on-write semantics}.  It increases
3714 performance considerably whenever one object occurs multiple times and
3715 represents a simple garbage collection scheme because when an @code{ex}
3716 runs out of scope its destructor checks whether other expressions handle
3717 the object it points to too and deletes the object from memory if that
3718 turns out not to be the case.  A slightly less trivial example of
3719 differentiation using the chain-rule should make clear how powerful this
3720 can be:
3721
3722 @example
3723 #include <ginac/ginac.h>
3724 using namespace std;
3725 using namespace GiNaC;
3726
3727 int main()
3728 @{
3729     symbol x("x"), y("y");
3730
3731     ex e1 = x + 3*y;
3732     ex e2 = pow(e1, 3);
3733     ex e3 = diff(sin(e2), x);   // first derivative of sin(e2) by x
3734     cout << e1 << endl          // prints x+3*y
3735          << e2 << endl          // prints (x+3*y)^3
3736          << e3 << endl;         // prints 3*(x+3*y)^2*cos((x+3*y)^3)
3737 @}
3738 @end example
3739
3740 Here, @code{e1} will actually be referenced three times while @code{e2}
3741 will be referenced two times.  When the power of an expression is built,
3742 that expression needs not be copied.  Likewise, since the derivative of
3743 a power of an expression can be easily expressed in terms of that
3744 expression, no copying of @code{e1} is involved when @code{e3} is
3745 constructed.  So, when @code{e3} is constructed it will print as
3746 @code{3*(x+3*y)^2*cos((x+3*y)^3)} but the argument of @code{cos()} only
3747 holds a reference to @code{e2} and the factor in front is just
3748 @code{3*e1^2}.
3749
3750 As a user of GiNaC, you cannot see this mechanism of copy-on-write
3751 semantics.  When you insert an expression into a second expression, the
3752 result behaves exactly as if the contents of the first expression were
3753 inserted.  But it may be useful to remember that this is not what
3754 happens.  Knowing this will enable you to write much more efficient
3755 code.  If you still have an uncertain feeling with copy-on-write
3756 semantics, we recommend you have a look at the
3757 @uref{http://www.cerfnet.com/~mpcline/c++-faq-lite/, C++-FAQ lite} by
3758 Marshall Cline.  Chapter 16 covers this issue and presents an
3759 implementation which is pretty close to the one in GiNaC.
3760
3761
3762 @node Internal representation of products and sums, Package Tools, Expressions are reference counted, Internal Structures
3763 @c    node-name, next, previous, up
3764 @appendixsection Internal representation of products and sums
3765
3766 @cindex representation
3767 @cindex @code{add}
3768 @cindex @code{mul}
3769 @cindex @code{power}
3770 Although it should be completely transparent for the user of
3771 GiNaC a short discussion of this topic helps to understand the sources
3772 and also explain performance to a large degree.  Consider the 
3773 unexpanded symbolic expression 
3774 @tex
3775 $2d^3 \left( 4a + 5b - 3 \right)$
3776 @end tex
3777 @ifnottex
3778 @math{2*d^3*(4*a+5*b-3)}
3779 @end ifnottex
3780 which could naively be represented by a tree of linear containers for
3781 addition and multiplication, one container for exponentiation with base
3782 and exponent and some atomic leaves of symbols and numbers in this
3783 fashion:
3784
3785 @image{repnaive}
3786
3787 @cindex pair-wise representation
3788 However, doing so results in a rather deeply nested tree which will
3789 quickly become inefficient to manipulate.  We can improve on this by
3790 representing the sum as a sequence of terms, each one being a pair of a
3791 purely numeric multiplicative coefficient and its rest.  In the same
3792 spirit we can store the multiplication as a sequence of terms, each
3793 having a numeric exponent and a possibly complicated base, the tree
3794 becomes much more flat:
3795
3796 @image{reppair}
3797
3798 The number @code{3} above the symbol @code{d} shows that @code{mul}
3799 objects are treated similarly where the coefficients are interpreted as
3800 @emph{exponents} now.  Addition of sums of terms or multiplication of
3801 products with numerical exponents can be coded to be very efficient with
3802 such a pair-wise representation.  Internally, this handling is performed
3803 by most CAS in this way.  It typically speeds up manipulations by an
3804 order of magnitude.  The overall multiplicative factor @code{2} and the
3805 additive term @code{-3} look somewhat out of place in this
3806 representation, however, since they are still carrying a trivial
3807 exponent and multiplicative factor @code{1} respectively.  Within GiNaC,
3808 this is avoided by adding a field that carries an overall numeric
3809 coefficient.  This results in the realistic picture of internal
3810 representation for
3811 @tex
3812 $2d^3 \left( 4a + 5b - 3 \right)$:
3813 @end tex
3814 @ifnottex
3815 @math{2*d^3*(4*a+5*b-3)}:
3816 @end ifnottex
3817
3818 @image{repreal}
3819
3820 @cindex radical
3821 This also allows for a better handling of numeric radicals, since
3822 @code{sqrt(2)} can now be carried along calculations.  Now it should be
3823 clear, why both classes @code{add} and @code{mul} are derived from the
3824 same abstract class: the data representation is the same, only the
3825 semantics differs.  In the class hierarchy, methods for polynomial
3826 expansion and the like are reimplemented for @code{add} and @code{mul},
3827 but the data structure is inherited from @code{expairseq}.
3828
3829
3830 @node Package Tools, ginac-config, Internal representation of products and sums, Top
3831 @c    node-name, next, previous, up
3832 @appendix Package Tools
3833
3834 If you are creating a software package that uses the GiNaC library,
3835 setting the correct command line options for the compiler and linker
3836 can be difficult. GiNaC includes two tools to make this process easier.
3837
3838 @menu
3839 * ginac-config::   A shell script to detect compiler and linker flags.
3840 * AM_PATH_GINAC::  Macro for GNU automake.
3841 @end menu
3842
3843
3844 @node ginac-config, AM_PATH_GINAC, Package Tools, Package Tools
3845 @c    node-name, next, previous, up
3846 @section @command{ginac-config}
3847 @cindex ginac-config
3848
3849 @command{ginac-config} is a shell script that you can use to determine
3850 the compiler and linker command line options required to compile and
3851 link a program with the GiNaC library.
3852
3853 @command{ginac-config} takes the following flags:
3854
3855 @table @samp
3856 @item --version
3857 Prints out the version of GiNaC installed.
3858 @item --cppflags
3859 Prints '-I' flags pointing to the installed header files.
3860 @item --libs
3861 Prints out the linker flags necessary to link a program against GiNaC.
3862 @item --prefix[=@var{PREFIX}]
3863 If @var{PREFIX} is specified, overrides the configured value of @env{$prefix}.
3864 (And of exec-prefix, unless @code{--exec-prefix} is also specified)
3865 Otherwise, prints out the configured value of @env{$prefix}.
3866 @item --exec-prefix[=@var{PREFIX}]
3867 If @var{PREFIX} is specified, overrides the configured value of @env{$exec_prefix}.
3868 Otherwise, prints out the configured value of @env{$exec_prefix}.
3869 @end table
3870
3871 Typically, @command{ginac-config} will be used within a configure
3872 script, as described below. It, however, can also be used directly from
3873 the command line using backquotes to compile a simple program. For
3874 example:
3875
3876 @example
3877 c++ -o simple `ginac-config --cppflags` simple.cpp `ginac-config --libs`
3878 @end example
3879
3880 This command line might expand to (for example):
3881
3882 @example
3883 cc -o simple -I/usr/local/include simple.cpp -L/usr/local/lib \
3884   -lginac -lcln -lstdc++
3885 @end example
3886
3887 Not only is the form using @command{ginac-config} easier to type, it will
3888 work on any system, no matter how GiNaC was configured.
3889
3890
3891 @node AM_PATH_GINAC, Configure script options, ginac-config, Package Tools
3892 @c    node-name, next, previous, up
3893 @section @samp{AM_PATH_GINAC}
3894 @cindex AM_PATH_GINAC
3895
3896 For packages configured using GNU automake, GiNaC also provides
3897 a macro to automate the process of checking for GiNaC.
3898
3899 @example
3900 AM_PATH_GINAC([@var{MINIMUM-VERSION}, [@var{ACTION-IF-FOUND} [, @var{ACTION-IF-NOT-FOUND}]]])
3901 @end example
3902
3903 This macro:
3904
3905 @itemize @bullet
3906
3907 @item
3908 Determines the location of GiNaC using @command{ginac-config}, which is
3909 either found in the user's path, or from the environment variable
3910 @env{GINACLIB_CONFIG}.
3911
3912 @item
3913 Tests the installed libraries to make sure that their version
3914 is later than @var{MINIMUM-VERSION}. (A default version will be used
3915 if not specified)
3916
3917 @item
3918 If the required version was found, sets the @env{GINACLIB_CPPFLAGS} variable
3919 to the output of @command{ginac-config --cppflags} and the @env{GINACLIB_LIBS}
3920 variable to the output of @command{ginac-config --libs}, and calls
3921 @samp{AC_SUBST()} for these variables so they can be used in generated
3922 makefiles, and then executes @var{ACTION-IF-FOUND}.
3923
3924 @item
3925 If the required version was not found, sets @env{GINACLIB_CPPFLAGS} and
3926 @env{GINACLIB_LIBS} to empty strings, and executes @var{ACTION-IF-NOT-FOUND}.
3927
3928 @end itemize
3929
3930 This macro is in file @file{ginac.m4} which is installed in
3931 @file{$datadir/aclocal}. Note that if automake was installed with a
3932 different @samp{--prefix} than GiNaC, you will either have to manually
3933 move @file{ginac.m4} to automake's @file{$datadir/aclocal}, or give
3934 aclocal the @samp{-I} option when running it.
3935
3936 @menu
3937 * Configure script options::  Configuring a package that uses AM_PATH_GINAC.
3938 * Example package::           Example of a package using AM_PATH_GINAC.
3939 @end menu
3940
3941
3942 @node Configure script options, Example package, AM_PATH_GINAC, AM_PATH_GINAC
3943 @c    node-name, next, previous, up
3944 @subsection Configuring a package that uses @samp{AM_PATH_GINAC}
3945
3946 Simply make sure that @command{ginac-config} is in your path, and run
3947 the configure script.
3948
3949 Notes:
3950
3951 @itemize @bullet
3952
3953 @item
3954 The directory where the GiNaC libraries are installed needs
3955 to be found by your system's dynamic linker.
3956   
3957 This is generally done by
3958
3959 @display
3960 editing @file{/etc/ld.so.conf} and running @command{ldconfig}
3961 @end display
3962
3963 or by
3964    
3965 @display
3966 setting the environment variable @env{LD_LIBRARY_PATH},
3967 @end display
3968
3969 or, as a last resort, 
3970  
3971 @display
3972 giving a @samp{-R} or @samp{-rpath} flag (depending on your linker) when
3973 running configure, for instance:
3974
3975 @example
3976 LDFLAGS=-R/home/cbauer/lib ./configure
3977 @end example
3978 @end display
3979
3980 @item
3981 You can also specify a @command{ginac-config} not in your path by
3982 setting the @env{GINACLIB_CONFIG} environment variable to the
3983 name of the executable
3984
3985 @item
3986 If you move the GiNaC package from its installed location,
3987 you will either need to modify @command{ginac-config} script
3988 manually to point to the new location or rebuild GiNaC.
3989
3990 @end itemize
3991
3992 Advanced note:
3993
3994 @itemize @bullet
3995 @item
3996 configure flags
3997   
3998 @example
3999 --with-ginac-prefix=@var{PREFIX}
4000 --with-ginac-exec-prefix=@var{PREFIX}
4001 @end example
4002
4003 are provided to override the prefix and exec-prefix that were stored
4004 in the @command{ginac-config} shell script by GiNaC's configure. You are
4005 generally better off configuring GiNaC with the right path to begin with.
4006 @end itemize
4007
4008
4009 @node Example package, Bibliography, Configure script options, AM_PATH_GINAC
4010 @c    node-name, next, previous, up
4011 @subsection Example of a package using @samp{AM_PATH_GINAC}
4012
4013 The following shows how to build a simple package using automake
4014 and the @samp{AM_PATH_GINAC} macro. The program used here is @file{simple.cpp}:
4015
4016 @example
4017 #include <ginac/ginac.h>
4018
4019 int main(void)
4020 @{
4021     GiNaC::symbol x("x");
4022     GiNaC::ex a = GiNaC::sin(x);
4023     std::cout << "Derivative of " << a 
4024               << " is " << a.diff(x) << std::endl;
4025     return 0;
4026 @}
4027 @end example
4028
4029 You should first read the introductory portions of the automake
4030 Manual, if you are not already familiar with it.
4031
4032 Two files are needed, @file{configure.in}, which is used to build the
4033 configure script:
4034
4035 @example
4036 dnl Process this file with autoconf to produce a configure script.
4037 AC_INIT(simple.cpp)
4038 AM_INIT_AUTOMAKE(simple.cpp, 1.0.0)
4039
4040 AC_PROG_CXX
4041 AC_PROG_INSTALL
4042 AC_LANG_CPLUSPLUS
4043
4044 AM_PATH_GINAC(0.7.0, [
4045   LIBS="$LIBS $GINACLIB_LIBS"
4046   CPPFLAGS="$CPPFLAGS $GINACLIB_CPPFLAGS"  
4047 ], AC_MSG_ERROR([need to have GiNaC installed]))
4048
4049 AC_OUTPUT(Makefile)
4050 @end example
4051
4052 The only command in this which is not standard for automake
4053 is the @samp{AM_PATH_GINAC} macro.
4054
4055 That command does the following: If a GiNaC version greater or equal
4056 than 0.7.0 is found, then it adds @env{$GINACLIB_LIBS} to @env{$LIBS}
4057 and @env{$GINACLIB_CPPFLAGS} to @env{$CPPFLAGS}. Otherwise, it dies with
4058 the error message `need to have GiNaC installed'
4059
4060 And the @file{Makefile.am}, which will be used to build the Makefile.
4061
4062 @example
4063 ## Process this file with automake to produce Makefile.in
4064 bin_PROGRAMS = simple
4065 simple_SOURCES = simple.cpp
4066 @end example
4067
4068 This @file{Makefile.am}, says that we are building a single executable,
4069 from a single sourcefile @file{simple.cpp}. Since every program
4070 we are building uses GiNaC we simply added the GiNaC options
4071 to @env{$LIBS} and @env{$CPPFLAGS}, but in other circumstances, we might
4072 want to specify them on a per-program basis: for instance by
4073 adding the lines:
4074
4075 @example
4076 simple_LDADD = $(GINACLIB_LIBS)
4077 INCLUDES = $(GINACLIB_CPPFLAGS)
4078 @end example
4079
4080 to the @file{Makefile.am}.
4081
4082 To try this example out, create a new directory and add the three
4083 files above to it.
4084
4085 Now execute the following commands:
4086
4087 @example
4088 $ automake --add-missing
4089 $ aclocal
4090 $ autoconf
4091 @end example
4092
4093 You now have a package that can be built in the normal fashion
4094
4095 @example
4096 $ ./configure
4097 $ make
4098 $ make install
4099 @end example
4100
4101
4102 @node Bibliography, Concept Index, Example package, Top
4103 @c    node-name, next, previous, up
4104 @appendix Bibliography
4105
4106 @itemize @minus{}
4107
4108 @item
4109 @cite{ISO/IEC 14882:1998: Programming Languages: C++}
4110
4111 @item
4112 @cite{CLN: A Class Library for Numbers}, @email{haible@@ilog.fr, Bruno Haible}
4113
4114 @item
4115 @cite{The C++ Programming Language}, Bjarne Stroustrup, 3rd Edition, ISBN 0-201-88954-4, Addison Wesley
4116
4117 @item
4118 @cite{C++ FAQs}, Marshall Cline, ISBN 0-201-58958-3, 1995, Addison Wesley
4119
4120 @item
4121 @cite{Algorithms for Computer Algebra}, Keith O. Geddes, Stephen R. Czapor,
4122 and George Labahn, ISBN 0-7923-9259-0, 1992, Kluwer Academic Publishers, Norwell, Massachusetts
4123
4124 @item
4125 @cite{Computer Algebra: Systems and Algorithms for Algebraic Computation},
4126 J.H. Davenport, Y. Siret, and E. Tournier, ISBN 0-12-204230-1, 1988, 
4127 Academic Press, London
4128
4129 @end itemize
4130
4131
4132 @node Concept Index, , Bibliography, Top
4133 @c    node-name, next, previous, up
4134 @unnumbered Concept Index
4135
4136 @printindex cp
4137
4138 @bye