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