]> www.ginac.de Git - ginac.git/blobdiff - cint/ginaccint.1
- Removed cint subdir for good because the new separate package seems to
[ginac.git] / cint / ginaccint.1
diff --git a/cint/ginaccint.1 b/cint/ginaccint.1
deleted file mode 100644 (file)
index e9ebd08..0000000
+++ /dev/null
@@ -1,261 +0,0 @@
-.TH ginaccint 1 "January, 2000" "GiNaC"
-.SH NAME
-GiNaC-cint \- An interactive interface for GiNaC based on the Cint C/C++ interpreter
-.SH SYNPOSIS
-.B ginaccint
-[file ...]
-.SH DESCRIPTION
-.B ginaccint
-is an interactive frontend for the GiNaC symbolic computation
-framework.  It is a tool that lets you write interactive programs
-(scripts) in C++ that directly make use of GiNaC's classes.  Thus it
-is a more complete replacement for traditional interactive computer
-algebra systems than \fBginsh\fP(1) is.  Programs may be composed as
-scripts and later compiled with the native compiler and linked into
-the system.
-.SH USAGE
-.SS INPUT FORMAT
-After startup, GiNaC-cint reads and executes the files given as 
-command line arguments. If any of these files contains a
-.BR .quit
-command, GiNaC-cint exits at this point.
-Otherwise it displays a prompt signifying that it is ready to
-accept your input. All C++ statements are valid as input, extended by
-GiNaC's numeric or symbolic expressions.  E.g.
-.BR fibonacci(numeric(24))/1104;
-returns a GiNaC object of class
-.BR "ex" ,
-which in this case represents the numeric 42.  Symbols are declared by 
-statements as
-.nf 
-GiNaC> symbol x("x"), y("y"), z;
-.fi
-which defines two named symbols and an anonymous one for later usage.
-All GiNaC methods and functions are available as they would be coded
-in C++.  It is not necessary to explicitly invoke a print command as
-the last expression is automatically printed:
-.nf
-GiNaC> pow(x+y,4).expand();
-Out2 = x^4+4*x^3*y+6*x^2*y^2+4*x*y^3+y^4
-.fi
-Statements are generally closed either when a closing brace 
-.RB ( } )
-matches the first opening brace
-.RB ( { ) 
-or a semicolon
-.RB ( ; )
-is encountered while there are no open braces. This implies that
-an input like 
-.nf
-GiNaC> class A {
-     > }
-     > ;
-.fi
-is misinterpreted to be complete after the closing brace.
-Instead you have to write
-.nf
-GiNaC> class A {
-     > };
-.fi
-
-.SS SPECIAL COMMANDS
-
-Lines starting with a dot mark special GiNaC-cint commands. Instead of
-.BR "\fB.cmd\fB"
-you can also write
-.BR "\fB//GiNaC-cint.cmd\fB"
-to be compatible with programs that will be compiled later.
-This is mostly useful for the
-.BR "\fB.function\fB" 
-declaration.
-
-Lines starting with #! (for #!/path/ginaccint) are ignored.
-
-
-.IP "\fB.cint\fR"
-Switch to cint's interactive mode.
-
-.IP "\fB.function\fR"
-
-Allow a function definition in interactive mode.  GiNaC-cint must be
-put into a special mode in order to define a function. After that any
-function definition in valid C++ syntax may be typed in.  It becomes
-immediatly available for usage.
-
-.IP "\fB.help\fB"
-
-List a short summary of available commands.
-
-.IP "\fB.quit\fR"
-Exit from GiNaC-cint.  Same as 
-.BR ".bye" ,
-.BR ".exit" ,
-.BR ".q" ,
-.BR "bye;" ,
-.BR "exit; " or
-.BR "quit;" .
-
-.IP "\fB.read filename\fB"
-
-Read a file from disk and execute it in GiNaC-cint
-(recursive call is possible).
-
-.IP "\fB.redirect [filename]\fB"
-
-Redirect
-.BR "\fBOut\fP\fInum\fP" 
-output to a file (
-.BR .redirect
-alone redirects output to console).
-
-.IP "\fB.restart\fB"
-
-Restart GiNaC-cint (does not re-read command line files).      
-
-.IP "\fB.save filename\fB"
-
-Save the commands you have entered so far in a file.
-
-.IP "\fB.silent\fB"
-
-suppress
-.BR "\fBOut\fP\fInum\fP" 
-output (variables are still accessible).
-
-.IP "\fB.> [filename]\fB"
-
-same as
-.BR "\fB.redirect [filename]\fB" .
-
-.IP "\fBOut\fP\fInum\fP"
-Returns the expression whose output was marked
-.BR "\fBOut\fP\fInum\fP" 
-as a handle.
-
-.IP "\fBLAST\fP, \fBLLAST, \fP\fBLLLAST\fP"
-Return the last, second last and third last expression, 
-respectively.
-
-.SH EXAMPLES
-.nf
-GiNaC> symbol x("x"), y("y"), z("z");
-GiNaC> ex a = pow(x,2)-x-2;
-GiNaC> ex b = pow(x+1,2);
-GiNaC> ex s = a/b;
-GiNaC> s.diff(x);
-Out1 = -2*(1+x)^(-3)*(-2-x+x^2)+(-1+2*x)*(1+x)^(-2)
-GiNaC> s.normal();
-Out2 = (-2+x)*(1+x)^(-1)
-GiNaC> for (int i=2; i<20; i+=2) {
-     >     cout << "B(" << i << ")==" << bernoulli(numeric(i)) << endl;
-     > }
-B(2)==1/6
-B(4)==-1/30
-B(6)==1/42
-B(8)==-1/30
-B(10)==5/66
-B(12)==-691/2730
-B(14)==7/6
-B(16)==-3617/510
-B(18)==43867/798
-GiNaC> .function
-next expression can be a function definition
-GiNaC> ex EulerNumber(unsigned n)
-     > {
-     >     symbol xi;
-     >     const ex generator = pow(cosh(xi),-1);
-     >     return generator.diff(xi,n).subs(xi==0);
-     > }
-creating file /tmp/ginac26197caa
-GiNaC> EulerNumber(42);
-Out3 = -10364622733519612119397957304745185976310201
-GiNaC> ex f = expand((x*y*z-1)*(x*y*z+3));
-GiNaC> ex g = expand((x*y*z-1)*(x*y*z-3));
-GiNaC> cout << "The GCD of " << f << " and " << g << endl
-     >      << " is " << gcd(f, g) << endl
-     >      << " so " << f/g << endl
-     >      << " is " << normal(f/g) << endl;
-The GCD of -3+2*x*z*y+x^2*z^2*y^2 and 3-4*x*z*y+x^2*z^2*y^2
- is -1+x*z*y
- so (-3+2*x*z*y+x^2*z^2*y^2)*(3-4*x*z*y+x^2*z^2*y^2)^(-1)
- is (-3+x*z*y)^(-1)*(3+x*z*y)
-GiNaC> .quit
-.fi
-
-.SH BUGS
-Cint accepts most of K&R and ANSI C/C++ language construct but not
-perfect.  In fact, Cint is not aimed to be a 100% ANSI/ISO compliant
-C/C++ language processor.  It rather is a portable script language
-environment which is close enough to the standard C++.  See the file 
-.BR limitati.txt
-in your Cint distribution.  Please take the time to track down any bug
-you encounter as far as possible and contact Masaharu Goto
-<MXJ02154@niftyserve.or.jp> for Cint-related bugs and
-<ginac-bugs@ginac.de> for any bugs in the GiNaC engine.
-
-Only expressions (class
-.BR ex )
-are typed out and available through 
-.BR "\fBOut\fP\fInum\fP" 
-and 
-.BR LAST
-after declaring them.  This accounts for some funny behaviour, like
-.BR fibonacci(numeric(7))
-doesn't print, but
-.BR fibonacci(numeric(7))*1
-does, since this is not a naked number but an expression holding
-that number. A warning message is printed in this case only for
-the first occurence.
-
-.SH AUTHOR
-.TP
-The GiNaC Group
-.br
-Christian Bauer <Christian.Bauer@uni-mainz.de>
-.br
-Alexander Frink <Alexander.Frink@uni-mainz.de>
-.br
-Richard Kreckel <Richard.Kreckel@uni-mainz.de>
-.TP
-Agilent Technologies Japan
-.br
-Masaharu Goto <MXJ02154@niftyserve.or.jp>
-.SH SEE ALSO
-GiNaC Tutorial \- An open framework for symbolic computation within the
-C++ programming language
-.PP
-CLN \- A Class Library for Numbers, Bruno Haible
-.PP
-\fBginsh\fP(1)
-.SH COPYRIGHT
-.SS GINAC COPYRIGHT
-Copyright \(co 1999-2001 Johannes Gutenberg Universit\(:at Mainz, Germany
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-.SS CINT COPYRIGHT
-Copyright \(co of Cint and associated tools are owned by Agilent
-Technologies Japan Company and the author (Masaharu Goto).  Source
-code, binary executable or library of Cint and associated tools can be
-used, modified and distributed with no royalty for any purpose
-provided that the copyright notice appear in all copies and that both
-that copyright notice and this permission notice appear in supporting
-documentation.  Registration is recommended for commercial use
-(=Selling a software that uses cint as a component).  Send e-mail to
-the author (MXJ02154@niftyserve.or.jp) with your name, e-mail address,
-institute, purpose of using cint and computer platform.  If a
-modification is made on any of the source or documentation, it has to
-be clearly documented and expressed.  Agilent Technologies Japan and
-the author make no representations about the suitability of this
-software for any purpose.