|
1.2.1
by Camm Maguire
Import upstream version 5.10.0 |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
|
2 |
<html> |
|
3 |
<!-- Created on September, 20 2006 by texi2html 1.76 -->
|
|
4 |
<!--
|
|
5 |
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
|
|
6 |
Karl Berry <karl@freefriends.org>
|
|
7 |
Olaf Bachmann <obachman@mathematik.uni-kl.de>
|
|
8 |
and many others.
|
|
9 |
Maintained by: Many creative people <dev@texi2html.cvshome.org>
|
|
10 |
Send bugs and suggestions to <users@texi2html.cvshome.org>
|
|
11 |
||
12 |
-->
|
|
13 |
<head> |
|
14 |
<title>Maxima Manual: 3. Help</title> |
|
15 |
||
16 |
<meta name="description" content="Maxima Manual: 3. Help"> |
|
17 |
<meta name="keywords" content="Maxima Manual: 3. Help"> |
|
18 |
<meta name="resource-type" content="document"> |
|
19 |
<meta name="distribution" content="global"> |
|
20 |
<meta name="Generator" content="texi2html 1.76"> |
|
21 |
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> |
|
22 |
<style type="text/css"> |
|
23 |
<!-- |
|
24 |
a.summary-letter {text-decoration: none} |
|
25 |
pre.display {font-family: serif} |
|
26 |
pre.format {font-family: serif} |
|
27 |
pre.menu-comment {font-family: serif} |
|
28 |
pre.menu-preformatted {font-family: serif} |
|
29 |
pre.smalldisplay {font-family: serif; font-size: smaller} |
|
30 |
pre.smallexample {font-size: smaller} |
|
31 |
pre.smallformat {font-family: serif; font-size: smaller} |
|
32 |
pre.smalllisp {font-size: smaller} |
|
33 |
span.sansserif {font-family:sans-serif; font-weight:normal;} |
|
34 |
ul.toc {list-style: none} |
|
35 |
body
|
|
36 |
{
|
|
37 |
color: black; |
|
38 |
background: white; |
|
39 |
margin-left: 8%; |
|
40 |
margin-right: 13%; |
|
41 |
}
|
|
42 |
||
43 |
h1
|
|
44 |
{
|
|
45 |
margin-left: +8%; |
|
46 |
font-size: 150%; |
|
47 |
font-family: sans-serif |
|
48 |
}
|
|
49 |
||
50 |
h2
|
|
51 |
{
|
|
52 |
font-size: 125%; |
|
53 |
font-family: sans-serif |
|
54 |
}
|
|
55 |
||
56 |
h3
|
|
57 |
{
|
|
58 |
font-size: 100%; |
|
59 |
font-family: sans-serif |
|
60 |
}
|
|
61 |
||
62 |
h2,h3,h4,h5,h6 { margin-left: +4%; } |
|
63 |
||
64 |
div.textbox |
|
65 |
{
|
|
66 |
border: solid; |
|
67 |
border-width: thin; |
|
68 |
/* width: 100%; */
|
|
69 |
padding-top: 1em; |
|
70 |
padding-bottom: 1em; |
|
71 |
padding-left: 2em; |
|
72 |
padding-right: 2em |
|
73 |
}
|
|
74 |
||
75 |
div.titlebox |
|
76 |
{
|
|
77 |
border: none; |
|
78 |
padding-top: 1em; |
|
79 |
padding-bottom: 1em; |
|
80 |
padding-left: 2em; |
|
81 |
padding-right: 2em; |
|
82 |
background: rgb(200,255,255); |
|
83 |
font-family: sans-serif |
|
84 |
}
|
|
85 |
||
86 |
div.synopsisbox |
|
87 |
{
|
|
88 |
border: none; |
|
89 |
padding-top: 1em; |
|
90 |
padding-bottom: 1em; |
|
91 |
padding-left: 2em; |
|
92 |
padding-right: 2em; |
|
93 |
background: rgb(255,220,255); |
|
94 |
/*background: rgb(200,255,255); */
|
|
95 |
/* font-family: fixed */
|
|
96 |
}
|
|
97 |
||
98 |
pre.example |
|
99 |
{
|
|
100 |
border: none; |
|
101 |
padding-top: 1em; |
|
102 |
padding-bottom: 1em; |
|
103 |
padding-left: 1em; |
|
104 |
padding-right: 1em; |
|
105 |
background: rgb(247,242,180); /* kind of sandy */ |
|
106 |
/* background: rgb(200,255,255); */ /* sky blue */ |
|
107 |
font-family: "Lucida Console", monospace |
|
108 |
}
|
|
109 |
||
110 |
div.spacerbox |
|
111 |
{
|
|
112 |
border: none; |
|
113 |
padding-top: 2em; |
|
114 |
padding-bottom: 2em |
|
115 |
}
|
|
116 |
||
117 |
div.image |
|
118 |
{
|
|
119 |
margin: 0; |
|
120 |
padding: 1em; |
|
121 |
text-align: center; |
|
122 |
}
|
|
123 |
--> |
|
124 |
</style> |
|
125 |
||
126 |
<link rel="icon" href="http://maxima.sourceforge.net/favicon.ico"/> |
|
127 |
</head> |
|
128 |
||
129 |
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> |
|
130 |
||
131 |
<a name="Help"></a> |
|
132 |
<a name="SEC5"></a> |
|
133 |
<table cellpadding="1" cellspacing="1" border="0"> |
|
134 |
<tr><td valign="middle" align="left">[<a href="maxima_2.html#SEC4" title="Previous section in reading order"> < </a>]</td> |
|
135 |
<td valign="middle" align="left">[<a href="#SEC6" title="Next section in reading order"> > </a>]</td> |
|
136 |
<td valign="middle" align="left"> </td> |
|
137 |
<td valign="middle" align="left">[<a href="maxima_2.html#SEC2" title="Beginning of this chapter or previous chapter"> << </a>]</td> |
|
138 |
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Up section"> Up </a>]</td> |
|
139 |
<td valign="middle" align="left">[<a href="maxima_4.html#SEC11" title="Next chapter"> >> </a>]</td> |
|
140 |
<td valign="middle" align="left"> </td> |
|
141 |
<td valign="middle" align="left"> </td> |
|
142 |
<td valign="middle" align="left"> </td> |
|
143 |
<td valign="middle" align="left"> </td> |
|
144 |
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> |
|
145 |
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td> |
|
146 |
<td valign="middle" align="left">[<a href="maxima_72.html#SEC264" title="Index">Index</a>]</td> |
|
147 |
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td> |
|
148 |
</tr></table> |
|
149 |
<h1 class="chapter"> 3. Help </h1> |
|
150 |
||
151 |
<table class="menu" border="0" cellspacing="0"> |
|
152 |
<tr><td align="left" valign="top"><a href="#SEC6">3.1 Introduction to Help</a></td><td> </td><td align="left" valign="top"> |
|
153 |
</td></tr> |
|
154 |
<tr><td align="left" valign="top"><a href="#SEC7">3.2 Lisp and Maxima</a></td><td> </td><td align="left" valign="top"> |
|
155 |
</td></tr> |
|
156 |
<tr><td align="left" valign="top"><a href="#SEC8">3.3 Garbage Collection</a></td><td> </td><td align="left" valign="top"> |
|
157 |
</td></tr> |
|
158 |
<tr><td align="left" valign="top"><a href="#SEC9">3.4 Documentation</a></td><td> </td><td align="left" valign="top"> |
|
159 |
</td></tr> |
|
160 |
<tr><td align="left" valign="top"><a href="#SEC10">3.5 Definitions for Help</a></td><td> </td><td align="left" valign="top"> |
|
161 |
</td></tr> |
|
162 |
</table> |
|
163 |
||
164 |
<hr size="6"> |
|
165 |
<a name="Introduction-to-Help"></a> |
|
166 |
<a name="SEC6"></a> |
|
167 |
<table cellpadding="1" cellspacing="1" border="0"> |
|
168 |
<tr><td valign="middle" align="left">[<a href="#SEC5" title="Previous section in reading order"> < </a>]</td> |
|
169 |
<td valign="middle" align="left">[<a href="#SEC7" title="Next section in reading order"> > </a>]</td> |
|
170 |
<td valign="middle" align="left"> </td> |
|
171 |
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> |
|
172 |
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> |
|
173 |
<td valign="middle" align="left">[<a href="maxima_4.html#SEC11" title="Next chapter"> >> </a>]</td> |
|
174 |
<td valign="middle" align="left"> </td> |
|
175 |
<td valign="middle" align="left"> </td> |
|
176 |
<td valign="middle" align="left"> </td> |
|
177 |
<td valign="middle" align="left"> </td> |
|
178 |
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> |
|
179 |
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td> |
|
180 |
<td valign="middle" align="left">[<a href="maxima_72.html#SEC264" title="Index">Index</a>]</td> |
|
181 |
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td> |
|
182 |
</tr></table> |
|
183 |
<h2 class="section"> 3.1 Introduction to Help </h2> |
|
184 |
||
185 |
||
186 |
<p>The primary on-line help function is <code>describe</code>, |
|
187 |
which is typically invoked by the question mark <code>?</code> at the interactive prompt. |
|
188 |
<code>? foo</code> (with a space between <code>?</code> and <code>foo</code>) |
|
189 |
is equivalent to <code>describe ("foo")</code>, where <code>foo</code> |
|
190 |
is the name or part of the name of a function or topic; |
|
191 |
<code>describe</code> then finds all documented items which contain the string |
|
192 |
<code>foo</code> in their titles. |
|
193 |
If there is more than one such item, Maxima asks the user to select |
|
194 |
an item or items to display. |
|
195 |
</p> |
|
196 |
<table><tr><td> </td><td><pre class="example">(%i1) ? integ |
|
197 |
0: (maxima.info)Introduction to Elliptic Functions and Integrals. |
|
198 |
1: Definitions for Elliptic Integrals. |
|
199 |
2: Integration. |
|
200 |
3: Introduction to Integration. |
|
201 |
4: Definitions for Integration. |
|
202 |
5: askinteger :Definitions for Simplification. |
|
203 |
6: integerp :Definitions for Miscellaneous Options. |
|
204 |
7: integrate :Definitions for Integration. |
|
205 |
8: integrate_use_rootsof :Definitions for Integration. |
|
206 |
9: integration_constant_counter :Definitions for Integration. |
|
207 |
Enter space-separated numbers, `all' or `none': 7 8 |
|
208 |
||
209 |
Info from file /use/local/maxima/doc/info/maxima.info: |
|
210 |
- Function: integrate (expr, var) |
|
211 |
- Function: integrate (expr, var, a, b) |
|
212 |
Attempts to symbolically compute the integral of `expr' with |
|
213 |
respect to `var'. `integrate (expr, var)' is an indefinite |
|
214 |
integral, while `integrate (expr, var, a, b)' is a definite |
|
215 |
integral, [...] |
|
216 |
</pre></td></tr></table> |
|
217 |
<p>In this example, items 7 and 8 were selected. |
|
218 |
All or none of the items could have been selected by entering <code>all</code> or <code>none</code>, |
|
219 |
which can be abbreviated <code>a</code> or <code>n</code>, respectively. |
|
220 |
</p> |
|
221 |
<hr size="6"> |
|
222 |
<a name="Lisp-and-Maxima"></a> |
|
223 |
<a name="SEC7"></a> |
|
224 |
<table cellpadding="1" cellspacing="1" border="0"> |
|
225 |
<tr><td valign="middle" align="left">[<a href="#SEC6" title="Previous section in reading order"> < </a>]</td> |
|
226 |
<td valign="middle" align="left">[<a href="#SEC8" title="Next section in reading order"> > </a>]</td> |
|
227 |
<td valign="middle" align="left"> </td> |
|
228 |
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> |
|
229 |
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> |
|
230 |
<td valign="middle" align="left">[<a href="maxima_4.html#SEC11" title="Next chapter"> >> </a>]</td> |
|
231 |
<td valign="middle" align="left"> </td> |
|
232 |
<td valign="middle" align="left"> </td> |
|
233 |
<td valign="middle" align="left"> </td> |
|
234 |
<td valign="middle" align="left"> </td> |
|
235 |
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> |
|
236 |
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td> |
|
237 |
<td valign="middle" align="left">[<a href="maxima_72.html#SEC264" title="Index">Index</a>]</td> |
|
238 |
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td> |
|
239 |
</tr></table> |
|
240 |
<h2 class="section"> 3.2 Lisp and Maxima </h2> |
|
241 |
<p>Maxima is written in Lisp, and it is easy to access Lisp functions and variables |
|
242 |
from Maxima and vice versa. |
|
243 |
Lisp and Maxima symbols are distinguished by a naming convention. |
|
244 |
A Lisp symbol which begins with a dollar sign <code>$</code> corresponds to |
|
245 |
a Maxima symbol without the dollar sign. |
|
246 |
A Maxima symbol which begins with a question mark <code>?</code> corresponds to |
|
247 |
a Lisp symbol without the question mark. |
|
248 |
For example, the Maxima symbol <code>foo</code> corresponds to the Lisp symbol <code>$foo</code>, |
|
249 |
while the Maxima symbol <code>?foo</code> corresponds to the Lisp symbol <code>foo</code>, |
|
250 |
Note that <code>?foo</code> is written without a space between <code>?</code> and <code>foo</code>; |
|
251 |
otherwise it might be mistaken for <code>describe ("foo")</code>. |
|
252 |
</p> |
|
253 |
<p>Hyphen <code>-</code>, asterisk <code>*</code>, or other special characters in Lisp symbols |
|
254 |
must be escaped by backslash <code>\</code> where they appear in Maxima code. |
|
255 |
For example, the Lisp identifier <code>*foo-bar*</code> is written <code>?\*foo\-bar\*</code> in Maxima. |
|
256 |
</p> |
|
257 |
<p>Lisp code may be executed from within a Maxima session. |
|
258 |
A single line of Lisp (containing one or more forms) may be executed |
|
259 |
by the special command <code>:lisp</code>. For example, |
|
260 |
</p> |
|
261 |
<table><tr><td> </td><td><pre class="example">(%i1) :lisp (foo $x $y) |
|
262 |
</pre></td></tr></table> |
|
263 |
||
264 |
<p>calls the Lisp function <code>foo</code> with Maxima variables <code>x</code> and <code>y</code> as arguments. |
|
265 |
The <code>:lisp</code> construct can appear at the interactive prompt |
|
266 |
or in a file processed by <code>batch</code> or <code>demo</code>, but not in a file processed by |
|
267 |
<code>load</code>, <code>batchload</code>, <code>translate_file</code>, or <code>compile_file</code>. |
|
268 |
</p> |
|
269 |
<p>The function <code>to_lisp()</code> opens an interactive Lisp session. |
|
270 |
Entering <code>(to-maxima)</code> closes the Lisp session and returns to Maxima. |
|
271 |
</p> |
|
272 |
<p>Lisp functions and variables which are to be visible in Maxima as |
|
273 |
functions and variables with ordinary names (no special punctuation) |
|
274 |
must have Lisp names beginning with the dollar sign <code>$</code>. |
|
275 |
</p> |
|
276 |
<p>Maxima is case-sensitive, distinguishing between lowercase and uppercase letters |
|
277 |
in identifiers, while Lisp is not. |
|
278 |
There are some rules governing the translation of names between Lisp and Maxima. |
|
279 |
</p> |
|
280 |
<ol> |
|
281 |
<li> |
|
282 |
A Lisp identifier not enclosed in vertical bars corresponds to a Maxima identifier |
|
283 |
in lowercase. |
|
284 |
Whether the Lisp identifier is uppercase, lowercase, or mixed case, is ignored. |
|
285 |
E.g., Lisp <code>$foo</code>, <code>$FOO</code>, and <code>$Foo</code> all correspond to Maxima <code>foo</code>. |
|
286 |
</li><li> |
|
287 |
A Lisp identifier which is all uppercase or all lowercase |
|
288 |
and enclosed in vertical bars corresponds to a Maxima identifier with case reversed. |
|
289 |
That is, uppercase is changed to lowercase and lowercase to uppercase. |
|
290 |
E.g., Lisp <code>|$FOO|</code> and <code>|$foo|</code> |
|
291 |
correspond to Maxima <code>foo</code> and <code>FOO</code>, respectively. |
|
292 |
</li><li> |
|
293 |
A Lisp identifier which is mixed uppercase and lowercase |
|
294 |
and enclosed in vertical bars corresponds to a Maxima identifier with the same case. |
|
295 |
E.g., Lisp <code>|$Foo|</code> corresponds to Maxima <code>Foo</code>. |
|
296 |
</li></ol> |
|
297 |
||
298 |
<p>The <code>#$</code> Lisp macro allows the use of Maxima expressions in Lisp code. |
|
299 |
<code>#$<var>expr</var>$</code> expands to a Lisp expression equivalent to the Maxima expression <var>expr</var>. |
|
300 |
</p> |
|
301 |
<table><tr><td> </td><td><pre class="example">(msetq $foo #$[x, y]$) |
|
302 |
</pre></td></tr></table> |
|
303 |
||
304 |
<p>This has the same effect as entering |
|
305 |
</p> |
|
306 |
<table><tr><td> </td><td><pre class="example">(%i1) foo: [x, y]; |
|
307 |
</pre></td></tr></table> |
|
308 |
||
309 |
<p>The Lisp function <code>displa</code> prints an expression in Maxima format. |
|
310 |
</p> |
|
311 |
<table><tr><td> </td><td><pre class="example">(%i1) :lisp #$[x, y, z]$ |
|
312 |
((MLIST SIMP) $X $Y $Z) |
|
313 |
(%i1) :lisp (displa '((MLIST SIMP) $X $Y $Z)) |
|
314 |
[x, y, z] |
|
315 |
NIL |
|
316 |
</pre></td></tr></table> |
|
317 |
<p>Functions defined in Maxima are not ordinary Lisp functions. |
|
318 |
The Lisp function <code>mfuncall</code> calls a Maxima function. |
|
319 |
For example: |
|
320 |
</p> |
|
321 |
<table><tr><td> </td><td><pre class="example">(%i1) foo(x,y) := x*y$ |
|
322 |
(%i2) :lisp (mfuncall '$foo 'a 'b) |
|
323 |
((MTIMES SIMP) A B) |
|
324 |
</pre></td></tr></table> |
|
325 |
<p>Some Lisp functions are shadowed in the Maxima package, namely the following. |
|
326 |
</p> |
|
327 |
<p><code>complement</code>, |
|
328 |
<code>continue</code>, |
|
329 |
<code>//</code>, |
|
330 |
<code>float</code>, |
|
331 |
<code>functionp</code>, |
|
332 |
<code>array</code>, |
|
333 |
<code>exp</code>, |
|
334 |
<code>listen</code>, |
|
335 |
<code>signum</code>, |
|
336 |
<code>atan</code>, |
|
337 |
<code>asin</code>, |
|
338 |
<code>acos</code>, |
|
339 |
<code>asinh</code>, |
|
340 |
<code>acosh</code>, |
|
341 |
<code>atanh</code>, |
|
342 |
<code>tanh</code>, |
|
343 |
<code>cosh</code>, |
|
344 |
<code>sinh</code>, |
|
345 |
<code>tan</code>, |
|
346 |
<code>break</code>, |
|
347 |
and <code>gcd</code>. |
|
348 |
</p> |
|
349 |
||
350 |
<hr size="6"> |
|
351 |
<a name="Garbage-Collection"></a> |
|
352 |
<a name="SEC8"></a> |
|
353 |
<table cellpadding="1" cellspacing="1" border="0"> |
|
354 |
<tr><td valign="middle" align="left">[<a href="#SEC7" title="Previous section in reading order"> < </a>]</td> |
|
355 |
<td valign="middle" align="left">[<a href="#SEC9" title="Next section in reading order"> > </a>]</td> |
|
356 |
<td valign="middle" align="left"> </td> |
|
357 |
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> |
|
358 |
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> |
|
359 |
<td valign="middle" align="left">[<a href="maxima_4.html#SEC11" title="Next chapter"> >> </a>]</td> |
|
360 |
<td valign="middle" align="left"> </td> |
|
361 |
<td valign="middle" align="left"> </td> |
|
362 |
<td valign="middle" align="left"> </td> |
|
363 |
<td valign="middle" align="left"> </td> |
|
364 |
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> |
|
365 |
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td> |
|
366 |
<td valign="middle" align="left">[<a href="maxima_72.html#SEC264" title="Index">Index</a>]</td> |
|
367 |
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td> |
|
368 |
</tr></table> |
|
369 |
<h2 class="section"> 3.3 Garbage Collection </h2> |
|
370 |
<p>Symbolic computation tends to create a good deal |
|
371 |
of garbage, and effective handling of this can be crucial to successful |
|
372 |
completion of some programs. |
|
373 |
</p> |
|
374 |
<p>Under GCL, on UNIX systems where the mprotect system call is available |
|
375 |
(including SUN OS 4.0 and some variants of BSD) a stratified garbage collection |
|
376 |
is available. This limits the collection to pages which have been recently |
|
377 |
written to. See the GCL documentation under ALLOCATE and GBC. At the |
|
378 |
Lisp level doing (setq si::*notify-gbc* t) will help you determine which |
|
379 |
areas might need more space. |
|
380 |
</p> |
|
381 |
<hr size="6"> |
|
382 |
<a name="Documentation"></a> |
|
383 |
<a name="SEC9"></a> |
|
384 |
<table cellpadding="1" cellspacing="1" border="0"> |
|
385 |
<tr><td valign="middle" align="left">[<a href="#SEC8" title="Previous section in reading order"> < </a>]</td> |
|
386 |
<td valign="middle" align="left">[<a href="#SEC10" title="Next section in reading order"> > </a>]</td> |
|
387 |
<td valign="middle" align="left"> </td> |
|
388 |
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> |
|
389 |
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> |
|
390 |
<td valign="middle" align="left">[<a href="maxima_4.html#SEC11" title="Next chapter"> >> </a>]</td> |
|
391 |
<td valign="middle" align="left"> </td> |
|
392 |
<td valign="middle" align="left"> </td> |
|
393 |
<td valign="middle" align="left"> </td> |
|
394 |
<td valign="middle" align="left"> </td> |
|
395 |
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> |
|
396 |
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td> |
|
397 |
<td valign="middle" align="left">[<a href="maxima_72.html#SEC264" title="Index">Index</a>]</td> |
|
398 |
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td> |
|
399 |
</tr></table> |
|
400 |
<h2 class="section"> 3.4 Documentation </h2> |
|
401 |
||
402 |
||
403 |
<p>The Maxima on-line user's manual can be viewed in different forms. |
|
404 |
From the Maxima interactive prompt, the user's manual |
|
405 |
is viewed as plain text by the <code>?</code> command (i.e., the <code>describe</code> function). |
|
406 |
The user's manual is viewed as <code>info</code> hypertext by the <code>info</code> viewer program |
|
407 |
and as a web page by any ordinary web browser. |
|
408 |
</p> |
|
409 |
<p><code>example</code> displays examples for many Maxima functions. |
|
410 |
For example, |
|
411 |
</p> |
|
412 |
<table><tr><td> </td><td><pre class="example">(%i1) example (integrate); |
|
413 |
</pre></td></tr></table> |
|
414 |
<p>yields |
|
415 |
</p> |
|
416 |
<table><tr><td> </td><td><pre class="example">(%i2) test(f):=block([u],u:integrate(f,x),ratsimp(f-diff(u,x))) |
|
417 |
(%o2) test(f) := block([u], u : integrate(f, x), |
|
418 |
||
419 |
ratsimp(f - diff(u, x))) |
|
420 |
(%i3) test(sin(x)) |
|
421 |
(%o3) 0 |
|
422 |
(%i4) test(1/(x+1)) |
|
423 |
(%o4) 0 |
|
424 |
(%i5) test(1/(x^2+1)) |
|
425 |
(%o5) 0 |
|
426 |
</pre></td></tr></table> |
|
427 |
<p>and additional output. |
|
428 |
</p> |
|
429 |
<hr size="6"> |
|
430 |
<a name="Definitions-for-Help"></a> |
|
431 |
<a name="SEC10"></a> |
|
432 |
<table cellpadding="1" cellspacing="1" border="0"> |
|
433 |
<tr><td valign="middle" align="left">[<a href="#SEC9" title="Previous section in reading order"> < </a>]</td> |
|
434 |
<td valign="middle" align="left">[<a href="maxima_4.html#SEC11" title="Next section in reading order"> > </a>]</td> |
|
435 |
<td valign="middle" align="left"> </td> |
|
436 |
<td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> |
|
437 |
<td valign="middle" align="left">[<a href="#SEC5" title="Up section"> Up </a>]</td> |
|
438 |
<td valign="middle" align="left">[<a href="maxima_4.html#SEC11" title="Next chapter"> >> </a>]</td> |
|
439 |
<td valign="middle" align="left"> </td> |
|
440 |
<td valign="middle" align="left"> </td> |
|
441 |
<td valign="middle" align="left"> </td> |
|
442 |
<td valign="middle" align="left"> </td> |
|
443 |
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> |
|
444 |
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td> |
|
445 |
<td valign="middle" align="left">[<a href="maxima_72.html#SEC264" title="Index">Index</a>]</td> |
|
446 |
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td> |
|
447 |
</tr></table> |
|
448 |
<h2 class="section"> 3.5 Definitions for Help </h2> |
|
449 |
||
450 |
<dl> |
|
451 |
<dt><u>Function:</u> <b>demo</b><i> (<var>filename</var>)</i> |
|
452 |
<a name="IDX8"></a> |
|
453 |
</dt> |
|
454 |
<dd><p>Evaluates Maxima expressions in <var>filename</var> and displays the results. |
|
455 |
<code>demo</code> pauses after evaluating each expression |
|
456 |
and continues after the user enters a carriage return. |
|
457 |
(If running in Xmaxima, <code>demo</code> may need to see a semicolon <code>;</code> |
|
458 |
followed by a carriage return.) |
|
459 |
</p> |
|
460 |
<p><code>demo</code> searches the list of directories |
|
461 |
<code>file_search_demo</code> to find <code>filename</code>. |
|
462 |
If the file has the suffix <code>dem</code>, |
|
463 |
the suffix may be omitted. |
|
464 |
See also <code>file_search</code>. |
|
465 |
</p> |
|
466 |
<p><code>demo</code> evaluates its argument. |
|
467 |
<code>demo</code> returns the name of the demonstration file. |
|
468 |
</p> |
|
469 |
<p>Example: |
|
470 |
</p> |
|
471 |
<table><tr><td> </td><td><pre class="example">(%i1) demo ("disol"); |
|
472 |
||
473 |
batching /home/wfs/maxima/share/simplification/disol.dem |
|
474 |
At the _ prompt, type ';' followed by enter to get next demo |
|
475 |
(%i2) load(disol) |
|
476 |
||
477 |
_ |
|
478 |
(%i3) exp1 : a (e (g + f) + b (d + c)) |
|
479 |
(%o3) a (e (g + f) + b (d + c)) |
|
480 |
||
481 |
_ |
|
482 |
(%i4) disolate(exp1, a, b, e) |
|
483 |
(%t4) d + c |
|
484 |
||
485 |
(%t5) g + f |
|
486 |
||
487 |
(%o5) a (%t5 e + %t4 b) |
|
488 |
||
489 |
_ |
|
490 |
(%i5) demo ("rncomb"); |
|
491 |
||
492 |
batching /home/wfs/maxima/share/simplification/rncomb.dem |
|
493 |
At the _ prompt, type ';' followed by enter to get next demo |
|
494 |
(%i6) load(rncomb) |
|
495 |
||
496 |
_ |
|
497 |
z x |
|
498 |
(%i7) exp1 : ----- + --------- |
|
499 |
y + x 2 (y + x) |
|
500 |
z x |
|
501 |
(%o7) ----- + --------- |
|
502 |
y + x 2 (y + x) |
|
503 |
||
504 |
_ |
|
505 |
(%i8) combine(exp1) |
|
506 |
z x |
|
507 |
(%o8) ----- + --------- |
|
508 |
y + x 2 (y + x) |
|
509 |
||
510 |
_ |
|
511 |
(%i9) rncombine(%) |
|
512 |
2 z + x |
|
513 |
(%o9) --------- |
|
514 |
2 (y + x) |
|
515 |
||
516 |
_ |
|
517 |
d c b a |
|
518 |
(%i10) exp2 : - + - + - + - |
|
519 |
3 3 2 2 |
|
520 |
d c b a |
|
521 |
(%o10) - + - + - + - |
|
522 |
3 3 2 2 |
|
523 |
||
524 |
_ |
|
525 |
(%i11) combine(exp2) |
|
526 |
2 d + 2 c + 3 (b + a) |
|
527 |
(%o11) --------------------- |
|
528 |
6 |
|
529 |
||
530 |
_ |
|
531 |
(%i12) rncombine(exp2) |
|
532 |
2 d + 2 c + 3 b + 3 a |
|
533 |
(%o12) --------------------- |
|
534 |
6 |
|
535 |
||
536 |
_ |
|
537 |
(%i13) |
|
538 |
</pre></td></tr></table> |
|
539 |
</dd></dl> |
|
540 |
||
541 |
<dl> |
|
542 |
<dt><u>Function:</u> <b>describe</b><i> (<var>string</var>)</i> |
|
543 |
<a name="IDX9"></a> |
|
544 |
</dt> |
|
545 |
<dd><p>Finds all documented items which contain <var>string</var> in their titles. |
|
546 |
If there is more than one such item, Maxima asks the user to select |
|
547 |
an item or items to display. |
|
548 |
At the interactive prompt, |
|
549 |
<code>? foo</code> (with a space between <code>?</code> and <code>foo</code>) |
|
550 |
is equivalent to <code>describe ("foo")</code>. |
|
551 |
</p> |
|
552 |
<p><code>describe ("")</code> yields a list of all topics documented in the on-line manual. |
|
553 |
</p> |
|
554 |
<p><code>describe</code> quotes its argument. <code>describe</code> always returns <code>false</code>. |
|
555 |
</p> |
|
556 |
<p>Example: |
|
557 |
</p> |
|
558 |
<table><tr><td> </td><td><pre class="example">(%i1) ? integ |
|
559 |
0: (maxima.info)Introduction to Elliptic Functions and Integrals. |
|
560 |
1: Definitions for Elliptic Integrals. |
|
561 |
2: Integration. |
|
562 |
3: Introduction to Integration. |
|
563 |
4: Definitions for Integration. |
|
564 |
5: askinteger :Definitions for Simplification. |
|
565 |
6: integerp :Definitions for Miscellaneous Options. |
|
566 |
7: integrate :Definitions for Integration. |
|
567 |
8: integrate_use_rootsof :Definitions for Integration. |
|
568 |
9: integration_constant_counter :Definitions for Integration. |
|
569 |
Enter space-separated numbers, `all' or `none': 7 8 |
|
570 |
||
571 |
Info from file /use/local/maxima/doc/info/maxima.info: |
|
572 |
- Function: integrate (expr, var) |
|
573 |
- Function: integrate (expr, var, a, b) |
|
574 |
Attempts to symbolically compute the integral of `expr' with |
|
575 |
respect to `var'. `integrate (expr, var)' is an indefinite |
|
576 |
integral, while `integrate (expr, var, a, b)' is a definite |
|
577 |
integral, [...] |
|
578 |
</pre></td></tr></table> |
|
579 |
<p>In this example, items 7 and 8 were selected. |
|
580 |
All or none of the items could have been selected by entering <code>all</code> or <code>none</code>, |
|
581 |
which can be abbreviated <code>a</code> or <code>n</code>, respectively. |
|
582 |
</p> |
|
583 |
<p>see section <a href="#SEC6">Introduction to Help</a> |
|
584 |
</p> |
|
585 |
</dd></dl> |
|
586 |
||
587 |
<dl> |
|
588 |
<dt><u>Function:</u> <b>example</b><i> (<var>topic</var>)</i> |
|
589 |
<a name="IDX10"></a> |
|
590 |
</dt> |
|
591 |
<dt><u>Function:</u> <b>example</b><i> ()</i> |
|
592 |
<a name="IDX11"></a> |
|
593 |
</dt> |
|
594 |
<dd><p><code>example (<var>topic</var>)</code> displays some examples of <var>topic</var>, |
|
595 |
which is a symbol (not a string). |
|
596 |
Most topics are function names. |
|
597 |
<code>example ()</code> returns the list of all recognized topics. |
|
598 |
</p> |
|
599 |
<p>The name of the file containing the examples is given by the |
|
600 |
global variable <code>manual_demo</code>, which defaults to <code>"manual.demo"</code>. |
|
601 |
</p> |
|
602 |
<p><code>example</code> quotes its argument. |
|
603 |
<code>example</code> returns <code>done</code> |
|
604 |
unless there is an error or there is no argument, in which case <code>example</code> |
|
605 |
returns the list of all recognized topics. |
|
606 |
</p> |
|
607 |
<p>Examples: |
|
608 |
</p> |
|
609 |
<table><tr><td> </td><td><pre class="example">(%i1) example (append); |
|
610 |
(%i2) append([x+y,0,-3.2],[2.5E+20,x]) |
|
611 |
(%o2) [y + x, 0, - 3.2, 2.5E+20, x] |
|
612 |
(%o2) done |
|
613 |
(%i3) example (coeff); |
|
614 |
(%i4) coeff(b+tan(x)+2*a*tan(x) = 3+5*tan(x),tan(x)) |
|
615 |
(%o4) 2 a + 1 = 5 |
|
616 |
(%i5) coeff(1+x*%e^x+y,x,0) |
|
617 |
(%o5) y + 1 |
|
618 |
(%o5) done |
|
619 |
</pre></td></tr></table> |
|
620 |
</dd></dl> |
|
621 |
||
622 |
||
623 |
<hr size="6"> |
|
624 |
<table cellpadding="1" cellspacing="1" border="0"> |
|
625 |
<tr><td valign="middle" align="left">[<a href="#SEC5" title="Beginning of this chapter or previous chapter"> << </a>]</td> |
|
626 |
<td valign="middle" align="left">[<a href="maxima_4.html#SEC11" title="Next chapter"> >> </a>]</td> |
|
627 |
<td valign="middle" align="left"> </td> |
|
628 |
<td valign="middle" align="left"> </td> |
|
629 |
<td valign="middle" align="left"> </td> |
|
630 |
<td valign="middle" align="left"> </td> |
|
631 |
<td valign="middle" align="left"> </td> |
|
632 |
<td valign="middle" align="left">[<a href="maxima.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> |
|
633 |
<td valign="middle" align="left">[<a href="maxima_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td> |
|
634 |
<td valign="middle" align="left">[<a href="maxima_72.html#SEC264" title="Index">Index</a>]</td> |
|
635 |
<td valign="middle" align="left">[<a href="maxima_abt.html#SEC_About" title="About (help)"> ? </a>]</td> |
|
636 |
</tr></table> |
|
637 |
<p> |
|
638 |
<font size="-1"> |
|
639 |
This document was generated by <em>Robert Dodier</em> on <em>September, 20 2006</em> using <a href="http://texi2html.cvshome.org/"><em>texi2html 1.76</em></a>. |
|
640 |
</font> |
|
641 |
<br> |
|
642 |
||
643 |
</p> |
|
644 |
</body> |
|
645 |
</html> |