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