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