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