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