* Removed obsolete exponent marker in float output example.
[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 LAST PRINTED EXPRESSIONS
113 ginsh provides the three special symbols
114 .RS
115 ", "" and """
116 .RE
117 that refer to the last, second last, and third last printed expression, respectively.
118 These are handy if you want to use the results of previous computations in a new
119 expression.
120 .SS OPERATORS
121 ginsh provides the following operators, listed in falling order of precedence:
122 .RS
123 .TP 8m
124 \" GINSH_OP_HELP_START
125 .B !
126 postfix factorial
127 .TP
128 .B ^
129 powering
130 .TP
131 .B +
132 unary plus
133 .TP
134 .B \-
135 unary minus
136 .TP
137 .B *
138 multiplication
139 .TP
140 .B %
141 non-commutative multiplication
142 .TP
143 .B /
144 division
145 .TP
146 .B +
147 addition
148 .TP
149 .B \-
150 subtraction
151 .TP
152 .B <
153 less than
154 .TP
155 .B >
156 greater than
157 .TP
158 .B <=
159 less or equal
160 .TP
161 .B >=
162 greater or equal
163 .TP
164 .B ==
165 equal
166 .TP
167 .B !=
168 not equal
169 .TP
170 .B =
171 symbol assignment
172 \" GINSH_OP_HELP_END
173 .RE
174 .PP
175 All binary operators are left-associative, with the exception of
176 .BR ^ " and " =
177 which are right-associative. The result of the assignment operator
178 .RB ( = )
179 is its right-hand side, so it's possible to assign multiple symbols in one
180 expression (e.g.
181 .BR "a = b = c = 2;" ).
182 .SS LISTS
183 Lists are used by the
184 .B subs
185 and
186 .B lsolve
187 functions. A list consists of an opening square bracket
188 .RB ( [ ),
189 a (possibly empty) comma-separated sequence of expressions, and a closing square
190 bracket
191 .RB ( ] ).
192 .SS MATRICES
193 A matrix consists of an opening double square bracket
194 .RB ( [[ ),
195 a non-empty comma-separated sequence of matrix rows, and a closing double square
196 bracket
197 .RB ( ]] ).
198 Each matrix row consists of an opening double square bracket
199 .RB ( [[ ),
200 a non-empty comma-separated sequence of expressions, and a closing double square
201 bracket
202 .RB ( ]] ).
203 If the rows of a matrix are not of the same length, the width of the matrix
204 becomes that of the longest row and shorter rows are filled up at the end
205 with elements of value zero.
206 .SS FUNCTIONS
207 A function call in ginsh has the form
208 .RS
209 .IB name ( arguments )
210 .RE
211 where
212 .I arguments
213 is a comma-separated sequence of expressions. ginsh provides a couple of built-in
214 functions and also "imports" all symbolic functions defined by GiNaC and additional
215 libraries. There is no way to define your own functions other than linking ginsh
216 against a library that defines symbolic GiNaC functions.
217 .PP
218 ginsh provides Tab-completion on function names: if you type the first part of
219 a function name, hitting Tab will complete the name if possible. If the part you
220 typed is not unique, hitting Tab again will display a list of matching functions.
221 Hitting Tab twice at the prompt will display the list of all available functions.
222 .PP
223 A list of the built-in functions follows. They nearly all work as the
224 respective GiNaC methods of the same name, so I will not describe them in
225 detail here. Please refer to the GiNaC documentation.
226 .PP
227 .RS
228 \" GINSH_FCN_HELP_START
229 .BI charpoly( matrix ", " symbol )
230 \- characteristic polynomial of a matrix
231 .br
232 .BI coeff( expression ", " symbol ", " number )
233 \- extracts coefficient of symbol^number from a polynomial
234 .br
235 .BI collect( expression ", " symbol )
236 \- collects coefficients of like powers
237 .br
238 .BI content( expression ", " symbol )
239 \- content part of a polynomial
240 .br
241 .BI degree( expression ", " symbol )
242 \- degree of a polynomial
243 .br
244 .BI denom( expression )
245 \- denominator of a rational function
246 .br
247 .BI determinant( matrix )
248 \- determinant of a matrix
249 .br
250 .BI diag( expression... )
251 \- constructs diagonal matrix
252 .br
253 .BI diff( expression ", " "symbol [" ", " number] )
254 \- partial differentiation
255 .br
256 .BI divide( expression ", " expression )
257 \- exact polynomial division
258 .br
259 .BI eval( "expression [" ", " level] )
260 \- evaluates an expression, replacing symbols by their assigned value
261 .br
262 .BI evalf( "expression [" ", " level] )
263 \- evaluates an expression to a floating point number
264 .br
265 .BI expand( expression )
266 \- expands an expression
267 .br
268 .BI gcd( expression ", " expression )
269 \- greatest common divisor
270 .br
271 .BI has( expression ", " expression )
272 \- returns "1" if the first expression contains the second as a subexpression, "0" otherwise
273 .br
274 .BI inverse( matrix )
275 \- inverse of a matrix
276 .br
277 .BI is( relation )
278 \- returns "1" if the relation is true, "0" otherwise (false or undecided)
279 .br
280 .BI lcm( expression ", " expression )
281 \- least common multiple
282 .br
283 .BI lcoeff( expression ", " symbol )
284 \- leading coefficient of a polynomial
285 .br
286 .BI ldegree( expression ", " symbol )
287 \- low degree of a polynomial
288 .br
289 .BI lsolve( equation-list ", " symbol-list )
290 \- solve system of linear equations
291 .br
292 .BI nops( expression )
293 \- number of operands in expression
294 .br
295 .BI normal( "expression [" ", " level] )
296 \- rational function normalization
297 .br
298 .BI numer( expression )
299 \- numerator of a rational function
300 .br
301 .BI op( expression ", " number )
302 \- extract operand from expression
303 .br
304 .BI power( expr1 ", " expr2 )
305 \- exponentiation (equivalent to writing expr1^expr2)
306 .br
307 .BI prem( expression ", " expression ", " symbol )
308 \- pseudo-remainder of polynomials
309 .br
310 .BI primpart( expression ", " symbol )
311 \- primitive part of a polynomial
312 .br
313 .BI quo( expression ", " expression ", " symbol )
314 \- quotient of polynomials
315 .br
316 .BI rem( expression ", " expression ", " symbol )
317 \- remainder of polynomials
318 .br
319 .BI series( expression ", " relation-or-symbol ", " order )
320 \- series expansion
321 .br
322 .BI sqrfree( "expression [" ", " symbol-list] )
323 \- square-free factorization of a polynomial
324 .br
325 .BI sqrt( expression )
326 \- square root
327 .br
328 .BI subs( expression ", " relation-or-list )
329 .br
330 .BI subs( expression ", " look-for-list ", " replace-by-list )
331 \- substitute subexpressions
332 .br
333 .BI tcoeff( expression ", " symbol )
334 \- trailing coefficient of a polynomial
335 .br
336 .BI time( expression )
337 \- returns the time in seconds needed to evaluate the given expression
338 .br
339 .BI trace( matrix )
340 \- trace of a matrix
341 .br
342 .BI transpose( matrix )
343 \- transpose of a matrix
344 .br
345 .BI unassign( symbol )
346 \- unassign an assigned symbol
347 .br
348 .BI unit( expression ", " symbol )
349 \- unit part of a polynomial
350 .br
351 \" GINSH_FCN_HELP_END
352 .RE
353 .SS SPECIAL COMMANDS
354 To exit ginsh, enter
355 .RS
356 .B quit
357 .RE
358 or
359 .RS
360 .B exit
361 .RE
362 .PP
363 ginsh can display a (short) help for a given topic (mostly about functions
364 and operators) by entering
365 .RS
366 .BI ? topic
367 .RE
368 Typing
369 .RS
370 .B ??
371 .RE
372 will display a list of available help topics.
373 .PP
374 The command
375 .RS
376 .BI print( expression );
377 .RE
378 will print a dump of GiNaC's internal representation for the given
379 .IR expression .
380 This is useful for debugging and for learning about GiNaC internals.
381 .PP
382 The command
383 .RS
384 .BI iprint( expression );
385 .RE
386 prints the given
387 .I expression
388 (which must evaluate to an integer) in decimal, octal, and hexadecimal representations.
389 .PP
390 Finally, the shell escape
391 .RS
392 .B !
393 .RI [ "command  " [ arguments ]]
394 .RE
395 passes the given
396 .I command
397 and optionally
398 .I arguments
399 to the shell for execution. With this method, you can execute shell commands
400 from within ginsh without having to quit.
401 .SH EXAMPLES
402 .nf
403 > a = x^2\-x\-2;
404 \-x+x^2\-2
405 > b = (x+1)^2;
406 (x+1)^2
407 > s = a/b;
408 (x+1)^(\-2)*(\-x+x^2\-2)
409 > diff(s, x);
410 (2*x\-1)*(x+1)^(\-2)\-2*(x+1)^(\-3)*(\-x+x^2\-2)
411 > normal(s);
412 (x\-2)*(x+1)^(\-1)
413 > x = 3^50;
414 717897987691852588770249
415 > s;
416 717897987691852588770247/717897987691852588770250
417 > Digits = 40;
418 40
419 > evalf(s);
420 0.999999999999999999999995821133292704384960990679
421 > unassign('x');
422 x
423 > s;
424 (x+1)^(\-2)*(\-x+x^2\-2)
425 > lsolve([3*x+5*y == 7], [x, y]);
426 [x==\-5/3*y+7/3,y==y]
427 > lsolve([3*x+5*y == 7, \-2*x+10*y == \-5], [x, y]);
428 [x==19/8,y==\-1/40]
429 > M = [[ [[a, b]], [[c, d]] ]];
430 [[ [[\-x+x^2\-2,(x+1)^2]], [[c,d]] ]]
431 > determinant(M);
432 \-2*d\-2*x*c\-x^2*c\-x*d+x^2*d\-c
433 > collect(", x);
434 (\-d\-2*c)*x+(d\-c)*x^2\-2*d\-c
435 > solve quantum field theory;
436 parse error at quantum
437 > quit
438 .fi
439 .SH DIAGNOSTICS
440 .TP
441 .RI "parse error at " foo
442 You entered something which ginsh was unable to parse. Please check the syntax
443 of your input and try again.
444 .TP
445 .RI "argument " num " to " function " must be a " type
446 The argument number
447 .I num
448 to the given
449 .I function
450 must be of a certain type (e.g. a symbol, or a list). The first argument has
451 number 0, the second argument number 1, etc.
452 .SH AUTHOR
453 .TP
454 The GiNaC Group:
455 .br
456 Christian Bauer <Christian.Bauer@uni-mainz.de>
457 .br
458 Alexander Frink <Alexander.Frink@uni-mainz.de>
459 .br
460 Richard Kreckel <Richard.Kreckel@uni-mainz.de>
461 .SH SEE ALSO
462 GiNaC Tutorial \- An open framework for symbolic computation within the
463 C++ programming language
464 .PP
465 CLN \- A Class Library for Numbers, Bruno Haible
466 .SH COPYRIGHT
467 Copyright \(co 1999-2001 Johannes Gutenberg Universit\(:at Mainz, Germany
468
469 This program is free software; you can redistribute it and/or modify
470 it under the terms of the GNU General Public License as published by
471 the Free Software Foundation; either version 2 of the License, or
472 (at your option) any later version.
473
474 This program is distributed in the hope that it will be useful,
475 but WITHOUT ANY WARRANTY; without even the implied warranty of
476 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
477 GNU General Public License for more details.
478
479 You should have received a copy of the GNU General Public License
480 along with this program; if not, write to the Free Software
481 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.