added the sprem() function
[ginac.git] / ginsh / ginsh.1.in
1 .TH ginsh 1 "January, 2000" "GiNaC @VERSION@" "The GiNaC Group"
2 .SH NAME
3 ginsh \- GiNaC Interactive Shell
4 .SH SYNPOSIS
5 .B ginsh
6 .RI [ file\&... ]
7 .SH DESCRIPTION
8 .B ginsh
9 is an interactive frontend for the GiNaC symbolic computation framework.
10 It is intended as a tool for testing and experimenting with GiNaC's
11 features, not as a replacement for traditional interactive computer
12 algebra systems. Although it can do many things these traditional systems
13 can do, ginsh provides no programming constructs like loops or conditional
14 expressions. If you need this functionality you are advised to write
15 your program in C++, using the "native" GiNaC class framework.
16 .SH USAGE
17 .SS INPUT FORMAT
18 After startup, ginsh displays a prompt ("> ") signifying that it is ready
19 to accept your input. Acceptable input are numeric or symbolic expressions
20 consisting of numbers (e.g.
21 .BR 42 ", " 2/3 " or " 0.17 ),
22 symbols (e.g.
23 .BR x " or " result ),
24 mathematical operators like
25 .BR + " and  " * ,
26 and functions (e.g.
27 .BR sin " or " normal ).
28 Every input expression must be terminated with either a semicolon
29 .RB ( ; )
30 or a colon
31 .RB ( : ).
32 If terminated with a semicolon, ginsh will evaluate the expression and print
33 the result to stdout. If terminated with a colon, ginsh will only evaluate the
34 expression but not print the result. It is possible to enter multiple
35 expressions on one line. Whitespace (spaces, tabs, newlines) can be applied
36 freely between tokens. To quit ginsh, enter
37 .BR quit " or " exit ,
38 or type an EOF (Ctrl-D) at the prompt.
39 .SS COMMENTS
40 Anything following a double slash
41 .RB ( // )
42 up to the end of the line, and all lines starting with a hash mark
43 .RB ( # )
44 are treated as a comment and ignored.
45 .SS NUMBERS
46 ginsh accepts numbers in the usual decimal notations. This includes arbitrary
47 precision integers and rationals as well as floating point numbers in standard
48 or scientific notation (e.g.
49 .BR 1.2E6 ).
50 The general rule is that if a number contains a decimal point
51 .RB ( . ),
52 it is an (inexact) floating point number; otherwise it is an (exact) integer or
53 rational.
54 Integers can be specified in binary, octal, hexadecimal or arbitrary (2-36) base
55 by prefixing them with
56 .BR #b ", " #o ", " #x ", or "
57 .BI # n R
58 , respectively.
59 .SS SYMBOLS
60 Symbols are made up of a string of alphanumeric characters and the underscore
61 .RB ( _ ),
62 with the first character being non-numeric. E.g.
63 .BR a " and " mu_1
64 are acceptable symbol names, while
65 .B 2pi
66 is not. It is possible to use symbols with the same names as functions (e.g.
67 .BR sin );
68 ginsh is able to distinguish between the two.
69 .PP
70 Symbols can be assigned values by entering
71 .RS
72 .IB symbol " = " expression ;
73 .RE
74 .PP
75 To unassign the value of an assigned symbol, type
76 .RS
77 .BI unassign(' symbol ');
78 .RE
79 .PP
80 Assigned symbols are automatically evaluated (= replaced by their assigned value)
81 when they are used. To refer to the unevaluated symbol, put single quotes
82 .RB ( ' )
83 around the name, as demonstrated for the "unassign" command above.
84 .PP
85 The following symbols are pre-defined constants that cannot be assigned
86 a value by the user:
87 .RS
88 .TP 8m
89 .B Pi
90 Archimedes' Constant
91 .TP
92 .B Catalan
93 Catalan's Constant
94 .TP
95 .B Euler
96 Euler-Mascheroni Constant
97 .TP
98 .B I
99 sqrt(-1)
100 .TP
101 .B FAIL
102 an object of the GiNaC "fail" class
103 .RE
104 .PP
105 There is also the special
106 .RS
107 .B Digits
108 .RE
109 symbol that controls the numeric precision of calculations with inexact numbers.
110 Assigning an integer value to digits will change the precision to the given
111 number of decimal places.
112 .SS WILDCARDS
113 The has(), find(), match() and subs() functions accept wildcards as placeholders
114 for expressions. These have the syntax
115 .RS
116 .BI $ number
117 .RE
118 for example $0, $1 etc.
119 .SS LAST PRINTED EXPRESSIONS
120 ginsh provides the three special symbols
121 .RS
122 %, %% and %%%
123 .RE
124 that refer to the last, second last, and third last printed expression, respectively.
125 These are handy if you want to use the results of previous computations in a new
126 expression.
127 .SS OPERATORS
128 ginsh provides the following operators, listed in falling order of precedence:
129 .RS
130 .TP 8m
131 \" GINSH_OP_HELP_START
132 .B !
133 postfix factorial
134 .TP
135 .B ^
136 powering
137 .TP
138 .B +
139 unary plus
140 .TP
141 .B \-
142 unary minus
143 .TP
144 .B *
145 multiplication
146 .TP
147 .B /
148 division
149 .TP
150 .B +
151 addition
152 .TP
153 .B \-
154 subtraction
155 .TP
156 .B <
157 less than
158 .TP
159 .B >
160 greater than
161 .TP
162 .B <=
163 less or equal
164 .TP
165 .B >=
166 greater or equal
167 .TP
168 .B ==
169 equal
170 .TP
171 .B !=
172 not equal
173 .TP
174 .B =
175 symbol assignment
176 \" GINSH_OP_HELP_END
177 .RE
178 .PP
179 All binary operators are left-associative, with the exception of
180 .BR ^ " and " =
181 which are right-associative. The result of the assignment operator
182 .RB ( = )
183 is its right-hand side, so it's possible to assign multiple symbols in one
184 expression (e.g.
185 .BR "a = b = c = 2;" ).
186 .SS LISTS
187 Lists are used by the
188 .B subs
189 and
190 .B lsolve
191 functions. A list consists of an opening curly brace
192 .RB ( { ),
193 a (possibly empty) comma-separated sequence of expressions, and a closing curly
194 brace
195 .RB ( } ).
196 .SS MATRICES
197 A matrix consists of an opening square bracket
198 .RB ( [ ),
199 a non-empty comma-separated sequence of matrix rows, and a closing square bracket
200 .RB ( ] ).
201 Each matrix row consists of an opening square bracket
202 .RB ( [ ),
203 a non-empty comma-separated sequence of expressions, and a closing square bracket
204 .RB ( ] ).
205 If the rows of a matrix are not of the same length, the width of the matrix
206 becomes that of the longest row and shorter rows are filled up at the end
207 with elements of value zero.
208 .SS FUNCTIONS
209 A function call in ginsh has the form
210 .RS
211 .IB name ( arguments )
212 .RE
213 where
214 .I arguments
215 is a comma-separated sequence of expressions. ginsh provides a couple of built-in
216 functions and also "imports" all symbolic functions defined by GiNaC and additional
217 libraries. There is no way to define your own functions other than linking ginsh
218 against a library that defines symbolic GiNaC functions.
219 .PP
220 ginsh provides Tab-completion on function names: if you type the first part of
221 a function name, hitting Tab will complete the name if possible. If the part you
222 typed is not unique, hitting Tab again will display a list of matching functions.
223 Hitting Tab twice at the prompt will display the list of all available functions.
224 .PP
225 A list of the built-in functions follows. They nearly all work as the
226 respective GiNaC methods of the same name, so I will not describe them in
227 detail here. Please refer to the GiNaC documentation.
228 .PP
229 .RS
230 \" GINSH_FCN_HELP_START
231 .BI charpoly( matrix ", " symbol )
232 \- characteristic polynomial of a matrix
233 .br
234 .BI coeff( expression ", " object ", " number )
235 \- extracts coefficient of object^number from a polynomial
236 .br
237 .BI collect( expression ", " object-or-list )
238 \- collects coefficients of like powers (result in recursive form)
239 .br
240 .BI collect_distributed( expression ", " list )
241 \- collects coefficients of like powers (result in distributed form)
242 .br
243 .BI content( expression ", " symbol )
244 \- content part of a polynomial
245 .br
246 .BI decomp_rational( expression ", " symbol )
247 \- decompose rational function into polynomial and proper rational function
248 .br
249 .BI degree( expression ", " object )
250 \- degree of a polynomial
251 .br
252 .BI denom( expression )
253 \- denominator of a rational function
254 .br
255 .BI determinant( matrix )
256 \- determinant of a matrix
257 .br
258 .BI diag( expression... )
259 \- constructs diagonal matrix
260 .br
261 .BI diff( expression ", " "symbol [" ", " number] )
262 \- partial differentiation
263 .br
264 .BI divide( expression ", " expression )
265 \- exact polynomial division
266 .br
267 .BI eval( "expression [" ", " level] )
268 \- evaluates an expression, replacing symbols by their assigned value
269 .br
270 .BI evalf( "expression [" ", " level] )
271 \- evaluates an expression to a floating point number
272 .br
273 .BI evalm( expression )
274 \- evaluates sums, products and integer powers of matrices
275 .br
276 .BI expand( expression )
277 \- expands an expression
278 .br
279 .BI find( expression ", " pattern )
280 \- returns a list of all occurrences of a pattern in an expression
281 .br
282 .BI gcd( expression ", " expression )
283 \- greatest common divisor
284 .br
285 .BI has( expression ", " pattern )
286 \- returns "1" if the first expression contains the pattern as a subexpression, "0" otherwise
287 .br
288 .BI inverse( matrix )
289 \- inverse of a matrix
290 .br
291 .BI is( relation )
292 \- returns "1" if the relation is true, "0" otherwise (false or undecided)
293 .br
294 .BI lcm( expression ", " expression )
295 \- least common multiple
296 .br
297 .BI lcoeff( expression ", " object )
298 \- leading coefficient of a polynomial
299 .br
300 .BI ldegree( expression ", " object )
301 \- low degree of a polynomial
302 .br
303 .BI lsolve( equation-list ", " symbol-list )
304 \- solve system of linear equations
305 .br
306 .BI map( expression ", " pattern )
307 \- apply function to each operand; the function to be applied is specified as a pattern with the "$0" wildcard standing for the operands
308 .br
309 .BI match( expression ", " pattern )
310 \- check whether expression matches a pattern; returns a list of wildcard substitutions or "FAIL" if there is no match
311 .br
312 .BI nops( expression )
313 \- number of operands in expression
314 .br
315 .BI normal( "expression [" ", " level] )
316 \- rational function normalization
317 .br
318 .BI numer( expression )
319 \- numerator of a rational function
320 .br
321 .BI numer_denom( expression )
322 \- numerator and denumerator of a rational function as a list
323 .br
324 .BI op( expression ", " number )
325 \- extract operand from expression
326 .br
327 .BI power( expr1 ", " expr2 )
328 \- exponentiation (equivalent to writing expr1^expr2)
329 .br
330 .BI prem( expression ", " expression ", " symbol )
331 \- pseudo-remainder of polynomials
332 .br
333 .BI primpart( expression ", " symbol )
334 \- primitive part of a polynomial
335 .br
336 .BI quo( expression ", " expression ", " symbol )
337 \- quotient of polynomials
338 .br
339 .BI rem( expression ", " expression ", " symbol )
340 \- remainder of polynomials
341 .br
342 .BI series( expression ", " relation-or-symbol ", " order )
343 \- series expansion
344 .br
345 .BI sprem( expression ", " expression ", " symbol )
346 \- sparse pseudo-remainder of polynomials
347 .br
348 .BI sqrfree( "expression [" ", " symbol-list] )
349 \- square-free factorization of a polynomial
350 .br
351 .BI sqrt( expression )
352 \- square root
353 .br
354 .BI subs( expression ", " relation-or-list )
355 .br
356 .BI subs( expression ", " look-for-list ", " replace-by-list )
357 \- substitute subexpressions (you may use wildcards)
358 .br
359 .BI tcoeff( expression ", " object )
360 \- trailing coefficient of a polynomial
361 .br
362 .BI time( expression )
363 \- returns the time in seconds needed to evaluate the given expression
364 .br
365 .BI trace( matrix )
366 \- trace of a matrix
367 .br
368 .BI transpose( matrix )
369 \- transpose of a matrix
370 .br
371 .BI unassign( symbol )
372 \- unassign an assigned symbol
373 .br
374 .BI unit( expression ", " symbol )
375 \- unit part of a polynomial
376 .br
377 \" GINSH_FCN_HELP_END
378 .RE
379 .SS SPECIAL COMMANDS
380 To exit ginsh, enter
381 .RS
382 .B quit
383 .RE
384 or
385 .RS
386 .B exit
387 .RE
388 .PP
389 ginsh can display a (short) help for a given topic (mostly about functions
390 and operators) by entering
391 .RS
392 .BI ? topic
393 .RE
394 Typing
395 .RS
396 .B ??
397 .RE
398 will display a list of available help topics.
399 .PP
400 The command
401 .RS
402 .BI print( expression );
403 .RE
404 will print a dump of GiNaC's internal representation for the given
405 .IR expression .
406 This is useful for debugging and for learning about GiNaC internals.
407 .PP
408 The command
409 .RS
410 .BI print_latex( expression );
411 .RE
412 prints a LaTeX representation of the given
413 .IR expression .
414 .PP
415 The command
416 .RS
417 .BI print_csrc( expression );
418 .RE
419 prints the given
420 .I expression
421 in a way that can be used in a C or C++ program (complex numbers are not
422 supported, though).
423 .PP
424 The command
425 .RS
426 .BI iprint( expression );
427 .RE
428 prints the given
429 .I expression
430 (which must evaluate to an integer) in decimal, octal, and hexadecimal representations.
431 .PP
432 Finally, the shell escape
433 .RS
434 .B !
435 .RI [ "command  " [ arguments ]]
436 .RE
437 passes the given
438 .I command
439 and optionally
440 .I arguments
441 to the shell for execution. With this method, you can execute shell commands
442 from within ginsh without having to quit.
443 .SH EXAMPLES
444 .nf
445 > a = x^2\-x\-2;
446 \-2\-x+x^2
447 > b = (x+1)^2;
448 (x+1)^2
449 > s = a/b;
450 (x+1)^(\-2)*(\-2\-x+x^2)
451 > diff(s, x);
452 (2*x\-1)*(x+1)^(\-2)\-2*(x+1)^(\-3)*(\-x+x^2\-2)
453 > normal(s);
454 (x\-2)*(x+1)^(\-1)
455 > x = 3^50;
456 717897987691852588770249
457 > s;
458 717897987691852588770247/717897987691852588770250
459 > Digits = 40;
460 40
461 > evalf(s);
462 0.999999999999999999999995821133292704384960990679
463 > unassign('x');
464 x
465 > s;
466 (x+1)^(\-2)*(\-x+x^2\-2)
467 > series(sin(x),x==0,6);
468 1*x+(\-1/6)*x^3+1/120*x^5+Order(x^6)
469 > lsolve({3*x+5*y == 7}, {x, y});
470 {x==\-5/3*y+7/3,y==y}
471 > lsolve({3*x+5*y == 7, \-2*x+10*y == \-5}, {x, y});
472 {x==19/8,y==\-1/40}
473 > M = [ [a, b], [c, d] ];
474 [[\-x+x^2\-2,(x+1)^2],[c,d]]
475 > determinant(M);
476 \-2*d\-2*x*c\-x^2*c\-x*d+x^2*d\-c
477 > collect(%, x);
478 (\-d\-2*c)*x+(d\-c)*x^2\-2*d\-c
479 > solve quantum field theory;
480 parse error at quantum
481 > quit
482 .fi
483 .SH DIAGNOSTICS
484 .TP
485 .RI "parse error at " foo
486 You entered something which ginsh was unable to parse. Please check the syntax
487 of your input and try again.
488 .TP
489 .RI "argument " num " to " function " must be a " type
490 The argument number
491 .I num
492 to the given
493 .I function
494 must be of a certain type (e.g. a symbol, or a list). The first argument has
495 number 0, the second argument number 1, etc.
496 .SH AUTHOR
497 .TP
498 The GiNaC Group:
499 .br
500 Christian Bauer <Christian.Bauer@uni-mainz.de>
501 .br
502 Alexander Frink <Alexander.Frink@uni-mainz.de>
503 .br
504 Richard Kreckel <Richard.Kreckel@uni-mainz.de>
505 .SH SEE ALSO
506 GiNaC Tutorial \- An open framework for symbolic computation within the
507 C++ programming language
508 .PP
509 CLN \- A Class Library for Numbers, Bruno Haible
510 .SH COPYRIGHT
511 Copyright \(co 1999-2002 Johannes Gutenberg Universit\(:at Mainz, Germany
512
513 This program is free software; you can redistribute it and/or modify
514 it under the terms of the GNU General Public License as published by
515 the Free Software Foundation; either version 2 of the License, or
516 (at your option) any later version.
517
518 This program is distributed in the hope that it will be useful,
519 but WITHOUT ANY WARRANTY; without even the implied warranty of
520 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
521 GNU General Public License for more details.
522
523 You should have received a copy of the GNU General Public License
524 along with this program; if not, write to the Free Software
525 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.