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