prepared for 1.0.13 release
[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 collect_common_factors( expression )
244 \- collects common factors from the terms of sums
245 .br
246 .BI content( expression ", " symbol )
247 \- content part of a polynomial
248 .br
249 .BI decomp_rational( expression ", " symbol )
250 \- decompose rational function into polynomial and proper rational function
251 .br
252 .BI degree( expression ", " object )
253 \- degree of a polynomial
254 .br
255 .BI denom( expression )
256 \- denominator of a rational function
257 .br
258 .BI determinant( matrix )
259 \- determinant of a matrix
260 .br
261 .BI diag( expression... )
262 \- constructs diagonal matrix
263 .br
264 .BI diff( expression ", " "symbol [" ", " number] )
265 \- partial differentiation
266 .br
267 .BI divide( expression ", " expression )
268 \- exact polynomial division
269 .br
270 .BI eval( "expression [" ", " level] )
271 \- evaluates an expression, replacing symbols by their assigned value
272 .br
273 .BI evalf( "expression [" ", " level] )
274 \- evaluates an expression to a floating point number
275 .br
276 .BI evalm( expression )
277 \- evaluates sums, products and integer powers of matrices
278 .br
279 .BI expand( expression )
280 \- expands an expression
281 .br
282 .BI find( expression ", " pattern )
283 \- returns a list of all occurrences of a pattern in an expression
284 .br
285 .BI gcd( expression ", " expression )
286 \- greatest common divisor
287 .br
288 .BI has( expression ", " pattern )
289 \- returns "1" if the first expression contains the pattern as a subexpression, "0" otherwise
290 .br
291 .BI inverse( matrix )
292 \- inverse of a matrix
293 .br
294 .BI is( relation )
295 \- returns "1" if the relation is true, "0" otherwise (false or undecided)
296 .br
297 .BI lcm( expression ", " expression )
298 \- least common multiple
299 .br
300 .BI lcoeff( expression ", " object )
301 \- leading coefficient of a polynomial
302 .br
303 .BI ldegree( expression ", " object )
304 \- low degree of a polynomial
305 .br
306 .BI lsolve( equation-list ", " symbol-list )
307 \- solve system of linear equations
308 .br
309 .BI map( expression ", " pattern )
310 \- apply function to each operand; the function to be applied is specified as a pattern with the "$0" wildcard standing for the operands
311 .br
312 .BI match( expression ", " pattern )
313 \- check whether expression matches a pattern; returns a list of wildcard substitutions or "FAIL" if there is no match
314 .br
315 .BI nops( expression )
316 \- number of operands in expression
317 .br
318 .BI normal( "expression [" ", " level] )
319 \- rational function normalization
320 .br
321 .BI numer( expression )
322 \- numerator of a rational function
323 .br
324 .BI numer_denom( expression )
325 \- numerator and denumerator of a rational function as a list
326 .br
327 .BI op( expression ", " number )
328 \- extract operand from expression
329 .br
330 .BI power( expr1 ", " expr2 )
331 \- exponentiation (equivalent to writing expr1^expr2)
332 .br
333 .BI prem( expression ", " expression ", " symbol )
334 \- pseudo-remainder of polynomials
335 .br
336 .BI primpart( expression ", " symbol )
337 \- primitive part of a polynomial
338 .br
339 .BI quo( expression ", " expression ", " symbol )
340 \- quotient of polynomials
341 .br
342 .BI rem( expression ", " expression ", " symbol )
343 \- remainder of polynomials
344 .br
345 .BI series( expression ", " relation-or-symbol ", " order )
346 \- series expansion
347 .br
348 .BI sprem( expression ", " expression ", " symbol )
349 \- sparse pseudo-remainder of polynomials
350 .br
351 .BI sqrfree( "expression [" ", " symbol-list] )
352 \- square-free factorization of a polynomial
353 .br
354 .BI sqrt( expression )
355 \- square root
356 .br
357 .BI subs( expression ", " relation-or-list )
358 .br
359 .BI subs( expression ", " look-for-list ", " replace-by-list )
360 \- substitute subexpressions (you may use wildcards)
361 .br
362 .BI tcoeff( expression ", " object )
363 \- trailing coefficient of a polynomial
364 .br
365 .BI time( expression )
366 \- returns the time in seconds needed to evaluate the given expression
367 .br
368 .BI trace( matrix )
369 \- trace of a matrix
370 .br
371 .BI transpose( matrix )
372 \- transpose of a matrix
373 .br
374 .BI unassign( symbol )
375 \- unassign an assigned symbol
376 .br
377 .BI unit( expression ", " symbol )
378 \- unit part of a polynomial
379 .br
380 \" GINSH_FCN_HELP_END
381 .RE
382 .SS SPECIAL COMMANDS
383 To exit ginsh, enter
384 .RS
385 .B quit
386 .RE
387 or
388 .RS
389 .B exit
390 .RE
391 .PP
392 ginsh can display a (short) help for a given topic (mostly about functions
393 and operators) by entering
394 .RS
395 .BI ? topic
396 .RE
397 Typing
398 .RS
399 .B ??
400 .RE
401 will display a list of available help topics.
402 .PP
403 The command
404 .RS
405 .BI print( expression );
406 .RE
407 will print a dump of GiNaC's internal representation for the given
408 .IR expression .
409 This is useful for debugging and for learning about GiNaC internals.
410 .PP
411 The command
412 .RS
413 .BI print_latex( expression );
414 .RE
415 prints a LaTeX representation of the given
416 .IR expression .
417 .PP
418 The command
419 .RS
420 .BI print_csrc( expression );
421 .RE
422 prints the given
423 .I expression
424 in a way that can be used in a C or C++ program (complex numbers are not
425 supported, though).
426 .PP
427 The command
428 .RS
429 .BI iprint( expression );
430 .RE
431 prints the given
432 .I expression
433 (which must evaluate to an integer) in decimal, octal, and hexadecimal representations.
434 .PP
435 Finally, the shell escape
436 .RS
437 .B !
438 .RI [ "command  " [ arguments ]]
439 .RE
440 passes the given
441 .I command
442 and optionally
443 .I arguments
444 to the shell for execution. With this method, you can execute shell commands
445 from within ginsh without having to quit.
446 .SH EXAMPLES
447 .nf
448 > a = x^2\-x\-2;
449 \-2\-x+x^2
450 > b = (x+1)^2;
451 (x+1)^2
452 > s = a/b;
453 (x+1)^(\-2)*(\-2\-x+x^2)
454 > diff(s, x);
455 (2*x\-1)*(x+1)^(\-2)\-2*(x+1)^(\-3)*(\-x+x^2\-2)
456 > normal(s);
457 (x\-2)*(x+1)^(\-1)
458 > x = 3^50;
459 717897987691852588770249
460 > s;
461 717897987691852588770247/717897987691852588770250
462 > Digits = 40;
463 40
464 > evalf(s);
465 0.999999999999999999999995821133292704384960990679
466 > unassign('x');
467 x
468 > s;
469 (x+1)^(\-2)*(\-x+x^2\-2)
470 > series(sin(x),x==0,6);
471 1*x+(\-1/6)*x^3+1/120*x^5+Order(x^6)
472 > lsolve({3*x+5*y == 7}, {x, y});
473 {x==\-5/3*y+7/3,y==y}
474 > lsolve({3*x+5*y == 7, \-2*x+10*y == \-5}, {x, y});
475 {x==19/8,y==\-1/40}
476 > M = [ [a, b], [c, d] ];
477 [[\-x+x^2\-2,(x+1)^2],[c,d]]
478 > determinant(M);
479 \-2*d\-2*x*c\-x^2*c\-x*d+x^2*d\-c
480 > collect(%, x);
481 (\-d\-2*c)*x+(d\-c)*x^2\-2*d\-c
482 > solve quantum field theory;
483 parse error at quantum
484 > quit
485 .fi
486 .SH DIAGNOSTICS
487 .TP
488 .RI "parse error at " foo
489 You entered something which ginsh was unable to parse. Please check the syntax
490 of your input and try again.
491 .TP
492 .RI "argument " num " to " function " must be a " type
493 The argument number
494 .I num
495 to the given
496 .I function
497 must be of a certain type (e.g. a symbol, or a list). The first argument has
498 number 0, the second argument number 1, etc.
499 .SH AUTHOR
500 .TP
501 The GiNaC Group:
502 .br
503 Christian Bauer <Christian.Bauer@uni-mainz.de>
504 .br
505 Alexander Frink <Alexander.Frink@uni-mainz.de>
506 .br
507 Richard Kreckel <Richard.Kreckel@uni-mainz.de>
508 .SH SEE ALSO
509 GiNaC Tutorial \- An open framework for symbolic computation within the
510 C++ programming language
511 .PP
512 CLN \- A Class Library for Numbers, Bruno Haible
513 .SH COPYRIGHT
514 Copyright \(co 1999-2003 Johannes Gutenberg Universit\(:at Mainz, Germany
515
516 This program is free software; you can redistribute it and/or modify
517 it under the terms of the GNU General Public License as published by
518 the Free Software Foundation; either version 2 of the License, or
519 (at your option) any later version.
520
521 This program is distributed in the hope that it will be useful,
522 but WITHOUT ANY WARRANTY; without even the implied warranty of
523 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
524 GNU General Public License for more details.
525
526 You should have received a copy of the GNU General Public License
527 along with this program; if not, write to the Free Software
528 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.