archive property example uses propinfovector
[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 Expressions},
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 Expressions}).
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 Expressions::
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 Expressions, 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 Expressions, Polynomial Arithmetic, Information About Expressions, Methods and Functions
2014 @c    node-name, next, previous, up
2015 @section Substituting expressions
2016 @cindex @code{subs()}
2017
2018 Algebraic objects inside expressions can be replaced with arbitrary
2019 expressions via the @code{.subs()} method:
2020
2021 @example
2022 ex ex::subs(const ex & e);
2023 ex ex::subs(const lst & syms, const lst & repls);
2024 @end example
2025
2026 In the first form, @code{subs()} accepts a relational of the form
2027 @samp{object == expression} or a @code{lst} of such relationals:
2028
2029 @example
2030 @{
2031     symbol x("x"), y("y");
2032
2033     ex e1 = 2*x^2-4*x+3;
2034     cout << "e1(7) = " << e1.subs(x == 7) << endl;
2035      // -> 73
2036
2037     ex e2 = x*y + x;
2038     cout << "e2(-2, 4) = " << e2.subs(lst(x == -2, y == 4)) << endl;
2039      // -> -10
2040 @}
2041 @end example
2042
2043 @code{subs()} performs syntactic substitution of any complete algebraic
2044 object; it does not try to match sub-expressions as is demonstrated by the
2045 following example:
2046
2047 @example
2048 @{
2049     symbol x("x"), y("y"), z("z");
2050
2051     ex e1 = pow(x+y, 2);
2052     cout << e1.subs(x+y == 4) << endl;
2053      // -> 16
2054
2055     ex e2 = sin(x)*cos(x);
2056     cout << e2.subs(sin(x) == cos(x)) << endl;
2057      // -> cos(x)^2
2058
2059     ex e3 = x+y+z;
2060     cout << e3.subs(x+y == 4) << endl;
2061      // -> x+y+z
2062      // (and not 4+z as one might expect)
2063 @}
2064 @end example
2065
2066 If you specify multiple substitutions, they are performed in parallel, so e.g.
2067 @code{subs(lst(x == y, y == x))} exchanges @samp{x} and @samp{y}.
2068
2069 The second form of @code{subs()} takes two lists, one for the objects to be
2070 replaced and one for the expressions to be substituted (both lists must
2071 contain the same number of elements). Using this form, you would write
2072 @code{subs(lst(x, y), lst(y, x))} to exchange @samp{x} and @samp{y}.
2073
2074
2075 @node Polynomial Arithmetic, Rational Expressions, Substituting Expressions, Methods and Functions
2076 @c    node-name, next, previous, up
2077 @section Polynomial arithmetic
2078
2079 @subsection Expanding and collecting
2080 @cindex @code{expand()}
2081 @cindex @code{collect()}
2082
2083 A polynomial in one or more variables has many equivalent
2084 representations.  Some useful ones serve a specific purpose.  Consider
2085 for example the trivariate polynomial @math{4*x*y + x*z + 20*y^2 +
2086 21*y*z + 4*z^2} (written down here in output-style).  It is equivalent
2087 to the factorized polynomial @math{(x + 5*y + 4*z)*(4*y + z)}.  Other
2088 representations are the recursive ones where one collects for exponents
2089 in one of the three variable.  Since the factors are themselves
2090 polynomials in the remaining two variables the procedure can be
2091 repeated.  In our expample, two possibilities would be @math{(4*y + z)*x
2092 + 20*y^2 + 21*y*z + 4*z^2} and @math{20*y^2 + (21*z + 4*x)*y + 4*z^2 +
2093 x*z}.
2094
2095 To bring an expression into expanded form, its method
2096
2097 @example
2098 ex ex::expand();
2099 @end example
2100
2101 may be called.  In our example above, this corresponds to @math{4*x*y +
2102 x*z + 20*y^2 + 21*y*z + 4*z^2}.  Again, since the canonical form in
2103 GiNaC is not easily guessable you should be prepared to see different
2104 orderings of terms in such sums!
2105
2106 Another useful representation of multivariate polynomials is as a
2107 univariate polynomial in one of the variables with the coefficients
2108 being polynomials in the remaining variables.  The method
2109 @code{collect()} accomplishes this task:
2110
2111 @example
2112 ex ex::collect(const ex & s);
2113 @end example
2114
2115 Note that the original polynomial needs to be in expanded form in order
2116 to be able to find the coefficients properly.
2117
2118 @subsection Degree and coefficients
2119 @cindex @code{degree()}
2120 @cindex @code{ldegree()}
2121 @cindex @code{coeff()}
2122
2123 The degree and low degree of a polynomial can be obtained using the two
2124 methods
2125
2126 @example
2127 int ex::degree(const ex & s);
2128 int ex::ldegree(const ex & s);
2129 @end example
2130
2131 which also work reliably on non-expanded input polynomials (they even work
2132 on rational functions, returning the asymptotic degree). To extract
2133 a coefficient with a certain power from an expanded polynomial you use
2134
2135 @example
2136 ex ex::coeff(const ex & s, int n);
2137 @end example
2138
2139 You can also obtain the leading and trailing coefficients with the methods
2140
2141 @example
2142 ex ex::lcoeff(const ex & s);
2143 ex ex::tcoeff(const ex & s);
2144 @end example
2145
2146 which are equivalent to @code{coeff(s, degree(s))} and @code{coeff(s, ldegree(s))},
2147 respectively.
2148
2149 An application is illustrated in the next example, where a multivariate
2150 polynomial is analyzed:
2151
2152 @example
2153 #include <ginac/ginac.h>
2154 using namespace std;
2155 using namespace GiNaC;
2156
2157 int main()
2158 @{
2159     symbol x("x"), y("y");
2160     ex PolyInp = 4*pow(x,3)*y + 5*x*pow(y,2) + 3*y
2161                  - pow(x+y,2) + 2*pow(y+2,2) - 8;
2162     ex Poly = PolyInp.expand();
2163     
2164     for (int i=Poly.ldegree(x); i<=Poly.degree(x); ++i) @{
2165         cout << "The x^" << i << "-coefficient is "
2166              << Poly.coeff(x,i) << endl;
2167     @}
2168     cout << "As polynomial in y: " 
2169          << Poly.collect(y) << endl;
2170 @}
2171 @end example
2172
2173 When run, it returns an output in the following fashion:
2174
2175 @example
2176 The x^0-coefficient is y^2+11*y
2177 The x^1-coefficient is 5*y^2-2*y
2178 The x^2-coefficient is -1
2179 The x^3-coefficient is 4*y
2180 As polynomial in y: -x^2+(5*x+1)*y^2+(-2*x+4*x^3+11)*y
2181 @end example
2182
2183 As always, the exact output may vary between different versions of GiNaC
2184 or even from run to run since the internal canonical ordering is not
2185 within the user's sphere of influence.
2186
2187 @code{degree()}, @code{ldegree()}, @code{coeff()}, @code{lcoeff()},
2188 @code{tcoeff()} and @code{collect()} can also be used to a certain degree
2189 with non-polynomial expressions as they not only work with symbols but with
2190 constants, functions and indexed objects as well:
2191
2192 @example
2193 @{
2194     symbol a("a"), b("b"), c("c");
2195     idx i(symbol("i"), 3);
2196
2197     ex e = pow(sin(x) - cos(x), 4);
2198     cout << e.degree(cos(x)) << endl;
2199      // -> 4
2200     cout << e.expand().coeff(sin(x), 3) << endl;
2201      // -> -4*cos(x)
2202
2203     e = indexed(a+b, i) * indexed(b+c, i); 
2204     e = e.expand(expand_options::expand_indexed);
2205     cout << e.collect(indexed(b, i)) << endl;
2206      // -> a.i*c.i+(a.i+c.i)*b.i+b.i^2
2207 @}
2208 @end example
2209
2210
2211 @subsection Polynomial division
2212 @cindex polynomial division
2213 @cindex quotient
2214 @cindex remainder
2215 @cindex pseudo-remainder
2216 @cindex @code{quo()}
2217 @cindex @code{rem()}
2218 @cindex @code{prem()}
2219 @cindex @code{divide()}
2220
2221 The two functions
2222
2223 @example
2224 ex quo(const ex & a, const ex & b, const symbol & x);
2225 ex rem(const ex & a, const ex & b, const symbol & x);
2226 @end example
2227
2228 compute the quotient and remainder of univariate polynomials in the variable
2229 @samp{x}. The results satisfy @math{a = b*quo(a, b, x) + rem(a, b, x)}.
2230
2231 The additional function
2232
2233 @example
2234 ex prem(const ex & a, const ex & b, const symbol & x);
2235 @end example
2236
2237 computes the pseudo-remainder of @samp{a} and @samp{b} which satisfies
2238 @math{c*a = b*q + prem(a, b, x)}, where @math{c = b.lcoeff(x) ^ (a.degree(x) - b.degree(x) + 1)}.
2239
2240 Exact division of multivariate polynomials is performed by the function
2241
2242 @example
2243 bool divide(const ex & a, const ex & b, ex & q);
2244 @end example
2245
2246 If @samp{b} divides @samp{a} over the rationals, this function returns @code{true}
2247 and returns the quotient in the variable @code{q}. Otherwise it returns @code{false}
2248 in which case the value of @code{q} is undefined.
2249
2250
2251 @subsection Unit, content and primitive part
2252 @cindex @code{unit()}
2253 @cindex @code{content()}
2254 @cindex @code{primpart()}
2255
2256 The methods
2257
2258 @example
2259 ex ex::unit(const symbol & x);
2260 ex ex::content(const symbol & x);
2261 ex ex::primpart(const symbol & x);
2262 @end example
2263
2264 return the unit part, content part, and primitive polynomial of a multivariate
2265 polynomial with respect to the variable @samp{x} (the unit part being the sign
2266 of the leading coefficient, the content part being the GCD of the coefficients,
2267 and the primitive polynomial being the input polynomial divided by the unit and
2268 content parts). The product of unit, content, and primitive part is the
2269 original polynomial.
2270
2271
2272 @subsection GCD and LCM
2273 @cindex GCD
2274 @cindex LCM
2275 @cindex @code{gcd()}
2276 @cindex @code{lcm()}
2277
2278 The functions for polynomial greatest common divisor and least common
2279 multiple have the synopsis
2280
2281 @example
2282 ex gcd(const ex & a, const ex & b);
2283 ex lcm(const ex & a, const ex & b);
2284 @end example
2285
2286 The functions @code{gcd()} and @code{lcm()} accept two expressions
2287 @code{a} and @code{b} as arguments and return a new expression, their
2288 greatest common divisor or least common multiple, respectively.  If the
2289 polynomials @code{a} and @code{b} are coprime @code{gcd(a,b)} returns 1
2290 and @code{lcm(a,b)} returns the product of @code{a} and @code{b}.
2291
2292 @example
2293 #include <ginac/ginac.h>
2294 using namespace GiNaC;
2295
2296 int main()
2297 @{
2298     symbol x("x"), y("y"), z("z");
2299     ex P_a = 4*x*y + x*z + 20*pow(y, 2) + 21*y*z + 4*pow(z, 2);
2300     ex P_b = x*y + 3*x*z + 5*pow(y, 2) + 19*y*z + 12*pow(z, 2);
2301
2302     ex P_gcd = gcd(P_a, P_b);
2303     // x + 5*y + 4*z
2304     ex P_lcm = lcm(P_a, P_b);
2305     // 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
2306 @}
2307 @end example
2308
2309
2310 @subsection Square-free decomposition
2311 @cindex square-free decomposition
2312 @cindex factorization
2313 @cindex @code{sqrfree()}
2314
2315 GiNaC still lacks proper factorization support.  Some form of
2316 factorization is, however, easily implemented by noting that factors
2317 appearing in a polynomial with power two or more also appear in the
2318 derivative and hence can easily be found by computing the GCD of the
2319 original polynomial and its derivatives.  Any system has an interface
2320 for this so called square-free factorization.  So we provide one, too:
2321 @example
2322 ex sqrfree(const ex & a, const lst & l = lst());
2323 @end example
2324 Here is an example that by the way illustrates how the result may depend
2325 on the order of differentiation:
2326 @example
2327     ...
2328     symbol x("x"), y("y");
2329     ex BiVarPol = expand(pow(x-2*y*x,3) * pow(x+y,2) * (x-y));
2330
2331     cout << sqrfree(BiVarPol, lst(x,y)) << endl;
2332      // -> (y+x)^2*(-1+6*y+8*y^3-12*y^2)*(y-x)*x^3
2333
2334     cout << sqrfree(BiVarPol, lst(y,x)) << endl;
2335      // -> (1-2*y)^3*(y+x)^2*(-y+x)*x^3
2336
2337     cout << sqrfree(BiVarPol) << endl;
2338      // -> depending on luck, any of the above
2339     ...
2340 @end example
2341
2342
2343 @node Rational Expressions, Symbolic Differentiation, Polynomial Arithmetic, Methods and Functions
2344 @c    node-name, next, previous, up
2345 @section Rational expressions
2346
2347 @subsection The @code{normal} method
2348 @cindex @code{normal()}
2349 @cindex simplification
2350 @cindex temporary replacement
2351
2352 Some basic form of simplification of expressions is called for frequently.
2353 GiNaC provides the method @code{.normal()}, which converts a rational function
2354 into an equivalent rational function of the form @samp{numerator/denominator}
2355 where numerator and denominator are coprime.  If the input expression is already
2356 a fraction, it just finds the GCD of numerator and denominator and cancels it,
2357 otherwise it performs fraction addition and multiplication.
2358
2359 @code{.normal()} can also be used on expressions which are not rational functions
2360 as it will replace all non-rational objects (like functions or non-integer
2361 powers) by temporary symbols to bring the expression to the domain of rational
2362 functions before performing the normalization, and re-substituting these
2363 symbols afterwards. This algorithm is also available as a separate method
2364 @code{.to_rational()}, described below.
2365
2366 This means that both expressions @code{t1} and @code{t2} are indeed
2367 simplified in this little program:
2368
2369 @example
2370 #include <ginac/ginac.h>
2371 using namespace GiNaC;
2372
2373 int main()
2374 @{
2375     symbol x("x");
2376     ex t1 = (pow(x,2) + 2*x + 1)/(x + 1);
2377     ex t2 = (pow(sin(x),2) + 2*sin(x) + 1)/(sin(x) + 1);
2378     std::cout << "t1 is " << t1.normal() << std::endl;
2379     std::cout << "t2 is " << t2.normal() << std::endl;
2380 @}
2381 @end example
2382
2383 Of course this works for multivariate polynomials too, so the ratio of
2384 the sample-polynomials from the section about GCD and LCM above would be
2385 normalized to @code{P_a/P_b} = @code{(4*y+z)/(y+3*z)}.
2386
2387
2388 @subsection Numerator and denominator
2389 @cindex numerator
2390 @cindex denominator
2391 @cindex @code{numer()}
2392 @cindex @code{denom()}
2393
2394 The numerator and denominator of an expression can be obtained with
2395
2396 @example
2397 ex ex::numer();
2398 ex ex::denom();
2399 @end example
2400
2401 These functions will first normalize the expression as described above and
2402 then return the numerator or denominator, respectively.
2403
2404
2405 @subsection Converting to a rational expression
2406 @cindex @code{to_rational()}
2407
2408 Some of the methods described so far only work on polynomials or rational
2409 functions. GiNaC provides a way to extend the domain of these functions to
2410 general expressions by using the temporary replacement algorithm described
2411 above. You do this by calling
2412
2413 @example
2414 ex ex::to_rational(lst &l);
2415 @end example
2416
2417 on the expression to be converted. The supplied @code{lst} will be filled
2418 with the generated temporary symbols and their replacement expressions in
2419 a format that can be used directly for the @code{subs()} method. It can also
2420 already contain a list of replacements from an earlier application of
2421 @code{.to_rational()}, so it's possible to use it on multiple expressions
2422 and get consistent results.
2423
2424 For example,
2425
2426 @example
2427 @{
2428     symbol x("x");
2429     ex a = pow(sin(x), 2) - pow(cos(x), 2);
2430     ex b = sin(x) + cos(x);
2431     ex q;
2432     lst l;
2433     divide(a.to_rational(l), b.to_rational(l), q);
2434     cout << q.subs(l) << endl;
2435 @}
2436 @end example
2437
2438 will print @samp{sin(x)-cos(x)}.
2439
2440
2441 @node Symbolic Differentiation, Series Expansion, Rational Expressions, Methods and Functions
2442 @c    node-name, next, previous, up
2443 @section Symbolic differentiation
2444 @cindex differentiation
2445 @cindex @code{diff()}
2446 @cindex chain rule
2447 @cindex product rule
2448
2449 GiNaC's objects know how to differentiate themselves.  Thus, a
2450 polynomial (class @code{add}) knows that its derivative is the sum of
2451 the derivatives of all the monomials:
2452
2453 @example
2454 #include <ginac/ginac.h>
2455 using namespace GiNaC;
2456
2457 int main()
2458 @{
2459     symbol x("x"), y("y"), z("z");
2460     ex P = pow(x, 5) + pow(x, 2) + y;
2461
2462     cout << P.diff(x,2) << endl;  // 20*x^3 + 2
2463     cout << P.diff(y) << endl;    // 1
2464     cout << P.diff(z) << endl;    // 0
2465 @}
2466 @end example
2467
2468 If a second integer parameter @var{n} is given, the @code{diff} method
2469 returns the @var{n}th derivative.
2470
2471 If @emph{every} object and every function is told what its derivative
2472 is, all derivatives of composed objects can be calculated using the
2473 chain rule and the product rule.  Consider, for instance the expression
2474 @code{1/cosh(x)}.  Since the derivative of @code{cosh(x)} is
2475 @code{sinh(x)} and the derivative of @code{pow(x,-1)} is
2476 @code{-pow(x,-2)}, GiNaC can readily compute the composition.  It turns
2477 out that the composition is the generating function for Euler Numbers,
2478 i.e. the so called @var{n}th Euler number is the coefficient of
2479 @code{x^n/n!} in the expansion of @code{1/cosh(x)}.  We may use this
2480 identity to code a function that generates Euler numbers in just three
2481 lines:
2482
2483 @cindex Euler numbers
2484 @example
2485 #include <ginac/ginac.h>
2486 using namespace GiNaC;
2487
2488 ex EulerNumber(unsigned n)
2489 @{
2490     symbol x;
2491     const ex generator = pow(cosh(x),-1);
2492     return generator.diff(x,n).subs(x==0);
2493 @}
2494
2495 int main()
2496 @{
2497     for (unsigned i=0; i<11; i+=2)
2498         std::cout << EulerNumber(i) << std::endl;
2499     return 0;
2500 @}
2501 @end example
2502
2503 When you run it, it produces the sequence @code{1}, @code{-1}, @code{5},
2504 @code{-61}, @code{1385}, @code{-50521}.  We increment the loop variable
2505 @code{i} by two since all odd Euler numbers vanish anyways.
2506
2507
2508 @node Series Expansion, Built-in Functions, Symbolic Differentiation, Methods and Functions
2509 @c    node-name, next, previous, up
2510 @section Series expansion
2511 @cindex @code{series()}
2512 @cindex Taylor expansion
2513 @cindex Laurent expansion
2514 @cindex @code{pseries} (class)
2515
2516 Expressions know how to expand themselves as a Taylor series or (more
2517 generally) a Laurent series.  As in most conventional Computer Algebra
2518 Systems, no distinction is made between those two.  There is a class of
2519 its own for storing such series (@code{class pseries}) and a built-in
2520 function (called @code{Order}) for storing the order term of the series.
2521 As a consequence, if you want to work with series, i.e. multiply two
2522 series, you need to call the method @code{ex::series} again to convert
2523 it to a series object with the usual structure (expansion plus order
2524 term).  A sample application from special relativity could read:
2525
2526 @example
2527 #include <ginac/ginac.h>
2528 using namespace std;
2529 using namespace GiNaC;
2530
2531 int main()
2532 @{
2533     symbol v("v"), c("c");
2534     
2535     ex gamma = 1/sqrt(1 - pow(v/c,2));
2536     ex mass_nonrel = gamma.series(v==0, 10);
2537     
2538     cout << "the relativistic mass increase with v is " << endl
2539          << mass_nonrel << endl;
2540     
2541     cout << "the inverse square of this series is " << endl
2542          << pow(mass_nonrel,-2).series(v==0, 10) << endl;
2543 @}
2544 @end example
2545
2546 Only calling the series method makes the last output simplify to
2547 @math{1-v^2/c^2+O(v^10)}, without that call we would just have a long
2548 series raised to the power @math{-2}.
2549
2550 @cindex M@'echain's formula
2551 As another instructive application, let us calculate the numerical 
2552 value of Archimedes' constant
2553 @tex
2554 $\pi$
2555 @end tex
2556 (for which there already exists the built-in constant @code{Pi}) 
2557 using M@'echain's amazing formula
2558 @tex
2559 $\pi=16$~atan~$\!\left(1 \over 5 \right)-4$~atan~$\!\left(1 \over 239 \right)$.
2560 @end tex
2561 @ifnottex
2562 @math{Pi==16*atan(1/5)-4*atan(1/239)}.
2563 @end ifnottex
2564 We may expand the arcus tangent around @code{0} and insert the fractions
2565 @code{1/5} and @code{1/239}.  But, as we have seen, a series in GiNaC
2566 carries an order term with it and the question arises what the system is
2567 supposed to do when the fractions are plugged into that order term.  The
2568 solution is to use the function @code{series_to_poly()} to simply strip
2569 the order term off:
2570
2571 @example
2572 #include <ginac/ginac.h>
2573 using namespace GiNaC;
2574
2575 ex mechain_pi(int degr)
2576 @{
2577     symbol x;
2578     ex pi_expansion = series_to_poly(atan(x).series(x,degr));
2579     ex pi_approx = 16*pi_expansion.subs(x==numeric(1,5))
2580                    -4*pi_expansion.subs(x==numeric(1,239));
2581     return pi_approx;
2582 @}
2583
2584 int main()
2585 @{
2586     using std::cout;  // just for fun, another way of...
2587     using std::endl;  // ...dealing with this namespace std.
2588     ex pi_frac;
2589     for (int i=2; i<12; i+=2) @{
2590         pi_frac = mechain_pi(i);
2591         cout << i << ":\t" << pi_frac << endl
2592              << "\t" << pi_frac.evalf() << endl;
2593     @}
2594     return 0;
2595 @}
2596 @end example
2597
2598 Note how we just called @code{.series(x,degr)} instead of
2599 @code{.series(x==0,degr)}.  This is a simple shortcut for @code{ex}'s
2600 method @code{series()}: if the first argument is a symbol the expression
2601 is expanded in that symbol around point @code{0}.  When you run this
2602 program, it will type out:
2603
2604 @example
2605 2:      3804/1195
2606         3.1832635983263598326
2607 4:      5359397032/1706489875
2608         3.1405970293260603143
2609 6:      38279241713339684/12184551018734375
2610         3.141621029325034425
2611 8:      76528487109180192540976/24359780855939418203125
2612         3.141591772182177295
2613 10:     327853873402258685803048818236/104359128170408663038552734375
2614         3.1415926824043995174
2615 @end example
2616
2617
2618 @node Built-in Functions, Input/Output, Series Expansion, Methods and Functions
2619 @c    node-name, next, previous, up
2620 @section Predefined mathematical functions
2621
2622 GiNaC contains the following predefined mathematical functions:
2623
2624 @cartouche
2625 @multitable @columnfractions .30 .70
2626 @item @strong{Name} @tab @strong{Function}
2627 @item @code{abs(x)}
2628 @tab absolute value
2629 @item @code{csgn(x)}
2630 @tab complex sign
2631 @item @code{sqrt(x)}
2632 @tab square root (not a GiNaC function proper but equivalent to @code{pow(x, numeric(1, 2)})
2633 @item @code{sin(x)}
2634 @tab sine
2635 @item @code{cos(x)}
2636 @tab cosine
2637 @item @code{tan(x)}
2638 @tab tangent
2639 @item @code{asin(x)}
2640 @tab inverse sine
2641 @item @code{acos(x)}
2642 @tab inverse cosine
2643 @item @code{atan(x)}
2644 @tab inverse tangent
2645 @item @code{atan2(y, x)}
2646 @tab inverse tangent with two arguments
2647 @item @code{sinh(x)}
2648 @tab hyperbolic sine
2649 @item @code{cosh(x)}
2650 @tab hyperbolic cosine
2651 @item @code{tanh(x)}
2652 @tab hyperbolic tangent
2653 @item @code{asinh(x)}
2654 @tab inverse hyperbolic sine
2655 @item @code{acosh(x)}
2656 @tab inverse hyperbolic cosine
2657 @item @code{atanh(x)}
2658 @tab inverse hyperbolic tangent
2659 @item @code{exp(x)}
2660 @tab exponential function
2661 @item @code{log(x)}
2662 @tab natural logarithm
2663 @item @code{Li2(x)}
2664 @tab Dilogarithm
2665 @item @code{zeta(x)}
2666 @tab Riemann's zeta function
2667 @item @code{zeta(n, x)}
2668 @tab derivatives of Riemann's zeta function
2669 @item @code{tgamma(x)}
2670 @tab Gamma function
2671 @item @code{lgamma(x)}
2672 @tab logarithm of Gamma function
2673 @item @code{beta(x, y)}
2674 @tab Beta function (@code{tgamma(x)*tgamma(y)/tgamma(x+y)})
2675 @item @code{psi(x)}
2676 @tab psi (digamma) function
2677 @item @code{psi(n, x)}
2678 @tab derivatives of psi function (polygamma functions)
2679 @item @code{factorial(n)}
2680 @tab factorial function
2681 @item @code{binomial(n, m)}
2682 @tab binomial coefficients
2683 @item @code{Order(x)}
2684 @tab order term function in truncated power series
2685 @item @code{Derivative(x, l)}
2686 @tab inert partial differentiation operator (used internally)
2687 @end multitable
2688 @end cartouche
2689
2690 @cindex branch cut
2691 For functions that have a branch cut in the complex plane GiNaC follows
2692 the conventions for C++ as defined in the ANSI standard as far as
2693 possible.  In particular: the natural logarithm (@code{log}) and the
2694 square root (@code{sqrt}) both have their branch cuts running along the
2695 negative real axis where the points on the axis itself belong to the
2696 upper part (i.e. continuous with quadrant II).  The inverse
2697 trigonometric and hyperbolic functions are not defined for complex
2698 arguments by the C++ standard, however.  In GiNaC we follow the
2699 conventions used by CLN, which in turn follow the carefully designed
2700 definitions in the Common Lisp standard.  It should be noted that this
2701 convention is identical to the one used by the C99 standard and by most
2702 serious CAS.  It is to be expected that future revisions of the C++
2703 standard incorporate these functions in the complex domain in a manner
2704 compatible with C99.
2705
2706
2707 @node Input/Output, Extending GiNaC, Built-in Functions, Methods and Functions
2708 @c    node-name, next, previous, up
2709 @section Input and output of expressions
2710 @cindex I/O
2711
2712 @subsection Expression output
2713 @cindex printing
2714 @cindex output of expressions
2715
2716 The easiest way to print an expression is to write it to a stream:
2717
2718 @example
2719 @{
2720     symbol x("x");
2721     ex e = 4.5+pow(x,2)*3/2;
2722     cout << e << endl;    // prints '(4.5)+3/2*x^2'
2723     // ...
2724 @end example
2725
2726 The output format is identical to the @command{ginsh} input syntax and
2727 to that used by most computer algebra systems, but not directly pastable
2728 into a GiNaC C++ program (note that in the above example, @code{pow(x,2)}
2729 is printed as @samp{x^2}).
2730
2731 It is possible to print expressions in a number of different formats with
2732 the method
2733
2734 @example
2735 void ex::print(const print_context & c, unsigned level = 0);
2736 @end example
2737
2738 The type of @code{print_context} object passed in determines the format
2739 of the output. The possible types are defined in @file{ginac/print.h}.
2740 All constructors of @code{print_context} and derived classes take an
2741 @code{ostream &} as their first argument.
2742
2743 To print an expression in a way that can be directly used in a C or C++
2744 program, you pass a @code{print_csrc} object like this:
2745
2746 @example
2747     // ...
2748     cout << "float f = ";
2749     e.print(print_csrc_float(cout));
2750     cout << ";\n";
2751
2752     cout << "double d = ";
2753     e.print(print_csrc_double(cout));
2754     cout << ";\n";
2755
2756     cout << "cl_N n = ";
2757     e.print(print_csrc_cl_N(cout));
2758     cout << ";\n";
2759     // ...
2760 @end example
2761
2762 The three possible types mostly affect the way in which floating point
2763 numbers are written.
2764
2765 The above example will produce (note the @code{x^2} being converted to @code{x*x}):
2766
2767 @example
2768 float f = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
2769 double d = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
2770 cl_N n = (cln::cl_F("3.0")/cln::cl_F("2.0"))*(x*x)+cln::cl_F("4.5");
2771 @end example
2772
2773 The @code{print_context} type @code{print_tree} provdes a dump of the
2774 internal structure of an expression for debugging purposes:
2775
2776 @example
2777     // ...
2778     e.print(print_tree(cout));
2779 @}
2780 @end example
2781
2782 produces
2783
2784 @example
2785 add, hash=0x0, flags=0x3, nops=2
2786     power, hash=0x9, flags=0x3, nops=2
2787         x (symbol), serial=3, hash=0x44a113a6, flags=0xf
2788         2 (numeric), hash=0x80000042, flags=0xf
2789     3/2 (numeric), hash=0x80000061, flags=0xf
2790     -----
2791     overall_coeff
2792     4.5L0 (numeric), hash=0x8000004b, flags=0xf
2793     =====
2794 @end example
2795
2796 This kind of output is also available in @command{ginsh} as the @code{print()}
2797 function.
2798
2799 If you need any fancy special output format, e.g. for interfacing GiNaC
2800 with other algebra systems or for producing code for different
2801 programming languages, you can always traverse the expression tree yourself:
2802
2803 @example
2804 static void my_print(const ex & e)
2805 @{
2806     if (is_ex_of_type(e, function))
2807         cout << ex_to_function(e).get_name();
2808     else
2809         cout << e.bp->class_name();
2810     cout << "(";
2811     unsigned n = e.nops();
2812     if (n)
2813         for (unsigned i=0; i<n; i++) @{
2814             my_print(e.op(i));
2815             if (i != n-1)
2816                 cout << ",";
2817         @}
2818     else
2819         cout << e;
2820     cout << ")";
2821 @}
2822
2823 int main(void)
2824 @{
2825     my_print(pow(3, x) - 2 * sin(y / Pi)); cout << endl;
2826     return 0;
2827 @}
2828 @end example
2829
2830 This will produce
2831
2832 @example
2833 add(power(numeric(3),symbol(x)),mul(sin(mul(power(constant(Pi),numeric(-1)),
2834 symbol(y))),numeric(-2)))
2835 @end example
2836
2837 If you need an output format that makes it possible to accurately
2838 reconstruct an expression by feeding the output to a suitable parser or
2839 object factory, you should consider storing the expression in an
2840 @code{archive} object and reading the object properties from there.
2841 See the section on archiving for more information.
2842
2843
2844 @subsection Expression input
2845 @cindex input of expressions
2846
2847 GiNaC provides no way to directly read an expression from a stream because
2848 you will usually want the user to be able to enter something like @samp{2*x+sin(y)}
2849 and have the @samp{x} and @samp{y} correspond to the symbols @code{x} and
2850 @code{y} you defined in your program and there is no way to specify the
2851 desired symbols to the @code{>>} stream input operator.
2852
2853 Instead, GiNaC lets you construct an expression from a string, specifying the
2854 list of symbols to be used:
2855
2856 @example
2857 @{
2858     symbol x("x"), y("y");
2859     ex e("2*x+sin(y)", lst(x, y));
2860 @}
2861 @end example
2862
2863 The input syntax is the same as that used by @command{ginsh} and the stream
2864 output operator @code{<<}. The symbols in the string are matched by name to
2865 the symbols in the list and if GiNaC encounters a symbol not specified in
2866 the list it will throw an exception.
2867
2868 With this constructor, it's also easy to implement interactive GiNaC programs:
2869
2870 @example
2871 #include <iostream>
2872 #include <string>
2873 #include <stdexcept>
2874 #include <ginac/ginac.h>
2875 using namespace std;
2876 using namespace GiNaC;
2877
2878 int main()
2879 @{
2880      symbol x("x");
2881      string s;
2882
2883      cout << "Enter an expression containing 'x': ";
2884      getline(cin, s);
2885
2886      try @{
2887          ex e(s, lst(x));
2888          cout << "The derivative of " << e << " with respect to x is ";
2889          cout << e.diff(x) << ".\n";
2890      @} catch (exception &p) @{
2891          cerr << p.what() << endl;
2892      @}
2893 @}
2894 @end example
2895
2896
2897 @subsection Archiving
2898 @cindex @code{archive} (class)
2899 @cindex archiving
2900
2901 GiNaC allows creating @dfn{archives} of expressions which can be stored
2902 to or retrieved from files. To create an archive, you declare an object
2903 of class @code{archive} and archive expressions in it, giving each
2904 expression a unique name:
2905
2906 @example
2907 #include <fstream>
2908 using namespace std;
2909 #include <ginac/ginac.h>
2910 using namespace GiNaC;
2911
2912 int main()
2913 @{
2914     symbol x("x"), y("y"), z("z");
2915
2916     ex foo = sin(x + 2*y) + 3*z + 41;
2917     ex bar = foo + 1;
2918
2919     archive a;
2920     a.archive_ex(foo, "foo");
2921     a.archive_ex(bar, "the second one");
2922     // ...
2923 @end example
2924
2925 The archive can then be written to a file:
2926
2927 @example
2928     // ...
2929     ofstream out("foobar.gar");
2930     out << a;
2931     out.close();
2932     // ...
2933 @end example
2934
2935 The file @file{foobar.gar} contains all information that is needed to
2936 reconstruct the expressions @code{foo} and @code{bar}.
2937
2938 @cindex @command{viewgar}
2939 The tool @command{viewgar} that comes with GiNaC can be used to view
2940 the contents of GiNaC archive files:
2941
2942 @example
2943 $ viewgar foobar.gar
2944 foo = 41+sin(x+2*y)+3*z
2945 the second one = 42+sin(x+2*y)+3*z
2946 @end example
2947
2948 The point of writing archive files is of course that they can later be
2949 read in again:
2950
2951 @example
2952     // ...
2953     archive a2;
2954     ifstream in("foobar.gar");
2955     in >> a2;
2956     // ...
2957 @end example
2958
2959 And the stored expressions can be retrieved by their name:
2960
2961 @example
2962     // ...
2963     lst syms(x, y);
2964
2965     ex ex1 = a2.unarchive_ex(syms, "foo");
2966     ex ex2 = a2.unarchive_ex(syms, "the second one");
2967
2968     cout << ex1 << endl;              // prints "41+sin(x+2*y)+3*z"
2969     cout << ex2 << endl;              // prints "42+sin(x+2*y)+3*z"
2970     cout << ex1.subs(x == 2) << endl; // prints "41+sin(2+2*y)+3*z"
2971 @}
2972 @end example
2973
2974 Note that you have to supply a list of the symbols which are to be inserted
2975 in the expressions. Symbols in archives are stored by their name only and
2976 if you don't specify which symbols you have, unarchiving the expression will
2977 create new symbols with that name. E.g. if you hadn't included @code{x} in
2978 the @code{syms} list above, the @code{ex1.subs(x == 2)} statement would
2979 have had no effect because the @code{x} in @code{ex1} would have been a
2980 different symbol than the @code{x} which was defined at the beginning of
2981 the program, altough both would appear as @samp{x} when printed.
2982
2983 You can also use the information stored in an @code{archive} object to
2984 output expressions in a format suitable for exact reconstruction. The
2985 @code{archive} and @code{archive_node} classes have a couple of member
2986 functions that let you access the stored properties:
2987
2988 @example
2989 static void my_print2(const archive_node & n)
2990 @{
2991     string class_name;
2992     n.find_string("class", class_name);
2993     cout << class_name << "(";
2994
2995     archive_node::propinfovector p;
2996     n.get_properties(p);
2997
2998     unsigned num = p.size();
2999     for (unsigned i=0; i<num; i++) @{
3000         const string &name = p[i].name;
3001         if (name == "class")
3002             continue;
3003         cout << name << "=";
3004
3005         unsigned count = p[i].count;
3006         if (count > 1)
3007             cout << "@{";
3008
3009         for (unsigned j=0; j<count; j++) @{
3010             switch (p[i].type) @{
3011                 case archive_node::PTYPE_BOOL: @{
3012                     bool x;
3013                     n.find_bool(name, x);
3014                     cout << (x ? "true" : "false");
3015                     break;
3016                 @}
3017                 case archive_node::PTYPE_UNSIGNED: @{
3018                     unsigned x;
3019                     n.find_unsigned(name, x);
3020                     cout << x;
3021                     break;
3022                 @}
3023                 case archive_node::PTYPE_STRING: @{
3024                     string x;
3025                     n.find_string(name, x);
3026                     cout << '\"' << x << '\"';
3027                     break;
3028                 @}
3029                 case archive_node::PTYPE_NODE: @{
3030                     const archive_node &x = n.find_ex_node(name, j);
3031                     my_print2(x);
3032                     break;
3033                 @}
3034             @}
3035
3036             if (j != count-1)
3037                 cout << ",";
3038         @}
3039
3040         if (count > 1)
3041             cout << "@}";
3042
3043         if (i != num-1)
3044             cout << ",";
3045     @}
3046
3047     cout << ")";
3048 @}
3049
3050 int main(void)
3051 @{
3052     ex e = pow(2, x) - y;
3053     archive ar(e, "e");
3054     my_print2(ar.get_top_node(0)); cout << endl;
3055     return 0;
3056 @}
3057 @end example
3058
3059 This will produce:
3060
3061 @example
3062 add(rest=@{power(basis=numeric(number="2"),exponent=symbol(name="x")),
3063 symbol(name="y")@},coeff=@{numeric(number="1"),numeric(number="-1")@},
3064 overall_coeff=numeric(number="0"))
3065 @end example
3066
3067 Be warned, however, that the set of properties and their meaning for each
3068 class may change between GiNaC versions.
3069
3070
3071 @node Extending GiNaC, What does not belong into GiNaC, Input/Output, Top
3072 @c    node-name, next, previous, up
3073 @chapter Extending GiNaC
3074
3075 By reading so far you should have gotten a fairly good understanding of
3076 GiNaC's design-patterns.  From here on you should start reading the
3077 sources.  All we can do now is issue some recommendations how to tackle
3078 GiNaC's many loose ends in order to fulfill everybody's dreams.  If you
3079 develop some useful extension please don't hesitate to contact the GiNaC
3080 authors---they will happily incorporate them into future versions.
3081
3082 @menu
3083 * What does not belong into GiNaC::  What to avoid.
3084 * Symbolic functions::               Implementing symbolic functions.
3085 * Adding classes::                   Defining new algebraic classes.
3086 @end menu
3087
3088
3089 @node What does not belong into GiNaC, Symbolic functions, Extending GiNaC, Extending GiNaC
3090 @c    node-name, next, previous, up
3091 @section What doesn't belong into GiNaC
3092
3093 @cindex @command{ginsh}
3094 First of all, GiNaC's name must be read literally.  It is designed to be
3095 a library for use within C++.  The tiny @command{ginsh} accompanying
3096 GiNaC makes this even more clear: it doesn't even attempt to provide a
3097 language.  There are no loops or conditional expressions in
3098 @command{ginsh}, it is merely a window into the library for the
3099 programmer to test stuff (or to show off).  Still, the design of a
3100 complete CAS with a language of its own, graphical capabilites and all
3101 this on top of GiNaC is possible and is without doubt a nice project for
3102 the future.
3103
3104 There are many built-in functions in GiNaC that do not know how to
3105 evaluate themselves numerically to a precision declared at runtime
3106 (using @code{Digits}).  Some may be evaluated at certain points, but not
3107 generally.  This ought to be fixed.  However, doing numerical
3108 computations with GiNaC's quite abstract classes is doomed to be
3109 inefficient.  For this purpose, the underlying foundation classes
3110 provided by @acronym{CLN} are much better suited.
3111
3112
3113 @node Symbolic functions, Adding classes, What does not belong into GiNaC, Extending GiNaC
3114 @c    node-name, next, previous, up
3115 @section Symbolic functions
3116
3117 The easiest and most instructive way to start with is probably to
3118 implement your own function.  GiNaC's functions are objects of class
3119 @code{function}.  The preprocessor is then used to convert the function
3120 names to objects with a corresponding serial number that is used
3121 internally to identify them.  You usually need not worry about this
3122 number.  New functions may be inserted into the system via a kind of
3123 `registry'.  It is your responsibility to care for some functions that
3124 are called when the user invokes certain methods.  These are usual
3125 C++-functions accepting a number of @code{ex} as arguments and returning
3126 one @code{ex}.  As an example, if we have a look at a simplified
3127 implementation of the cosine trigonometric function, we first need a
3128 function that is called when one wishes to @code{eval} it.  It could
3129 look something like this:
3130
3131 @example
3132 static ex cos_eval_method(const ex & x)
3133 @{
3134     // if (!x%(2*Pi)) return 1
3135     // if (!x%Pi) return -1
3136     // if (!x%Pi/2) return 0
3137     // care for other cases...
3138     return cos(x).hold();
3139 @}
3140 @end example
3141
3142 @cindex @code{hold()}
3143 @cindex evaluation
3144 The last line returns @code{cos(x)} if we don't know what else to do and
3145 stops a potential recursive evaluation by saying @code{.hold()}, which
3146 sets a flag to the expression signaling that it has been evaluated.  We
3147 should also implement a method for numerical evaluation and since we are
3148 lazy we sweep the problem under the rug by calling someone else's
3149 function that does so, in this case the one in class @code{numeric}:
3150
3151 @example
3152 static ex cos_evalf(const ex & x)
3153 @{
3154     return cos(ex_to_numeric(x));
3155 @}
3156 @end example
3157
3158 Differentiation will surely turn up and so we need to tell @code{cos}
3159 what the first derivative is (higher derivatives (@code{.diff(x,3)} for
3160 instance are then handled automatically by @code{basic::diff} and
3161 @code{ex::diff}):
3162
3163 @example
3164 static ex cos_deriv(const ex & x, unsigned diff_param)
3165 @{
3166     return -sin(x);
3167 @}
3168 @end example
3169
3170 @cindex product rule
3171 The second parameter is obligatory but uninteresting at this point.  It
3172 specifies which parameter to differentiate in a partial derivative in
3173 case the function has more than one parameter and its main application
3174 is for correct handling of the chain rule.  For Taylor expansion, it is
3175 enough to know how to differentiate.  But if the function you want to
3176 implement does have a pole somewhere in the complex plane, you need to
3177 write another method for Laurent expansion around that point.
3178
3179 Now that all the ingredients for @code{cos} have been set up, we need
3180 to tell the system about it.  This is done by a macro and we are not
3181 going to descibe how it expands, please consult your preprocessor if you
3182 are curious:
3183
3184 @example
3185 REGISTER_FUNCTION(cos, eval_func(cos_eval).
3186                        evalf_func(cos_evalf).
3187                        derivative_func(cos_deriv));
3188 @end example
3189
3190 The first argument is the function's name used for calling it and for
3191 output.  The second binds the corresponding methods as options to this
3192 object.  Options are separated by a dot and can be given in an arbitrary
3193 order.  GiNaC functions understand several more options which are always
3194 specified as @code{.option(params)}, for example a method for series
3195 expansion @code{.series_func(cos_series)}.  Again, if no series
3196 expansion method is given, GiNaC defaults to simple Taylor expansion,
3197 which is correct if there are no poles involved as is the case for the
3198 @code{cos} function.  The way GiNaC handles poles in case there are any
3199 is best understood by studying one of the examples, like the Gamma
3200 (@code{tgamma}) function for instance.  (In essence the function first
3201 checks if there is a pole at the evaluation point and falls back to
3202 Taylor expansion if there isn't.  Then, the pole is regularized by some
3203 suitable transformation.)  Also, the new function needs to be declared
3204 somewhere.  This may also be done by a convenient preprocessor macro:
3205
3206 @example
3207 DECLARE_FUNCTION_1P(cos)
3208 @end example
3209
3210 The suffix @code{_1P} stands for @emph{one parameter}.  Of course, this
3211 implementation of @code{cos} is very incomplete and lacks several safety
3212 mechanisms.  Please, have a look at the real implementation in GiNaC.
3213 (By the way: in case you are worrying about all the macros above we can
3214 assure you that functions are GiNaC's most macro-intense classes.  We
3215 have done our best to avoid macros where we can.)
3216
3217
3218 @node Adding classes, A Comparison With Other CAS, Symbolic functions, Extending GiNaC
3219 @c    node-name, next, previous, up
3220 @section Adding classes
3221
3222 If you are doing some very specialized things with GiNaC you may find that
3223 you have to implement your own algebraic classes to fit your needs. This
3224 section will explain how to do this by giving the example of a simple
3225 'string' class. After reading this section you will know how to properly
3226 declare a GiNaC class and what the minimum required member functions are
3227 that you have to implement. We only cover the implementation of a 'leaf'
3228 class here (i.e. one that doesn't contain subexpressions). Creating a
3229 container class like, for example, a class representing tensor products is
3230 more involved but this section should give you enough information so you can
3231 consult the source to GiNaC's predefined classes if you want to implement
3232 something more complicated.
3233
3234 @subsection GiNaC's run-time type information system
3235
3236 @cindex hierarchy of classes
3237 @cindex RTTI
3238 All algebraic classes (that is, all classes that can appear in expressions)
3239 in GiNaC are direct or indirect subclasses of the class @code{basic}. So a
3240 @code{basic *} (which is essentially what an @code{ex} is) represents a
3241 generic pointer to an algebraic class. Occasionally it is necessary to find
3242 out what the class of an object pointed to by a @code{basic *} really is.
3243 Also, for the unarchiving of expressions it must be possible to find the
3244 @code{unarchive()} function of a class given the class name (as a string). A
3245 system that provides this kind of information is called a run-time type
3246 information (RTTI) system. The C++ language provides such a thing (see the
3247 standard header file @file{<typeinfo>}) but for efficiency reasons GiNaC
3248 implements its own, simpler RTTI.
3249
3250 The RTTI in GiNaC is based on two mechanisms:
3251
3252 @itemize @bullet
3253
3254 @item
3255 The @code{basic} class declares a member variable @code{tinfo_key} which
3256 holds an unsigned integer that identifies the object's class. These numbers
3257 are defined in the @file{tinfos.h} header file for the built-in GiNaC
3258 classes. They all start with @code{TINFO_}.
3259
3260 @item
3261 By means of some clever tricks with static members, GiNaC maintains a list
3262 of information for all classes derived from @code{basic}. The information
3263 available includes the class names, the @code{tinfo_key}s, and pointers
3264 to the unarchiving functions. This class registry is defined in the
3265 @file{registrar.h} header file.
3266
3267 @end itemize
3268
3269 The disadvantage of this proprietary RTTI implementation is that there's
3270 a little more to do when implementing new classes (C++'s RTTI works more
3271 or less automatic) but don't worry, most of the work is simplified by
3272 macros.
3273
3274 @subsection A minimalistic example
3275
3276 Now we will start implementing a new class @code{mystring} that allows
3277 placing character strings in algebraic expressions (this is not very useful,
3278 but it's just an example). This class will be a direct subclass of
3279 @code{basic}. You can use this sample implementation as a starting point
3280 for your own classes.
3281
3282 The code snippets given here assume that you have included some header files
3283 as follows:
3284
3285 @example
3286 #include <iostream>
3287 #include <string>   
3288 #include <stdexcept>
3289 using namespace std;
3290
3291 #include <ginac/ginac.h>
3292 using namespace GiNaC;
3293 @end example
3294
3295 The first thing we have to do is to define a @code{tinfo_key} for our new
3296 class. This can be any arbitrary unsigned number that is not already taken
3297 by one of the existing classes but it's better to come up with something
3298 that is unlikely to clash with keys that might be added in the future. The
3299 numbers in @file{tinfos.h} are modeled somewhat after the class hierarchy
3300 which is not a requirement but we are going to stick with this scheme:
3301
3302 @example
3303 const unsigned TINFO_mystring = 0x42420001U;
3304 @end example
3305
3306 Now we can write down the class declaration. The class stores a C++
3307 @code{string} and the user shall be able to construct a @code{mystring}
3308 object from a C or C++ string:
3309
3310 @example
3311 class mystring : public basic
3312 @{
3313     GINAC_DECLARE_REGISTERED_CLASS(mystring, basic)
3314   
3315 public:
3316     mystring(const string &s);
3317     mystring(const char *s);
3318
3319 private:
3320     string str;
3321 @};
3322
3323 GIANC_IMPLEMENT_REGISTERED_CLASS(mystring, basic)
3324 @end example
3325
3326 The @code{GINAC_DECLARE_REGISTERED_CLASS} and @code{GINAC_IMPLEMENT_REGISTERED_CLASS}
3327 macros are defined in @file{registrar.h}. They take the name of the class
3328 and its direct superclass as arguments and insert all required declarations
3329 for the RTTI system. The @code{GINAC_DECLARE_REGISTERED_CLASS} should be
3330 the first line after the opening brace of the class definition. The
3331 @code{GINAC_IMPLEMENT_REGISTERED_CLASS} may appear anywhere else in the
3332 source (at global scope, of course, not inside a function).
3333
3334 @code{GINAC_DECLARE_REGISTERED_CLASS} contains, among other things the
3335 declarations of the default and copy constructor, the destructor, the
3336 assignment operator and a couple of other functions that are required. It
3337 also defines a type @code{inherited} which refers to the superclass so you
3338 don't have to modify your code every time you shuffle around the class
3339 hierarchy. @code{GINAC_IMPLEMENT_REGISTERED_CLASS} implements the copy
3340 constructor, the destructor and the assignment operator.
3341
3342 Now there are nine member functions we have to implement to get a working
3343 class:
3344
3345 @itemize
3346
3347 @item
3348 @code{mystring()}, the default constructor.
3349
3350 @item
3351 @code{void destroy(bool call_parent)}, which is used in the destructor and the
3352 assignment operator to free dynamically allocated members. The @code{call_parent}
3353 specifies whether the @code{destroy()} function of the superclass is to be
3354 called also.
3355
3356 @item
3357 @code{void copy(const mystring &other)}, which is used in the copy constructor
3358 and assignment operator to copy the member variables over from another
3359 object of the same class.
3360
3361 @item
3362 @code{void archive(archive_node &n)}, the archiving function. This stores all
3363 information needed to reconstruct an object of this class inside an
3364 @code{archive_node}.
3365
3366 @item
3367 @code{mystring(const archive_node &n, const lst &sym_lst)}, the unarchiving
3368 constructor. This constructs an instance of the class from the information
3369 found in an @code{archive_node}.
3370
3371 @item
3372 @code{ex unarchive(const archive_node &n, const lst &sym_lst)}, the static
3373 unarchiving function. It constructs a new instance by calling the unarchiving
3374 constructor.
3375
3376 @item
3377 @code{int compare_same_type(const basic &other)}, which is used internally
3378 by GiNaC to establish a canonical sort order for terms. It returns 0, +1 or
3379 -1, depending on the relative order of this object and the @code{other}
3380 object. If it returns 0, the objects are considered equal.
3381 @strong{Note:} This has nothing to do with the (numeric) ordering
3382 relationship expressed by @code{<}, @code{>=} etc (which cannot be defined
3383 for non-numeric classes). For example, @code{numeric(1).compare_same_type(numeric(2))}
3384 may return +1 even though 1 is clearly smaller than 2. Every GiNaC class
3385 must provide a @code{compare_same_type()} function, even those representing
3386 objects for which no reasonable algebraic ordering relationship can be
3387 defined.
3388
3389 @item
3390 And, of course, @code{mystring(const string &s)} and @code{mystring(const char *s)}
3391 which are the two constructors we declared.
3392
3393 @end itemize
3394
3395 Let's proceed step-by-step. The default constructor looks like this:
3396
3397 @example
3398 mystring::mystring() : inherited(TINFO_mystring)
3399 @{
3400     // dynamically allocate resources here if required
3401 @}
3402 @end example
3403
3404 The golden rule is that in all constructors you have to set the
3405 @code{tinfo_key} member to the @code{TINFO_*} value of your class. Otherwise
3406 it will be set by the constructor of the superclass and all hell will break
3407 loose in the RTTI. For your convenience, the @code{basic} class provides
3408 a constructor that takes a @code{tinfo_key} value, which we are using here
3409 (remember that in our case @code{inherited = basic}). If the superclass
3410 didn't have such a constructor, we would have to set the @code{tinfo_key}
3411 to the right value manually.
3412
3413 In the default constructor you should set all other member variables to
3414 reasonable default values (we don't need that here since our @code{str}
3415 member gets set to an empty string automatically). The constructor(s) are of
3416 course also the right place to allocate any dynamic resources you require.
3417
3418 Next, the @code{destroy()} function:
3419
3420 @example
3421 void mystring::destroy(bool call_parent)
3422 @{
3423     // free dynamically allocated resources here if required
3424     if (call_parent)
3425         inherited::destroy(call_parent);
3426 @}
3427 @end example
3428
3429 This function is where we free all dynamically allocated resources. We don't
3430 have any so we're not doing anything here, but if we had, for example, used
3431 a C-style @code{char *} to store our string, this would be the place to
3432 @code{delete[]} the string storage. If @code{call_parent} is true, we have
3433 to call the @code{destroy()} function of the superclass after we're done
3434 (to mimic C++'s automatic invocation of superclass destructors where
3435 @code{destroy()} is called from outside a destructor).
3436
3437 The @code{copy()} function just copies over the member variables from
3438 another object:
3439
3440 @example
3441 void mystring::copy(const mystring &other)
3442 @{
3443     inherited::copy(other);
3444     str = other.str;
3445 @}
3446 @end example
3447
3448 We can simply overwrite the member variables here. There's no need to worry
3449 about dynamically allocated storage. The assignment operator (which is
3450 automatically defined by @code{GINAC_IMPLEMENT_REGISTERED_CLASS}, as you
3451 recall) calls @code{destroy()} before it calls @code{copy()}. You have to
3452 explicitly call the @code{copy()} function of the superclass here so
3453 all the member variables will get copied.
3454
3455 Next are the three functions for archiving. You have to implement them even
3456 if you don't plan to use archives, but the minimum required implementation
3457 is really simple. First, the archiving function:
3458
3459 @example
3460 void mystring::archive(archive_node &n) const
3461 @{
3462     inherited::archive(n);
3463     n.add_string("string", str);
3464 @}
3465 @end example
3466
3467 The only thing that is really required is calling the @code{archive()}
3468 function of the superclass. Optionally, you can store all information you
3469 deem necessary for representing the object into the passed
3470 @code{archive_node}. We are just storing our string here. For more
3471 information on how the archiving works, consult the @file{archive.h} header
3472 file.
3473
3474 The unarchiving constructor is basically the inverse of the archiving
3475 function:
3476
3477 @example
3478 mystring::mystring(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
3479 @{
3480     n.find_string("string", str);
3481 @}
3482 @end example
3483
3484 If you don't need archiving, just leave this function empty (but you must
3485 invoke the unarchiving constructor of the superclass). Note that we don't
3486 have to set the @code{tinfo_key} here because it is done automatically
3487 by the unarchiving constructor of the @code{basic} class.
3488
3489 Finally, the unarchiving function:
3490
3491 @example
3492 ex mystring::unarchive(const archive_node &n, const lst &sym_lst)
3493 @{
3494     return (new mystring(n, sym_lst))->setflag(status_flags::dynallocated);
3495 @}
3496 @end example
3497
3498 You don't have to understand how exactly this works. Just copy these four
3499 lines into your code literally (replacing the class name, of course). It
3500 calls the unarchiving constructor of the class and unless you are doing
3501 something very special (like matching @code{archive_node}s to global
3502 objects) you don't need a different implementation. For those who are
3503 interested: setting the @code{dynallocated} flag puts the object under
3504 the control of GiNaC's garbage collection. It will get deleted automatically
3505 once it is no longer referenced.
3506
3507 Our @code{compare_same_type()} function uses a provided function to compare
3508 the string members:
3509
3510 @example
3511 int mystring::compare_same_type(const basic &other) const
3512 @{
3513     const mystring &o = static_cast<const mystring &>(other);
3514     int cmpval = str.compare(o.str);
3515     if (cmpval == 0)
3516         return 0;
3517     else if (cmpval < 0)
3518         return -1;
3519     else
3520         return 1;
3521 @}
3522 @end example
3523
3524 Although this function takes a @code{basic &}, it will always be a reference
3525 to an object of exactly the same class (objects of different classes are not
3526 comparable), so the cast is safe. If this function returns 0, the two objects
3527 are considered equal (in the sense that @math{A-B=0}), so you should compare
3528 all relevant member variables.
3529
3530 Now the only thing missing is our two new constructors:
3531
3532 @example
3533 mystring::mystring(const string &s) : inherited(TINFO_mystring), str(s)
3534 @{
3535     // dynamically allocate resources here if required
3536 @}
3537
3538 mystring::mystring(const char *s) : inherited(TINFO_mystring), str(s)
3539 @{
3540     // dynamically allocate resources here if required
3541 @}
3542 @end example
3543
3544 No surprises here. We set the @code{str} member from the argument and
3545 remember to pass the right @code{tinfo_key} to the @code{basic} constructor.
3546
3547 That's it! We now have a minimal working GiNaC class that can store
3548 strings in algebraic expressions. Let's confirm that the RTTI works:
3549
3550 @example
3551 ex e = mystring("Hello, world!");
3552 cout << is_ex_of_type(e, mystring) << endl;
3553  // -> 1 (true)
3554
3555 cout << e.bp->class_name() << endl;
3556  // -> mystring
3557 @end example
3558
3559 Obviously it does. Let's see what the expression @code{e} looks like:
3560
3561 @example
3562 cout << e << endl;
3563  // -> [mystring object]
3564 @end example
3565
3566 Hm, not exactly what we expect, but of course the @code{mystring} class
3567 doesn't yet know how to print itself. This is done in the @code{print()}
3568 member function. Let's say that we wanted to print the string surrounded
3569 by double quotes:
3570
3571 @example
3572 class mystring : public basic
3573 @{
3574     ...
3575 public:
3576     void print(const print_context &c, unsigned level = 0) const;
3577     ...
3578 @};
3579
3580 void mystring::print(const print_context &c, unsigned level) const
3581 @{
3582     // print_context::s is a reference to an ostream
3583     c.s << '\"' << str << '\"';
3584 @}
3585 @end example
3586
3587 The @code{level} argument is only required for container classes to
3588 correctly parenthesize the output. Let's try again to print the expression:
3589
3590 @example
3591 cout << e << endl;
3592  // -> "Hello, world!"
3593 @end example
3594
3595 Much better. The @code{mystring} class can be used in arbitrary expressions:
3596
3597 @example
3598 e += mystring("GiNaC rulez"); 
3599 cout << e << endl;
3600  // -> "GiNaC rulez"+"Hello, world!"
3601 @end example
3602
3603 (note that GiNaC's automatic term reordering is in effect here), or even
3604
3605 @example
3606 e = pow(mystring("One string"), 2*sin(Pi-mystring("Another string")));
3607 cout << e << endl;
3608  // -> "One string"^(2*sin(-"Another string"+Pi))
3609 @end example
3610
3611 Whether this makes sense is debatable but remember that this is only an
3612 example. At least it allows you to implement your own symbolic algorithms
3613 for your objects.
3614
3615 Note that GiNaC's algebraic rules remain unchanged:
3616
3617 @example
3618 e = mystring("Wow") * mystring("Wow");
3619 cout << e << endl;
3620  // -> "Wow"^2
3621
3622 e = pow(mystring("First")-mystring("Second"), 2);
3623 cout << e.expand() << endl;
3624  // -> -2*"First"*"Second"+"First"^2+"Second"^2
3625 @end example
3626
3627 There's no way to, for example, make GiNaC's @code{add} class perform string
3628 concatenation. You would have to implement this yourself.
3629
3630 @subsection Automatic evaluation
3631
3632 @cindex @code{hold()}
3633 @cindex evaluation
3634 When dealing with objects that are just a little more complicated than the
3635 simple string objects we have implemented, chances are that you will want to
3636 have some automatic simplifications or canonicalizations performed on them.
3637 This is done in the evaluation member function @code{eval()}. Let's say that
3638 we wanted all strings automatically converted to lowercase with
3639 non-alphabetic characters stripped, and empty strings removed:
3640
3641 @example
3642 class mystring : public basic
3643 @{
3644     ...
3645 public:
3646     ex eval(int level = 0) const;
3647     ...
3648 @};
3649
3650 ex mystring::eval(int level) const
3651 @{
3652     string new_str;
3653     for (int i=0; i<str.length(); i++) @{
3654         char c = str[i];
3655         if (c >= 'A' && c <= 'Z') 
3656             new_str += tolower(c);
3657         else if (c >= 'a' && c <= 'z')
3658             new_str += c;
3659     @}
3660
3661     if (new_str.length() == 0)
3662         return _ex0();
3663     else
3664         return mystring(new_str).hold();
3665 @}
3666 @end example
3667
3668 The @code{level} argument is used to limit the recursion depth of the
3669 evaluation. We don't have any subexpressions in the @code{mystring} class
3670 so we are not concerned with this. If we had, we would call the @code{eval()}
3671 functions of the subexpressions with @code{level - 1} as the argument if
3672 @code{level != 1}. The @code{hold()} member function sets a flag in the
3673 object that prevents further evaluation. Otherwise we might end up in an
3674 endless loop. When you want to return the object unmodified, use
3675 @code{return this->hold();}.
3676
3677 Let's confirm that it works:
3678
3679 @example
3680 ex e = mystring("Hello, world!") + mystring("!?#");
3681 cout << e << endl;
3682  // -> "helloworld"
3683
3684 e = mystring("Wow!") + mystring("WOW") + mystring(" W ** o ** W");  
3685 cout << e << endl;
3686  // -> 3*"wow"
3687 @end example
3688
3689 @subsection Other member functions
3690
3691 We have implemented only a small set of member functions to make the class
3692 work in the GiNaC framework. For a real algebraic class, there are probably
3693 some more functions that you will want to re-implement, such as
3694 @code{evalf()}, @code{series()} or @code{op()}. Have a look at @file{basic.h}
3695 or the header file of the class you want to make a subclass of to see
3696 what's there. You can, of course, also add your own new member functions.
3697 In this case you will probably want to define a little helper function like
3698
3699 @example
3700 inline const mystring &ex_to_mystring(const ex &e)
3701 @{
3702     return static_cast<const mystring &>(*e.bp);
3703 @}
3704 @end example
3705
3706 that let's you get at the object inside an expression (after you have verified
3707 that the type is correct) so you can call member functions that are specific
3708 to the class.
3709
3710 That's it. May the source be with you!
3711
3712
3713 @node A Comparison With Other CAS, Advantages, Adding classes, Top
3714 @c    node-name, next, previous, up
3715 @chapter A Comparison With Other CAS
3716 @cindex advocacy
3717
3718 This chapter will give you some information on how GiNaC compares to
3719 other, traditional Computer Algebra Systems, like @emph{Maple},
3720 @emph{Mathematica} or @emph{Reduce}, where it has advantages and
3721 disadvantages over these systems.
3722
3723 @menu
3724 * Advantages::                       Stengths of the GiNaC approach.
3725 * Disadvantages::                    Weaknesses of the GiNaC approach.
3726 * Why C++?::                         Attractiveness of C++.
3727 @end menu
3728
3729 @node Advantages, Disadvantages, A Comparison With Other CAS, A Comparison With Other CAS
3730 @c    node-name, next, previous, up
3731 @section Advantages
3732
3733 GiNaC has several advantages over traditional Computer
3734 Algebra Systems, like 
3735
3736 @itemize @bullet
3737
3738 @item
3739 familiar language: all common CAS implement their own proprietary
3740 grammar which you have to learn first (and maybe learn again when your
3741 vendor decides to `enhance' it).  With GiNaC you can write your program
3742 in common C++, which is standardized.
3743
3744 @cindex STL
3745 @item
3746 structured data types: you can build up structured data types using
3747 @code{struct}s or @code{class}es together with STL features instead of
3748 using unnamed lists of lists of lists.
3749
3750 @item
3751 strongly typed: in CAS, you usually have only one kind of variables
3752 which can hold contents of an arbitrary type.  This 4GL like feature is
3753 nice for novice programmers, but dangerous.
3754     
3755 @item
3756 development tools: powerful development tools exist for C++, like fancy
3757 editors (e.g. with automatic indentation and syntax highlighting),
3758 debuggers, visualization tools, documentation generators...
3759
3760 @item
3761 modularization: C++ programs can easily be split into modules by
3762 separating interface and implementation.
3763
3764 @item
3765 price: GiNaC is distributed under the GNU Public License which means
3766 that it is free and available with source code.  And there are excellent
3767 C++-compilers for free, too.
3768     
3769 @item
3770 extendable: you can add your own classes to GiNaC, thus extending it on
3771 a very low level.  Compare this to a traditional CAS that you can
3772 usually only extend on a high level by writing in the language defined
3773 by the parser.  In particular, it turns out to be almost impossible to
3774 fix bugs in a traditional system.
3775
3776 @item
3777 multiple interfaces: Though real GiNaC programs have to be written in
3778 some editor, then be compiled, linked and executed, there are more ways
3779 to work with the GiNaC engine.  Many people want to play with
3780 expressions interactively, as in traditional CASs.  Currently, two such
3781 windows into GiNaC have been implemented and many more are possible: the
3782 tiny @command{ginsh} that is part of the distribution exposes GiNaC's
3783 types to a command line and second, as a more consistent approach, an
3784 interactive interface to the @acronym{Cint} C++ interpreter has been put
3785 together (called @acronym{GiNaC-cint}) that allows an interactive
3786 scripting interface consistent with the C++ language.
3787
3788 @item
3789 seemless integration: it is somewhere between difficult and impossible
3790 to call CAS functions from within a program written in C++ or any other
3791 programming language and vice versa.  With GiNaC, your symbolic routines
3792 are part of your program.  You can easily call third party libraries,
3793 e.g. for numerical evaluation or graphical interaction.  All other
3794 approaches are much more cumbersome: they range from simply ignoring the
3795 problem (i.e. @emph{Maple}) to providing a method for `embedding' the
3796 system (i.e. @emph{Yacas}).
3797
3798 @item
3799 efficiency: often large parts of a program do not need symbolic
3800 calculations at all.  Why use large integers for loop variables or
3801 arbitrary precision arithmetics where @code{int} and @code{double} are
3802 sufficient?  For pure symbolic applications, GiNaC is comparable in
3803 speed with other CAS.
3804
3805 @end itemize
3806
3807
3808 @node Disadvantages, Why C++?, Advantages, A Comparison With Other CAS
3809 @c    node-name, next, previous, up
3810 @section Disadvantages
3811
3812 Of course it also has some disadvantages:
3813
3814 @itemize @bullet
3815
3816 @item
3817 advanced features: GiNaC cannot compete with a program like
3818 @emph{Reduce} which exists for more than 30 years now or @emph{Maple}
3819 which grows since 1981 by the work of dozens of programmers, with
3820 respect to mathematical features.  Integration, factorization,
3821 non-trivial simplifications, limits etc. are missing in GiNaC (and are
3822 not planned for the near future).
3823
3824 @item
3825 portability: While the GiNaC library itself is designed to avoid any
3826 platform dependent features (it should compile on any ANSI compliant C++
3827 compiler), the currently used version of the CLN library (fast large
3828 integer and arbitrary precision arithmetics) can be compiled only on
3829 systems with a recently new C++ compiler from the GNU Compiler
3830 Collection (@acronym{GCC}).@footnote{This is because CLN uses
3831 PROVIDE/REQUIRE like macros to let the compiler gather all static
3832 initializations, which works for GNU C++ only.}  GiNaC uses recent
3833 language features like explicit constructors, mutable members, RTTI,
3834 @code{dynamic_cast}s and STL, so ANSI compliance is meant literally.
3835 Recent @acronym{GCC} versions starting at 2.95, although itself not yet
3836 ANSI compliant, support all needed features.
3837     
3838 @end itemize
3839
3840
3841 @node Why C++?, Internal Structures, Disadvantages, A Comparison With Other CAS
3842 @c    node-name, next, previous, up
3843 @section Why C++?
3844
3845 Why did we choose to implement GiNaC in C++ instead of Java or any other
3846 language?  C++ is not perfect: type checking is not strict (casting is
3847 possible), separation between interface and implementation is not
3848 complete, object oriented design is not enforced.  The main reason is
3849 the often scolded feature of operator overloading in C++.  While it may
3850 be true that operating on classes with a @code{+} operator is rarely
3851 meaningful, it is perfectly suited for algebraic expressions.  Writing
3852 @math{3x+5y} as @code{3*x+5*y} instead of
3853 @code{x.times(3).plus(y.times(5))} looks much more natural.
3854 Furthermore, the main developers are more familiar with C++ than with
3855 any other programming language.
3856
3857
3858 @node Internal Structures, Expressions are reference counted, Why C++? , Top
3859 @c    node-name, next, previous, up
3860 @appendix Internal Structures
3861
3862 @menu
3863 * Expressions are reference counted::
3864 * Internal representation of products and sums::
3865 @end menu
3866
3867 @node Expressions are reference counted, Internal representation of products and sums, Internal Structures, Internal Structures
3868 @c    node-name, next, previous, up
3869 @appendixsection Expressions are reference counted
3870
3871 @cindex reference counting
3872 @cindex copy-on-write
3873 @cindex garbage collection
3874 An expression is extremely light-weight since internally it works like a
3875 handle to the actual representation and really holds nothing more than a
3876 pointer to some other object. What this means in practice is that
3877 whenever you create two @code{ex} and set the second equal to the first
3878 no copying process is involved. Instead, the copying takes place as soon
3879 as you try to change the second.  Consider the simple sequence of code:
3880
3881 @example
3882 #include <ginac/ginac.h>
3883 using namespace std;
3884 using namespace GiNaC;
3885
3886 int main()
3887 @{
3888     symbol x("x"), y("y"), z("z");
3889     ex e1, e2;
3890
3891     e1 = sin(x + 2*y) + 3*z + 41;
3892     e2 = e1;                // e2 points to same object as e1
3893     cout << e2 << endl;     // prints sin(x+2*y)+3*z+41
3894     e2 += 1;                // e2 is copied into a new object
3895     cout << e2 << endl;     // prints sin(x+2*y)+3*z+42
3896 @}
3897 @end example
3898
3899 The line @code{e2 = e1;} creates a second expression pointing to the
3900 object held already by @code{e1}.  The time involved for this operation
3901 is therefore constant, no matter how large @code{e1} was.  Actual
3902 copying, however, must take place in the line @code{e2 += 1;} because
3903 @code{e1} and @code{e2} are not handles for the same object any more.
3904 This concept is called @dfn{copy-on-write semantics}.  It increases
3905 performance considerably whenever one object occurs multiple times and
3906 represents a simple garbage collection scheme because when an @code{ex}
3907 runs out of scope its destructor checks whether other expressions handle
3908 the object it points to too and deletes the object from memory if that
3909 turns out not to be the case.  A slightly less trivial example of
3910 differentiation using the chain-rule should make clear how powerful this
3911 can be:
3912
3913 @example
3914 #include <ginac/ginac.h>
3915 using namespace std;
3916 using namespace GiNaC;
3917
3918 int main()
3919 @{
3920     symbol x("x"), y("y");
3921
3922     ex e1 = x + 3*y;
3923     ex e2 = pow(e1, 3);
3924     ex e3 = diff(sin(e2), x);   // first derivative of sin(e2) by x
3925     cout << e1 << endl          // prints x+3*y
3926          << e2 << endl          // prints (x+3*y)^3
3927          << e3 << endl;         // prints 3*(x+3*y)^2*cos((x+3*y)^3)
3928 @}
3929 @end example
3930
3931 Here, @code{e1} will actually be referenced three times while @code{e2}
3932 will be referenced two times.  When the power of an expression is built,
3933 that expression needs not be copied.  Likewise, since the derivative of
3934 a power of an expression can be easily expressed in terms of that
3935 expression, no copying of @code{e1} is involved when @code{e3} is
3936 constructed.  So, when @code{e3} is constructed it will print as
3937 @code{3*(x+3*y)^2*cos((x+3*y)^3)} but the argument of @code{cos()} only
3938 holds a reference to @code{e2} and the factor in front is just
3939 @code{3*e1^2}.
3940
3941 As a user of GiNaC, you cannot see this mechanism of copy-on-write
3942 semantics.  When you insert an expression into a second expression, the
3943 result behaves exactly as if the contents of the first expression were
3944 inserted.  But it may be useful to remember that this is not what
3945 happens.  Knowing this will enable you to write much more efficient
3946 code.  If you still have an uncertain feeling with copy-on-write
3947 semantics, we recommend you have a look at the
3948 @uref{http://www.cerfnet.com/~mpcline/c++-faq-lite/, C++-FAQ lite} by
3949 Marshall Cline.  Chapter 16 covers this issue and presents an
3950 implementation which is pretty close to the one in GiNaC.
3951
3952
3953 @node Internal representation of products and sums, Package Tools, Expressions are reference counted, Internal Structures
3954 @c    node-name, next, previous, up
3955 @appendixsection Internal representation of products and sums
3956
3957 @cindex representation
3958 @cindex @code{add}
3959 @cindex @code{mul}
3960 @cindex @code{power}
3961 Although it should be completely transparent for the user of
3962 GiNaC a short discussion of this topic helps to understand the sources
3963 and also explain performance to a large degree.  Consider the 
3964 unexpanded symbolic expression 
3965 @tex
3966 $2d^3 \left( 4a + 5b - 3 \right)$
3967 @end tex
3968 @ifnottex
3969 @math{2*d^3*(4*a+5*b-3)}
3970 @end ifnottex
3971 which could naively be represented by a tree of linear containers for
3972 addition and multiplication, one container for exponentiation with base
3973 and exponent and some atomic leaves of symbols and numbers in this
3974 fashion:
3975
3976 @image{repnaive}
3977
3978 @cindex pair-wise representation
3979 However, doing so results in a rather deeply nested tree which will
3980 quickly become inefficient to manipulate.  We can improve on this by
3981 representing the sum as a sequence of terms, each one being a pair of a
3982 purely numeric multiplicative coefficient and its rest.  In the same
3983 spirit we can store the multiplication as a sequence of terms, each
3984 having a numeric exponent and a possibly complicated base, the tree
3985 becomes much more flat:
3986
3987 @image{reppair}
3988
3989 The number @code{3} above the symbol @code{d} shows that @code{mul}
3990 objects are treated similarly where the coefficients are interpreted as
3991 @emph{exponents} now.  Addition of sums of terms or multiplication of
3992 products with numerical exponents can be coded to be very efficient with
3993 such a pair-wise representation.  Internally, this handling is performed
3994 by most CAS in this way.  It typically speeds up manipulations by an
3995 order of magnitude.  The overall multiplicative factor @code{2} and the
3996 additive term @code{-3} look somewhat out of place in this
3997 representation, however, since they are still carrying a trivial
3998 exponent and multiplicative factor @code{1} respectively.  Within GiNaC,
3999 this is avoided by adding a field that carries an overall numeric
4000 coefficient.  This results in the realistic picture of internal
4001 representation for
4002 @tex
4003 $2d^3 \left( 4a + 5b - 3 \right)$:
4004 @end tex
4005 @ifnottex
4006 @math{2*d^3*(4*a+5*b-3)}:
4007 @end ifnottex
4008
4009 @image{repreal}
4010
4011 @cindex radical
4012 This also allows for a better handling of numeric radicals, since
4013 @code{sqrt(2)} can now be carried along calculations.  Now it should be
4014 clear, why both classes @code{add} and @code{mul} are derived from the
4015 same abstract class: the data representation is the same, only the
4016 semantics differs.  In the class hierarchy, methods for polynomial
4017 expansion and the like are reimplemented for @code{add} and @code{mul},
4018 but the data structure is inherited from @code{expairseq}.
4019
4020
4021 @node Package Tools, ginac-config, Internal representation of products and sums, Top
4022 @c    node-name, next, previous, up
4023 @appendix Package Tools
4024
4025 If you are creating a software package that uses the GiNaC library,
4026 setting the correct command line options for the compiler and linker
4027 can be difficult. GiNaC includes two tools to make this process easier.
4028
4029 @menu
4030 * ginac-config::   A shell script to detect compiler and linker flags.
4031 * AM_PATH_GINAC::  Macro for GNU automake.
4032 @end menu
4033
4034
4035 @node ginac-config, AM_PATH_GINAC, Package Tools, Package Tools
4036 @c    node-name, next, previous, up
4037 @section @command{ginac-config}
4038 @cindex ginac-config
4039
4040 @command{ginac-config} is a shell script that you can use to determine
4041 the compiler and linker command line options required to compile and
4042 link a program with the GiNaC library.
4043
4044 @command{ginac-config} takes the following flags:
4045
4046 @table @samp
4047 @item --version
4048 Prints out the version of GiNaC installed.
4049 @item --cppflags
4050 Prints '-I' flags pointing to the installed header files.
4051 @item --libs
4052 Prints out the linker flags necessary to link a program against GiNaC.
4053 @item --prefix[=@var{PREFIX}]
4054 If @var{PREFIX} is specified, overrides the configured value of @env{$prefix}.
4055 (And of exec-prefix, unless @code{--exec-prefix} is also specified)
4056 Otherwise, prints out the configured value of @env{$prefix}.
4057 @item --exec-prefix[=@var{PREFIX}]
4058 If @var{PREFIX} is specified, overrides the configured value of @env{$exec_prefix}.
4059 Otherwise, prints out the configured value of @env{$exec_prefix}.
4060 @end table
4061
4062 Typically, @command{ginac-config} will be used within a configure
4063 script, as described below. It, however, can also be used directly from
4064 the command line using backquotes to compile a simple program. For
4065 example:
4066
4067 @example
4068 c++ -o simple `ginac-config --cppflags` simple.cpp `ginac-config --libs`
4069 @end example
4070
4071 This command line might expand to (for example):
4072
4073 @example
4074 cc -o simple -I/usr/local/include simple.cpp -L/usr/local/lib \
4075   -lginac -lcln -lstdc++
4076 @end example
4077
4078 Not only is the form using @command{ginac-config} easier to type, it will
4079 work on any system, no matter how GiNaC was configured.
4080
4081
4082 @node AM_PATH_GINAC, Configure script options, ginac-config, Package Tools
4083 @c    node-name, next, previous, up
4084 @section @samp{AM_PATH_GINAC}
4085 @cindex AM_PATH_GINAC
4086
4087 For packages configured using GNU automake, GiNaC also provides
4088 a macro to automate the process of checking for GiNaC.
4089
4090 @example
4091 AM_PATH_GINAC([@var{MINIMUM-VERSION}, [@var{ACTION-IF-FOUND} [, @var{ACTION-IF-NOT-FOUND}]]])
4092 @end example
4093
4094 This macro:
4095
4096 @itemize @bullet
4097
4098 @item
4099 Determines the location of GiNaC using @command{ginac-config}, which is
4100 either found in the user's path, or from the environment variable
4101 @env{GINACLIB_CONFIG}.
4102
4103 @item
4104 Tests the installed libraries to make sure that their version
4105 is later than @var{MINIMUM-VERSION}. (A default version will be used
4106 if not specified)
4107
4108 @item
4109 If the required version was found, sets the @env{GINACLIB_CPPFLAGS} variable
4110 to the output of @command{ginac-config --cppflags} and the @env{GINACLIB_LIBS}
4111 variable to the output of @command{ginac-config --libs}, and calls
4112 @samp{AC_SUBST()} for these variables so they can be used in generated
4113 makefiles, and then executes @var{ACTION-IF-FOUND}.
4114
4115 @item
4116 If the required version was not found, sets @env{GINACLIB_CPPFLAGS} and
4117 @env{GINACLIB_LIBS} to empty strings, and executes @var{ACTION-IF-NOT-FOUND}.
4118
4119 @end itemize
4120
4121 This macro is in file @file{ginac.m4} which is installed in
4122 @file{$datadir/aclocal}. Note that if automake was installed with a
4123 different @samp{--prefix} than GiNaC, you will either have to manually
4124 move @file{ginac.m4} to automake's @file{$datadir/aclocal}, or give
4125 aclocal the @samp{-I} option when running it.
4126
4127 @menu
4128 * Configure script options::  Configuring a package that uses AM_PATH_GINAC.
4129 * Example package::           Example of a package using AM_PATH_GINAC.
4130 @end menu
4131
4132
4133 @node Configure script options, Example package, AM_PATH_GINAC, AM_PATH_GINAC
4134 @c    node-name, next, previous, up
4135 @subsection Configuring a package that uses @samp{AM_PATH_GINAC}
4136
4137 Simply make sure that @command{ginac-config} is in your path, and run
4138 the configure script.
4139
4140 Notes:
4141
4142 @itemize @bullet
4143
4144 @item
4145 The directory where the GiNaC libraries are installed needs
4146 to be found by your system's dynamic linker.
4147   
4148 This is generally done by
4149
4150 @display
4151 editing @file{/etc/ld.so.conf} and running @command{ldconfig}
4152 @end display
4153
4154 or by
4155    
4156 @display
4157 setting the environment variable @env{LD_LIBRARY_PATH},
4158 @end display
4159
4160 or, as a last resort, 
4161  
4162 @display
4163 giving a @samp{-R} or @samp{-rpath} flag (depending on your linker) when
4164 running configure, for instance:
4165
4166 @example
4167 LDFLAGS=-R/home/cbauer/lib ./configure
4168 @end example
4169 @end display
4170
4171 @item
4172 You can also specify a @command{ginac-config} not in your path by
4173 setting the @env{GINACLIB_CONFIG} environment variable to the
4174 name of the executable
4175
4176 @item
4177 If you move the GiNaC package from its installed location,
4178 you will either need to modify @command{ginac-config} script
4179 manually to point to the new location or rebuild GiNaC.
4180
4181 @end itemize
4182
4183 Advanced note:
4184
4185 @itemize @bullet
4186 @item
4187 configure flags
4188   
4189 @example
4190 --with-ginac-prefix=@var{PREFIX}
4191 --with-ginac-exec-prefix=@var{PREFIX}
4192 @end example
4193
4194 are provided to override the prefix and exec-prefix that were stored
4195 in the @command{ginac-config} shell script by GiNaC's configure. You are
4196 generally better off configuring GiNaC with the right path to begin with.
4197 @end itemize
4198
4199
4200 @node Example package, Bibliography, Configure script options, AM_PATH_GINAC
4201 @c    node-name, next, previous, up
4202 @subsection Example of a package using @samp{AM_PATH_GINAC}
4203
4204 The following shows how to build a simple package using automake
4205 and the @samp{AM_PATH_GINAC} macro. The program used here is @file{simple.cpp}:
4206
4207 @example
4208 #include <ginac/ginac.h>
4209
4210 int main(void)
4211 @{
4212     GiNaC::symbol x("x");
4213     GiNaC::ex a = GiNaC::sin(x);
4214     std::cout << "Derivative of " << a 
4215               << " is " << a.diff(x) << std::endl;
4216     return 0;
4217 @}
4218 @end example
4219
4220 You should first read the introductory portions of the automake
4221 Manual, if you are not already familiar with it.
4222
4223 Two files are needed, @file{configure.in}, which is used to build the
4224 configure script:
4225
4226 @example
4227 dnl Process this file with autoconf to produce a configure script.
4228 AC_INIT(simple.cpp)
4229 AM_INIT_AUTOMAKE(simple.cpp, 1.0.0)
4230
4231 AC_PROG_CXX
4232 AC_PROG_INSTALL
4233 AC_LANG_CPLUSPLUS
4234
4235 AM_PATH_GINAC(0.7.0, [
4236   LIBS="$LIBS $GINACLIB_LIBS"
4237   CPPFLAGS="$CPPFLAGS $GINACLIB_CPPFLAGS"  
4238 ], AC_MSG_ERROR([need to have GiNaC installed]))
4239
4240 AC_OUTPUT(Makefile)
4241 @end example
4242
4243 The only command in this which is not standard for automake
4244 is the @samp{AM_PATH_GINAC} macro.
4245
4246 That command does the following: If a GiNaC version greater or equal
4247 than 0.7.0 is found, then it adds @env{$GINACLIB_LIBS} to @env{$LIBS}
4248 and @env{$GINACLIB_CPPFLAGS} to @env{$CPPFLAGS}. Otherwise, it dies with
4249 the error message `need to have GiNaC installed'
4250
4251 And the @file{Makefile.am}, which will be used to build the Makefile.
4252
4253 @example
4254 ## Process this file with automake to produce Makefile.in
4255 bin_PROGRAMS = simple
4256 simple_SOURCES = simple.cpp
4257 @end example
4258
4259 This @file{Makefile.am}, says that we are building a single executable,
4260 from a single sourcefile @file{simple.cpp}. Since every program
4261 we are building uses GiNaC we simply added the GiNaC options
4262 to @env{$LIBS} and @env{$CPPFLAGS}, but in other circumstances, we might
4263 want to specify them on a per-program basis: for instance by
4264 adding the lines:
4265
4266 @example
4267 simple_LDADD = $(GINACLIB_LIBS)
4268 INCLUDES = $(GINACLIB_CPPFLAGS)
4269 @end example
4270
4271 to the @file{Makefile.am}.
4272
4273 To try this example out, create a new directory and add the three
4274 files above to it.
4275
4276 Now execute the following commands:
4277
4278 @example
4279 $ automake --add-missing
4280 $ aclocal
4281 $ autoconf
4282 @end example
4283
4284 You now have a package that can be built in the normal fashion
4285
4286 @example
4287 $ ./configure
4288 $ make
4289 $ make install
4290 @end example
4291
4292
4293 @node Bibliography, Concept Index, Example package, Top
4294 @c    node-name, next, previous, up
4295 @appendix Bibliography
4296
4297 @itemize @minus{}
4298
4299 @item
4300 @cite{ISO/IEC 14882:1998: Programming Languages: C++}
4301
4302 @item
4303 @cite{CLN: A Class Library for Numbers}, @email{haible@@ilog.fr, Bruno Haible}
4304
4305 @item
4306 @cite{The C++ Programming Language}, Bjarne Stroustrup, 3rd Edition, ISBN 0-201-88954-4, Addison Wesley
4307
4308 @item
4309 @cite{C++ FAQs}, Marshall Cline, ISBN 0-201-58958-3, 1995, Addison Wesley
4310
4311 @item
4312 @cite{Algorithms for Computer Algebra}, Keith O. Geddes, Stephen R. Czapor,
4313 and George Labahn, ISBN 0-7923-9259-0, 1992, Kluwer Academic Publishers, Norwell, Massachusetts
4314
4315 @item
4316 @cite{Computer Algebra: Systems and Algorithms for Algebraic Computation},
4317 J.H. Davenport, Y. Siret, and E. Tournier, ISBN 0-12-204230-1, 1988, 
4318 Academic Press, London
4319
4320 @end itemize
4321
4322
4323 @node Concept Index, , Bibliography, Top
4324 @c    node-name, next, previous, up
4325 @unnumbered Concept Index
4326
4327 @printindex cp
4328
4329 @bye