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