documented symmetrize() and antisymmetrize()
[ginac.git] / doc / tutorial / ginac.texi
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename ginac.info
4 @settitle GiNaC, an open framework for symbolic computation within the C++ programming language
5 @setchapternewpage on
6 @afourpaper
7 @c For `info' only.
8 @paragraphindent 0
9 @c For TeX only.
10 @iftex
11 @c I hate putting "@noindent" in front of every paragraph.
12 @parindent=0pt
13 @end iftex
14 @c %**end of header
15
16 @include version.texi
17
18 @direntry
19 * ginac: (ginac).                   C++ library for symbolic computation.
20 @end direntry
21
22 @ifinfo
23 This is a tutorial that documents GiNaC @value{VERSION}, an open
24 framework for symbolic computation within the C++ programming language.
25
26 Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
27
28 Permission is granted to make and distribute verbatim copies of
29 this manual provided the copyright notice and this permission notice
30 are preserved on all copies.
31
32 @ignore
33 Permission is granted to process this file through TeX and print the
34 results, provided the printed document carries copying permission
35 notice identical to this one except for the removal of this paragraph
36
37 @end ignore
38 Permission is granted to copy and distribute modified versions of this
39 manual under the conditions for verbatim copying, provided that the entire
40 resulting derived work is distributed under the terms of a permission
41 notice identical to this one.
42 @end ifinfo
43
44 @finalout
45 @c finalout prevents ugly black rectangles on overfull hbox lines
46 @titlepage
47 @title GiNaC @value{VERSION}
48 @subtitle An open framework for symbolic computation within the C++ programming language
49 @subtitle @value{UPDATED}
50 @author The GiNaC Group:
51 @author Christian Bauer, Alexander Frink, Richard Kreckel
52
53 @page
54 @vskip 0pt plus 1filll
55 Copyright @copyright{} 1999-2001 Johannes Gutenberg University Mainz, Germany
56 @sp 2
57 Permission is granted to make and distribute verbatim copies of
58 this manual provided the copyright notice and this permission notice
59 are preserved on all copies.
60
61 Permission is granted to copy and distribute modified versions of this
62 manual under the conditions for verbatim copying, provided that the entire
63 resulting derived work is distributed under the terms of a permission
64 notice identical to this one.
65 @end titlepage
66
67 @page
68 @contents
69
70 @page
71
72
73 @node Top, Introduction, (dir), (dir)
74 @c    node-name, next, previous, up
75 @top GiNaC
76
77 This is a tutorial that documents GiNaC @value{VERSION}, an open
78 framework for symbolic computation within the C++ programming language.
79
80 @menu
81 * Introduction::                 GiNaC's purpose.
82 * A Tour of GiNaC::              A quick tour of the library.
83 * Installation::                 How to install the package.
84 * Basic Concepts::               Description of fundamental classes.
85 * Methods and Functions::        Algorithms for symbolic manipulations.
86 * Extending GiNaC::              How to extend the library.
87 * A Comparison With Other CAS::  Compares GiNaC to traditional CAS.
88 * Internal Structures::          Description of some internal structures.
89 * Package Tools::                Configuring packages to work with GiNaC.
90 * Bibliography::
91 * Concept Index::
92 @end menu
93
94
95 @node Introduction, A Tour of GiNaC, Top, Top
96 @c    node-name, next, previous, up
97 @chapter Introduction
98 @cindex history of GiNaC
99
100 The motivation behind GiNaC derives from the observation that most
101 present day computer algebra systems (CAS) are linguistically and
102 semantically impoverished.  Although they are quite powerful tools for
103 learning math and solving particular problems they lack modern
104 linguistical structures that allow for the creation of large-scale
105 projects.  GiNaC is an attempt to overcome this situation by extending a
106 well established and standardized computer language (C++) by some
107 fundamental symbolic capabilities, thus allowing for integrated systems
108 that embed symbolic manipulations together with more established areas
109 of computer science (like computation-intense numeric applications,
110 graphical interfaces, etc.) under one roof.
111
112 The particular problem that led to the writing of the GiNaC framework is
113 still a very active field of research, namely the calculation of higher
114 order corrections to elementary particle interactions.  There,
115 theoretical physicists are interested in matching present day theories
116 against experiments taking place at particle accelerators.  The
117 computations involved are so complex they call for a combined symbolical
118 and numerical approach.  This turned out to be quite difficult to
119 accomplish with the present day CAS we have worked with so far and so we
120 tried to fill the gap by writing GiNaC.  But of course its applications
121 are in no way restricted to theoretical physics.
122
123 This tutorial is intended for the novice user who is new to GiNaC but
124 already has some background in C++ programming.  However, since a
125 hand-made documentation like this one is difficult to keep in sync with
126 the development, the actual documentation is inside the sources in the
127 form of comments.  That documentation may be parsed by one of the many
128 Javadoc-like documentation systems.  If you fail at generating it you
129 may access it from @uref{http://www.ginac.de/reference/, the GiNaC home
130 page}.  It is an invaluable resource not only for the advanced user who
131 wishes to extend the system (or chase bugs) but for everybody who wants
132 to comprehend the inner workings of GiNaC.  This little tutorial on the
133 other hand only covers the basic things that are unlikely to change in
134 the near future.
135
136 @section License
137 The GiNaC framework for symbolic computation within the C++ programming
138 language is Copyright @copyright{} 1999-2001 Johannes Gutenberg
139 University Mainz, Germany.
140
141 This program is free software; you can redistribute it and/or
142 modify it under the terms of the GNU General Public License as
143 published by the Free Software Foundation; either version 2 of the
144 License, or (at your option) any later version.
145
146 This program is distributed in the hope that it will be useful, but
147 WITHOUT ANY WARRANTY; without even the implied warranty of
148 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
149 General Public License for more details.
150
151 You should have received a copy of the GNU General Public License
152 along with this program; see the file COPYING.  If not, write to the
153 Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
154 MA 02111-1307, USA.
155
156
157 @node A Tour of GiNaC, How to use it from within C++, Introduction, Top
158 @c    node-name, next, previous, up
159 @chapter A Tour of GiNaC
160
161 This quick tour of GiNaC wants to arise your interest in the
162 subsequent chapters by showing off a bit.  Please excuse us if it
163 leaves many open questions.
164
165 @menu
166 * How to use it from within C++::  Two simple examples.
167 * What it can do for you::         A Tour of GiNaC's features.
168 @end menu
169
170
171 @node How to use it from within C++, What it can do for you, A Tour of GiNaC, A Tour of GiNaC
172 @c    node-name, next, previous, up
173 @section How to use it from within C++
174
175 The GiNaC open framework for symbolic computation within the C++ programming
176 language does not try to define a language of its own as conventional
177 CAS do.  Instead, it extends the capabilities of C++ by symbolic
178 manipulations.  Here is how to generate and print a simple (and rather
179 pointless) bivariate polynomial with some large coefficients:
180
181 @example
182 #include <ginac/ginac.h>
183 using namespace std;
184 using namespace GiNaC;
185
186 int main()
187 @{
188     symbol x("x"), y("y");
189     ex poly;
190
191     for (int i=0; i<3; ++i)
192         poly += factorial(i+16)*pow(x,i)*pow(y,2-i);
193
194     cout << poly << endl;
195     return 0;
196 @}
197 @end example
198
199 Assuming the file is called @file{hello.cc}, on our system we can compile
200 and run it like this:
201
202 @example
203 $ c++ hello.cc -o hello -lcln -lginac
204 $ ./hello
205 355687428096000*x*y+20922789888000*y^2+6402373705728000*x^2
206 @end example
207
208 (@xref{Package Tools}, for tools that help you when creating a software
209 package that uses GiNaC.)
210
211 @cindex Hermite polynomial
212 Next, there is a more meaningful C++ program that calls a function which
213 generates Hermite polynomials in a specified free variable.
214
215 @example
216 #include <ginac/ginac.h>
217 using namespace std;
218 using namespace GiNaC;
219
220 ex HermitePoly(const symbol & x, int n)
221 @{
222     ex HKer=exp(-pow(x, 2));
223     // uses the identity H_n(x) == (-1)^n exp(x^2) (d/dx)^n exp(-x^2)
224     return normal(pow(-1, n) * diff(HKer, x, n) / HKer);
225 @}
226
227 int main()
228 @{
229     symbol z("z");
230
231     for (int i=0; i<6; ++i)
232         cout << "H_" << i << "(z) == " << HermitePoly(z,i) << endl;
233
234     return 0;
235 @}
236 @end example
237
238 When run, this will type out
239
240 @example
241 H_0(z) == 1
242 H_1(z) == 2*z
243 H_2(z) == 4*z^2-2
244 H_3(z) == -12*z+8*z^3
245 H_4(z) == -48*z^2+16*z^4+12
246 H_5(z) == 120*z-160*z^3+32*z^5
247 @end example
248
249 This method of generating the coefficients is of course far from optimal
250 for production purposes.
251
252 In order to show some more examples of what GiNaC can do we will now use
253 the @command{ginsh}, a simple GiNaC interactive shell that provides a
254 convenient window into GiNaC's capabilities.
255
256
257 @node What it can do for you, Installation, How to use it from within C++, A Tour of GiNaC
258 @c    node-name, next, previous, up
259 @section What it can do for you
260
261 @cindex @command{ginsh}
262 After invoking @command{ginsh} one can test and experiment with GiNaC's
263 features much like in other Computer Algebra Systems except that it does
264 not provide programming constructs like loops or conditionals.  For a
265 concise description of the @command{ginsh} syntax we refer to its
266 accompanied man page. Suffice to say that assignments and comparisons in
267 @command{ginsh} are written as they are in C, i.e. @code{=} assigns and
268 @code{==} compares.
269
270 It can manipulate arbitrary precision integers in a very fast way.
271 Rational numbers are automatically converted to fractions of coprime
272 integers:
273
274 @example
275 > x=3^150;
276 369988485035126972924700782451696644186473100389722973815184405301748249
277 > y=3^149;
278 123329495011708990974900260817232214728824366796574324605061468433916083
279 > x/y;
280 3
281 > y/x;
282 1/3
283 @end example
284
285 Exact numbers are always retained as exact numbers and only evaluated as
286 floating point numbers if requested.  For instance, with numeric
287 radicals is dealt pretty much as with symbols.  Products of sums of them
288 can be expanded:
289
290 @example
291 > expand((1+a^(1/5)-a^(2/5))^3);
292 1+3*a+3*a^(1/5)-5*a^(3/5)-a^(6/5)
293 > expand((1+3^(1/5)-3^(2/5))^3);
294 10-5*3^(3/5)
295 > evalf((1+3^(1/5)-3^(2/5))^3);
296 0.33408977534118624228
297 @end example
298
299 The function @code{evalf} that was used above converts any number in
300 GiNaC's expressions into floating point numbers.  This can be done to
301 arbitrary predefined accuracy:
302
303 @example
304 > evalf(1/7);
305 0.14285714285714285714
306 > Digits=150;
307 150
308 > evalf(1/7);
309 0.1428571428571428571428571428571428571428571428571428571428571428571428
310 5714285714285714285714285714285714285
311 @end example
312
313 Exact numbers other than rationals that can be manipulated in GiNaC
314 include predefined constants like Archimedes' @code{Pi}.  They can both
315 be used in symbolic manipulations (as an exact number) as well as in
316 numeric expressions (as an inexact number):
317
318 @example
319 > a=Pi^2+x;
320 x+Pi^2
321 > evalf(a);
322 9.869604401089358619+x
323 > x=2;
324 2
325 > evalf(a);
326 11.869604401089358619
327 @end example
328
329 Built-in functions evaluate immediately to exact numbers if
330 this is possible.  Conversions that can be safely performed are done
331 immediately; conversions that are not generally valid are not done:
332
333 @example
334 > cos(42*Pi);
335 1
336 > cos(acos(x));
337 x
338 > acos(cos(x));
339 acos(cos(x))
340 @end example
341
342 (Note that converting the last input to @code{x} would allow one to
343 conclude that @code{42*Pi} is equal to @code{0}.)
344
345 Linear equation systems can be solved along with basic linear
346 algebra manipulations over symbolic expressions.  In C++ GiNaC offers
347 a matrix class for this purpose but we can see what it can do using
348 @command{ginsh}'s notation of double brackets to type them in:
349
350 @example
351 > lsolve(a+x*y==z,x);
352 y^(-1)*(z-a);
353 > lsolve([3*x+5*y == 7, -2*x+10*y == -5], [x, y]);
354 [x==19/8,y==-1/40]
355 > M = [[ [[1, 3]], [[-3, 2]] ]];
356 [[ [[1,3]], [[-3,2]] ]]
357 > determinant(M);
358 11
359 > charpoly(M,lambda);
360 lambda^2-3*lambda+11
361 @end example
362
363 Multivariate polynomials and rational functions may be expanded,
364 collected and normalized (i.e. converted to a ratio of two coprime 
365 polynomials):
366
367 @example
368 > a = x^4 + 2*x^2*y^2 + 4*x^3*y + 12*x*y^3 - 3*y^4;
369 12*x*y^3+2*x^2*y^2+4*x^3*y-3*y^4+x^4
370 > b = x^2 + 4*x*y - y^2;
371 4*x*y-y^2+x^2
372 > expand(a*b);
373 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
374 > collect(a+b,x);
375 4*x^3*y-y^2-3*y^4+(12*y^3+4*y)*x+x^4+x^2*(1+2*y^2)
376 > collect(a+b,y);
377 12*x*y^3-3*y^4+(-1+2*x^2)*y^2+(4*x+4*x^3)*y+x^2+x^4
378 > normal(a/b);
379 3*y^2+x^2
380 @end example
381
382 You can differentiate functions and expand them as Taylor or Laurent
383 series in a very natural syntax (the second argument of @code{series} is
384 a relation defining the evaluation point, the third specifies the
385 order):
386
387 @cindex Zeta function
388 @example
389 > diff(tan(x),x);
390 tan(x)^2+1
391 > series(sin(x),x==0,4);
392 x-1/6*x^3+Order(x^4)
393 > series(1/tan(x),x==0,4);
394 x^(-1)-1/3*x+Order(x^2)
395 > series(tgamma(x),x==0,3);
396 x^(-1)-Euler+(1/12*Pi^2+1/2*Euler^2)*x+
397 (-1/3*zeta(3)-1/12*Pi^2*Euler-1/6*Euler^3)*x^2+Order(x^3)
398 > evalf(");
399 x^(-1)-0.5772156649015328606+(0.9890559953279725555)*x
400 -(0.90747907608088628905)*x^2+Order(x^3)
401 > series(tgamma(2*sin(x)-2),x==Pi/2,6);
402 -(x-1/2*Pi)^(-2)+(-1/12*Pi^2-1/2*Euler^2-1/240)*(x-1/2*Pi)^2
403 -Euler-1/12+Order((x-1/2*Pi)^3)
404 @end example
405
406 Here we have made use of the @command{ginsh}-command @code{"} to pop the
407 previously evaluated element from @command{ginsh}'s internal stack.
408
409 If you ever wanted to convert units in C or C++ and found this is
410 cumbersome, here is the solution.  Symbolic types can always be used as
411 tags for different types of objects.  Converting from wrong units to the
412 metric system is now easy:
413
414 @example
415 > in=.0254*m;
416 0.0254*m
417 > lb=.45359237*kg;
418 0.45359237*kg
419 > 200*lb/in^2;
420 140613.91592783185568*kg*m^(-2)
421 @end example
422
423
424 @node Installation, Prerequisites, What it can do for you, Top
425 @c    node-name, next, previous, up
426 @chapter Installation
427
428 @cindex CLN
429 GiNaC's installation follows the spirit of most GNU software. It is
430 easily installed on your system by three steps: configuration, build,
431 installation.
432
433 @menu
434 * Prerequisites::                Packages upon which GiNaC depends.
435 * Configuration::                How to configure GiNaC.
436 * Building GiNaC::               How to compile GiNaC.
437 * Installing GiNaC::             How to install GiNaC on your system.
438 @end menu
439
440
441 @node Prerequisites, Configuration, Installation, Installation
442 @c    node-name, next, previous, up
443 @section Prerequisites
444
445 In order to install GiNaC on your system, some prerequisites need to be
446 met.  First of all, you need to have a C++-compiler adhering to the
447 ANSI-standard @cite{ISO/IEC 14882:1998(E)}.  We used @acronym{GCC} for
448 development so if you have a different compiler you are on your own.
449 For the configuration to succeed you need a Posix compliant shell
450 installed in @file{/bin/sh}, GNU @command{bash} is fine.  Perl is needed
451 by the built process as well, since some of the source files are
452 automatically generated by Perl scripts.  Last but not least, Bruno
453 Haible's library @acronym{CLN} is extensively used and needs to be
454 installed on your system.  Please get it either from
455 @uref{ftp://ftp.santafe.edu/pub/gnu/}, from
456 @uref{ftp://ftpthep.physik.uni-mainz.de/pub/gnu/, GiNaC's FTP site} or
457 from @uref{ftp://ftp.ilog.fr/pub/Users/haible/gnu/, Bruno Haible's FTP
458 site} (it is covered by GPL) and install it prior to trying to install
459 GiNaC.  The configure script checks if it can find it and if it cannot
460 it will refuse to continue.
461
462
463 @node Configuration, Building GiNaC, Prerequisites, Installation
464 @c    node-name, next, previous, up
465 @section Configuration
466 @cindex configuration
467 @cindex Autoconf
468
469 To configure GiNaC means to prepare the source distribution for
470 building.  It is done via a shell script called @command{configure} that
471 is shipped with the sources and was originally generated by GNU
472 Autoconf.  Since a configure script generated by GNU Autoconf never
473 prompts, all customization must be done either via command line
474 parameters or environment variables.  It accepts a list of parameters,
475 the complete set of which can be listed by calling it with the
476 @option{--help} option.  The most important ones will be shortly
477 described in what follows:
478
479 @itemize @bullet
480
481 @item
482 @option{--disable-shared}: When given, this option switches off the
483 build of a shared library, i.e. a @file{.so} file.  This may be convenient
484 when developing because it considerably speeds up compilation.
485
486 @item
487 @option{--prefix=@var{PREFIX}}: The directory where the compiled library
488 and headers are installed. It defaults to @file{/usr/local} which means
489 that the library is installed in the directory @file{/usr/local/lib},
490 the header files in @file{/usr/local/include/ginac} and the documentation
491 (like this one) into @file{/usr/local/share/doc/GiNaC}.
492
493 @item
494 @option{--libdir=@var{LIBDIR}}: Use this option in case you want to have
495 the library installed in some other directory than
496 @file{@var{PREFIX}/lib/}.
497
498 @item
499 @option{--includedir=@var{INCLUDEDIR}}: Use this option in case you want
500 to have the header files installed in some other directory than
501 @file{@var{PREFIX}/include/ginac/}. For instance, if you specify
502 @option{--includedir=/usr/include} you will end up with the header files
503 sitting in the directory @file{/usr/include/ginac/}. Note that the
504 subdirectory @file{ginac} is enforced by this process in order to
505 keep the header files separated from others.  This avoids some
506 clashes and allows for an easier deinstallation of GiNaC. This ought
507 to be considered A Good Thing (tm).
508
509 @item
510 @option{--datadir=@var{DATADIR}}: This option may be given in case you
511 want to have the documentation installed in some other directory than
512 @file{@var{PREFIX}/share/doc/GiNaC/}.
513
514 @end itemize
515
516 In addition, you may specify some environment variables.
517 @env{CXX} holds the path and the name of the C++ compiler
518 in case you want to override the default in your path.  (The
519 @command{configure} script searches your path for @command{c++},
520 @command{g++}, @command{gcc}, @command{CC}, @command{cxx}
521 and @command{cc++} in that order.)  It may be very useful to
522 define some compiler flags with the @env{CXXFLAGS} environment
523 variable, like optimization, debugging information and warning
524 levels.  If omitted, it defaults to @option{-g -O2}.
525
526 The whole process is illustrated in the following two
527 examples. (Substitute @command{setenv @var{VARIABLE} @var{value}} for
528 @command{export @var{VARIABLE}=@var{value}} if the Berkeley C shell is
529 your login shell.)
530
531 Here is a simple configuration for a site-wide GiNaC library assuming
532 everything is in default paths:
533
534 @example
535 $ export CXXFLAGS="-Wall -O2"
536 $ ./configure
537 @end example
538
539 And here is a configuration for a private static GiNaC library with
540 several components sitting in custom places (site-wide @acronym{GCC} and
541 private @acronym{CLN}).  The compiler is pursuaded to be picky and full
542 assertions and debugging information are switched on:
543
544 @example
545 $ export CXX=/usr/local/gnu/bin/c++
546 $ export CPPFLAGS="$(CPPFLAGS) -I$(HOME)/include"
547 $ export CXXFLAGS="$(CXXFLAGS) -DDO_GINAC_ASSERT -ggdb -Wall -ansi -pedantic"
548 $ export LDFLAGS="$(LDFLAGS) -L$(HOME)/lib"
549 $ ./configure --disable-shared --prefix=$(HOME)
550 @end example
551
552
553 @node Building GiNaC, Installing GiNaC, Configuration, Installation
554 @c    node-name, next, previous, up
555 @section Building GiNaC
556 @cindex building GiNaC
557
558 After proper configuration you should just build the whole
559 library by typing
560 @example
561 $ make
562 @end example
563 at the command prompt and go for a cup of coffee.  The exact time it
564 takes to compile GiNaC depends not only on the speed of your machines
565 but also on other parameters, for instance what value for @env{CXXFLAGS}
566 you entered.  Optimization may be very time-consuming.
567
568 Just to make sure GiNaC works properly you may run a collection of
569 regression tests by typing
570
571 @example
572 $ make check
573 @end example
574
575 This will compile some sample programs, run them and check the output
576 for correctness.  The regression tests fall in three categories.  First,
577 the so called @emph{exams} are performed, simple tests where some
578 predefined input is evaluated (like a pupils' exam).  Second, the
579 @emph{checks} test the coherence of results among each other with
580 possible random input.  Third, some @emph{timings} are performed, which
581 benchmark some predefined problems with different sizes and display the
582 CPU time used in seconds.  Each individual test should return a message
583 @samp{passed}.  This is mostly intended to be a QA-check if something
584 was broken during development, not a sanity check of your system.  Some
585 of the tests in sections @emph{checks} and @emph{timings} may require
586 insane amounts of memory and CPU time.  Feel free to kill them if your
587 machine catches fire.  Another quite important intent is to allow people
588 to fiddle around with optimization.
589
590 Generally, the top-level Makefile runs recursively to the
591 subdirectories.  It is therfore safe to go into any subdirectory
592 (@code{doc/}, @code{ginsh/}, ...) and simply type @code{make}
593 @var{target} there in case something went wrong.
594
595
596 @node Installing GiNaC, Basic Concepts, Building GiNaC, Installation
597 @c    node-name, next, previous, up
598 @section Installing GiNaC
599 @cindex installation
600
601 To install GiNaC on your system, simply type
602
603 @example
604 $ make install
605 @end example
606
607 As described in the section about configuration the files will be
608 installed in the following directories (the directories will be created
609 if they don't already exist):
610
611 @itemize @bullet
612
613 @item
614 @file{libginac.a} will go into @file{@var{PREFIX}/lib/} (or
615 @file{@var{LIBDIR}}) which defaults to @file{/usr/local/lib/}.
616 So will @file{libginac.so} unless the configure script was
617 given the option @option{--disable-shared}.  The proper symlinks
618 will be established as well.
619
620 @item
621 All the header files will be installed into @file{@var{PREFIX}/include/ginac/}
622 (or @file{@var{INCLUDEDIR}/ginac/}, if specified).
623
624 @item
625 All documentation (HTML and Postscript) will be stuffed into
626 @file{@var{PREFIX}/share/doc/GiNaC/} (or
627 @file{@var{DATADIR}/doc/GiNaC/}, if @var{DATADIR} was specified).
628
629 @end itemize
630
631 For the sake of completeness we will list some other useful make
632 targets: @command{make clean} deletes all files generated by
633 @command{make}, i.e. all the object files.  In addition @command{make
634 distclean} removes all files generated by the configuration and
635 @command{make maintainer-clean} goes one step further and deletes files
636 that may require special tools to rebuild (like the @command{libtool}
637 for instance).  Finally @command{make uninstall} removes the installed
638 library, header files and documentation@footnote{Uninstallation does not
639 work after you have called @command{make distclean} since the
640 @file{Makefile} is itself generated by the configuration from
641 @file{Makefile.in} and hence deleted by @command{make distclean}.  There
642 are two obvious ways out of this dilemma.  First, you can run the
643 configuration again with the same @var{PREFIX} thus creating a
644 @file{Makefile} with a working @samp{uninstall} target.  Second, you can
645 do it by hand since you now know where all the files went during
646 installation.}.
647
648
649 @node Basic Concepts, Expressions, Installing GiNaC, Top
650 @c    node-name, next, previous, up
651 @chapter Basic Concepts
652
653 This chapter will describe the different fundamental objects that can be
654 handled by GiNaC.  But before doing so, it is worthwhile introducing you
655 to the more commonly used class of expressions, representing a flexible
656 meta-class for storing all mathematical objects.
657
658 @menu
659 * Expressions::                  The fundamental GiNaC class.
660 * The Class Hierarchy::          Overview of GiNaC's classes.
661 * Symbols::                      Symbolic objects.
662 * Numbers::                      Numerical objects.
663 * Constants::                    Pre-defined constants.
664 * Fundamental containers::       The power, add and mul classes.
665 * Lists::                        Lists of expressions.
666 * Mathematical functions::       Mathematical functions.
667 * Relations::                    Equality, Inequality and all that.
668 * Indexed objects::              Handling indexed quantities.
669 * Non-commutative objects::      Algebras with non-commutative products.
670 @end menu
671
672
673 @node Expressions, The Class Hierarchy, Basic Concepts, Basic Concepts
674 @c    node-name, next, previous, up
675 @section Expressions
676 @cindex expression (class @code{ex})
677 @cindex @code{has()}
678
679 The most common class of objects a user deals with is the expression
680 @code{ex}, representing a mathematical object like a variable, number,
681 function, sum, product, etc...  Expressions may be put together to form
682 new expressions, passed as arguments to functions, and so on.  Here is a
683 little collection of valid expressions:
684
685 @example
686 ex MyEx1 = 5;                       // simple number
687 ex MyEx2 = x + 2*y;                 // polynomial in x and y
688 ex MyEx3 = (x + 1)/(x - 1);         // rational expression
689 ex MyEx4 = sin(x + 2*y) + 3*z + 41; // containing a function
690 ex MyEx5 = MyEx4 + 1;               // similar to above
691 @end example
692
693 Expressions are handles to other more fundamental objects, that often
694 contain other expressions thus creating a tree of expressions
695 (@xref{Internal Structures}, for particular examples).  Most methods on
696 @code{ex} therefore run top-down through such an expression tree.  For
697 example, the method @code{has()} scans recursively for occurrences of
698 something inside an expression.  Thus, if you have declared @code{MyEx4}
699 as in the example above @code{MyEx4.has(y)} will find @code{y} inside
700 the argument of @code{sin} and hence return @code{true}.
701
702 The next sections will outline the general picture of GiNaC's class
703 hierarchy and describe the classes of objects that are handled by
704 @code{ex}.
705
706
707 @node The Class Hierarchy, Symbols, Expressions, Basic Concepts
708 @c    node-name, next, previous, up
709 @section The Class Hierarchy
710
711 GiNaC's class hierarchy consists of several classes representing
712 mathematical objects, all of which (except for @code{ex} and some
713 helpers) are internally derived from one abstract base class called
714 @code{basic}.  You do not have to deal with objects of class
715 @code{basic}, instead you'll be dealing with symbols, numbers,
716 containers of expressions and so on.
717
718 @cindex container
719 @cindex atom
720 To get an idea about what kinds of symbolic composits may be built we
721 have a look at the most important classes in the class hierarchy and
722 some of the relations among the classes:
723
724 @image{classhierarchy}
725
726 The abstract classes shown here (the ones without drop-shadow) are of no
727 interest for the user.  They are used internally in order to avoid code
728 duplication if two or more classes derived from them share certain
729 features.  An example is @code{expairseq}, a container for a sequence of
730 pairs each consisting of one expression and a number (@code{numeric}).
731 What @emph{is} visible to the user are the derived classes @code{add}
732 and @code{mul}, representing sums and products.  @xref{Internal
733 Structures}, where these two classes are described in more detail.  The
734 following table shortly summarizes what kinds of mathematical objects
735 are stored in the different classes:
736
737 @cartouche
738 @multitable @columnfractions .22 .78
739 @item @code{symbol} @tab Algebraic symbols @math{a}, @math{x}, @math{y}@dots{}
740 @item @code{constant} @tab Constants like 
741 @tex
742 $\pi$
743 @end tex
744 @ifnottex
745 @math{Pi}
746 @end ifnottex
747 @item @code{numeric} @tab All kinds of numbers, @math{42}, @math{7/3*I}, @math{3.14159}@dots{}
748 @item @code{add} @tab Sums like @math{x+y} or @math{a-(2*b)+3}
749 @item @code{mul} @tab Products like @math{x*y} or @math{2*a^2*(x+y+z)/b}
750 @item @code{ncmul} @tab Products of non-commutative objects
751 @item @code{power} @tab Exponentials such as @math{x^2}, @math{a^b}, 
752 @tex
753 $\sqrt{2}$
754 @end tex
755 @ifnottex
756 @code{sqrt(}@math{2}@code{)}
757 @end ifnottex
758 @dots{}
759 @item @code{pseries} @tab Power Series, e.g. @math{x-1/6*x^3+1/120*x^5+O(x^7)}
760 @item @code{function} @tab A symbolic function like @math{sin(2*x)}
761 @item @code{lst} @tab Lists of expressions [@math{x}, @math{2*y}, @math{3+z}]
762 @item @code{matrix} @tab @math{n}x@math{m} matrices of expressions
763 @item @code{relational} @tab A relation like the identity @math{x}@code{==}@math{y}
764 @item @code{indexed} @tab Indexed object like @math{A_ij}
765 @item @code{tensor} @tab Special tensor like the delta and metric tensors
766 @item @code{idx} @tab Index of an indexed object
767 @item @code{varidx} @tab Index with variance
768 @item @code{spinidx} @tab Index with variance and dot (used in Weyl-van-der-Waerden spinor formalism)
769 @item @code{wildcard} @tab Wildcard for pattern matching
770 @end multitable
771 @end cartouche
772
773 @node Symbols, Numbers, The Class Hierarchy, Basic Concepts
774 @c    node-name, next, previous, up
775 @section Symbols
776 @cindex @code{symbol} (class)
777 @cindex hierarchy of classes
778
779 @cindex atom
780 Symbols are for symbolic manipulation what atoms are for chemistry.  You
781 can declare objects of class @code{symbol} as any other object simply by
782 saying @code{symbol x,y;}.  There is, however, a catch in here having to
783 do with the fact that C++ is a compiled language.  The information about
784 the symbol's name is thrown away by the compiler but at a later stage
785 you may want to print expressions holding your symbols.  In order to
786 avoid confusion GiNaC's symbols are able to know their own name.  This
787 is accomplished by declaring its name for output at construction time in
788 the fashion @code{symbol x("x");}.  If you declare a symbol using the
789 default constructor (i.e. without string argument) the system will deal
790 out a unique name.  That name may not be suitable for printing but for
791 internal routines when no output is desired it is often enough.  We'll
792 come across examples of such symbols later in this tutorial.
793
794 This implies that the strings passed to symbols at construction time may
795 not be used for comparing two of them.  It is perfectly legitimate to
796 write @code{symbol x("x"),y("x");} but it is likely to lead into
797 trouble.  Here, @code{x} and @code{y} are different symbols and
798 statements like @code{x-y} will not be simplified to zero although the
799 output @code{x-x} looks funny.  Such output may also occur when there
800 are two different symbols in two scopes, for instance when you call a
801 function that declares a symbol with a name already existent in a symbol
802 in the calling function.  Again, comparing them (using @code{operator==}
803 for instance) will always reveal their difference.  Watch out, please.
804
805 @cindex @code{subs()}
806 Although symbols can be assigned expressions for internal reasons, you
807 should not do it (and we are not going to tell you how it is done).  If
808 you want to replace a symbol with something else in an expression, you
809 can use the expression's @code{.subs()} method (@xref{Substituting Expressions},
810 for more information).
811
812
813 @node Numbers, Constants, Symbols, Basic Concepts
814 @c    node-name, next, previous, up
815 @section Numbers
816 @cindex @code{numeric} (class)
817
818 @cindex GMP
819 @cindex CLN
820 @cindex rational
821 @cindex fraction
822 For storing numerical things, GiNaC uses Bruno Haible's library
823 @acronym{CLN}.  The classes therein serve as foundation classes for
824 GiNaC.  @acronym{CLN} stands for Class Library for Numbers or
825 alternatively for Common Lisp Numbers.  In order to find out more about
826 @acronym{CLN}'s internals the reader is refered to the documentation of
827 that library.  @inforef{Introduction, , cln}, for more
828 information. Suffice to say that it is by itself build on top of another
829 library, the GNU Multiple Precision library @acronym{GMP}, which is an
830 extremely fast library for arbitrary long integers and rationals as well
831 as arbitrary precision floating point numbers.  It is very commonly used
832 by several popular cryptographic applications.  @acronym{CLN} extends
833 @acronym{GMP} by several useful things: First, it introduces the complex
834 number field over either reals (i.e. floating point numbers with
835 arbitrary precision) or rationals.  Second, it automatically converts
836 rationals to integers if the denominator is unity and complex numbers to
837 real numbers if the imaginary part vanishes and also correctly treats
838 algebraic functions.  Third it provides good implementations of
839 state-of-the-art algorithms for all trigonometric and hyperbolic
840 functions as well as for calculation of some useful constants.
841
842 The user can construct an object of class @code{numeric} in several
843 ways.  The following example shows the four most important constructors.
844 It uses construction from C-integer, construction of fractions from two
845 integers, construction from C-float and construction from a string:
846
847 @example
848 #include <ginac/ginac.h>
849 using namespace GiNaC;
850
851 int main()
852 @{
853     numeric two(2);                       // exact integer 2
854     numeric r(2,3);                       // exact fraction 2/3
855     numeric e(2.71828);                   // floating point number
856     numeric p("3.1415926535897932385");   // floating point number
857     // Trott's constant in scientific notation:
858     numeric trott("1.0841015122311136151E-2");
859     
860     std::cout << two*p << std::endl;  // floating point 6.283...
861 @}
862 @end example
863
864 Note that all those constructors are @emph{explicit} which means you are
865 not allowed to write @code{numeric two=2;}.  This is because the basic
866 objects to be handled by GiNaC are the expressions @code{ex} and we want
867 to keep things simple and wish objects like @code{pow(x,2)} to be
868 handled the same way as @code{pow(x,a)}, which means that we need to
869 allow a general @code{ex} as base and exponent.  Therefore there is an
870 implicit constructor from C-integers directly to expressions handling
871 numerics at work in most of our examples.  This design really becomes
872 convenient when one declares own functions having more than one
873 parameter but it forbids using implicit constructors because that would
874 lead to compile-time ambiguities.
875
876 It may be tempting to construct numbers writing @code{numeric r(3/2)}.
877 This would, however, call C's built-in operator @code{/} for integers
878 first and result in a numeric holding a plain integer 1.  @strong{Never
879 use the operator @code{/} on integers} unless you know exactly what you
880 are doing!  Use the constructor from two integers instead, as shown in
881 the example above.  Writing @code{numeric(1)/2} may look funny but works
882 also.
883
884 @cindex @code{Digits}
885 @cindex accuracy
886 We have seen now the distinction between exact numbers and floating
887 point numbers.  Clearly, the user should never have to worry about
888 dynamically created exact numbers, since their `exactness' always
889 determines how they ought to be handled, i.e. how `long' they are.  The
890 situation is different for floating point numbers.  Their accuracy is
891 controlled by one @emph{global} variable, called @code{Digits}.  (For
892 those readers who know about Maple: it behaves very much like Maple's
893 @code{Digits}).  All objects of class numeric that are constructed from
894 then on will be stored with a precision matching that number of decimal
895 digits:
896
897 @example
898 #include <ginac/ginac.h>
899 using namespace std;
900 using namespace GiNaC;
901
902 void foo()
903 @{
904     numeric three(3.0), one(1.0);
905     numeric x = one/three;
906
907     cout << "in " << Digits << " digits:" << endl;
908     cout << x << endl;
909     cout << Pi.evalf() << endl;
910 @}
911
912 int main()
913 @{
914     foo();
915     Digits = 60;
916     foo();
917     return 0;
918 @}
919 @end example
920
921 The above example prints the following output to screen:
922
923 @example
924 in 17 digits:
925 0.333333333333333333
926 3.14159265358979324
927 in 60 digits:
928 0.333333333333333333333333333333333333333333333333333333333333333333
929 3.14159265358979323846264338327950288419716939937510582097494459231
930 @end example
931
932 It should be clear that objects of class @code{numeric} should be used
933 for constructing numbers or for doing arithmetic with them.  The objects
934 one deals with most of the time are the polymorphic expressions @code{ex}.
935
936 @subsection Tests on numbers
937
938 Once you have declared some numbers, assigned them to expressions and
939 done some arithmetic with them it is frequently desired to retrieve some
940 kind of information from them like asking whether that number is
941 integer, rational, real or complex.  For those cases GiNaC provides
942 several useful methods.  (Internally, they fall back to invocations of
943 certain CLN functions.)
944
945 As an example, let's construct some rational number, multiply it with
946 some multiple of its denominator and test what comes out:
947
948 @example
949 #include <ginac/ginac.h>
950 using namespace std;
951 using namespace GiNaC;
952
953 // some very important constants:
954 const numeric twentyone(21);
955 const numeric ten(10);
956 const numeric five(5);
957
958 int main()
959 @{
960     numeric answer = twentyone;
961
962     answer /= five;
963     cout << answer.is_integer() << endl;  // false, it's 21/5
964     answer *= ten;
965     cout << answer.is_integer() << endl;  // true, it's 42 now!
966 @}
967 @end example
968
969 Note that the variable @code{answer} is constructed here as an integer
970 by @code{numeric}'s copy constructor but in an intermediate step it
971 holds a rational number represented as integer numerator and integer
972 denominator.  When multiplied by 10, the denominator becomes unity and
973 the result is automatically converted to a pure integer again.
974 Internally, the underlying @acronym{CLN} is responsible for this
975 behaviour and we refer the reader to @acronym{CLN}'s documentation.
976 Suffice to say that the same behaviour applies to complex numbers as
977 well as return values of certain functions.  Complex numbers are
978 automatically converted to real numbers if the imaginary part becomes
979 zero.  The full set of tests that can be applied is listed in the
980 following table.
981
982 @cartouche
983 @multitable @columnfractions .30 .70
984 @item @strong{Method} @tab @strong{Returns true if the object is@dots{}}
985 @item @code{.is_zero()}
986 @tab @dots{}equal to zero
987 @item @code{.is_positive()}
988 @tab @dots{}not complex and greater than 0
989 @item @code{.is_integer()}
990 @tab @dots{}a (non-complex) integer
991 @item @code{.is_pos_integer()}
992 @tab @dots{}an integer and greater than 0
993 @item @code{.is_nonneg_integer()}
994 @tab @dots{}an integer and greater equal 0
995 @item @code{.is_even()}
996 @tab @dots{}an even integer
997 @item @code{.is_odd()}
998 @tab @dots{}an odd integer
999 @item @code{.is_prime()}
1000 @tab @dots{}a prime integer (probabilistic primality test)
1001 @item @code{.is_rational()}
1002 @tab @dots{}an exact rational number (integers are rational, too)
1003 @item @code{.is_real()}
1004 @tab @dots{}a real integer, rational or float (i.e. is not complex)
1005 @item @code{.is_cinteger()}
1006 @tab @dots{}a (complex) integer (such as @math{2-3*I})
1007 @item @code{.is_crational()}
1008 @tab @dots{}an exact (complex) rational number (such as @math{2/3+7/2*I})
1009 @end multitable
1010 @end cartouche
1011
1012
1013 @node Constants, Fundamental containers, Numbers, Basic Concepts
1014 @c    node-name, next, previous, up
1015 @section Constants
1016 @cindex @code{constant} (class)
1017
1018 @cindex @code{Pi}
1019 @cindex @code{Catalan}
1020 @cindex @code{Euler}
1021 @cindex @code{evalf()}
1022 Constants behave pretty much like symbols except that they return some
1023 specific number when the method @code{.evalf()} is called.
1024
1025 The predefined known constants are:
1026
1027 @cartouche
1028 @multitable @columnfractions .14 .30 .56
1029 @item @strong{Name} @tab @strong{Common Name} @tab @strong{Numerical Value (to 35 digits)}
1030 @item @code{Pi}
1031 @tab Archimedes' constant
1032 @tab 3.14159265358979323846264338327950288
1033 @item @code{Catalan}
1034 @tab Catalan's constant
1035 @tab 0.91596559417721901505460351493238411
1036 @item @code{Euler}
1037 @tab Euler's (or Euler-Mascheroni) constant
1038 @tab 0.57721566490153286060651209008240243
1039 @end multitable
1040 @end cartouche
1041
1042
1043 @node Fundamental containers, Lists, Constants, Basic Concepts
1044 @c    node-name, next, previous, up
1045 @section Fundamental containers: the @code{power}, @code{add} and @code{mul} classes
1046 @cindex polynomial
1047 @cindex @code{add}
1048 @cindex @code{mul}
1049 @cindex @code{power}
1050
1051 Simple polynomial expressions are written down in GiNaC pretty much like
1052 in other CAS or like expressions involving numerical variables in C.
1053 The necessary operators @code{+}, @code{-}, @code{*} and @code{/} have
1054 been overloaded to achieve this goal.  When you run the following
1055 code snippet, the constructor for an object of type @code{mul} is
1056 automatically called to hold the product of @code{a} and @code{b} and
1057 then the constructor for an object of type @code{add} is called to hold
1058 the sum of that @code{mul} object and the number one:
1059
1060 @example
1061     ...
1062     symbol a("a"), b("b");
1063     ex MyTerm = 1+a*b;
1064     ...
1065 @end example
1066
1067 @cindex @code{pow()}
1068 For exponentiation, you have already seen the somewhat clumsy (though C-ish)
1069 statement @code{pow(x,2);} to represent @code{x} squared.  This direct
1070 construction is necessary since we cannot safely overload the constructor
1071 @code{^} in C++ to construct a @code{power} object.  If we did, it would
1072 have several counterintuitive and undesired effects:
1073
1074 @itemize @bullet
1075 @item
1076 Due to C's operator precedence, @code{2*x^2} would be parsed as @code{(2*x)^2}.
1077 @item
1078 Due to the binding of the operator @code{^}, @code{x^a^b} would result in
1079 @code{(x^a)^b}. This would be confusing since most (though not all) other CAS
1080 interpret this as @code{x^(a^b)}.
1081 @item
1082 Also, expressions involving integer exponents are very frequently used,
1083 which makes it even more dangerous to overload @code{^} since it is then
1084 hard to distinguish between the semantics as exponentiation and the one
1085 for exclusive or.  (It would be embarassing to return @code{1} where one
1086 has requested @code{2^3}.)
1087 @end itemize
1088
1089 @cindex @command{ginsh}
1090 All effects are contrary to mathematical notation and differ from the
1091 way most other CAS handle exponentiation, therefore overloading @code{^}
1092 is ruled out for GiNaC's C++ part.  The situation is different in
1093 @command{ginsh}, there the exponentiation-@code{^} exists.  (Also note
1094 that the other frequently used exponentiation operator @code{**} does
1095 not exist at all in C++).
1096
1097 To be somewhat more precise, objects of the three classes described
1098 here, are all containers for other expressions.  An object of class
1099 @code{power} is best viewed as a container with two slots, one for the
1100 basis, one for the exponent.  All valid GiNaC expressions can be
1101 inserted.  However, basic transformations like simplifying
1102 @code{pow(pow(x,2),3)} to @code{x^6} automatically are only performed
1103 when this is mathematically possible.  If we replace the outer exponent
1104 three in the example by some symbols @code{a}, the simplification is not
1105 safe and will not be performed, since @code{a} might be @code{1/2} and
1106 @code{x} negative.
1107
1108 Objects of type @code{add} and @code{mul} are containers with an
1109 arbitrary number of slots for expressions to be inserted.  Again, simple
1110 and safe simplifications are carried out like transforming
1111 @code{3*x+4-x} to @code{2*x+4}.
1112
1113 The general rule is that when you construct such objects, GiNaC
1114 automatically creates them in canonical form, which might differ from
1115 the form you typed in your program.  This allows for rapid comparison of
1116 expressions, since after all @code{a-a} is simply zero.  Note, that the
1117 canonical form is not necessarily lexicographical ordering or in any way
1118 easily guessable.  It is only guaranteed that constructing the same
1119 expression twice, either implicitly or explicitly, results in the same
1120 canonical form.
1121
1122
1123 @node Lists, Mathematical functions, Fundamental containers, Basic Concepts
1124 @c    node-name, next, previous, up
1125 @section Lists of expressions
1126 @cindex @code{lst} (class)
1127 @cindex lists
1128 @cindex @code{nops()}
1129 @cindex @code{op()}
1130 @cindex @code{append()}
1131 @cindex @code{prepend()}
1132
1133 The GiNaC class @code{lst} serves for holding a list of arbitrary expressions.
1134 These are sometimes used to supply a variable number of arguments of the same
1135 type to GiNaC methods such as @code{subs()} and @code{to_rational()}, so you
1136 should have a basic understanding about them.
1137
1138 Lists of up to 15 expressions can be directly constructed from single
1139 expressions:
1140
1141 @example
1142 @{
1143     symbol x("x"), y("y");
1144     lst l(x, 2, y, x+y);
1145     // now, l is a list holding the expressions 'x', '2', 'y', and 'x+y'
1146     // ...
1147 @end example
1148
1149 Use the @code{nops()} method to determine the size (number of expressions) of
1150 a list and the @code{op()} method to access individual elements:
1151
1152 @example
1153     // ...
1154     cout << l.nops() << endl;                   // prints '4'
1155     cout << l.op(2) << " " << l.op(0) << endl;  // prints 'y x'
1156     // ...
1157 @end example
1158
1159 Finally you can append or prepend an expression to a list with the
1160 @code{append()} and @code{prepend()} methods:
1161
1162 @example
1163     // ...
1164     l.append(4*x);   // l is now [x, 2, y, x+y, 4*x]
1165     l.prepend(0);    // l is now [0, x, 2, y, x+y, 4*x]
1166 @}
1167 @end example
1168
1169
1170 @node Mathematical functions, Relations, Lists, Basic Concepts
1171 @c    node-name, next, previous, up
1172 @section Mathematical functions
1173 @cindex @code{function} (class)
1174 @cindex trigonometric function
1175 @cindex hyperbolic function
1176
1177 There are quite a number of useful functions hard-wired into GiNaC.  For
1178 instance, all trigonometric and hyperbolic functions are implemented
1179 (@xref{Built-in Functions}, for a complete list).
1180
1181 These functions are all objects of class @code{function}.  They accept
1182 one or more expressions as arguments and return one expression.  If the
1183 arguments are not numerical, the evaluation of the function may be
1184 halted, as it does in the next example, showing how a function returns
1185 itself twice and finally an expression that may be really useful:
1186
1187 @cindex Gamma function
1188 @cindex @code{subs()}
1189 @example
1190     ...
1191     symbol x("x"), y("y");    
1192     ex foo = x+y/2;
1193     cout << tgamma(foo) << endl;
1194      // -> tgamma(x+(1/2)*y)
1195     ex bar = foo.subs(y==1);
1196     cout << tgamma(bar) << endl;
1197      // -> tgamma(x+1/2)
1198     ex foobar = bar.subs(x==7);
1199     cout << tgamma(foobar) << endl;
1200      // -> (135135/128)*Pi^(1/2)
1201     ...
1202 @end example
1203
1204 Besides evaluation most of these functions allow differentiation, series
1205 expansion and so on.  Read the next chapter in order to learn more about
1206 this.
1207
1208
1209 @node Relations, Indexed objects, Mathematical functions, Basic Concepts
1210 @c    node-name, next, previous, up
1211 @section Relations
1212 @cindex @code{relational} (class)
1213
1214 Sometimes, a relation holding between two expressions must be stored
1215 somehow.  The class @code{relational} is a convenient container for such
1216 purposes.  A relation is by definition a container for two @code{ex} and
1217 a relation between them that signals equality, inequality and so on.
1218 They are created by simply using the C++ operators @code{==}, @code{!=},
1219 @code{<}, @code{<=}, @code{>} and @code{>=} between two expressions.
1220
1221 @xref{Mathematical functions}, for examples where various applications
1222 of the @code{.subs()} method show how objects of class relational are
1223 used as arguments.  There they provide an intuitive syntax for
1224 substitutions.  They are also used as arguments to the @code{ex::series}
1225 method, where the left hand side of the relation specifies the variable
1226 to expand in and the right hand side the expansion point.  They can also
1227 be used for creating systems of equations that are to be solved for
1228 unknown variables.  But the most common usage of objects of this class
1229 is rather inconspicuous in statements of the form @code{if
1230 (expand(pow(a+b,2))==a*a+2*a*b+b*b) @{...@}}.  Here, an implicit
1231 conversion from @code{relational} to @code{bool} takes place.  Note,
1232 however, that @code{==} here does not perform any simplifications, hence
1233 @code{expand()} must be called explicitly.
1234
1235
1236 @node Indexed objects, Non-commutative objects, Relations, Basic Concepts
1237 @c    node-name, next, previous, up
1238 @section Indexed objects
1239
1240 GiNaC allows you to handle expressions containing general indexed objects in
1241 arbitrary spaces. It is also able to canonicalize and simplify such
1242 expressions and perform symbolic dummy index summations. There are a number
1243 of predefined indexed objects provided, like delta and metric tensors.
1244
1245 There are few restrictions placed on indexed objects and their indices and
1246 it is easy to construct nonsense expressions, but our intention is to
1247 provide a general framework that allows you to implement algorithms with
1248 indexed quantities, getting in the way as little as possible.
1249
1250 @cindex @code{idx} (class)
1251 @cindex @code{indexed} (class)
1252 @subsection Indexed quantities and their indices
1253
1254 Indexed expressions in GiNaC are constructed of two special types of objects,
1255 @dfn{index objects} and @dfn{indexed objects}.
1256
1257 @itemize @bullet
1258
1259 @cindex contravariant
1260 @cindex covariant
1261 @cindex variance
1262 @item Index objects are of class @code{idx} or a subclass. Every index has
1263 a @dfn{value} and a @dfn{dimension} (which is the dimension of the space
1264 the index lives in) which can both be arbitrary expressions but are usually
1265 a number or a simple symbol. In addition, indices of class @code{varidx} have
1266 a @dfn{variance} (they can be co- or contravariant), and indices of class
1267 @code{spinidx} have a variance and can be @dfn{dotted} or @dfn{undotted}.
1268
1269 @item Indexed objects are of class @code{indexed} or a subclass. They
1270 contain a @dfn{base expression} (which is the expression being indexed), and
1271 one or more indices.
1272
1273 @end itemize
1274
1275 @strong{Note:} when printing expressions, covariant indices and indices
1276 without variance are denoted @samp{.i} while contravariant indices are
1277 denoted @samp{~i}. Dotted indices have a @samp{*} in front of the index
1278 value. In the following, we are going to use that notation in the text so
1279 instead of @math{A^i_jk} we will write @samp{A~i.j.k}. Index dimensions are
1280 not visible in the output.
1281
1282 A simple example shall illustrate the concepts:
1283
1284 @example
1285 #include <ginac/ginac.h>
1286 using namespace std;
1287 using namespace GiNaC;
1288
1289 int main()
1290 @{
1291     symbol i_sym("i"), j_sym("j");
1292     idx i(i_sym, 3), j(j_sym, 3);
1293
1294     symbol A("A");
1295     cout << indexed(A, i, j) << endl;
1296      // -> A.i.j
1297     ...
1298 @end example
1299
1300 The @code{idx} constructor takes two arguments, the index value and the
1301 index dimension. First we define two index objects, @code{i} and @code{j},
1302 both with the numeric dimension 3. The value of the index @code{i} is the
1303 symbol @code{i_sym} (which prints as @samp{i}) and the value of the index
1304 @code{j} is the symbol @code{j_sym} (which prints as @samp{j}). Next we
1305 construct an expression containing one indexed object, @samp{A.i.j}. It has
1306 the symbol @code{A} as its base expression and the two indices @code{i} and
1307 @code{j}.
1308
1309 Note the difference between the indices @code{i} and @code{j} which are of
1310 class @code{idx}, and the index values which are the sybols @code{i_sym}
1311 and @code{j_sym}. The indices of indexed objects cannot directly be symbols
1312 or numbers but must be index objects. For example, the following is not
1313 correct and will raise an exception:
1314
1315 @example
1316 symbol i("i"), j("j");
1317 e = indexed(A, i, j); // ERROR: indices must be of type idx
1318 @end example
1319
1320 You can have multiple indexed objects in an expression, index values can
1321 be numeric, and index dimensions symbolic:
1322
1323 @example
1324     ...
1325     symbol B("B"), dim("dim");
1326     cout << 4 * indexed(A, i)
1327           + indexed(B, idx(j_sym, 4), idx(2, 3), idx(i_sym, dim)) << endl;
1328      // -> B.j.2.i+4*A.i
1329     ...
1330 @end example
1331
1332 @code{B} has a 4-dimensional symbolic index @samp{k}, a 3-dimensional numeric
1333 index of value 2, and a symbolic index @samp{i} with the symbolic dimension
1334 @samp{dim}. Note that GiNaC doesn't automatically notify you that the free
1335 indices of @samp{A} and @samp{B} in the sum don't match (you have to call
1336 @code{simplify_indexed()} for that, see below).
1337
1338 In fact, base expressions, index values and index dimensions can be
1339 arbitrary expressions:
1340
1341 @example
1342     ...
1343     cout << indexed(A+B, idx(2*i_sym+1, dim/2)) << endl;
1344      // -> (B+A).(1+2*i)
1345     ...
1346 @end example
1347
1348 It's also possible to construct nonsense like @samp{Pi.sin(x)}. You will not
1349 get an error message from this but you will probably not be able to do
1350 anything useful with it.
1351
1352 @cindex @code{get_value()}
1353 @cindex @code{get_dimension()}
1354 The methods
1355
1356 @example
1357 ex idx::get_value(void);
1358 ex idx::get_dimension(void);
1359 @end example
1360
1361 return the value and dimension of an @code{idx} object. If you have an index
1362 in an expression, such as returned by calling @code{.op()} on an indexed
1363 object, you can get a reference to the @code{idx} object with the function
1364 @code{ex_to_idx()} on the expression.
1365
1366 There are also the methods
1367
1368 @example
1369 bool idx::is_numeric(void);
1370 bool idx::is_symbolic(void);
1371 bool idx::is_dim_numeric(void);
1372 bool idx::is_dim_symbolic(void);
1373 @end example
1374
1375 for checking whether the value and dimension are numeric or symbolic
1376 (non-numeric). Using the @code{info()} method of an index (see @ref{Information
1377 About Expressions}) returns information about the index value.
1378
1379 @cindex @code{varidx} (class)
1380 If you need co- and contravariant indices, use the @code{varidx} class:
1381
1382 @example
1383     ...
1384     symbol mu_sym("mu"), nu_sym("nu");
1385     varidx mu(mu_sym, 4), nu(nu_sym, 4); // default is contravariant ~mu, ~nu
1386     varidx mu_co(mu_sym, 4, true);       // covariant index .mu
1387
1388     cout << indexed(A, mu, nu) << endl;
1389      // -> A~mu~nu
1390     cout << indexed(A, mu_co, nu) << endl;
1391      // -> A.mu~nu
1392     cout << indexed(A, mu.toggle_variance(), nu) << endl;
1393      // -> A.mu~nu
1394     ...
1395 @end example
1396
1397 A @code{varidx} is an @code{idx} with an additional flag that marks it as
1398 co- or contravariant. The default is a contravariant (upper) index, but
1399 this can be overridden by supplying a third argument to the @code{varidx}
1400 constructor. The two methods
1401
1402 @example
1403 bool varidx::is_covariant(void);
1404 bool varidx::is_contravariant(void);
1405 @end example
1406
1407 allow you to check the variance of a @code{varidx} object (use @code{ex_to_varidx()}
1408 to get the object reference from an expression). There's also the very useful
1409 method
1410
1411 @example
1412 ex varidx::toggle_variance(void);
1413 @end example
1414
1415 which makes a new index with the same value and dimension but the opposite
1416 variance. By using it you only have to define the index once.
1417
1418 @cindex @code{spinidx} (class)
1419 The @code{spinidx} class provides dotted and undotted variant indices, as
1420 used in the Weyl-van-der-Waerden spinor formalism:
1421
1422 @example
1423     ...
1424     symbol K("K"), C_sym("C"), D_sym("D");
1425     spinidx C(C_sym, 2), D(D_sym);          // default is 2-dimensional,
1426                                             // contravariant, undotted
1427     spinidx C_co(C_sym, 2, true);           // covariant index
1428     spinidx D_dot(D_sym, 2, false, true);   // contravariant, dotted
1429     spinidx D_co_dot(D_sym, 2, true, true); // covariant, dotted
1430
1431     cout << indexed(K, C, D) << endl;
1432      // -> K~C~D
1433     cout << indexed(K, C_co, D_dot) << endl;
1434      // -> K.C~*D
1435     cout << indexed(K, D_co_dot, D) << endl;
1436      // -> K.*D~D
1437     ...
1438 @end example
1439
1440 A @code{spinidx} is a @code{varidx} with an additional flag that marks it as
1441 dotted or undotted. The default is undotted but this can be overridden by
1442 supplying a fourth argument to the @code{spinidx} constructor. The two
1443 methods
1444
1445 @example
1446 bool spinidx::is_dotted(void);
1447 bool spinidx::is_undotted(void);
1448 @end example
1449
1450 allow you to check whether or not a @code{spinidx} object is dotted (use
1451 @code{ex_to_spinidx()} to get the object reference from an expression).
1452 Finally, the two methods
1453
1454 @example
1455 ex spinidx::toggle_dot(void);
1456 ex spinidx::toggle_variance_dot(void);
1457 @end example
1458
1459 create a new index with the same value and dimension but opposite dottedness
1460 and the same or opposite variance.
1461
1462 @subsection Substituting indices
1463
1464 @cindex @code{subs()}
1465 Sometimes you will want to substitute one symbolic index with another
1466 symbolic or numeric index, for example when calculating one specific element
1467 of a tensor expression. This is done with the @code{.subs()} method, as it
1468 is done for symbols (see @ref{Substituting Expressions}).
1469
1470 You have two possibilities here. You can either substitute the whole index
1471 by another index or expression:
1472
1473 @example
1474     ...
1475     ex e = indexed(A, mu_co);
1476     cout << e << " becomes " << e.subs(mu_co == nu) << endl;
1477      // -> A.mu becomes A~nu
1478     cout << e << " becomes " << e.subs(mu_co == varidx(0, 4)) << endl;
1479      // -> A.mu becomes A~0
1480     cout << e << " becomes " << e.subs(mu_co == 0) << endl;
1481      // -> A.mu becomes A.0
1482     ...
1483 @end example
1484
1485 The third example shows that trying to replace an index with something that
1486 is not an index will substitute the index value instead.
1487
1488 Alternatively, you can substitute the @emph{symbol} of a symbolic index by
1489 another expression:
1490
1491 @example
1492     ...
1493     ex e = indexed(A, mu_co);
1494     cout << e << " becomes " << e.subs(mu_sym == nu_sym) << endl;
1495      // -> A.mu becomes A.nu
1496     cout << e << " becomes " << e.subs(mu_sym == 0) << endl;
1497      // -> A.mu becomes A.0
1498     ...
1499 @end example
1500
1501 As you see, with the second method only the value of the index will get
1502 substituted. Its other properties, including its dimension, remain unchanged.
1503 If you want to change the dimension of an index you have to substitute the
1504 whole index by another one with the new dimension.
1505
1506 Finally, substituting the base expression of an indexed object works as
1507 expected:
1508
1509 @example
1510     ...
1511     ex e = indexed(A, mu_co);
1512     cout << e << " becomes " << e.subs(A == A+B) << endl;
1513      // -> A.mu becomes (B+A).mu
1514     ...
1515 @end example
1516
1517 @subsection Symmetries
1518
1519 Indexed objects can be declared as being totally symmetric or antisymmetric
1520 with respect to their indices. In this case, GiNaC will automatically bring
1521 the indices into a canonical order which allows for some immediate
1522 simplifications:
1523
1524 @example
1525     ...
1526     cout << indexed(A, indexed::symmetric, i, j)
1527           + indexed(A, indexed::symmetric, j, i) << endl;
1528      // -> 2*A.j.i
1529     cout << indexed(B, indexed::antisymmetric, i, j)
1530           + indexed(B, indexed::antisymmetric, j, j) << endl;
1531      // -> -B.j.i
1532     cout << indexed(B, indexed::antisymmetric, i, j)
1533           + indexed(B, indexed::antisymmetric, j, i) << endl;
1534      // -> 0
1535     ...
1536 @end example
1537
1538 @cindex @code{get_free_indices()}
1539 @cindex Dummy index
1540 @subsection Dummy indices
1541
1542 GiNaC treats certain symbolic index pairs as @dfn{dummy indices} meaning
1543 that a summation over the index range is implied. Symbolic indices which are
1544 not dummy indices are called @dfn{free indices}. Numeric indices are neither
1545 dummy nor free indices.
1546
1547 To be recognized as a dummy index pair, the two indices must be of the same
1548 class and dimension and their value must be the same single symbol (an index
1549 like @samp{2*n+1} is never a dummy index). If the indices are of class
1550 @code{varidx} they must also be of opposite variance; if they are of class
1551 @code{spinidx} they must be both dotted or both undotted.
1552
1553 The method @code{.get_free_indices()} returns a vector containing the free
1554 indices of an expression. It also checks that the free indices of the terms
1555 of a sum are consistent:
1556
1557 @example
1558 @{
1559     symbol A("A"), B("B"), C("C");
1560
1561     symbol i_sym("i"), j_sym("j"), k_sym("k"), l_sym("l");
1562     idx i(i_sym, 3), j(j_sym, 3), k(k_sym, 3), l(l_sym, 3);
1563
1564     ex e = indexed(A, i, j) * indexed(B, j, k) + indexed(C, k, l, i, l);
1565     cout << exprseq(e.get_free_indices()) << endl;
1566      // -> (.i,.k)
1567      // 'j' and 'l' are dummy indices
1568
1569     symbol mu_sym("mu"), nu_sym("nu"), rho_sym("rho"), sigma_sym("sigma");
1570     varidx mu(mu_sym, 4), nu(nu_sym, 4), rho(rho_sym, 4), sigma(sigma_sym, 4);
1571
1572     e = indexed(A, mu, nu) * indexed(B, nu.toggle_variance(), rho)
1573       + indexed(C, mu, sigma, rho, sigma.toggle_variance());
1574     cout << exprseq(e.get_free_indices()) << endl;
1575      // -> (~mu,~rho)
1576      // 'nu' is a dummy index, but 'sigma' is not
1577
1578     e = indexed(A, mu, mu);
1579     cout << exprseq(e.get_free_indices()) << endl;
1580      // -> (~mu)
1581      // 'mu' is not a dummy index because it appears twice with the same
1582      // variance
1583
1584     e = indexed(A, mu, nu) + 42;
1585     cout << exprseq(e.get_free_indices()) << endl; // ERROR
1586      // this will throw an exception:
1587      // "add::get_free_indices: inconsistent indices in sum"
1588 @}
1589 @end example
1590
1591 @cindex @code{simplify_indexed()}
1592 @subsection Simplifying indexed expressions
1593
1594 In addition to the few automatic simplifications that GiNaC performs on
1595 indexed expressions (such as re-ordering the indices of symmetric tensors
1596 and calculating traces and convolutions of matrices and predefined tensors)
1597 there is the method
1598
1599 @example
1600 ex ex::simplify_indexed(void);
1601 ex ex::simplify_indexed(const scalar_products & sp);
1602 @end example
1603
1604 that performs some more expensive operations:
1605
1606 @itemize
1607 @item it checks the consistency of free indices in sums in the same way
1608   @code{get_free_indices()} does
1609 @item it tries to give dumy indices that appear in different terms of a sum
1610   the same name to allow simplifications like @math{a_i*b_i-a_j*b_j=0}
1611 @item it (symbolically) calculates all possible dummy index summations/contractions
1612   with the predefined tensors (this will be explained in more detail in the
1613   next section)
1614 @item as a special case of dummy index summation, it can replace scalar products
1615   of two tensors with a user-defined value
1616 @end itemize
1617
1618 The last point is done with the help of the @code{scalar_products} class
1619 which is used to store scalar products with known values (this is not an
1620 arithmetic class, you just pass it to @code{simplify_indexed()}):
1621
1622 @example
1623 @{
1624     symbol A("A"), B("B"), C("C"), i_sym("i");
1625     idx i(i_sym, 3);
1626
1627     scalar_products sp;
1628     sp.add(A, B, 0); // A and B are orthogonal
1629     sp.add(A, C, 0); // A and C are orthogonal
1630     sp.add(A, A, 4); // A^2 = 4 (A has length 2)
1631
1632     e = indexed(A + B, i) * indexed(A + C, i);
1633     cout << e << endl;
1634      // -> (B+A).i*(A+C).i
1635
1636     cout << e.expand(expand_options::expand_indexed).simplify_indexed(sp)
1637          << endl;
1638      // -> 4+C.i*B.i
1639 @}
1640 @end example
1641
1642 The @code{scalar_products} object @code{sp} acts as a storage for the
1643 scalar products added to it with the @code{.add()} method. This method
1644 takes three arguments: the two expressions of which the scalar product is
1645 taken, and the expression to replace it with. After @code{sp.add(A, B, 0)},
1646 @code{simplify_indexed()} will replace all scalar products of indexed
1647 objects that have the symbols @code{A} and @code{B} as base expressions
1648 with the single value 0. The number, type and dimension of the indices
1649 don't matter; @samp{A~mu~nu*B.mu.nu} would also be replaced by 0.
1650
1651 @cindex @code{expand()}
1652 The example above also illustrates a feature of the @code{expand()} method:
1653 if passed the @code{expand_indexed} option it will distribute indices
1654 over sums, so @samp{(A+B).i} becomes @samp{A.i+B.i}.
1655
1656 @cindex @code{tensor} (class)
1657 @subsection Predefined tensors
1658
1659 Some frequently used special tensors such as the delta, epsilon and metric
1660 tensors are predefined in GiNaC. They have special properties when
1661 contracted with other tensor expressions and some of them have constant
1662 matrix representations (they will evaluate to a number when numeric
1663 indices are specified).
1664
1665 @cindex @code{delta_tensor()}
1666 @subsubsection Delta tensor
1667
1668 The delta tensor takes two indices, is symmetric and has the matrix
1669 representation @code{diag(1,1,1,...)}. It is constructed by the function
1670 @code{delta_tensor()}:
1671
1672 @example
1673 @{
1674     symbol A("A"), B("B");
1675
1676     idx i(symbol("i"), 3), j(symbol("j"), 3),
1677         k(symbol("k"), 3), l(symbol("l"), 3);
1678
1679     ex e = indexed(A, i, j) * indexed(B, k, l)
1680          * delta_tensor(i, k) * delta_tensor(j, l) << endl;
1681     cout << e.simplify_indexed() << endl;
1682      // -> B.i.j*A.i.j
1683
1684     cout << delta_tensor(i, i) << endl;
1685      // -> 3
1686 @}
1687 @end example
1688
1689 @cindex @code{metric_tensor()}
1690 @subsubsection General metric tensor
1691
1692 The function @code{metric_tensor()} creates a general symmetric metric
1693 tensor with two indices that can be used to raise/lower tensor indices. The
1694 metric tensor is denoted as @samp{g} in the output and if its indices are of
1695 mixed variance it is automatically replaced by a delta tensor:
1696
1697 @example
1698 @{
1699     symbol A("A");
1700
1701     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4), rho(symbol("rho"), 4);
1702
1703     ex e = metric_tensor(mu, nu) * indexed(A, nu.toggle_variance(), rho);
1704     cout << e.simplify_indexed() << endl;
1705      // -> A~mu~rho
1706
1707     e = delta_tensor(mu, nu.toggle_variance()) * metric_tensor(nu, rho);
1708     cout << e.simplify_indexed() << endl;
1709      // -> g~mu~rho
1710
1711     e = metric_tensor(mu.toggle_variance(), nu.toggle_variance())
1712       * metric_tensor(nu, rho);
1713     cout << e.simplify_indexed() << endl;
1714      // -> delta.mu~rho
1715
1716     e = metric_tensor(nu.toggle_variance(), rho.toggle_variance())
1717       * metric_tensor(mu, nu) * (delta_tensor(mu.toggle_variance(), rho)
1718         + indexed(A, mu.toggle_variance(), rho));
1719     cout << e.simplify_indexed() << endl;
1720      // -> 4+A.rho~rho
1721 @}
1722 @end example
1723
1724 @cindex @code{lorentz_g()}
1725 @subsubsection Minkowski metric tensor
1726
1727 The Minkowski metric tensor is a special metric tensor with a constant
1728 matrix representation which is either @code{diag(1, -1, -1, ...)} (negative
1729 signature, the default) or @code{diag(-1, 1, 1, ...)} (positive signature).
1730 It is created with the function @code{lorentz_g()} (although it is output as
1731 @samp{eta}):
1732
1733 @example
1734 @{
1735     varidx mu(symbol("mu"), 4);
1736
1737     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
1738       * lorentz_g(mu, varidx(0, 4));       // negative signature
1739     cout << e.simplify_indexed() << endl;
1740      // -> 1
1741
1742     e = delta_tensor(varidx(0, 4), mu.toggle_variance())
1743       * lorentz_g(mu, varidx(0, 4), true); // positive signature
1744     cout << e.simplify_indexed() << endl;
1745      // -> -1
1746 @}
1747 @end example
1748
1749 @cindex @code{spinor_metric()}
1750 @subsubsection Spinor metric tensor
1751
1752 The function @code{spinor_metric()} creates an antisymmetric tensor with
1753 two indices that is used to raise/lower indices of 2-component spinors.
1754 It is output as @samp{eps}:
1755
1756 @example
1757 @{
1758     symbol psi("psi");
1759
1760     spinidx A(symbol("A")), B(symbol("B")), C(symbol("C"));
1761     ex A_co = A.toggle_variance(), B_co = B.toggle_variance();
1762
1763     e = spinor_metric(A, B) * indexed(psi, B_co);
1764     cout << e.simplify_indexed() << endl;
1765      // -> psi~A
1766
1767     e = spinor_metric(A, B) * indexed(psi, A_co);
1768     cout << e.simplify_indexed() << endl;
1769      // -> -psi~B
1770
1771     e = spinor_metric(A_co, B_co) * indexed(psi, B);
1772     cout << e.simplify_indexed() << endl;
1773      // -> -psi.A
1774
1775     e = spinor_metric(A_co, B_co) * indexed(psi, A);
1776     cout << e.simplify_indexed() << endl;
1777      // -> psi.B
1778
1779     e = spinor_metric(A_co, B_co) * spinor_metric(A, B);
1780     cout << e.simplify_indexed() << endl;
1781      // -> 2
1782
1783     e = spinor_metric(A_co, B_co) * spinor_metric(B, C);
1784     cout << e.simplify_indexed() << endl;
1785      // -> -delta.A~C
1786 @}
1787 @end example
1788
1789 The matrix representation of the spinor metric is @code{[[ [[ 0, 1 ]], [[ -1, 0 ]] ]]}.
1790
1791 @cindex @code{epsilon_tensor()}
1792 @cindex @code{lorentz_eps()}
1793 @subsubsection Epsilon tensor
1794
1795 The epsilon tensor is totally antisymmetric, its number of indices is equal
1796 to the dimension of the index space (the indices must all be of the same
1797 numeric dimension), and @samp{eps.1.2.3...} (resp. @samp{eps~0~1~2...}) is
1798 defined to be 1. Its behaviour with indices that have a variance also
1799 depends on the signature of the metric. Epsilon tensors are output as
1800 @samp{eps}.
1801
1802 There are three functions defined to create epsilon tensors in 2, 3 and 4
1803 dimensions:
1804
1805 @example
1806 ex epsilon_tensor(const ex & i1, const ex & i2);
1807 ex epsilon_tensor(const ex & i1, const ex & i2, const ex & i3);
1808 ex lorentz_eps(const ex & i1, const ex & i2, const ex & i3, const ex & i4, bool pos_sig = false);
1809 @end example
1810
1811 The first two functions create an epsilon tensor in 2 or 3 Euclidean
1812 dimensions, the last function creates an epsilon tensor in a 4-dimensional
1813 Minkowski space (the last @code{bool} argument specifies whether the metric
1814 has negative or positive signature, as in the case of the Minkowski metric
1815 tensor).
1816
1817 @subsection Linear algebra
1818
1819 The @code{matrix} class can be used with indices to do some simple linear
1820 algebra (linear combinations and products of vectors and matrices, traces
1821 and scalar products):
1822
1823 @example
1824 @{
1825     idx i(symbol("i"), 2), j(symbol("j"), 2);
1826     symbol x("x"), y("y");
1827
1828     matrix A(2, 2, lst(1, 2, 3, 4)), X(2, 1, lst(x, y));
1829
1830     cout << indexed(A, i, i) << endl;
1831      // -> 5
1832
1833     ex e = indexed(A, i, j) * indexed(X, j);
1834     cout << e.simplify_indexed() << endl;
1835      // -> [[ [[2*y+x]], [[4*y+3*x]] ]].i
1836
1837     e = indexed(A, i, j) * indexed(X, i) + indexed(X, j) * 2;
1838     cout << e.simplify_indexed() << endl;
1839      // -> [[ [[3*y+3*x,6*y+2*x]] ]].j
1840 @}
1841 @end example
1842
1843 You can of course obtain the same results with the @code{matrix::add()},
1844 @code{matrix::mul()} and @code{matrix::trace()} methods but with indices you
1845 don't have to worry about transposing matrices.
1846
1847 Matrix indices always start at 0 and their dimension must match the number
1848 of rows/columns of the matrix. Matrices with one row or one column are
1849 vectors and can have one or two indices (it doesn't matter whether it's a
1850 row or a column vector). Other matrices must have two indices.
1851
1852 You should be careful when using indices with variance on matrices. GiNaC
1853 doesn't look at the variance and doesn't know that @samp{F~mu~nu} and
1854 @samp{F.mu.nu} are different matrices. In this case you should use only
1855 one form for @samp{F} and explicitly multiply it with a matrix representation
1856 of the metric tensor.
1857
1858
1859 @node Non-commutative objects, Methods and Functions, Indexed objects, Basic Concepts
1860 @c    node-name, next, previous, up
1861 @section Non-commutative objects
1862
1863 GiNaC is equipped to handle certain non-commutative algebras. Three classes of
1864 non-commutative objects are built-in which are mostly of use in high energy
1865 physics:
1866
1867 @itemize
1868 @item Clifford (Dirac) algebra (class @code{clifford})
1869 @item su(3) Lie algebra (class @code{color})
1870 @item Matrices (unindexed) (class @code{matrix})
1871 @end itemize
1872
1873 The @code{clifford} and @code{color} classes are subclasses of
1874 @code{indexed} because the elements of these algebras ususally carry
1875 indices.
1876
1877 Unlike most computer algebra systems, GiNaC does not primarily provide an
1878 operator (often denoted @samp{&*}) for representing inert products of
1879 arbitrary objects. Rather, non-commutativity in GiNaC is a property of the
1880 classes of objects involved, and non-commutative products are formed with
1881 the usual @samp{*} operator, as are ordinary products. GiNaC is capable of
1882 figuring out by itself which objects commute and will group the factors
1883 by their class. Consider this example:
1884
1885 @example
1886     ...
1887     varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
1888     idx a(symbol("a"), 8), b(symbol("b"), 8);
1889     ex e = -dirac_gamma(mu) * (2*color_T(a)) * 8 * color_T(b) * dirac_gamma(nu);
1890     cout << e << endl;
1891      // -> -16*(gamma~mu*gamma~nu)*(T.a*T.b)
1892     ...
1893 @end example
1894
1895 As can be seen, GiNaC pulls out the overall commutative factor @samp{-16} and
1896 groups the non-commutative factors (the gammas and the su(3) generators)
1897 together while preserving the order of factors within each class (because
1898 Clifford objects commute with color objects). The resulting expression is a
1899 @emph{commutative} product with two factors that are themselves non-commutative
1900 products (@samp{gamma~mu*gamma~nu} and @samp{T.a*T.b}). For clarification,
1901 parentheses are placed around the non-commutative products in the output.
1902
1903 @cindex @code{ncmul} (class)
1904 Non-commutative products are internally represented by objects of the class
1905 @code{ncmul}, as opposed to commutative products which are handled by the
1906 @code{mul} class. You will normally not have to worry about this distinction,
1907 though.
1908
1909 The advantage of this approach is that you never have to worry about using
1910 (or forgetting to use) a special operator when constructing non-commutative
1911 expressions. Also, non-commutative products in GiNaC are more intelligent
1912 than in other computer algebra systems; they can, for example, automatically
1913 canonicalize themselves according to rules specified in the implementation
1914 of the non-commutative classes. The drawback is that to work with other than
1915 the built-in algebras you have to implement new classes yourself. Symbols
1916 always commute and it's not possible to construct non-commutative products
1917 using symbols to represent the algebra elements or generators. User-defined
1918 functions can, however, be specified as being non-commutative.
1919
1920 @cindex @code{return_type()}
1921 @cindex @code{return_type_tinfo()}
1922 Information about the commutativity of an object or expression can be
1923 obtained with the two member functions
1924
1925 @example
1926 unsigned ex::return_type(void) const;
1927 unsigned ex::return_type_tinfo(void) const;
1928 @end example
1929
1930 The @code{return_type()} function returns one of three values (defined in
1931 the header file @file{flags.h}), corresponding to three categories of
1932 expressions in GiNaC:
1933
1934 @itemize
1935 @item @code{return_types::commutative}: Commutes with everything. Most GiNaC
1936   classes are of this kind.
1937 @item @code{return_types::noncommutative}: Non-commutative, belonging to a
1938   certain class of non-commutative objects which can be determined with the
1939   @code{return_type_tinfo()} method. Expressions of this category commute
1940   with everything except @code{noncommutative} expressions of the same
1941   class.
1942 @item @code{return_types::noncommutative_composite}: Non-commutative, composed
1943   of non-commutative objects of different classes. Expressions of this
1944   category don't commute with any other @code{noncommutative} or
1945   @code{noncommutative_composite} expressions.
1946 @end itemize
1947
1948 The value returned by the @code{return_type_tinfo()} method is valid only
1949 when the return type of the expression is @code{noncommutative}. It is a
1950 value that is unique to the class of the object and usually one of the
1951 constants in @file{tinfos.h}, or derived therefrom.
1952
1953 Here are a couple of examples:
1954
1955 @cartouche
1956 @multitable @columnfractions 0.33 0.33 0.34
1957 @item @strong{Expression} @tab @strong{@code{return_type()}} @tab @strong{@code{return_type_tinfo()}}
1958 @item @code{42} @tab @code{commutative} @tab -
1959 @item @code{2*x-y} @tab @code{commutative} @tab -
1960 @item @code{dirac_ONE()} @tab @code{noncommutative} @tab @code{TINFO_clifford}
1961 @item @code{dirac_gamma(mu)*dirac_gamma(nu)} @tab @code{noncommutative} @tab @code{TINFO_clifford}
1962 @item @code{2*color_T(a)} @tab @code{noncommutative} @tab @code{TINFO_color}
1963 @item @code{dirac_ONE()*color_T(a)} @tab @code{noncommutative_composite} @tab -
1964 @end multitable
1965 @end cartouche
1966
1967 Note: the @code{return_type_tinfo()} of Clifford objects is only equal to
1968 @code{TINFO_clifford} for objects with a representation label of zero.
1969 Other representation labels yield a different @code{return_type_tinfo()},
1970 but it's the same for any two objects with the same label. This is also true
1971 for color objects.
1972
1973 As a last note, powers of non-commutative objects are not allowed in GiNaC.
1974 You can use the function
1975
1976 @example
1977 ex ncpow(const ex & basis, unsigned exponent)
1978 @end example
1979
1980 instead which returns an expanded product (e.g. @code{ncpow(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
3142 The numerator and denominator of an expression can be obtained with
3143
3144 @example
3145 ex ex::numer();
3146 ex ex::denom();
3147 @end example
3148
3149 These functions will first normalize the expression as described above and
3150 then return the numerator or denominator, respectively.
3151
3152
3153 @subsection Converting to a rational expression
3154 @cindex @code{to_rational()}
3155
3156 Some of the methods described so far only work on polynomials or rational
3157 functions. GiNaC provides a way to extend the domain of these functions to
3158 general expressions by using the temporary replacement algorithm described
3159 above. You do this by calling
3160
3161 @example
3162 ex ex::to_rational(lst &l);
3163 @end example
3164
3165 on the expression to be converted. The supplied @code{lst} will be filled
3166 with the generated temporary symbols and their replacement expressions in
3167 a format that can be used directly for the @code{subs()} method. It can also
3168 already contain a list of replacements from an earlier application of
3169 @code{.to_rational()}, so it's possible to use it on multiple expressions
3170 and get consistent results.
3171
3172 For example,
3173
3174 @example
3175 @{
3176     symbol x("x");
3177     ex a = pow(sin(x), 2) - pow(cos(x), 2);
3178     ex b = sin(x) + cos(x);
3179     ex q;
3180     lst l;
3181     divide(a.to_rational(l), b.to_rational(l), q);
3182     cout << q.subs(l) << endl;
3183 @}
3184 @end example
3185
3186 will print @samp{sin(x)-cos(x)}.
3187
3188
3189 @node Symbolic Differentiation, Series Expansion, Rational Expressions, Methods and Functions
3190 @c    node-name, next, previous, up
3191 @section Symbolic differentiation
3192 @cindex differentiation
3193 @cindex @code{diff()}
3194 @cindex chain rule
3195 @cindex product rule
3196
3197 GiNaC's objects know how to differentiate themselves.  Thus, a
3198 polynomial (class @code{add}) knows that its derivative is the sum of
3199 the derivatives of all the monomials:
3200
3201 @example
3202 #include <ginac/ginac.h>
3203 using namespace GiNaC;
3204
3205 int main()
3206 @{
3207     symbol x("x"), y("y"), z("z");
3208     ex P = pow(x, 5) + pow(x, 2) + y;
3209
3210     cout << P.diff(x,2) << endl;  // 20*x^3 + 2
3211     cout << P.diff(y) << endl;    // 1
3212     cout << P.diff(z) << endl;    // 0
3213 @}
3214 @end example
3215
3216 If a second integer parameter @var{n} is given, the @code{diff} method
3217 returns the @var{n}th derivative.
3218
3219 If @emph{every} object and every function is told what its derivative
3220 is, all derivatives of composed objects can be calculated using the
3221 chain rule and the product rule.  Consider, for instance the expression
3222 @code{1/cosh(x)}.  Since the derivative of @code{cosh(x)} is
3223 @code{sinh(x)} and the derivative of @code{pow(x,-1)} is
3224 @code{-pow(x,-2)}, GiNaC can readily compute the composition.  It turns
3225 out that the composition is the generating function for Euler Numbers,
3226 i.e. the so called @var{n}th Euler number is the coefficient of
3227 @code{x^n/n!} in the expansion of @code{1/cosh(x)}.  We may use this
3228 identity to code a function that generates Euler numbers in just three
3229 lines:
3230
3231 @cindex Euler numbers
3232 @example
3233 #include <ginac/ginac.h>
3234 using namespace GiNaC;
3235
3236 ex EulerNumber(unsigned n)
3237 @{
3238     symbol x;
3239     const ex generator = pow(cosh(x),-1);
3240     return generator.diff(x,n).subs(x==0);
3241 @}
3242
3243 int main()
3244 @{
3245     for (unsigned i=0; i<11; i+=2)
3246         std::cout << EulerNumber(i) << std::endl;
3247     return 0;
3248 @}
3249 @end example
3250
3251 When you run it, it produces the sequence @code{1}, @code{-1}, @code{5},
3252 @code{-61}, @code{1385}, @code{-50521}.  We increment the loop variable
3253 @code{i} by two since all odd Euler numbers vanish anyways.
3254
3255
3256 @node Series Expansion, Symmetrization, Symbolic Differentiation, Methods and Functions
3257 @c    node-name, next, previous, up
3258 @section Series expansion
3259 @cindex @code{series()}
3260 @cindex Taylor expansion
3261 @cindex Laurent expansion
3262 @cindex @code{pseries} (class)
3263
3264 Expressions know how to expand themselves as a Taylor series or (more
3265 generally) a Laurent series.  As in most conventional Computer Algebra
3266 Systems, no distinction is made between those two.  There is a class of
3267 its own for storing such series (@code{class pseries}) and a built-in
3268 function (called @code{Order}) for storing the order term of the series.
3269 As a consequence, if you want to work with series, i.e. multiply two
3270 series, you need to call the method @code{ex::series} again to convert
3271 it to a series object with the usual structure (expansion plus order
3272 term).  A sample application from special relativity could read:
3273
3274 @example
3275 #include <ginac/ginac.h>
3276 using namespace std;
3277 using namespace GiNaC;
3278
3279 int main()
3280 @{
3281     symbol v("v"), c("c");
3282     
3283     ex gamma = 1/sqrt(1 - pow(v/c,2));
3284     ex mass_nonrel = gamma.series(v==0, 10);
3285     
3286     cout << "the relativistic mass increase with v is " << endl
3287          << mass_nonrel << endl;
3288     
3289     cout << "the inverse square of this series is " << endl
3290          << pow(mass_nonrel,-2).series(v==0, 10) << endl;
3291 @}
3292 @end example
3293
3294 Only calling the series method makes the last output simplify to
3295 @math{1-v^2/c^2+O(v^10)}, without that call we would just have a long
3296 series raised to the power @math{-2}.
3297
3298 @cindex M@'echain's formula
3299 As another instructive application, let us calculate the numerical 
3300 value of Archimedes' constant
3301 @tex
3302 $\pi$
3303 @end tex
3304 (for which there already exists the built-in constant @code{Pi}) 
3305 using M@'echain's amazing formula
3306 @tex
3307 $\pi=16$~atan~$\!\left(1 \over 5 \right)-4$~atan~$\!\left(1 \over 239 \right)$.
3308 @end tex
3309 @ifnottex
3310 @math{Pi==16*atan(1/5)-4*atan(1/239)}.
3311 @end ifnottex
3312 We may expand the arcus tangent around @code{0} and insert the fractions
3313 @code{1/5} and @code{1/239}.  But, as we have seen, a series in GiNaC
3314 carries an order term with it and the question arises what the system is
3315 supposed to do when the fractions are plugged into that order term.  The
3316 solution is to use the function @code{series_to_poly()} to simply strip
3317 the order term off:
3318
3319 @example
3320 #include <ginac/ginac.h>
3321 using namespace GiNaC;
3322
3323 ex mechain_pi(int degr)
3324 @{
3325     symbol x;
3326     ex pi_expansion = series_to_poly(atan(x).series(x,degr));
3327     ex pi_approx = 16*pi_expansion.subs(x==numeric(1,5))
3328                    -4*pi_expansion.subs(x==numeric(1,239));
3329     return pi_approx;
3330 @}
3331
3332 int main()
3333 @{
3334     using std::cout;  // just for fun, another way of...
3335     using std::endl;  // ...dealing with this namespace std.
3336     ex pi_frac;
3337     for (int i=2; i<12; i+=2) @{
3338         pi_frac = mechain_pi(i);
3339         cout << i << ":\t" << pi_frac << endl
3340              << "\t" << pi_frac.evalf() << endl;
3341     @}
3342     return 0;
3343 @}
3344 @end example
3345
3346 Note how we just called @code{.series(x,degr)} instead of
3347 @code{.series(x==0,degr)}.  This is a simple shortcut for @code{ex}'s
3348 method @code{series()}: if the first argument is a symbol the expression
3349 is expanded in that symbol around point @code{0}.  When you run this
3350 program, it will type out:
3351
3352 @example
3353 2:      3804/1195
3354         3.1832635983263598326
3355 4:      5359397032/1706489875
3356         3.1405970293260603143
3357 6:      38279241713339684/12184551018734375
3358         3.141621029325034425
3359 8:      76528487109180192540976/24359780855939418203125
3360         3.141591772182177295
3361 10:     327853873402258685803048818236/104359128170408663038552734375
3362         3.1415926824043995174
3363 @end example
3364
3365
3366 @node Symmetrization, Built-in Functions, Series Expansion, Methods and Functions
3367 @c    node-name, next, previous, up
3368 @section Symmetrization
3369
3370 The two functions
3371
3372 @example
3373 ex symmetrize(const ex & e, const lst & l);
3374 ex antisymmetrize(const ex & e, const lst & l);
3375 @end example
3376
3377 symmetrize an expression by returning the symmetric or antisymmetric sum
3378 over all permutations of the specified list of objects, weighted by the
3379 number of permutations.
3380
3381 The two additional functions
3382
3383 @example
3384 ex symmetrize(const ex & e);
3385 ex antisymmetrize(const ex & e);
3386 @end example
3387
3388 symmetrize or antisymmetrize an expression over its free indices.
3389
3390 Symmetrization is most useful with indexed expressions but can be used with
3391 almost any kind of object (anything that is @code{subs()}able):
3392
3393 @example
3394 @{
3395     idx i(symbol("i"), 3), j(symbol("j"), 3), k(symbol("k"), 3);
3396     symbol A("A"), B("B"), a("a"), b("b"), c("c");
3397                                            
3398     cout << symmetrize(indexed(A, i, j)) << endl;
3399      // -> 1/2*A.j.i+1/2*A.i.j
3400     cout << antisymmetrize(indexed(A, i, j, k), lst(i, j)) << endl;
3401      // -> -1/2*A.j.i.k+1/2*A.i.j.k
3402     cout << symmetrize(lst(a, b, c), lst(a, b, c)) << endl;
3403      // -> 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]
3404 @}
3405 @end example
3406
3407
3408 @node Built-in Functions, Input/Output, Symmetrization, Methods and Functions
3409 @c    node-name, next, previous, up
3410 @section Predefined mathematical functions
3411
3412 GiNaC contains the following predefined mathematical functions:
3413
3414 @cartouche
3415 @multitable @columnfractions .30 .70
3416 @item @strong{Name} @tab @strong{Function}
3417 @item @code{abs(x)}
3418 @tab absolute value
3419 @item @code{csgn(x)}
3420 @tab complex sign
3421 @item @code{sqrt(x)}
3422 @tab square root (not a GiNaC function proper but equivalent to @code{pow(x, numeric(1, 2)})
3423 @item @code{sin(x)}
3424 @tab sine
3425 @item @code{cos(x)}
3426 @tab cosine
3427 @item @code{tan(x)}
3428 @tab tangent
3429 @item @code{asin(x)}
3430 @tab inverse sine
3431 @item @code{acos(x)}
3432 @tab inverse cosine
3433 @item @code{atan(x)}
3434 @tab inverse tangent
3435 @item @code{atan2(y, x)}
3436 @tab inverse tangent with two arguments
3437 @item @code{sinh(x)}
3438 @tab hyperbolic sine
3439 @item @code{cosh(x)}
3440 @tab hyperbolic cosine
3441 @item @code{tanh(x)}
3442 @tab hyperbolic tangent
3443 @item @code{asinh(x)}
3444 @tab inverse hyperbolic sine
3445 @item @code{acosh(x)}
3446 @tab inverse hyperbolic cosine
3447 @item @code{atanh(x)}
3448 @tab inverse hyperbolic tangent
3449 @item @code{exp(x)}
3450 @tab exponential function
3451 @item @code{log(x)}
3452 @tab natural logarithm
3453 @item @code{Li2(x)}
3454 @tab Dilogarithm
3455 @item @code{zeta(x)}
3456 @tab Riemann's zeta function
3457 @item @code{zeta(n, x)}
3458 @tab derivatives of Riemann's zeta function
3459 @item @code{tgamma(x)}
3460 @tab Gamma function
3461 @item @code{lgamma(x)}
3462 @tab logarithm of Gamma function
3463 @item @code{beta(x, y)}
3464 @tab Beta function (@code{tgamma(x)*tgamma(y)/tgamma(x+y)})
3465 @item @code{psi(x)}
3466 @tab psi (digamma) function
3467 @item @code{psi(n, x)}
3468 @tab derivatives of psi function (polygamma functions)
3469 @item @code{factorial(n)}
3470 @tab factorial function
3471 @item @code{binomial(n, m)}
3472 @tab binomial coefficients
3473 @item @code{Order(x)}
3474 @tab order term function in truncated power series
3475 @item @code{Derivative(x, l)}
3476 @tab inert partial differentiation operator (used internally)
3477 @end multitable
3478 @end cartouche
3479
3480 @cindex branch cut
3481 For functions that have a branch cut in the complex plane GiNaC follows
3482 the conventions for C++ as defined in the ANSI standard as far as
3483 possible.  In particular: the natural logarithm (@code{log}) and the
3484 square root (@code{sqrt}) both have their branch cuts running along the
3485 negative real axis where the points on the axis itself belong to the
3486 upper part (i.e. continuous with quadrant II).  The inverse
3487 trigonometric and hyperbolic functions are not defined for complex
3488 arguments by the C++ standard, however.  In GiNaC we follow the
3489 conventions used by CLN, which in turn follow the carefully designed
3490 definitions in the Common Lisp standard.  It should be noted that this
3491 convention is identical to the one used by the C99 standard and by most
3492 serious CAS.  It is to be expected that future revisions of the C++
3493 standard incorporate these functions in the complex domain in a manner
3494 compatible with C99.
3495
3496
3497 @node Input/Output, Extending GiNaC, Built-in Functions, Methods and Functions
3498 @c    node-name, next, previous, up
3499 @section Input and output of expressions
3500 @cindex I/O
3501
3502 @subsection Expression output
3503 @cindex printing
3504 @cindex output of expressions
3505
3506 The easiest way to print an expression is to write it to a stream:
3507
3508 @example
3509 @{
3510     symbol x("x");
3511     ex e = 4.5+pow(x,2)*3/2;
3512     cout << e << endl;    // prints '(4.5)+3/2*x^2'
3513     // ...
3514 @end example
3515
3516 The output format is identical to the @command{ginsh} input syntax and
3517 to that used by most computer algebra systems, but not directly pastable
3518 into a GiNaC C++ program (note that in the above example, @code{pow(x,2)}
3519 is printed as @samp{x^2}).
3520
3521 It is possible to print expressions in a number of different formats with
3522 the method
3523
3524 @example
3525 void ex::print(const print_context & c, unsigned level = 0);
3526 @end example
3527
3528 @cindex @code{print_context} (class)
3529 The type of @code{print_context} object passed in determines the format
3530 of the output. The possible types are defined in @file{ginac/print.h}.
3531 All constructors of @code{print_context} and derived classes take an
3532 @code{ostream &} as their first argument.
3533
3534 To print an expression in a way that can be directly used in a C or C++
3535 program, you pass a @code{print_csrc} object like this:
3536
3537 @example
3538     // ...
3539     cout << "float f = ";
3540     e.print(print_csrc_float(cout));
3541     cout << ";\n";
3542
3543     cout << "double d = ";
3544     e.print(print_csrc_double(cout));
3545     cout << ";\n";
3546
3547     cout << "cl_N n = ";
3548     e.print(print_csrc_cl_N(cout));
3549     cout << ";\n";
3550     // ...
3551 @end example
3552
3553 The three possible types mostly affect the way in which floating point
3554 numbers are written.
3555
3556 The above example will produce (note the @code{x^2} being converted to @code{x*x}):
3557
3558 @example
3559 float f = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
3560 double d = (3.000000e+00/2.000000e+00)*(x*x)+4.500000e+00;
3561 cl_N n = (cln::cl_F("3.0")/cln::cl_F("2.0"))*(x*x)+cln::cl_F("4.5");
3562 @end example
3563
3564 The @code{print_context} type @code{print_tree} provides a dump of the
3565 internal structure of an expression for debugging purposes:
3566
3567 @example
3568     // ...
3569     e.print(print_tree(cout));
3570 @}
3571 @end example
3572
3573 produces
3574
3575 @example
3576 add, hash=0x0, flags=0x3, nops=2
3577     power, hash=0x9, flags=0x3, nops=2
3578         x (symbol), serial=3, hash=0x44a113a6, flags=0xf
3579         2 (numeric), hash=0x80000042, flags=0xf
3580     3/2 (numeric), hash=0x80000061, flags=0xf
3581     -----
3582     overall_coeff
3583     4.5L0 (numeric), hash=0x8000004b, flags=0xf
3584     =====
3585 @end example
3586
3587 This kind of output is also available in @command{ginsh} as the @code{print()}
3588 function.
3589
3590 Another useful output format is for LaTeX parsing in mathematical mode.
3591 It is rather similar to the default @code{print_context} but provides
3592 some braces needed by LaTeX for delimiting boxes and also converts some
3593 common objects to conventional LaTeX names. It is possible to give symbols
3594 a special name for LaTeX output by supplying it as a second argument to
3595 the @code{symbol} constructor.
3596
3597 For example, the code snippet
3598
3599 @example
3600     // ...
3601     symbol x("x");
3602     ex foo = lgamma(x).series(x==0,3);
3603     foo.print(print_latex(std::cout));
3604 @end example
3605
3606 will print out:
3607
3608 @example
3609     @{(-\ln(x))@}+@{(-\gamma_E)@} x+@{(1/12 \pi^2)@} x^@{2@}+\mathcal@{O@}(x^3)
3610 @end example
3611
3612 If you need any fancy special output format, e.g. for interfacing GiNaC
3613 with other algebra systems or for producing code for different
3614 programming languages, you can always traverse the expression tree yourself:
3615
3616 @example
3617 static void my_print(const ex & e)
3618 @{
3619     if (is_ex_of_type(e, function))
3620         cout << ex_to_function(e).get_name();
3621     else
3622         cout << e.bp->class_name();
3623     cout << "(";
3624     unsigned n = e.nops();
3625     if (n)
3626         for (unsigned i=0; i<n; i++) @{
3627             my_print(e.op(i));
3628             if (i != n-1)
3629                 cout << ",";
3630         @}
3631     else
3632         cout << e;
3633     cout << ")";
3634 @}
3635
3636 int main(void)
3637 @{
3638     my_print(pow(3, x) - 2 * sin(y / Pi)); cout << endl;
3639     return 0;
3640 @}
3641 @end example
3642
3643 This will produce
3644
3645 @example
3646 add(power(numeric(3),symbol(x)),mul(sin(mul(power(constant(Pi),numeric(-1)),
3647 symbol(y))),numeric(-2)))
3648 @end example
3649
3650 If you need an output format that makes it possible to accurately
3651 reconstruct an expression by feeding the output to a suitable parser or
3652 object factory, you should consider storing the expression in an
3653 @code{archive} object and reading the object properties from there.
3654 See the section on archiving for more information.
3655
3656
3657 @subsection Expression input
3658 @cindex input of expressions
3659
3660 GiNaC provides no way to directly read an expression from a stream because
3661 you will usually want the user to be able to enter something like @samp{2*x+sin(y)}
3662 and have the @samp{x} and @samp{y} correspond to the symbols @code{x} and
3663 @code{y} you defined in your program and there is no way to specify the
3664 desired symbols to the @code{>>} stream input operator.
3665
3666 Instead, GiNaC lets you construct an expression from a string, specifying the
3667 list of symbols to be used:
3668
3669 @example
3670 @{
3671     symbol x("x"), y("y");
3672     ex e("2*x+sin(y)", lst(x, y));
3673 @}
3674 @end example
3675
3676 The input syntax is the same as that used by @command{ginsh} and the stream
3677 output operator @code{<<}. The symbols in the string are matched by name to
3678 the symbols in the list and if GiNaC encounters a symbol not specified in
3679 the list it will throw an exception.
3680
3681 With this constructor, it's also easy to implement interactive GiNaC programs:
3682
3683 @example
3684 #include <iostream>
3685 #include <string>
3686 #include <stdexcept>
3687 #include <ginac/ginac.h>
3688 using namespace std;
3689 using namespace GiNaC;
3690
3691 int main()
3692 @{
3693      symbol x("x");
3694      string s;
3695
3696      cout << "Enter an expression containing 'x': ";
3697      getline(cin, s);
3698
3699      try @{
3700          ex e(s, lst(x));
3701          cout << "The derivative of " << e << " with respect to x is ";
3702          cout << e.diff(x) << ".\n";
3703      @} catch (exception &p) @{
3704          cerr << p.what() << endl;
3705      @}
3706 @}
3707 @end example
3708
3709
3710 @subsection Archiving
3711 @cindex @code{archive} (class)
3712 @cindex archiving
3713
3714 GiNaC allows creating @dfn{archives} of expressions which can be stored
3715 to or retrieved from files. To create an archive, you declare an object
3716 of class @code{archive} and archive expressions in it, giving each
3717 expression a unique name:
3718
3719 @example
3720 #include <fstream>
3721 using namespace std;
3722 #include <ginac/ginac.h>
3723 using namespace GiNaC;
3724
3725 int main()
3726 @{
3727     symbol x("x"), y("y"), z("z");
3728
3729     ex foo = sin(x + 2*y) + 3*z + 41;
3730     ex bar = foo + 1;
3731
3732     archive a;
3733     a.archive_ex(foo, "foo");
3734     a.archive_ex(bar, "the second one");
3735     // ...
3736 @end example
3737
3738 The archive can then be written to a file:
3739
3740 @example
3741     // ...
3742     ofstream out("foobar.gar");
3743     out << a;
3744     out.close();
3745     // ...
3746 @end example
3747
3748 The file @file{foobar.gar} contains all information that is needed to
3749 reconstruct the expressions @code{foo} and @code{bar}.
3750
3751 @cindex @command{viewgar}
3752 The tool @command{viewgar} that comes with GiNaC can be used to view
3753 the contents of GiNaC archive files:
3754
3755 @example
3756 $ viewgar foobar.gar
3757 foo = 41+sin(x+2*y)+3*z
3758 the second one = 42+sin(x+2*y)+3*z
3759 @end example
3760
3761 The point of writing archive files is of course that they can later be
3762 read in again:
3763
3764 @example
3765     // ...
3766     archive a2;
3767     ifstream in("foobar.gar");
3768     in >> a2;
3769     // ...
3770 @end example
3771
3772 And the stored expressions can be retrieved by their name:
3773
3774 @example
3775     // ...
3776     lst syms(x, y);
3777
3778     ex ex1 = a2.unarchive_ex(syms, "foo");
3779     ex ex2 = a2.unarchive_ex(syms, "the second one");
3780
3781     cout << ex1 << endl;              // prints "41+sin(x+2*y)+3*z"
3782     cout << ex2 << endl;              // prints "42+sin(x+2*y)+3*z"
3783     cout << ex1.subs(x == 2) << endl; // prints "41+sin(2+2*y)+3*z"
3784 @}
3785 @end example
3786
3787 Note that you have to supply a list of the symbols which are to be inserted
3788 in the expressions. Symbols in archives are stored by their name only and
3789 if you don't specify which symbols you have, unarchiving the expression will
3790 create new symbols with that name. E.g. if you hadn't included @code{x} in
3791 the @code{syms} list above, the @code{ex1.subs(x == 2)} statement would
3792 have had no effect because the @code{x} in @code{ex1} would have been a
3793 different symbol than the @code{x} which was defined at the beginning of
3794 the program, altough both would appear as @samp{x} when printed.
3795
3796 You can also use the information stored in an @code{archive} object to
3797 output expressions in a format suitable for exact reconstruction. The
3798 @code{archive} and @code{archive_node} classes have a couple of member
3799 functions that let you access the stored properties:
3800
3801 @example
3802 static void my_print2(const archive_node & n)
3803 @{
3804     string class_name;
3805     n.find_string("class", class_name);
3806     cout << class_name << "(";
3807
3808     archive_node::propinfovector p;
3809     n.get_properties(p);
3810
3811     unsigned num = p.size();
3812     for (unsigned i=0; i<num; i++) @{
3813         const string &name = p[i].name;
3814         if (name == "class")
3815             continue;
3816         cout << name << "=";
3817
3818         unsigned count = p[i].count;
3819         if (count > 1)
3820             cout << "@{";
3821
3822         for (unsigned j=0; j<count; j++) @{
3823             switch (p[i].type) @{
3824                 case archive_node::PTYPE_BOOL: @{
3825                     bool x;
3826                     n.find_bool(name, x);
3827                     cout << (x ? "true" : "false");
3828                     break;
3829                 @}
3830                 case archive_node::PTYPE_UNSIGNED: @{
3831                     unsigned x;
3832                     n.find_unsigned(name, x);
3833                     cout << x;
3834                     break;
3835                 @}
3836                 case archive_node::PTYPE_STRING: @{
3837                     string x;
3838                     n.find_string(name, x);
3839                     cout << '\"' << x << '\"';
3840                     break;
3841                 @}
3842                 case archive_node::PTYPE_NODE: @{
3843                     const archive_node &x = n.find_ex_node(name, j);
3844                     my_print2(x);
3845                     break;
3846                 @}
3847             @}
3848
3849             if (j != count-1)
3850                 cout << ",";
3851         @}
3852
3853         if (count > 1)
3854             cout << "@}";
3855
3856         if (i != num-1)
3857             cout << ",";
3858     @}
3859
3860     cout << ")";
3861 @}
3862
3863 int main(void)
3864 @{
3865     ex e = pow(2, x) - y;
3866     archive ar(e, "e");
3867     my_print2(ar.get_top_node(0)); cout << endl;
3868     return 0;
3869 @}
3870 @end example
3871
3872 This will produce:
3873
3874 @example
3875 add(rest=@{power(basis=numeric(number="2"),exponent=symbol(name="x")),
3876 symbol(name="y")@},coeff=@{numeric(number="1"),numeric(number="-1")@},
3877 overall_coeff=numeric(number="0"))
3878 @end example
3879
3880 Be warned, however, that the set of properties and their meaning for each
3881 class may change between GiNaC versions.
3882
3883
3884 @node Extending GiNaC, What does not belong into GiNaC, Input/Output, Top
3885 @c    node-name, next, previous, up
3886 @chapter Extending GiNaC
3887
3888 By reading so far you should have gotten a fairly good understanding of
3889 GiNaC's design-patterns.  From here on you should start reading the
3890 sources.  All we can do now is issue some recommendations how to tackle
3891 GiNaC's many loose ends in order to fulfill everybody's dreams.  If you
3892 develop some useful extension please don't hesitate to contact the GiNaC
3893 authors---they will happily incorporate them into future versions.
3894
3895 @menu
3896 * What does not belong into GiNaC::  What to avoid.
3897 * Symbolic functions::               Implementing symbolic functions.
3898 * Adding classes::                   Defining new algebraic classes.
3899 @end menu
3900
3901
3902 @node What does not belong into GiNaC, Symbolic functions, Extending GiNaC, Extending GiNaC
3903 @c    node-name, next, previous, up
3904 @section What doesn't belong into GiNaC
3905
3906 @cindex @command{ginsh}
3907 First of all, GiNaC's name must be read literally.  It is designed to be
3908 a library for use within C++.  The tiny @command{ginsh} accompanying
3909 GiNaC makes this even more clear: it doesn't even attempt to provide a
3910 language.  There are no loops or conditional expressions in
3911 @command{ginsh}, it is merely a window into the library for the
3912 programmer to test stuff (or to show off).  Still, the design of a
3913 complete CAS with a language of its own, graphical capabilites and all
3914 this on top of GiNaC is possible and is without doubt a nice project for
3915 the future.
3916
3917 There are many built-in functions in GiNaC that do not know how to
3918 evaluate themselves numerically to a precision declared at runtime
3919 (using @code{Digits}).  Some may be evaluated at certain points, but not
3920 generally.  This ought to be fixed.  However, doing numerical
3921 computations with GiNaC's quite abstract classes is doomed to be
3922 inefficient.  For this purpose, the underlying foundation classes
3923 provided by @acronym{CLN} are much better suited.
3924
3925
3926 @node Symbolic functions, Adding classes, What does not belong into GiNaC, Extending GiNaC
3927 @c    node-name, next, previous, up
3928 @section Symbolic functions
3929
3930 The easiest and most instructive way to start with is probably to
3931 implement your own function.  GiNaC's functions are objects of class
3932 @code{function}.  The preprocessor is then used to convert the function
3933 names to objects with a corresponding serial number that is used
3934 internally to identify them.  You usually need not worry about this
3935 number.  New functions may be inserted into the system via a kind of
3936 `registry'.  It is your responsibility to care for some functions that
3937 are called when the user invokes certain methods.  These are usual
3938 C++-functions accepting a number of @code{ex} as arguments and returning
3939 one @code{ex}.  As an example, if we have a look at a simplified
3940 implementation of the cosine trigonometric function, we first need a
3941 function that is called when one wishes to @code{eval} it.  It could
3942 look something like this:
3943
3944 @example
3945 static ex cos_eval_method(const ex & x)
3946 @{
3947     // if (!x%(2*Pi)) return 1
3948     // if (!x%Pi) return -1
3949     // if (!x%Pi/2) return 0
3950     // care for other cases...
3951     return cos(x).hold();
3952 @}
3953 @end example
3954
3955 @cindex @code{hold()}
3956 @cindex evaluation
3957 The last line returns @code{cos(x)} if we don't know what else to do and
3958 stops a potential recursive evaluation by saying @code{.hold()}, which
3959 sets a flag to the expression signaling that it has been evaluated.  We
3960 should also implement a method for numerical evaluation and since we are
3961 lazy we sweep the problem under the rug by calling someone else's
3962 function that does so, in this case the one in class @code{numeric}:
3963
3964 @example
3965 static ex cos_evalf(const ex & x)
3966 @{
3967     return cos(ex_to_numeric(x));
3968 @}
3969 @end example
3970
3971 Differentiation will surely turn up and so we need to tell @code{cos}
3972 what the first derivative is (higher derivatives (@code{.diff(x,3)} for
3973 instance are then handled automatically by @code{basic::diff} and
3974 @code{ex::diff}):
3975
3976 @example
3977 static ex cos_deriv(const ex & x, unsigned diff_param)
3978 @{
3979     return -sin(x);
3980 @}
3981 @end example
3982
3983 @cindex product rule
3984 The second parameter is obligatory but uninteresting at this point.  It
3985 specifies which parameter to differentiate in a partial derivative in
3986 case the function has more than one parameter and its main application
3987 is for correct handling of the chain rule.  For Taylor expansion, it is
3988 enough to know how to differentiate.  But if the function you want to
3989 implement does have a pole somewhere in the complex plane, you need to
3990 write another method for Laurent expansion around that point.
3991
3992 Now that all the ingredients for @code{cos} have been set up, we need
3993 to tell the system about it.  This is done by a macro and we are not
3994 going to descibe how it expands, please consult your preprocessor if you
3995 are curious:
3996
3997 @example
3998 REGISTER_FUNCTION(cos, eval_func(cos_eval).
3999                        evalf_func(cos_evalf).
4000                        derivative_func(cos_deriv));
4001 @end example
4002
4003 The first argument is the function's name used for calling it and for
4004 output.  The second binds the corresponding methods as options to this
4005 object.  Options are separated by a dot and can be given in an arbitrary
4006 order.  GiNaC functions understand several more options which are always
4007 specified as @code{.option(params)}, for example a method for series
4008 expansion @code{.series_func(cos_series)}.  Again, if no series
4009 expansion method is given, GiNaC defaults to simple Taylor expansion,
4010 which is correct if there are no poles involved as is the case for the
4011 @code{cos} function.  The way GiNaC handles poles in case there are any
4012 is best understood by studying one of the examples, like the Gamma
4013 (@code{tgamma}) function for instance.  (In essence the function first
4014 checks if there is a pole at the evaluation point and falls back to
4015 Taylor expansion if there isn't.  Then, the pole is regularized by some
4016 suitable transformation.)  Also, the new function needs to be declared
4017 somewhere.  This may also be done by a convenient preprocessor macro:
4018
4019 @example
4020 DECLARE_FUNCTION_1P(cos)
4021 @end example
4022
4023 The suffix @code{_1P} stands for @emph{one parameter}.  Of course, this
4024 implementation of @code{cos} is very incomplete and lacks several safety
4025 mechanisms.  Please, have a look at the real implementation in GiNaC.
4026 (By the way: in case you are worrying about all the macros above we can
4027 assure you that functions are GiNaC's most macro-intense classes.  We
4028 have done our best to avoid macros where we can.)
4029
4030
4031 @node Adding classes, A Comparison With Other CAS, Symbolic functions, Extending GiNaC
4032 @c    node-name, next, previous, up
4033 @section Adding classes
4034
4035 If you are doing some very specialized things with GiNaC you may find that
4036 you have to implement your own algebraic classes to fit your needs. This
4037 section will explain how to do this by giving the example of a simple
4038 'string' class. After reading this section you will know how to properly
4039 declare a GiNaC class and what the minimum required member functions are
4040 that you have to implement. We only cover the implementation of a 'leaf'
4041 class here (i.e. one that doesn't contain subexpressions). Creating a
4042 container class like, for example, a class representing tensor products is
4043 more involved but this section should give you enough information so you can
4044 consult the source to GiNaC's predefined classes if you want to implement
4045 something more complicated.
4046
4047 @subsection GiNaC's run-time type information system
4048
4049 @cindex hierarchy of classes
4050 @cindex RTTI
4051 All algebraic classes (that is, all classes that can appear in expressions)
4052 in GiNaC are direct or indirect subclasses of the class @code{basic}. So a
4053 @code{basic *} (which is essentially what an @code{ex} is) represents a
4054 generic pointer to an algebraic class. Occasionally it is necessary to find
4055 out what the class of an object pointed to by a @code{basic *} really is.
4056 Also, for the unarchiving of expressions it must be possible to find the
4057 @code{unarchive()} function of a class given the class name (as a string). A
4058 system that provides this kind of information is called a run-time type
4059 information (RTTI) system. The C++ language provides such a thing (see the
4060 standard header file @file{<typeinfo>}) but for efficiency reasons GiNaC
4061 implements its own, simpler RTTI.
4062
4063 The RTTI in GiNaC is based on two mechanisms:
4064
4065 @itemize @bullet
4066
4067 @item
4068 The @code{basic} class declares a member variable @code{tinfo_key} which
4069 holds an unsigned integer that identifies the object's class. These numbers
4070 are defined in the @file{tinfos.h} header file for the built-in GiNaC
4071 classes. They all start with @code{TINFO_}.
4072
4073 @item
4074 By means of some clever tricks with static members, GiNaC maintains a list
4075 of information for all classes derived from @code{basic}. The information
4076 available includes the class names, the @code{tinfo_key}s, and pointers
4077 to the unarchiving functions. This class registry is defined in the
4078 @file{registrar.h} header file.
4079
4080 @end itemize
4081
4082 The disadvantage of this proprietary RTTI implementation is that there's
4083 a little more to do when implementing new classes (C++'s RTTI works more
4084 or less automatic) but don't worry, most of the work is simplified by
4085 macros.
4086
4087 @subsection A minimalistic example
4088
4089 Now we will start implementing a new class @code{mystring} that allows
4090 placing character strings in algebraic expressions (this is not very useful,
4091 but it's just an example). This class will be a direct subclass of
4092 @code{basic}. You can use this sample implementation as a starting point
4093 for your own classes.
4094
4095 The code snippets given here assume that you have included some header files
4096 as follows:
4097
4098 @example
4099 #include <iostream>
4100 #include <string>   
4101 #include <stdexcept>
4102 using namespace std;
4103
4104 #include <ginac/ginac.h>
4105 using namespace GiNaC;
4106 @end example
4107
4108 The first thing we have to do is to define a @code{tinfo_key} for our new
4109 class. This can be any arbitrary unsigned number that is not already taken
4110 by one of the existing classes but it's better to come up with something
4111 that is unlikely to clash with keys that might be added in the future. The
4112 numbers in @file{tinfos.h} are modeled somewhat after the class hierarchy
4113 which is not a requirement but we are going to stick with this scheme:
4114
4115 @example
4116 const unsigned TINFO_mystring = 0x42420001U;
4117 @end example
4118
4119 Now we can write down the class declaration. The class stores a C++
4120 @code{string} and the user shall be able to construct a @code{mystring}
4121 object from a C or C++ string:
4122
4123 @example
4124 class mystring : public basic
4125 @{
4126     GINAC_DECLARE_REGISTERED_CLASS(mystring, basic)
4127   
4128 public:
4129     mystring(const string &s);
4130     mystring(const char *s);
4131
4132 private:
4133     string str;
4134 @};
4135
4136 GIANC_IMPLEMENT_REGISTERED_CLASS(mystring, basic)
4137 @end example
4138
4139 The @code{GINAC_DECLARE_REGISTERED_CLASS} and @code{GINAC_IMPLEMENT_REGISTERED_CLASS}
4140 macros are defined in @file{registrar.h}. They take the name of the class
4141 and its direct superclass as arguments and insert all required declarations
4142 for the RTTI system. The @code{GINAC_DECLARE_REGISTERED_CLASS} should be
4143 the first line after the opening brace of the class definition. The
4144 @code{GINAC_IMPLEMENT_REGISTERED_CLASS} may appear anywhere else in the
4145 source (at global scope, of course, not inside a function).
4146
4147 @code{GINAC_DECLARE_REGISTERED_CLASS} contains, among other things the
4148 declarations of the default and copy constructor, the destructor, the
4149 assignment operator and a couple of other functions that are required. It
4150 also defines a type @code{inherited} which refers to the superclass so you
4151 don't have to modify your code every time you shuffle around the class
4152 hierarchy. @code{GINAC_IMPLEMENT_REGISTERED_CLASS} implements the copy
4153 constructor, the destructor and the assignment operator.
4154
4155 Now there are nine member functions we have to implement to get a working
4156 class:
4157
4158 @itemize
4159
4160 @item
4161 @code{mystring()}, the default constructor.
4162
4163 @item
4164 @code{void destroy(bool call_parent)}, which is used in the destructor and the
4165 assignment operator to free dynamically allocated members. The @code{call_parent}
4166 specifies whether the @code{destroy()} function of the superclass is to be
4167 called also.
4168
4169 @item
4170 @code{void copy(const mystring &other)}, which is used in the copy constructor
4171 and assignment operator to copy the member variables over from another
4172 object of the same class.
4173
4174 @item
4175 @code{void archive(archive_node &n)}, the archiving function. This stores all
4176 information needed to reconstruct an object of this class inside an
4177 @code{archive_node}.
4178
4179 @item
4180 @code{mystring(const archive_node &n, const lst &sym_lst)}, the unarchiving
4181 constructor. This constructs an instance of the class from the information
4182 found in an @code{archive_node}.
4183
4184 @item
4185 @code{ex unarchive(const archive_node &n, const lst &sym_lst)}, the static
4186 unarchiving function. It constructs a new instance by calling the unarchiving
4187 constructor.
4188
4189 @item
4190 @code{int compare_same_type(const basic &other)}, which is used internally
4191 by GiNaC to establish a canonical sort order for terms. It returns 0, +1 or
4192 -1, depending on the relative order of this object and the @code{other}
4193 object. If it returns 0, the objects are considered equal.
4194 @strong{Note:} This has nothing to do with the (numeric) ordering
4195 relationship expressed by @code{<}, @code{>=} etc (which cannot be defined
4196 for non-numeric classes). For example, @code{numeric(1).compare_same_type(numeric(2))}
4197 may return +1 even though 1 is clearly smaller than 2. Every GiNaC class
4198 must provide a @code{compare_same_type()} function, even those representing
4199 objects for which no reasonable algebraic ordering relationship can be
4200 defined.
4201
4202 @item
4203 And, of course, @code{mystring(const string &s)} and @code{mystring(const char *s)}
4204 which are the two constructors we declared.
4205
4206 @end itemize
4207
4208 Let's proceed step-by-step. The default constructor looks like this:
4209
4210 @example
4211 mystring::mystring() : inherited(TINFO_mystring)
4212 @{
4213     // dynamically allocate resources here if required
4214 @}
4215 @end example
4216
4217 The golden rule is that in all constructors you have to set the
4218 @code{tinfo_key} member to the @code{TINFO_*} value of your class. Otherwise
4219 it will be set by the constructor of the superclass and all hell will break
4220 loose in the RTTI. For your convenience, the @code{basic} class provides
4221 a constructor that takes a @code{tinfo_key} value, which we are using here
4222 (remember that in our case @code{inherited = basic}). If the superclass
4223 didn't have such a constructor, we would have to set the @code{tinfo_key}
4224 to the right value manually.
4225
4226 In the default constructor you should set all other member variables to
4227 reasonable default values (we don't need that here since our @code{str}
4228 member gets set to an empty string automatically). The constructor(s) are of
4229 course also the right place to allocate any dynamic resources you require.
4230
4231 Next, the @code{destroy()} function:
4232
4233 @example
4234 void mystring::destroy(bool call_parent)
4235 @{
4236     // free dynamically allocated resources here if required
4237     if (call_parent)
4238         inherited::destroy(call_parent);
4239 @}
4240 @end example
4241
4242 This function is where we free all dynamically allocated resources. We don't
4243 have any so we're not doing anything here, but if we had, for example, used
4244 a C-style @code{char *} to store our string, this would be the place to
4245 @code{delete[]} the string storage. If @code{call_parent} is true, we have
4246 to call the @code{destroy()} function of the superclass after we're done
4247 (to mimic C++'s automatic invocation of superclass destructors where
4248 @code{destroy()} is called from outside a destructor).
4249
4250 The @code{copy()} function just copies over the member variables from
4251 another object:
4252
4253 @example
4254 void mystring::copy(const mystring &other)
4255 @{
4256     inherited::copy(other);
4257     str = other.str;
4258 @}
4259 @end example
4260
4261 We can simply overwrite the member variables here. There's no need to worry
4262 about dynamically allocated storage. The assignment operator (which is
4263 automatically defined by @code{GINAC_IMPLEMENT_REGISTERED_CLASS}, as you
4264 recall) calls @code{destroy()} before it calls @code{copy()}. You have to
4265 explicitly call the @code{copy()} function of the superclass here so
4266 all the member variables will get copied.
4267
4268 Next are the three functions for archiving. You have to implement them even
4269 if you don't plan to use archives, but the minimum required implementation
4270 is really simple. First, the archiving function:
4271
4272 @example
4273 void mystring::archive(archive_node &n) const
4274 @{
4275     inherited::archive(n);
4276     n.add_string("string", str);
4277 @}
4278 @end example
4279
4280 The only thing that is really required is calling the @code{archive()}
4281 function of the superclass. Optionally, you can store all information you
4282 deem necessary for representing the object into the passed
4283 @code{archive_node}. We are just storing our string here. For more
4284 information on how the archiving works, consult the @file{archive.h} header
4285 file.
4286
4287 The unarchiving constructor is basically the inverse of the archiving
4288 function:
4289
4290 @example
4291 mystring::mystring(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
4292 @{
4293     n.find_string("string", str);
4294 @}
4295 @end example
4296
4297 If you don't need archiving, just leave this function empty (but you must
4298 invoke the unarchiving constructor of the superclass). Note that we don't
4299 have to set the @code{tinfo_key} here because it is done automatically
4300 by the unarchiving constructor of the @code{basic} class.
4301
4302 Finally, the unarchiving function:
4303
4304 @example
4305 ex mystring::unarchive(const archive_node &n, const lst &sym_lst)
4306 @{
4307     return (new mystring(n, sym_lst))->setflag(status_flags::dynallocated);
4308 @}
4309 @end example
4310
4311 You don't have to understand how exactly this works. Just copy these four
4312 lines into your code literally (replacing the class name, of course). It
4313 calls the unarchiving constructor of the class and unless you are doing
4314 something very special (like matching @code{archive_node}s to global
4315 objects) you don't need a different implementation. For those who are
4316 interested: setting the @code{dynallocated} flag puts the object under
4317 the control of GiNaC's garbage collection. It will get deleted automatically
4318 once it is no longer referenced.
4319
4320 Our @code{compare_same_type()} function uses a provided function to compare
4321 the string members:
4322
4323 @example
4324 int mystring::compare_same_type(const basic &other) const
4325 @{
4326     const mystring &o = static_cast<const mystring &>(other);
4327     int cmpval = str.compare(o.str);
4328     if (cmpval == 0)
4329         return 0;
4330     else if (cmpval < 0)
4331         return -1;
4332     else
4333         return 1;
4334 @}
4335 @end example
4336
4337 Although this function takes a @code{basic &}, it will always be a reference
4338 to an object of exactly the same class (objects of different classes are not
4339 comparable), so the cast is safe. If this function returns 0, the two objects
4340 are considered equal (in the sense that @math{A-B=0}), so you should compare
4341 all relevant member variables.
4342
4343 Now the only thing missing is our two new constructors:
4344
4345 @example
4346 mystring::mystring(const string &s) : inherited(TINFO_mystring), str(s)
4347 @{
4348     // dynamically allocate resources here if required
4349 @}
4350
4351 mystring::mystring(const char *s) : inherited(TINFO_mystring), str(s)
4352 @{
4353     // dynamically allocate resources here if required
4354 @}
4355 @end example
4356
4357 No surprises here. We set the @code{str} member from the argument and
4358 remember to pass the right @code{tinfo_key} to the @code{basic} constructor.
4359
4360 That's it! We now have a minimal working GiNaC class that can store
4361 strings in algebraic expressions. Let's confirm that the RTTI works:
4362
4363 @example
4364 ex e = mystring("Hello, world!");
4365 cout << is_ex_of_type(e, mystring) << endl;
4366  // -> 1 (true)
4367
4368 cout << e.bp->class_name() << endl;
4369  // -> mystring
4370 @end example
4371
4372 Obviously it does. Let's see what the expression @code{e} looks like:
4373
4374 @example
4375 cout << e << endl;
4376  // -> [mystring object]
4377 @end example
4378
4379 Hm, not exactly what we expect, but of course the @code{mystring} class
4380 doesn't yet know how to print itself. This is done in the @code{print()}
4381 member function. Let's say that we wanted to print the string surrounded
4382 by double quotes:
4383
4384 @example
4385 class mystring : public basic
4386 @{
4387     ...
4388 public:
4389     void print(const print_context &c, unsigned level = 0) const;
4390     ...
4391 @};
4392
4393 void mystring::print(const print_context &c, unsigned level) const
4394 @{
4395     // print_context::s is a reference to an ostream
4396     c.s << '\"' << str << '\"';
4397 @}
4398 @end example
4399
4400 The @code{level} argument is only required for container classes to
4401 correctly parenthesize the output. Let's try again to print the expression:
4402