0ce268b5b009da7cfacd559a6926057e96fa0cfe
[ginac.git] / cint / ginaccint.1
1 .TH ginaccint 1 "January, 2000" "GiNaC"
2 .SH NAME
3 GiNaC-cint \- An interactive interface for GiNaC based on the Cint C/C++ interpreter
4 .SH SYNPOSIS
5 .B ginaccint
6 .SH DESCRIPTION
7 .B ginaccint
8 is an interactive frontend for the GiNaC symbolic computation
9 framework.  It is a tool that lets you write interactive programs in
10 C++ that directly make use of GiNaC's classes and thus a more complete
11 replacement for traditional interactive computer algebra systems than
12 \fBginsh\fP(1) is.  Programs may be composed as scripts and later compiled
13 with the native compiler and linked into the system.
14 .SH USAGE
15 .SS INPUT FORMAT
16 After startup, ginsh displays a prompt signifying that it is ready to
17 accept your input. All C++ statements are valid as input, extended by
18 GiNaC's numeric or symbolic expressions.  E.g.
19 .BR fibonacci(24)/1104; 
20 returns a GiNaC object of class
21 .BR ex,
22 , which in this case represents the numeric 42.  Symbols are declared by 
23 statements as
24 .nf 
25 GiNaC> symbol x("x"), y("y"), z;
26 .fi
27 which defines two named symbols and an anonymous one for later usage.
28 All GiNaC methods and functions are available as they would be typed
29 in C++.  It is not necessary to explicitly invoke a print command as
30 the last expression is automatically printed:
31 .nf
32 GiNaC> pow(x+y,4).expand();
33 out2 = x^4+4*x^3*y+6*x^2*y^2+4*x*y^3+y^4
34 .fi
35 Statements are generally closed by either when a closing brace 
36 .RB ( } )
37 matches the first opening brace
38 .RB ( { ) 
39 or a semicolon
40 .RB ( ; )
41 is encountered.
42
43 .SS SPECIAL COMMANDS
44 .IP "\fB.cint\fR"
45 Switch to cint interactive mode.
46 .IP "\fB.function\fR"
47
48 Allow a function definition in interactive mode.  GiNaC-cint must be
49 put into a special mode in order to define a function. After that any
50 function definition in valid C++ syntax may be typed in.  It becomes
51 immediatly available for usage.
52
53 .IP "\fBquit;\fR"
54 Exit from GiNaC-Cint.  Same as 
55 .BR "exit;" ,
56 .BR "bye;" ,
57 .BR ".q" ,
58 .BR ".quit" ,
59 .BR ".exit " or
60 .BR ".bye" .
61
62 .IP "\fBOut\fP\fInum\fP"
63 Returns the expression whose output was marked
64 .BR "\fBOut\fP\fInum\fP" 
65 as a handle.
66
67 .SH EXAMPLES
68 .nf
69 GiNaC> symbol x("x"), y("y"), z("z");
70 GiNaC> ex a = pow(x,2)-x-2;
71 GiNaC> ex b = pow(x+1,2);
72 GiNaC> ex s = a/b;
73 GiNaC> s.diff(x);
74 Out1 = -2*(1+x)^(-3)*(-2-x+x^2)+(-1+2*x)*(1+x)^(-2)
75 GiNaC> s.normal();
76 Out2 = (-2+x)*(1+x)^(-1)
77 GiNaC> for (int i=2; i<20; i+=2) {
78      >     cout << "B(" << i << ") == " << bernoulli(i) << endl;
79      > }
80 B(2)==1/6
81 B(4)==-1/30
82 B(6)==1/42
83 B(8)==-1/30
84 B(10)==5/66
85 B(12)==-691/2730
86 B(14)==7/6
87 B(16)==-3617/510
88 B(18)==43867/798
89 GiNaC> .function
90 next expression can be a function definition
91 GiNaC> ex EulerNumber(unsigned n)
92      > {
93      >     symbol x;
94      >     const ex generator = pow(cosh(x),-1);
95      >     return generator.diff(x,n).subs(x==0);
96      > }
97 creating file /tmp/ginac26197caa
98 GiNaC> EulerNumber(42);
99 Out3 = -10364622733519612119397957304745185976310201
100 GiNaC> quit;
101 .fi
102
103 .SH BUGS
104 Cint accepts most of K&R and ANSI C/C++ language construct but not
105 perfect.  In fact, Cint is not aimed to be a 100% ANSI/ISO compliant
106 C/C++ language processor.  It rather is a portable script language
107 environment which is close enough to the standard C++.  See the file 
108 .BR limitati.txt
109 in your Cint distribution.  Please take the time to track down any bug
110 you encounter as far as possible and contact Masaharu Goto
111 <MXJ02154@niftyserve.or.jp> for Cint-related bugs and
112 <ginac-bugs@ginac.de> for any bugs in the GiNaC engine.
113
114 .SH AUTHOR
115 .TP
116 The GiNaC Group
117 .br
118 Christian Bauer <Christian.Bauer@uni-mainz.de>
119 .br
120 Alexander Frink <Alexander.Frink@uni-mainz.de>
121 .br
122 Richard Kreckel <Richard.Kreckel@uni-mainz.de>
123 .TP
124 Agilent Technologies Japan
125 .br
126 Masaharu Goto <MXJ02154@niftyserve.or.jp>
127 .SH SEE ALSO
128 GiNaC Tutorial \- An open framework for symbolic computation within the
129 C++ programming language
130 .PP
131 CLN \- A Class Library for Numbers, Bruno Haible
132 .PP
133 \fBginsh\fP(1)
134 .SH COPYRIGHT
135 .SS CINT COPYRIGHT
136 Copyright \(co of Cint and associated tools are owned by Agilent
137 Technologies Japan Company and the author.  Acknowledgement to the
138 author by e-mail is recommended at installation.  Source code, binary
139 executable or library of Cint and associated tools can be used,
140 modified and distributed free of charge for any purpose provided that
141 the copyright notice appear in all copies and that both that copyright
142 notice and this permission notice appear in documentation.
143 Registration is requested, at this moment, for commercial use.  Send
144 e-mail to the author <MXJ02154@niftyserve.or.jp>.  The registration is
145 free.
146 .SS GINAC COPYRIGHT
147 Copyright \(co 1999-2000 Johannes Gutenberg Universit\(:at Mainz, Germany
148
149 This program is free software; you can redistribute it and/or modify
150 it under the terms of the GNU General Public License as published by
151 the Free Software Foundation; either version 2 of the License, or
152 (at your option) any later version.
153
154 This program is distributed in the hope that it will be useful,
155 but WITHOUT ANY WARRANTY; without even the implied warranty of
156 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
157 GNU General Public License for more details.
158
159 You should have received a copy of the GNU General Public License
160 along with this program; if not, write to the Free Software
161 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.