index fbe21f4f46db5a04a9f5e55f92ec1d4367a34c4d..32b0cec6456afe0645e12e93394417bdda5312d4 100644 (file)
@@ -111,6 +111,7 @@ expression.
ginsh provides the following operators, listed in falling order of precedence:
.RS
.TP 8m
+\" GINSH_OP_HELP_START
.B !
postfix factorial
.TP
@@ -158,6 +159,7 @@ not equal
.TP
.B =
symbol assignment
+\" GINSH_OP_HELP_END
.RE
.PP
All binary operators are left-associative, with the exception of
@@ -213,94 +215,133 @@ respective GiNaC methods of the same name, so I will not describe them in
detail here. Please refer to the GiNaC documentation.
.PP
.RS
+\" GINSH_FCN_HELP_START
.BI beta( expression ", " expression )
+\- beta function
.br
.BI charpoly( matrix ", " symbol )
+\- characteristic polynomial of a matrix
.br
.BI coeff( expression ", " symbol ", " number )
+\- extracts coefficient of symbol^number from a polynomial
.br
.BI collect( expression ", " symbol )
+\- collects coefficients of like powers
.br
.BI content( expression ", " symbol )
+\- content part of a polynomial
.br
.BI degree( expression ", " symbol )
+\- degree of a polynomial
.br
.BI denom( expression )
+\- denominator of a rational function
.br
.BI determinant( matrix )
+\- determinant of a matrix
.br
.BI diag( expression... )
+\- constructs diagonal matrix
.br
.BI diff( expression ", " "symbol [" ", " number] )
+\- partial differentiation
.br
.BI divide( expression ", " expression )
+\- exact polynomial division
.br
-.BI eval( "expression [" ", " number] )
+.BI eval( "expression [" ", " level] )
+\- evaluates an expression, replacing symbols by their assigned value
.br
-.BI evalf( "expression [" ", " number] )
+.BI evalf( "expression [" ", " level] )
+\- evaluates an expression to a floating point number
.br
.BI expand( expression )
+\- expands an expression
.br
.BI gcd( expression ", " expression )
+\- greatest common divisor
.br
.BI has( expression ", " expression )
+\- returns "1" if the first expression contains the second as a subexpression, "0" otherwise
.br
.BI inverse( matrix )
+\- inverse of a matrix
.br
.BI is( relation )
-\- returns "1" if the
-.I relation
-is true, "0" otherwise (false or undecided)
+\- returns "1" if the relation is true, "0" otherwise (false or undecided)
.br
.BI lcm( expression ", " expression )
+\- least common multiple
.br
.BI lcoeff( expression ", " symbol )
+\- leading coefficient of a polynomial
.br
.BI ldegree( expression ", " symbol )
+\- low degree of a polynomial
.br
-.BI lsolve( list ", " list )
+.BI lsolve( equation-list ", " symbol-list )
+\- solve system of linear equations
.br
.BI nops( expression )
+\- number of operands in expression
.br
-.BI normal( "expression [" ", " number] )
+.BI normal( "expression [" ", " level] )
+\- rational function normalization
.br
.BI numer( expression )
+\- numerator of a rational function
.br
.BI op( expression ", " number )
+\- extract operand from expression
.br
-.BI power( expression ", " expression )
+.BI power( expr1 ", " expr2 )
+\- exponentiation (equivalent to writing expr1^expr2)
.br
.BI prem( expression ", " expression ", " symbol )
+\- pseudo-remainder of polynomials
.br
.BI primpart( expression ", " symbol )
+\- primitive part of a polynomial
.br
.BI quo( expression ", " expression ", " symbol )
+\- quotient of polynomials
.br
.BI rem( expression ", " expression ", " symbol )
+\- remainder of polynomials
.br
-.BI series( expression ", " "symbol [" ", " "number [" ", " number]] )
+.BI series( expression ", " "symbol [" ", " "point [" ", " order]] )
+\- series expansion
.br
.BI sqrfree( expression ", " symbol )
+\- square-free factorization of a polynomial
.br
.BI sqrt( expression )
+\- square root
.br
.BI subs( expression ", " relation-or-list )
.br
-.BI subs( expression ", " list ", " list )
+.BI subs( expression ", " look-for-list ", " replace-by-list )
+\- substitute subexpressions
.br
.BI tcoeff( expression ", " symbol )
+\- trailing coefficient of a polynomial
.br
.BI time( expression )
-\- returns the time in seconds needed to evaluate the given
-.I expression
+\- returns the time in seconds needed to evaluate the given expression
.br
.BI trace( matrix )
+\- trace of a matrix
.br
.BI transpose( matrix )
+\- transpose of a matrix
.br
.BI unassign( symbol )
+\- unassign an assigned symbol
.br
.BI unit( expression ", " symbol )
+\- unit part of a polynomial
+.br
+\" GINSH_FCN_HELP_END
.RE
.SS SPECIAL COMMANDS
To exit ginsh, enter
@@ -312,6 +353,17 @@ or
.B exit
.RE
.PP
+ginsh can display a (short) help for a given topic (mostly about functions
+and operators) by entering
+.RS
+.BI ? topic
+.RE
+Typing
+.RS
+.B ??
+.RE
+will display a list of available help topics.
+.PP
The command
.RS
.BI print( expression );
@@ -365,6 +417,8 @@ x
\-2*d\-2*x*c\-x^2*c\-x*d+x^2*d\-c
> collect(", x);
(\-d\-2*c)*x+(d\-c)*x^2\-2*d\-c
+> solve quantum field theory;
+parse error at quantum
> quit
.fi
.SH DIAGNOSTICS