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