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