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