(ring-elements): Make it return a list of the elements of RING in
[bpt/emacs.git] / man / calc.texi
CommitLineData
d7b8e6c6
EZ
1\input texinfo @c -*-texinfo-*-
2@comment %**start of header (This is for running Texinfo on a region.)
3@c smallbook
4@setfilename ../info/calc
5@c [title]
5208b407 6@settitle GNU Emacs Calc 2.1 Manual
d7b8e6c6
EZ
7@setchapternewpage odd
8@comment %**end of header (This is for running Texinfo on a region.)
9
a4231b04
JB
10@c The following macros are used for conditional output for single lines.
11@c @texline foo
12@c `foo' will appear only in TeX output
13@c @infoline foo
14@c `foo' will appear only in non-TeX output
15
8e04863e 16@c @expr{expr} will typeset an expression;
a4231b04
JB
17@c $x$ in TeX, @samp{x} otherwise.
18
19@iftex
bd712b70 20@macro texline
a4231b04 21@end macro
a4231b04 22@alias infoline=comment
bd712b70
JB
23@alias expr=math
24@alias tfn=code
8e04863e 25@alias mathit=expr
a4231b04
JB
26@macro cpi{}
27@math{@pi{}}
28@end macro
29@macro cpiover{den}
30@math{@pi/\den\}
31@end macro
32@end iftex
33
34@ifnottex
35@alias texline=comment
36@macro infoline{stuff}
37\stuff\
38@end macro
39@alias expr=samp
bd712b70 40@alias tfn=t
8e04863e 41@alias mathit=i
a4231b04
JB
42@macro cpi{}
43@expr{pi}
44@end macro
45@macro cpiover{den}
46@expr{pi/\den\}
47@end macro
48@end ifnottex
49
50
d7b8e6c6 51@tex
b275eac7
EZ
52% Suggested by Karl Berry <karl@@freefriends.org>
53\gdef\!{\mskip-\thinmuskip}
d7b8e6c6
EZ
54@end tex
55
d7b8e6c6
EZ
56@c Fix some other things specifically for this manual.
57@iftex
58@finalout
59@mathcode`@:=`@: @c Make Calc fractions come out right in math mode
d7b8e6c6
EZ
60@tex
61\gdef\coloneq{\mathrel{\mathord:\mathord=}}
5d67986c 62
d7b8e6c6
EZ
63\gdef\beforedisplay{\vskip-10pt}
64\gdef\afterdisplay{\vskip-5pt}
65\gdef\beforedisplayh{\vskip-25pt}
66\gdef\afterdisplayh{\vskip-10pt}
d7b8e6c6
EZ
67@end tex
68@newdimen@kyvpos @kyvpos=0pt
69@newdimen@kyhpos @kyhpos=0pt
70@newcount@calcclubpenalty @calcclubpenalty=1000
5d67986c 71@ignore
d7b8e6c6
EZ
72@newcount@calcpageno
73@newtoks@calcoldeverypar @calcoldeverypar=@everypar
74@everypar={@calceverypar@the@calcoldeverypar}
75@ifx@turnoffactive@undefinedzzz@def@turnoffactive{}@fi
76@ifx@ninett@undefinedzzz@font@ninett=cmtt9@fi
77@catcode`@\=0 \catcode`\@=11
78\r@ggedbottomtrue
79\catcode`\@=0 @catcode`@\=@active
5d67986c 80@end ignore
d7b8e6c6
EZ
81@end iftex
82
18f952d5 83@copying
d7b8e6c6
EZ
84This file documents Calc, the GNU Emacs calculator.
85
ce7c7522 86Copyright (C) 1990, 1991, 2001, 2002, 2005 Free Software Foundation, Inc.
d7b8e6c6 87
18f952d5 88@quotation
0d48e8aa
EZ
89Permission is granted to copy, distribute and/or modify this document
90under the terms of the GNU Free Documentation License, Version 1.1 or
91any later version published by the Free Software Foundation; with the
92Invariant Sections being just ``GNU GENERAL PUBLIC LICENSE'', with the
93Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover
94Texts as in (a) below.
d7b8e6c6 95
0d48e8aa
EZ
96(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
97this GNU Manual, like GNU software. Copies published by the Free
98Software Foundation raise funds for GNU development.''
18f952d5
KB
99@end quotation
100@end copying
101
102@dircategory Emacs
103@direntry
104* Calc: (calc). Advanced desk calculator and mathematical tool.
105@end direntry
d7b8e6c6
EZ
106
107@titlepage
108@sp 6
109@center @titlefont{Calc Manual}
110@sp 4
5208b407 111@center GNU Emacs Calc Version 2.1
d7b8e6c6
EZ
112@c [volume]
113@sp 1
ce7c7522 114@center March 2005
d7b8e6c6
EZ
115@sp 5
116@center Dave Gillespie
117@center daveg@@synaptics.com
118@page
119
120@vskip 0pt plus 1filll
ce7c7522
WL
121Copyright @copyright{} 1990, 1991, 2001, 2002, 2005
122Free Software Foundation, Inc.
18f952d5 123@insertcopying
d7b8e6c6
EZ
124@end titlepage
125
126@c [begin]
127@ifinfo
b275eac7
EZ
128@node Top, , (dir), (dir)
129@chapter The GNU Emacs Calculator
d7b8e6c6
EZ
130
131@noindent
0d48e8aa 132@dfn{Calc} is an advanced desk calculator and mathematical tool
d7b8e6c6
EZ
133that runs as part of the GNU Emacs environment.
134
0d48e8aa
EZ
135This manual is divided into three major parts: ``Getting Started,''
136the ``Calc Tutorial,'' and the ``Calc Reference.'' The Tutorial
137introduces all the major aspects of Calculator use in an easy,
138hands-on way. The remainder of the manual is a complete reference to
139the features of the Calculator.
d7b8e6c6
EZ
140
141For help in the Emacs Info system (which you are using to read this
142file), type @kbd{?}. (You can also type @kbd{h} to run through a
143longer Info tutorial.)
144
145@end ifinfo
146@menu
147* Copying:: How you can copy and share Calc.
148
149* Getting Started:: General description and overview.
b275eac7 150* Interactive Tutorial::
d7b8e6c6
EZ
151* Tutorial:: A step-by-step introduction for beginners.
152
153* Introduction:: Introduction to the Calc reference manual.
154* Data Types:: Types of objects manipulated by Calc.
155* Stack and Trail:: Manipulating the stack and trail buffers.
156* Mode Settings:: Adjusting display format and other modes.
157* Arithmetic:: Basic arithmetic functions.
158* Scientific Functions:: Transcendentals and other scientific functions.
159* Matrix Functions:: Operations on vectors and matrices.
160* Algebra:: Manipulating expressions algebraically.
161* Units:: Operations on numbers with units.
162* Store and Recall:: Storing and recalling variables.
163* Graphics:: Commands for making graphs of data.
164* Kill and Yank:: Moving data into and out of Calc.
17c5c219 165* Keypad Mode:: Operating Calc from a keypad.
d7b8e6c6
EZ
166* Embedded Mode:: Working with formulas embedded in a file.
167* Programming:: Calc as a programmable calculator.
168
b154df16 169* Customizable Variables:: Customizable Variables.
d7b8e6c6
EZ
170* Reporting Bugs:: How to report bugs and make suggestions.
171
172* Summary:: Summary of Calc commands and functions.
173
174* Key Index:: The standard Calc key sequences.
175* Command Index:: The interactive Calc commands.
176* Function Index:: Functions (in algebraic formulas).
177* Concept Index:: General concepts.
178* Variable Index:: Variables used by Calc (both user and internal).
179* Lisp Function Index:: Internal Lisp math functions.
180@end menu
181
182@node Copying, Getting Started, Top, Top
183@unnumbered GNU GENERAL PUBLIC LICENSE
5208b407
JB
184@center Version 2, June 1991
185
186@c This file is intended to be included in another file.
d7b8e6c6
EZ
187
188@display
5208b407
JB
189Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
19059 Temple Place - Suite 330, Boston, MA 02111-1307, USA
d7b8e6c6
EZ
191
192Everyone is permitted to copy and distribute verbatim copies
193of this license document, but changing it is not allowed.
194@end display
195
196@unnumberedsec Preamble
197
5208b407
JB
198 The licenses for most software are designed to take away your
199freedom to share and change it. By contrast, the GNU General Public
d7b8e6c6 200License is intended to guarantee your freedom to share and change free
5208b407
JB
201software---to make sure the software is free for all its users. This
202General Public License applies to most of the Free Software
203Foundation's software and to any other program whose authors commit to
204using it. (Some other Free Software Foundation software is covered by
205the GNU Library General Public License instead.) You can apply it to
206your programs, too.
d7b8e6c6
EZ
207
208 When we speak of free software, we are referring to freedom, not
5208b407
JB
209price. Our General Public Licenses are designed to make sure that you
210have the freedom to distribute copies of free software (and charge for
211this service if you wish), that you receive source code or can get it
212if you want it, that you can change the software or use pieces of it
213in new free programs; and that you know you can do these things.
d7b8e6c6
EZ
214
215 To protect your rights, we need to make restrictions that forbid
216anyone to deny you these rights or to ask you to surrender the rights.
217These restrictions translate to certain responsibilities for you if you
218distribute copies of the software, or if you modify it.
219
5208b407 220 For example, if you distribute copies of such a program, whether
d7b8e6c6
EZ
221gratis or for a fee, you must give the recipients all the rights that
222you have. You must make sure that they, too, receive or can get the
5208b407
JB
223source code. And you must show them these terms so they know their
224rights.
d7b8e6c6
EZ
225
226 We protect your rights with two steps: (1) copyright the software, and
227(2) offer you this license which gives you legal permission to copy,
228distribute and/or modify the software.
229
230 Also, for each author's protection and ours, we want to make certain
231that everyone understands that there is no warranty for this free
232software. If the software is modified by someone else and passed on, we
233want its recipients to know that what they have is not the original, so
234that any problems introduced by others will not reflect on the original
235authors' reputations.
236
5208b407
JB
237 Finally, any free program is threatened constantly by software
238patents. We wish to avoid the danger that redistributors of a free
239program will individually obtain patent licenses, in effect making the
240program proprietary. To prevent this, we have made it clear that any
241patent must be licensed for everyone's free use or not licensed at all.
242
d7b8e6c6
EZ
243 The precise terms and conditions for copying, distribution and
244modification follow.
245
246@iftex
5208b407 247@unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
d7b8e6c6
EZ
248@end iftex
249@ifinfo
5208b407 250@center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
d7b8e6c6
EZ
251@end ifinfo
252
5208b407 253@enumerate 0
d7b8e6c6 254@item
5208b407
JB
255This License applies to any program or other work which contains
256a notice placed by the copyright holder saying it may be distributed
257under the terms of this General Public License. The ``Program'', below,
258refers to any such program or work, and a ``work based on the Program''
259means either the Program or any derivative work under copyright law:
260that is to say, a work containing the Program or a portion of it,
261either verbatim or with modifications and/or translated into another
262language. (Hereinafter, translation is included without limitation in
263the term ``modification''.) Each licensee is addressed as ``you''.
264
265Activities other than copying, distribution and modification are not
266covered by this License; they are outside its scope. The act of
267running the Program is not restricted, and the output from the Program
268is covered only if its contents constitute a work based on the
269Program (independent of having been made by running the Program).
270Whether that is true depends on what the Program does.
d7b8e6c6
EZ
271
272@item
5208b407
JB
273You may copy and distribute verbatim copies of the Program's
274source code as you receive it, in any medium, provided that you
275conspicuously and appropriately publish on each copy an appropriate
276copyright notice and disclaimer of warranty; keep intact all the
277notices that refer to this License and to the absence of any warranty;
278and give any other recipients of the Program a copy of this License
279along with the Program.
d7b8e6c6 280
5208b407
JB
281You may charge a fee for the physical act of transferring a copy, and
282you may at your option offer warranty protection in exchange for a fee.
d7b8e6c6 283
d7b8e6c6 284@item
5208b407
JB
285You may modify your copy or copies of the Program or any portion
286of it, thus forming a work based on the Program, and copy and
287distribute such modifications or work under the terms of Section 1
288above, provided that you also meet all of these conditions:
d7b8e6c6 289
5208b407 290@enumerate a
d7b8e6c6 291@item
5208b407
JB
292You must cause the modified files to carry prominent notices
293stating that you changed the files and the date of any change.
d7b8e6c6
EZ
294
295@item
5208b407
JB
296You must cause any work that you distribute or publish, that in
297whole or in part contains or is derived from the Program or any
298part thereof, to be licensed as a whole at no charge to all third
299parties under the terms of this License.
d7b8e6c6
EZ
300
301@item
5208b407
JB
302If the modified program normally reads commands interactively
303when run, you must cause it, when started running for such
304interactive use in the most ordinary way, to print or display an
305announcement including an appropriate copyright notice and a
306notice that there is no warranty (or else, saying that you provide
307a warranty) and that users may redistribute the program under
308these conditions, and telling the user how to view a copy of this
309License. (Exception: if the Program itself is interactive but
310does not normally print such an announcement, your work based on
311the Program is not required to print an announcement.)
312@end enumerate
d7b8e6c6 313
5208b407
JB
314These requirements apply to the modified work as a whole. If
315identifiable sections of that work are not derived from the Program,
316and can be reasonably considered independent and separate works in
317themselves, then this License, and its terms, do not apply to those
318sections when you distribute them as separate works. But when you
319distribute the same sections as part of a whole which is a work based
320on the Program, the distribution of the whole must be on the terms of
321this License, whose permissions for other licensees extend to the
322entire whole, and thus to each and every part regardless of who wrote it.
323
324Thus, it is not the intent of this section to claim rights or contest
325your rights to work written entirely by you; rather, the intent is to
326exercise the right to control the distribution of derivative or
327collective works based on the Program.
328
329In addition, mere aggregation of another work not based on the Program
330with the Program (or with a work based on the Program) on a volume of
331a storage or distribution medium does not bring the other work under
332the scope of this License.
d7b8e6c6
EZ
333
334@item
5208b407
JB
335You may copy and distribute the Program (or a work based on it,
336under Section 2) in object code or executable form under the terms of
337Sections 1 and 2 above provided that you also do one of the following:
d7b8e6c6 338
5208b407 339@enumerate a
d7b8e6c6 340@item
5208b407
JB
341Accompany it with the complete corresponding machine-readable
342source code, which must be distributed under the terms of Sections
3431 and 2 above on a medium customarily used for software interchange; or,
d7b8e6c6
EZ
344
345@item
5208b407
JB
346Accompany it with a written offer, valid for at least three
347years, to give any third party, for a charge no more than your
348cost of physically performing source distribution, a complete
349machine-readable copy of the corresponding source code, to be
350distributed under the terms of Sections 1 and 2 above on a medium
351customarily used for software interchange; or,
d7b8e6c6
EZ
352
353@item
5208b407
JB
354Accompany it with the information you received as to the offer
355to distribute corresponding source code. (This alternative is
d7b8e6c6 356allowed only for noncommercial distribution and only if you
5208b407
JB
357received the program in object code or executable form with such
358an offer, in accord with Subsection b above.)
359@end enumerate
d7b8e6c6 360
5208b407
JB
361The source code for a work means the preferred form of the work for
362making modifications to it. For an executable work, complete source
363code means all the source code for all modules it contains, plus any
364associated interface definition files, plus the scripts used to
365control compilation and installation of the executable. However, as a
366special exception, the source code distributed need not include
367anything that is normally distributed (in either source or binary
368form) with the major components (compiler, kernel, and so on) of the
369operating system on which the executable runs, unless that component
370itself accompanies the executable.
371
372If distribution of executable or object code is made by offering
373access to copy from a designated place, then offering equivalent
374access to copy the source code from the same place counts as
375distribution of the source code, even though third parties are not
376compelled to copy the source along with the object code.
d7b8e6c6
EZ
377
378@item
5208b407
JB
379You may not copy, modify, sublicense, or distribute the Program
380except as expressly provided under this License. Any attempt
381otherwise to copy, modify, sublicense or distribute the Program is
382void, and will automatically terminate your rights under this License.
383However, parties who have received copies, or rights, from you under
384this License will not have their licenses terminated so long as such
385parties remain in full compliance.
d7b8e6c6
EZ
386
387@item
5208b407
JB
388You are not required to accept this License, since you have not
389signed it. However, nothing else grants you permission to modify or
390distribute the Program or its derivative works. These actions are
391prohibited by law if you do not accept this License. Therefore, by
392modifying or distributing the Program (or any work based on the
393Program), you indicate your acceptance of this License to do so, and
394all its terms and conditions for copying, distributing or modifying
395the Program or works based on it.
d7b8e6c6
EZ
396
397@item
398Each time you redistribute the Program (or any work based on the
5208b407
JB
399Program), the recipient automatically receives a license from the
400original licensor to copy, distribute or modify the Program subject to
401these terms and conditions. You may not impose any further
402restrictions on the recipients' exercise of the rights granted herein.
403You are not responsible for enforcing compliance by third parties to
404this License.
405
406@item
407If, as a consequence of a court judgment or allegation of patent
408infringement or for any other reason (not limited to patent issues),
409conditions are imposed on you (whether by court order, agreement or
410otherwise) that contradict the conditions of this License, they do not
411excuse you from the conditions of this License. If you cannot
412distribute so as to satisfy simultaneously your obligations under this
413License and any other pertinent obligations, then as a consequence you
414may not distribute the Program at all. For example, if a patent
415license would not permit royalty-free redistribution of the Program by
416all those who receive copies directly or indirectly through you, then
417the only way you could satisfy both it and this License would be to
418refrain entirely from distribution of the Program.
419
420If any portion of this section is held invalid or unenforceable under
421any particular circumstance, the balance of the section is intended to
422apply and the section as a whole is intended to apply in other
423circumstances.
424
425It is not the purpose of this section to induce you to infringe any
426patents or other property right claims or to contest validity of any
427such claims; this section has the sole purpose of protecting the
428integrity of the free software distribution system, which is
429implemented by public license practices. Many people have made
430generous contributions to the wide range of software distributed
431through that system in reliance on consistent application of that
432system; it is up to the author/donor to decide if he or she is willing
433to distribute software through any other system and a licensee cannot
434impose that choice.
435
436This section is intended to make thoroughly clear what is believed to
437be a consequence of the rest of this License.
438
439@item
440If the distribution and/or use of the Program is restricted in
441certain countries either by patents or by copyrighted interfaces, the
442original copyright holder who places the Program under this License
443may add an explicit geographical distribution limitation excluding
444those countries, so that distribution is permitted only in or among
445countries not thus excluded. In such case, this License incorporates
446the limitation as if written in the body of this License.
d7b8e6c6
EZ
447
448@item
449The Free Software Foundation may publish revised and/or new versions
450of the General Public License from time to time. Such new versions will
451be similar in spirit to the present version, but may differ in detail to
452address new problems or concerns.
453
454Each version is given a distinguishing version number. If the Program
5208b407 455specifies a version number of this License which applies to it and ``any
d7b8e6c6
EZ
456later version'', you have the option of following the terms and conditions
457either of that version or of any later version published by the Free
458Software Foundation. If the Program does not specify a version number of
5208b407 459this License, you may choose any version ever published by the Free Software
d7b8e6c6
EZ
460Foundation.
461
462@item
463If you wish to incorporate parts of the Program into other free
464programs whose distribution conditions are different, write to the author
465to ask for permission. For software which is copyrighted by the Free
466Software Foundation, write to the Free Software Foundation; we sometimes
467make exceptions for this. Our decision will be guided by the two goals
468of preserving the free status of all derivatives of our free software and
469of promoting the sharing and reuse of software generally.
470
471@iftex
472@heading NO WARRANTY
473@end iftex
474@ifinfo
475@center NO WARRANTY
476@end ifinfo
477
478@item
479BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
480FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
481OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
482PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
483OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
484MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
485TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
486PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
487REPAIR OR CORRECTION.
488
489@item
5208b407
JB
490IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
491WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
d7b8e6c6 492REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5208b407
JB
493INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
494OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
495TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
496YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
497PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
498POSSIBILITY OF SUCH DAMAGES.
d7b8e6c6
EZ
499@end enumerate
500
5208b407
JB
501@iftex
502@heading END OF TERMS AND CONDITIONS
503@end iftex
504@ifinfo
505@center END OF TERMS AND CONDITIONS
506@end ifinfo
507
508@page
509@unnumberedsec Appendix: How to Apply These Terms to Your New Programs
510
511 If you develop a new program, and you want it to be of the greatest
512possible use to the public, the best way to achieve this is to make it
513free software which everyone can redistribute and change under these terms.
514
515 To do so, attach the following notices to the program. It is safest
516to attach them to the start of each source file to most effectively
517convey the exclusion of warranty; and each file should have at least
518the ``copyright'' line and a pointer to where the full notice is found.
519
520@smallexample
521@var{one line to give the program's name and a brief idea of what it does.}
522Copyright (C) @var{yyyy} @var{name of author}
523
524This program is free software; you can redistribute it and/or modify
525it under the terms of the GNU General Public License as published by
526the Free Software Foundation; either version 2 of the License, or
527(at your option) any later version.
528
529This program is distributed in the hope that it will be useful,
530but WITHOUT ANY WARRANTY; without even the implied warranty of
531MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
532GNU General Public License for more details.
533
534You should have received a copy of the GNU General Public License
535along with this program; if not, write to the Free Software
536Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
537@end smallexample
538
539Also add information on how to contact you by electronic and paper mail.
540
541If the program is interactive, make it output a short notice like this
542when it starts in an interactive mode:
543
544@smallexample
545Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
546Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
547This is free software, and you are welcome to redistribute it
548under certain conditions; type `show c' for details.
549@end smallexample
550
551The hypothetical commands @samp{show w} and @samp{show c} should show
552the appropriate parts of the General Public License. Of course, the
553commands you use may be called something other than @samp{show w} and
554@samp{show c}; they could even be mouse-clicks or menu items---whatever
555suits your program.
556
557You should also get your employer (if you work as a programmer) or your
558school, if any, to sign a ``copyright disclaimer'' for the program, if
559necessary. Here is a sample; alter the names:
560
561@example
562Yoyodyne, Inc., hereby disclaims all copyright interest in the program
563`Gnomovision' (which makes passes at compilers) written by James Hacker.
564
565@var{signature of Ty Coon}, 1 April 1989
566Ty Coon, President of Vice
567@end example
568
569This General Public License does not permit incorporating your program into
570proprietary programs. If your program is a subroutine library, you may
571consider it more useful to permit linking proprietary applications with the
572library. If this is what you want to do, use the GNU Library General
573Public License instead of this License.
574
b275eac7 575@node Getting Started, Tutorial, Copying, Top
d7b8e6c6 576@chapter Getting Started
d7b8e6c6
EZ
577@noindent
578This chapter provides a general overview of Calc, the GNU Emacs
579Calculator: What it is, how to start it and how to exit from it,
580and what are the various ways that it can be used.
581
582@menu
583* What is Calc::
584* About This Manual::
585* Notations Used in This Manual::
d7059a75 586* Demonstration of Calc::
d7b8e6c6 587* Using Calc::
d7b8e6c6
EZ
588* History and Acknowledgements::
589@end menu
590
591@node What is Calc, About This Manual, Getting Started, Getting Started
592@section What is Calc?
593
594@noindent
595@dfn{Calc} is an advanced calculator and mathematical tool that runs as
596part of the GNU Emacs environment. Very roughly based on the HP-28/48
597series of calculators, its many features include:
598
599@itemize @bullet
600@item
601Choice of algebraic or RPN (stack-based) entry of calculations.
602
603@item
604Arbitrary precision integers and floating-point numbers.
605
606@item
607Arithmetic on rational numbers, complex numbers (rectangular and polar),
608error forms with standard deviations, open and closed intervals, vectors
609and matrices, dates and times, infinities, sets, quantities with units,
610and algebraic formulas.
611
612@item
613Mathematical operations such as logarithms and trigonometric functions.
614
615@item
616Programmer's features (bitwise operations, non-decimal numbers).
617
618@item
619Financial functions such as future value and internal rate of return.
620
621@item
622Number theoretical features such as prime factorization and arithmetic
5d67986c 623modulo @var{m} for any @var{m}.
d7b8e6c6
EZ
624
625@item
626Algebraic manipulation features, including symbolic calculus.
627
628@item
629Moving data to and from regular editing buffers.
630
631@item
07ce2eb3 632Embedded mode for manipulating Calc formulas and data directly
d7b8e6c6
EZ
633inside any editing buffer.
634
635@item
636Graphics using GNUPLOT, a versatile (and free) plotting program.
637
638@item
639Easy programming using keyboard macros, algebraic formulas,
640algebraic rewrite rules, or extended Emacs Lisp.
641@end itemize
642
643Calc tries to include a little something for everyone; as a result it is
644large and might be intimidating to the first-time user. If you plan to
645use Calc only as a traditional desk calculator, all you really need to
646read is the ``Getting Started'' chapter of this manual and possibly the
647first few sections of the tutorial. As you become more comfortable with
87101b33
RS
648the program you can learn its additional features. Calc does not
649have the scope and depth of a fully-functional symbolic math package,
650but Calc has the advantages of convenience, portability, and freedom.
d7b8e6c6
EZ
651
652@node About This Manual, Notations Used in This Manual, What is Calc, Getting Started
653@section About This Manual
654
655@noindent
656This document serves as a complete description of the GNU Emacs
657Calculator. It works both as an introduction for novices, and as
658a reference for experienced users. While it helps to have some
659experience with GNU Emacs in order to get the most out of Calc,
660this manual ought to be readable even if you don't know or use Emacs
661regularly.
662
663@ifinfo
664The manual is divided into three major parts:@: the ``Getting
665Started'' chapter you are reading now, the Calc tutorial (chapter 2),
666and the Calc reference manual (the remaining chapters and appendices).
667@end ifinfo
668@iftex
669The manual is divided into three major parts:@: the ``Getting
670Started'' chapter you are reading now, the Calc tutorial (chapter 2),
671and the Calc reference manual (the remaining chapters and appendices).
672@c [when-split]
673@c This manual has been printed in two volumes, the @dfn{Tutorial} and the
674@c @dfn{Reference}. Both volumes include a copy of the ``Getting Started''
675@c chapter.
676@end iftex
677
678If you are in a hurry to use Calc, there is a brief ``demonstration''
679below which illustrates the major features of Calc in just a couple of
680pages. If you don't have time to go through the full tutorial, this
681will show you everything you need to know to begin.
682@xref{Demonstration of Calc}.
683
684The tutorial chapter walks you through the various parts of Calc
685with lots of hands-on examples and explanations. If you are new
686to Calc and you have some time, try going through at least the
687beginning of the tutorial. The tutorial includes about 70 exercises
688with answers. These exercises give you some guided practice with
689Calc, as well as pointing out some interesting and unusual ways
690to use its features.
691
692The reference section discusses Calc in complete depth. You can read
693the reference from start to finish if you want to learn every aspect
694of Calc. Or, you can look in the table of contents or the Concept
695Index to find the parts of the manual that discuss the things you
696need to know.
697
698@cindex Marginal notes
699Every Calc keyboard command is listed in the Calc Summary, and also
700in the Key Index. Algebraic functions, @kbd{M-x} commands, and
a4231b04
JB
701variables also have their own indices.
702@texline Each
703@infoline In the printed manual, each
d7b8e6c6
EZ
704paragraph that is referenced in the Key or Function Index is marked
705in the margin with its index entry.
706
707@c [fix-ref Help Commands]
708You can access this manual on-line at any time within Calc by
709pressing the @kbd{h i} key sequence. Outside of the Calc window,
710you can press @kbd{M-# i} to read the manual on-line. Also, you
711can jump directly to the Tutorial by pressing @kbd{h t} or @kbd{M-# t},
712or to the Summary by pressing @kbd{h s} or @kbd{M-# s}. Within Calc,
713you can also go to the part of the manual describing any Calc key,
714function, or variable using @w{@kbd{h k}}, @kbd{h f}, or @kbd{h v},
715respectively. @xref{Help Commands}.
716
029b2a44
JB
717The Calc manual can be printed, but because the manual is so large, you
718should only make a printed copy if you really need it. To print the
719manual, you will need the @TeX{} typesetting program (this is a free
720program by Donald Knuth at Stanford University) as well as the
721@file{texindex} program and @file{texinfo.tex} file, both of which can
722be obtained from the FSF as part of the @code{texinfo} package.
723To print the Calc manual in one huge tome, you will need the
724source code to this manual, @file{calc.texi}, available as part of the
725Emacs source. Once you have this file, type @kbd{texi2dvi calc.texi}.
726Alternatively, change to the @file{man} subdirectory of the Emacs
727source distribution, and type @kbd{make calc.dvi}. (Don't worry if you
728get some ``overfull box'' warnings while @TeX{} runs.)
729The result will be a device-independent output file called
730@file{calc.dvi}, which you must print in whatever way is right
731for your system. On many systems, the command is
732
733@example
734lpr -d calc.dvi
735@end example
736
737@noindent
738or
739
740@example
741dvips calc.dvi
742@end example
743
744@c Printed copies of this manual are also available from the Free Software
745@c Foundation.
d7b8e6c6
EZ
746
747@node Notations Used in This Manual, Demonstration of Calc, About This Manual, Getting Started
748@section Notations Used in This Manual
749
750@noindent
751This section describes the various notations that are used
752throughout the Calc manual.
753
754In keystroke sequences, uppercase letters mean you must hold down
755the shift key while typing the letter. Keys pressed with Control
756held down are shown as @kbd{C-x}. Keys pressed with Meta held down
757are shown as @kbd{M-x}. Other notations are @key{RET} for the
758Return key, @key{SPC} for the space bar, @key{TAB} for the Tab key,
759@key{DEL} for the Delete key, and @key{LFD} for the Line-Feed key.
909a758a
JB
760The @key{DEL} key is called Backspace on some keyboards, it is
761whatever key you would use to correct a simple typing error when
762regularly using Emacs.
d7b8e6c6
EZ
763
764(If you don't have the @key{LFD} or @key{TAB} keys on your keyboard,
765the @kbd{C-j} and @kbd{C-i} keys are equivalent to them, respectively.
766If you don't have a Meta key, look for Alt or Extend Char. You can
d7059a75 767also press @key{ESC} or @kbd{C-[} first to get the same effect, so
5d67986c 768that @kbd{M-x}, @kbd{@key{ESC} x}, and @kbd{C-[ x} are all equivalent.)
d7b8e6c6
EZ
769
770Sometimes the @key{RET} key is not shown when it is ``obvious''
5d67986c 771that you must press @key{RET} to proceed. For example, the @key{RET}
d7b8e6c6
EZ
772is usually omitted in key sequences like @kbd{M-x calc-keypad @key{RET}}.
773
774Commands are generally shown like this: @kbd{p} (@code{calc-precision})
775or @kbd{M-# k} (@code{calc-keypad}). This means that the command is
776normally used by pressing the @kbd{p} key or @kbd{M-# k} key sequence,
777but it also has the full-name equivalent shown, e.g., @kbd{M-x calc-precision}.
778
779Commands that correspond to functions in algebraic notation
780are written: @kbd{C} (@code{calc-cos}) [@code{cos}]. This means
781the @kbd{C} key is equivalent to @kbd{M-x calc-cos}, and that
782the corresponding function in an algebraic-style formula would
783be @samp{cos(@var{x})}.
784
785A few commands don't have key equivalents: @code{calc-sincos}
a4231b04 786[@code{sincos}].
d7b8e6c6
EZ
787
788@node Demonstration of Calc, Using Calc, Notations Used in This Manual, Getting Started
789@section A Demonstration of Calc
790
791@noindent
792@cindex Demonstration of Calc
793This section will show some typical small problems being solved with
794Calc. The focus is more on demonstration than explanation, but
795everything you see here will be covered more thoroughly in the
796Tutorial.
797
798To begin, start Emacs if necessary (usually the command @code{emacs}
5d67986c 799does this), and type @kbd{M-# c} (or @kbd{@key{ESC} # c}) to start the
d7059a75
JB
800Calculator. (You can also use @kbd{M-x calc} if this doesn't work.
801@xref{Starting Calc}, for various ways of starting the Calculator.)
d7b8e6c6
EZ
802
803Be sure to type all the sample input exactly, especially noting the
804difference between lower-case and upper-case letters. Remember,
5d67986c 805@key{RET}, @key{TAB}, @key{DEL}, and @key{SPC} are the Return, Tab,
d7b8e6c6
EZ
806Delete, and Space keys.
807
808@strong{RPN calculation.} In RPN, you type the input number(s) first,
809then the command to operate on the numbers.
810
811@noindent
a4231b04 812Type @kbd{2 @key{RET} 3 + Q} to compute
8e04863e 813@texline @math{\sqrt{2+3} = 2.2360679775}.
a4231b04 814@infoline the square root of 2+3, which is 2.2360679775.
d7b8e6c6
EZ
815
816@noindent
a4231b04 817Type @kbd{P 2 ^} to compute
8e04863e 818@texline @math{\pi^2 = 9.86960440109}.
a4231b04 819@infoline the value of `pi' squared, 9.86960440109.
d7b8e6c6
EZ
820
821@noindent
5d67986c 822Type @key{TAB} to exchange the order of these two results.
d7b8e6c6
EZ
823
824@noindent
825Type @kbd{- I H S} to subtract these results and compute the Inverse
826Hyperbolic sine of the difference, 2.72996136574.
827
828@noindent
5d67986c 829Type @key{DEL} to erase this result.
d7b8e6c6
EZ
830
831@strong{Algebraic calculation.} You can also enter calculations using
832conventional ``algebraic'' notation. To enter an algebraic formula,
833use the apostrophe key.
834
835@noindent
a4231b04 836Type @kbd{' sqrt(2+3) @key{RET}} to compute
8e04863e 837@texline @math{\sqrt{2+3}}.
a4231b04 838@infoline the square root of 2+3.
d7b8e6c6
EZ
839
840@noindent
a4231b04 841Type @kbd{' pi^2 @key{RET}} to enter
8e04863e 842@texline @math{\pi^2}.
a4231b04
JB
843@infoline `pi' squared.
844To evaluate this symbolic formula as a number, type @kbd{=}.
d7b8e6c6
EZ
845
846@noindent
5d67986c 847Type @kbd{' arcsinh($ - $$) @key{RET}} to subtract the second-most-recent
d7b8e6c6
EZ
848result from the most-recent and compute the Inverse Hyperbolic sine.
849
850@strong{Keypad mode.} If you are using the X window system, press
851@w{@kbd{M-# k}} to get Keypad mode. (If you don't use X, skip to
852the next section.)
853
854@noindent
855Click on the @key{2}, @key{ENTER}, @key{3}, @key{+}, and @key{SQRT}
856``buttons'' using your left mouse button.
857
858@noindent
bd712b70 859Click on @key{PI}, @key{2}, and @tfn{y^x}.
d7b8e6c6
EZ
860
861@noindent
862Click on @key{INV}, then @key{ENTER} to swap the two results.
863
864@noindent
865Click on @key{-}, @key{INV}, @key{HYP}, and @key{SIN}.
866
867@noindent
868Click on @key{<-} to erase the result, then click @key{OFF} to turn
869the Keypad Calculator off.
870
871@strong{Grabbing data.} Type @kbd{M-# x} if necessary to exit Calc.
872Now select the following numbers as an Emacs region: ``Mark'' the
5d67986c 873front of the list by typing @kbd{C-@key{SPC}} or @kbd{C-@@} there,
d7b8e6c6
EZ
874then move to the other end of the list. (Either get this list from
875the on-line copy of this manual, accessed by @w{@kbd{M-# i}}, or just
876type these numbers into a scratch file.) Now type @kbd{M-# g} to
877``grab'' these numbers into Calc.
878
d7b8e6c6 879@example
5d67986c 880@group
d7b8e6c6
EZ
8811.23 1.97
8821.6 2
8831.19 1.08
d7b8e6c6 884@end group
5d67986c 885@end example
d7b8e6c6
EZ
886
887@noindent
888The result @samp{[1.23, 1.97, 1.6, 2, 1.19, 1.08]} is a Calc ``vector.''
889Type @w{@kbd{V R +}} to compute the sum of these numbers.
890
891@noindent
892Type @kbd{U} to Undo this command, then type @kbd{V R *} to compute
893the product of the numbers.
894
895@noindent
896You can also grab data as a rectangular matrix. Place the cursor on
897the upper-leftmost @samp{1} and set the mark, then move to just after
898the lower-right @samp{8} and press @kbd{M-# r}.
899
900@noindent
a4231b04 901Type @kbd{v t} to transpose this
8e04863e 902@texline @math{3\times2}
a4231b04
JB
903@infoline 3x2
904matrix into a
8e04863e 905@texline @math{2\times3}
a4231b04
JB
906@infoline 2x3
907matrix. Type @w{@kbd{v u}} to unpack the rows into two separate
908vectors. Now type @w{@kbd{V R + @key{TAB} V R +}} to compute the sums
909of the two original columns. (There is also a special
910grab-and-sum-columns command, @kbd{M-# :}.)
d7b8e6c6
EZ
911
912@strong{Units conversion.} Units are entered algebraically.
5d67986c
RS
913Type @w{@kbd{' 43 mi/hr @key{RET}}} to enter the quantity 43 miles-per-hour.
914Type @w{@kbd{u c km/hr @key{RET}}}. Type @w{@kbd{u c m/s @key{RET}}}.
d7b8e6c6
EZ
915
916@strong{Date arithmetic.} Type @kbd{t N} to get the current date and
917time. Type @kbd{90 +} to find the date 90 days from now. Type
5d67986c 918@kbd{' <25 dec 87> @key{RET}} to enter a date, then @kbd{- 7 /} to see how
d7b8e6c6
EZ
919many weeks have passed since then.
920
921@strong{Algebra.} Algebraic entries can also include formulas
5d67986c 922or equations involving variables. Type @kbd{@w{' [x + y} = a, x y = 1] @key{RET}}
d7b8e6c6
EZ
923to enter a pair of equations involving three variables.
924(Note the leading apostrophe in this example; also, note that the space
5d67986c 925between @samp{x y} is required.) Type @w{@kbd{a S x,y @key{RET}}} to solve
a4231b04 926these equations for the variables @expr{x} and @expr{y}.
d7b8e6c6
EZ
927
928@noindent
929Type @kbd{d B} to view the solutions in more readable notation.
8ed713c6
JB
930Type @w{@kbd{d C}} to view them in C language notation, @kbd{d T}
931to view them in the notation for the @TeX{} typesetting system,
053bc283 932and @kbd{d L} to view them in the notation for the La@TeX{} typesetting
8ed713c6 933system. Type @kbd{d N} to return to normal notation.
d7b8e6c6
EZ
934
935@noindent
a4231b04 936Type @kbd{7.5}, then @kbd{s l a @key{RET}} to let @expr{a = 7.5} in these formulas.
d7b8e6c6
EZ
937(That's a letter @kbd{l}, not a numeral @kbd{1}.)
938
939@iftex
940@strong{Help functions.} You can read about any command in the on-line
941manual. Type @kbd{M-# c} to return to Calc after each of these
942commands: @kbd{h k t N} to read about the @kbd{t N} command,
5d67986c 943@kbd{h f sqrt @key{RET}} to read about the @code{sqrt} function, and
d7b8e6c6
EZ
944@kbd{h s} to read the Calc summary.
945@end iftex
946@ifinfo
947@strong{Help functions.} You can read about any command in the on-line
948manual. Remember to type the letter @kbd{l}, then @kbd{M-# c}, to
949return here after each of these commands: @w{@kbd{h k t N}} to read
5d67986c 950about the @w{@kbd{t N}} command, @kbd{h f sqrt @key{RET}} to read about the
d7b8e6c6
EZ
951@code{sqrt} function, and @kbd{h s} to read the Calc summary.
952@end ifinfo
953
5d67986c 954Press @key{DEL} repeatedly to remove any leftover results from the stack.
d7b8e6c6
EZ
955To exit from Calc, press @kbd{q} or @kbd{M-# c} again.
956
957@node Using Calc, History and Acknowledgements, Demonstration of Calc, Getting Started
958@section Using Calc
959
960@noindent
961Calc has several user interfaces that are specialized for
962different kinds of tasks. As well as Calc's standard interface,
07ce2eb3 963there are Quick mode, Keypad mode, and Embedded mode.
d7b8e6c6 964
d7b8e6c6
EZ
965@menu
966* Starting Calc::
967* The Standard Interface::
968* Quick Mode Overview::
969* Keypad Mode Overview::
970* Standalone Operation::
971* Embedded Mode Overview::
972* Other M-# Commands::
973@end menu
974
975@node Starting Calc, The Standard Interface, Using Calc, Using Calc
976@subsection Starting Calc
977
978@noindent
979On most systems, you can type @kbd{M-#} to start the Calculator.
980The notation @kbd{M-#} is short for Meta-@kbd{#}. On most
981keyboards this means holding down the Meta (or Alt) and
982Shift keys while typing @kbd{3}.
983
984@cindex META key
985Once again, if you don't have a Meta key on your keyboard you can type
986@key{ESC} first, then @kbd{#}, to accomplish the same thing. If you
987don't even have an @key{ESC} key, you can fake it by holding down
988Control or @key{CTRL} while typing a left square bracket
a4231b04 989(that's @kbd{C-[} in Emacs notation).
d7b8e6c6 990
d7059a75
JB
991The key @kbd{M-#} is bound to the command @code{calc-dispatch},
992which can be rebound if convenient.
993(@xref{Key Bindings,,Customizing Key Bindings,emacs,
994The GNU Emacs Manual}.)
995
996When you press @kbd{M-#}, Emacs waits for you to press a second key to
997complete the command. In this case, you will follow @kbd{M-#} with a
998letter (upper- or lower-case, it doesn't matter for @kbd{M-#}) that says
999which Calc interface you want to use.
d7b8e6c6
EZ
1000
1001To get Calc's standard interface, type @kbd{M-# c}. To get
07ce2eb3 1002Keypad mode, type @kbd{M-# k}. Type @kbd{M-# ?} to get a brief
d7b8e6c6
EZ
1003list of the available options, and type a second @kbd{?} to get
1004a complete list.
1005
1006To ease typing, @kbd{M-# M-#} (or @kbd{M-# #} if that's easier)
1007also works to start Calc. It starts the same interface (either
1008@kbd{M-# c} or @w{@kbd{M-# k}}) that you last used, selecting the
1009@kbd{M-# c} interface by default. (If your installation has
1010a special function key set up to act like @kbd{M-#}, hitting that
1011function key twice is just like hitting @kbd{M-# M-#}.)
1012
1013If @kbd{M-#} doesn't work for you, you can always type explicit
1014commands like @kbd{M-x calc} (for the standard user interface) or
07ce2eb3 1015@w{@kbd{M-x calc-keypad}} (for Keypad mode). First type @kbd{M-x}
d7b8e6c6
EZ
1016(that's Meta with the letter @kbd{x}), then, at the prompt,
1017type the full command (like @kbd{calc-keypad}) and press Return.
1018
d7b8e6c6
EZ
1019The same commands (like @kbd{M-# c} or @kbd{M-# M-#}) that start
1020the Calculator also turn it off if it is already on.
1021
1022@node The Standard Interface, Quick Mode Overview, Starting Calc, Using Calc
1023@subsection The Standard Calc Interface
1024
1025@noindent
1026@cindex Standard user interface
1027Calc's standard interface acts like a traditional RPN calculator,
1028operated by the normal Emacs keyboard. When you type @kbd{M-# c}
1029to start the Calculator, the Emacs screen splits into two windows
1030with the file you were editing on top and Calc on the bottom.
1031
d7b8e6c6 1032@smallexample
5d67986c 1033@group
d7b8e6c6
EZ
1034
1035...
1036--**-Emacs: myfile (Fundamental)----All----------------------
17c5c219 1037--- Emacs Calculator Mode --- |Emacs Calc Mode v2.1 ...
d7b8e6c6
EZ
10382: 17.3 | 17.3
10391: -5 | 3
1040 . | 2
1041 | 4
1042 | * 8
1043 | ->-5
1044 |
1045--%%-Calc: 12 Deg (Calculator)----All----- --%%-Emacs: *Calc Trail*
d7b8e6c6 1046@end group
5d67986c 1047@end smallexample
d7b8e6c6
EZ
1048
1049In this figure, the mode-line for @file{myfile} has moved up and the
1050``Calculator'' window has appeared below it. As you can see, Calc
1051actually makes two windows side-by-side. The lefthand one is
1052called the @dfn{stack window} and the righthand one is called the
1053@dfn{trail window.} The stack holds the numbers involved in the
1054calculation you are currently performing. The trail holds a complete
1055record of all calculations you have done. In a desk calculator with
1056a printer, the trail corresponds to the paper tape that records what
1057you do.
1058
1059In this case, the trail shows that four numbers (17.3, 3, 2, and 4)
1060were first entered into the Calculator, then the 2 and 4 were
8e04863e 1061multiplied to get 8, then the 3 and 8 were subtracted to get @mathit{-5}.
d7b8e6c6 1062(The @samp{>} symbol shows that this was the most recent calculation.)
8e04863e 1063The net result is the two numbers 17.3 and @mathit{-5} sitting on the stack.
d7b8e6c6
EZ
1064
1065Most Calculator commands deal explicitly with the stack only, but
1066there is a set of commands that allow you to search back through
1067the trail and retrieve any previous result.
1068
1069Calc commands use the digits, letters, and punctuation keys.
1070Shifted (i.e., upper-case) letters are different from lowercase
1071letters. Some letters are @dfn{prefix} keys that begin two-letter
1072commands. For example, @kbd{e} means ``enter exponent'' and shifted
a4231b04 1073@kbd{E} means @expr{e^x}. With the @kbd{d} (``display modes'') prefix
d7b8e6c6
EZ
1074the letter ``e'' takes on very different meanings: @kbd{d e} means
1075``engineering notation'' and @kbd{d E} means ``@dfn{eqn} language mode.''
1076
1077There is nothing stopping you from switching out of the Calc
1078window and back into your editing window, say by using the Emacs
1079@w{@kbd{C-x o}} (@code{other-window}) command. When the cursor is
1080inside a regular window, Emacs acts just like normal. When the
1081cursor is in the Calc stack or trail windows, keys are interpreted
1082as Calc commands.
1083
1084When you quit by pressing @kbd{M-# c} a second time, the Calculator
1085windows go away but the actual Stack and Trail are not gone, just
1086hidden. When you press @kbd{M-# c} once again you will get the
1087same stack and trail contents you had when you last used the
1088Calculator.
1089
1090The Calculator does not remember its state between Emacs sessions.
1091Thus if you quit Emacs and start it again, @kbd{M-# c} will give you
1092a fresh stack and trail. There is a command (@kbd{m m}) that lets
1093you save your favorite mode settings between sessions, though.
1094One of the things it saves is which user interface (standard or
1095Keypad) you last used; otherwise, a freshly started Emacs will
1096always treat @kbd{M-# M-#} the same as @kbd{M-# c}.
1097
1098The @kbd{q} key is another equivalent way to turn the Calculator off.
1099
1100If you type @kbd{M-# b} first and then @kbd{M-# c}, you get a
1101full-screen version of Calc (@code{full-calc}) in which the stack and
1102trail windows are still side-by-side but are now as tall as the whole
1103Emacs screen. When you press @kbd{q} or @kbd{M-# c} again to quit,
1104the file you were editing before reappears. The @kbd{M-# b} key
1105switches back and forth between ``big'' full-screen mode and the
1106normal partial-screen mode.
1107
1108Finally, @kbd{M-# o} (@code{calc-other-window}) is like @kbd{M-# c}
1109except that the Calc window is not selected. The buffer you were
1110editing before remains selected instead. @kbd{M-# o} is a handy
1111way to switch out of Calc momentarily to edit your file; type
1112@kbd{M-# c} to switch back into Calc when you are done.
1113
1114@node Quick Mode Overview, Keypad Mode Overview, The Standard Interface, Using Calc
1115@subsection Quick Mode (Overview)
1116
1117@noindent
07ce2eb3 1118@dfn{Quick mode} is a quick way to use Calc when you don't need the
d7b8e6c6
EZ
1119full complexity of the stack and trail. To use it, type @kbd{M-# q}
1120(@code{quick-calc}) in any regular editing buffer.
1121
07ce2eb3 1122Quick mode is very simple: It prompts you to type any formula in
d7b8e6c6 1123standard algebraic notation (like @samp{4 - 2/3}) and then displays
8e04863e 1124the result at the bottom of the Emacs screen (@mathit{3.33333333333}
d7b8e6c6
EZ
1125in this case). You are then back in the same editing buffer you
1126were in before, ready to continue editing or to type @kbd{M-# q}
1127again to do another quick calculation. The result of the calculation
1128will also be in the Emacs ``kill ring'' so that a @kbd{C-y} command
1129at this point will yank the result into your editing buffer.
1130
07ce2eb3 1131Calc mode settings affect Quick mode, too, though you will have to
d7b8e6c6
EZ
1132go into regular Calc (with @kbd{M-# c}) to change the mode settings.
1133
1134@c [fix-ref Quick Calculator mode]
1135@xref{Quick Calculator}, for further information.
1136
1137@node Keypad Mode Overview, Standalone Operation, Quick Mode Overview, Using Calc
1138@subsection Keypad Mode (Overview)
1139
1140@noindent
07ce2eb3 1141@dfn{Keypad mode} is a mouse-based interface to the Calculator.
7d8c2d57 1142It is designed for use with terminals that support a mouse. If you
07ce2eb3 1143don't have a mouse, you will have to operate Keypad mode with your
be6a9738 1144arrow keys (which is probably more trouble than it's worth).
d7b8e6c6 1145
07ce2eb3 1146Type @kbd{M-# k} to turn Keypad mode on or off. Once again you
d7b8e6c6
EZ
1147get two new windows, this time on the righthand side of the screen
1148instead of at the bottom. The upper window is the familiar Calc
1149Stack; the lower window is a picture of a typical calculator keypad.
1150
1151@tex
1152\dimen0=\pagetotal%
1153\advance \dimen0 by 24\baselineskip%
1154\ifdim \dimen0>\pagegoal \vfill\eject \fi%
1155\medskip
1156@end tex
1157@smallexample
17c5c219
JB
1158@group
1159|--- Emacs Calculator Mode ---
1160|2: 17.3
1161|1: -5
1162| .
1163|--%%-Calc: 12 Deg (Calcul
1164|----+-----Calc 2.1------+----1
1165|FLR |CEIL|RND |TRNC|CLN2|FLT |
1166|----+----+----+----+----+----|
1167| LN |EXP | |ABS |IDIV|MOD |
1168|----+----+----+----+----+----|
1169|SIN |COS |TAN |SQRT|y^x |1/x |
1170|----+----+----+----+----+----|
1171| ENTER |+/- |EEX |UNDO| <- |
1172|-----+---+-+--+--+-+---++----|
1173| INV | 7 | 8 | 9 | / |
1174|-----+-----+-----+-----+-----|
1175| HYP | 4 | 5 | 6 | * |
1176|-----+-----+-----+-----+-----|
1177|EXEC | 1 | 2 | 3 | - |
1178|-----+-----+-----+-----+-----|
1179| OFF | 0 | . | PI | + |
1180|-----+-----+-----+-----+-----+
1181@end group
d7b8e6c6 1182@end smallexample
d7b8e6c6 1183
07ce2eb3 1184Keypad mode is much easier for beginners to learn, because there
d7b8e6c6
EZ
1185is no need to memorize lots of obscure key sequences. But not all
1186commands in regular Calc are available on the Keypad. You can
1187always switch the cursor into the Calc stack window to use
1188standard Calc commands if you need. Serious Calc users, though,
07ce2eb3 1189often find they prefer the standard interface over Keypad mode.
d7b8e6c6
EZ
1190
1191To operate the Calculator, just click on the ``buttons'' of the
1192keypad using your left mouse button. To enter the two numbers
1193shown here you would click @w{@kbd{1 7 .@: 3 ENTER 5 +/- ENTER}}; to
1194add them together you would then click @kbd{+} (to get 12.3 on
1195the stack).
1196
1197If you click the right mouse button, the top three rows of the
1198keypad change to show other sets of commands, such as advanced
1199math functions, vector operations, and operations on binary
1200numbers.
1201
07ce2eb3 1202Because Keypad mode doesn't use the regular keyboard, Calc leaves
d7b8e6c6
EZ
1203the cursor in your original editing buffer. You can type in
1204this buffer in the usual way while also clicking on the Calculator
07ce2eb3 1205keypad. One advantage of Keypad mode is that you don't need an
d7b8e6c6
EZ
1206explicit command to switch between editing and calculating.
1207
07ce2eb3 1208If you press @kbd{M-# b} first, you get a full-screen Keypad mode
d7b8e6c6
EZ
1209(@code{full-calc-keypad}) with three windows: The keypad in the lower
1210left, the stack in the lower right, and the trail on top.
1211
1212@c [fix-ref Keypad Mode]
1213@xref{Keypad Mode}, for further information.
1214
1215@node Standalone Operation, Embedded Mode Overview, Keypad Mode Overview, Using Calc
1216@subsection Standalone Operation
1217
1218@noindent
1219@cindex Standalone Operation
1220If you are not in Emacs at the moment but you wish to use Calc,
1221you must start Emacs first. If all you want is to run Calc, you
1222can give the commands:
1223
1224@example
1225emacs -f full-calc
1226@end example
1227
1228@noindent
1229or
1230
1231@example
1232emacs -f full-calc-keypad
1233@end example
1234
1235@noindent
1236which run a full-screen Calculator (as if by @kbd{M-# b M-# c}) or
1237a full-screen X-based Calculator (as if by @kbd{M-# b M-# k}).
1238In standalone operation, quitting the Calculator (by pressing
1239@kbd{q} or clicking on the keypad @key{EXIT} button) quits Emacs
1240itself.
1241
1242@node Embedded Mode Overview, Other M-# Commands, Standalone Operation, Using Calc
1243@subsection Embedded Mode (Overview)
1244
1245@noindent
07ce2eb3 1246@dfn{Embedded mode} is a way to use Calc directly from inside an
d7b8e6c6
EZ
1247editing buffer. Suppose you have a formula written as part of a
1248document like this:
1249
d7b8e6c6 1250@smallexample
5d67986c 1251@group
d7b8e6c6
EZ
1252The derivative of
1253
1254 ln(ln(x))
1255
1256is
d7b8e6c6 1257@end group
5d67986c 1258@end smallexample
d7b8e6c6
EZ
1259
1260@noindent
1261and you wish to have Calc compute and format the derivative for
1262you and store this derivative in the buffer automatically. To
07ce2eb3 1263do this with Embedded mode, first copy the formula down to where
d7b8e6c6
EZ
1264you want the result to be:
1265
d7b8e6c6 1266@smallexample
5d67986c 1267@group
d7b8e6c6
EZ
1268The derivative of
1269
1270 ln(ln(x))
1271
1272is
1273
1274 ln(ln(x))
d7b8e6c6 1275@end group
5d67986c 1276@end smallexample
d7b8e6c6
EZ
1277
1278Now, move the cursor onto this new formula and press @kbd{M-# e}.
1279Calc will read the formula (using the surrounding blank lines to
1280tell how much text to read), then push this formula (invisibly)
1281onto the Calc stack. The cursor will stay on the formula in the
1282editing buffer, but the buffer's mode line will change to look
1283like the Calc mode line (with mode indicators like @samp{12 Deg}
1284and so on). Even though you are still in your editing buffer,
1285the keyboard now acts like the Calc keyboard, and any new result
1286you get is copied from the stack back into the buffer. To take
1287the derivative, you would type @kbd{a d x @key{RET}}.
1288
d7b8e6c6 1289@smallexample
5d67986c 1290@group
d7b8e6c6
EZ
1291The derivative of
1292
1293 ln(ln(x))
1294
1295is
1296
12971 / ln(x) x
d7b8e6c6 1298@end group
5d67986c 1299@end smallexample
d7b8e6c6
EZ
1300
1301To make this look nicer, you might want to press @kbd{d =} to center
07ce2eb3 1302the formula, and even @kbd{d B} to use Big display mode.
d7b8e6c6 1303
d7b8e6c6 1304@smallexample
5d67986c 1305@group
d7b8e6c6
EZ
1306The derivative of
1307
1308 ln(ln(x))
1309
1310is
1311% [calc-mode: justify: center]
1312% [calc-mode: language: big]
1313
1314 1
1315 -------
1316 ln(x) x
d7b8e6c6 1317@end group
5d67986c 1318@end smallexample
d7b8e6c6
EZ
1319
1320Calc has added annotations to the file to help it remember the modes
1321that were used for this formula. They are formatted like comments
8ed713c6 1322in the @TeX{} typesetting language, just in case you are using @TeX{} or
053bc283 1323La@TeX{}. (In this example @TeX{} is not being used, so you might want
8ed713c6
JB
1324to move these comments up to the top of the file or otherwise put them
1325out of the way.)
d7b8e6c6
EZ
1326
1327As an extra flourish, we can add an equation number using a
5d67986c 1328righthand label: Type @kbd{d @} (1) @key{RET}}.
d7b8e6c6 1329
d7b8e6c6 1330@smallexample
5d67986c 1331@group
d7b8e6c6
EZ
1332% [calc-mode: justify: center]
1333% [calc-mode: language: big]
1334% [calc-mode: right-label: " (1)"]
1335
1336 1
1337 ------- (1)
1338 ln(x) x
d7b8e6c6 1339@end group
5d67986c 1340@end smallexample
d7b8e6c6 1341
07ce2eb3 1342To leave Embedded mode, type @kbd{M-# e} again. The mode line
d7059a75 1343and keyboard will revert to the way they were before.
d7b8e6c6
EZ
1344
1345The related command @kbd{M-# w} operates on a single word, which
1346generally means a single number, inside text. It uses any
1347non-numeric characters rather than blank lines to delimit the
1348formula it reads. Here's an example of its use:
1349
1350@smallexample
1351A slope of one-third corresponds to an angle of 1 degrees.
1352@end smallexample
1353
1354Place the cursor on the @samp{1}, then type @kbd{M-# w} to enable
07ce2eb3 1355Embedded mode on that number. Now type @kbd{3 /} (to get one-third),
d7b8e6c6
EZ
1356and @kbd{I T} (the Inverse Tangent converts a slope into an angle),
1357then @w{@kbd{M-# w}} again to exit Embedded mode.
1358
1359@smallexample
1360A slope of one-third corresponds to an angle of 18.4349488229 degrees.
1361@end smallexample
1362
1363@c [fix-ref Embedded Mode]
1364@xref{Embedded Mode}, for full details.
1365
1366@node Other M-# Commands, , Embedded Mode Overview, Using Calc
1367@subsection Other @kbd{M-#} Commands
1368
1369@noindent
1370Two more Calc-related commands are @kbd{M-# g} and @kbd{M-# r},
1371which ``grab'' data from a selected region of a buffer into the
1372Calculator. The region is defined in the usual Emacs way, by
1373a ``mark'' placed at one end of the region, and the Emacs
1374cursor or ``point'' placed at the other.
1375
1376The @kbd{M-# g} command reads the region in the usual left-to-right,
1377top-to-bottom order. The result is packaged into a Calc vector
1378of numbers and placed on the stack. Calc (in its standard
1379user interface) is then started. Type @kbd{v u} if you want
1380to unpack this vector into separate numbers on the stack. Also,
1381@kbd{C-u M-# g} interprets the region as a single number or
1382formula.
1383
1384The @kbd{M-# r} command reads a rectangle, with the point and
1385mark defining opposite corners of the rectangle. The result
1386is a matrix of numbers on the Calculator stack.
1387
1388Complementary to these is @kbd{M-# y}, which ``yanks'' the
1389value at the top of the Calc stack back into an editing buffer.
1390If you type @w{@kbd{M-# y}} while in such a buffer, the value is
1391yanked at the current position. If you type @kbd{M-# y} while
1392in the Calc buffer, Calc makes an educated guess as to which
1393editing buffer you want to use. The Calc window does not have
1394to be visible in order to use this command, as long as there
1395is something on the Calc stack.
1396
1397Here, for reference, is the complete list of @kbd{M-#} commands.
1398The shift, control, and meta keys are ignored for the keystroke
1399following @kbd{M-#}.
1400
1401@noindent
1402Commands for turning Calc on and off:
1403
1404@table @kbd
1405@item #
1406Turn Calc on or off, employing the same user interface as last time.
1407
1408@item C
1409Turn Calc on or off using its standard bottom-of-the-screen
1410interface. If Calc is already turned on but the cursor is not
1411in the Calc window, move the cursor into the window.
1412
1413@item O
1414Same as @kbd{C}, but don't select the new Calc window. If
1415Calc is already turned on and the cursor is in the Calc window,
1416move it out of that window.
1417
1418@item B
1419Control whether @kbd{M-# c} and @kbd{M-# k} use the full screen.
1420
1421@item Q
07ce2eb3 1422Use Quick mode for a single short calculation.
d7b8e6c6
EZ
1423
1424@item K
1425Turn Calc Keypad mode on or off.
1426
1427@item E
1428Turn Calc Embedded mode on or off at the current formula.
1429
1430@item J
1431Turn Calc Embedded mode on or off, select the interesting part.
1432
1433@item W
1434Turn Calc Embedded mode on or off at the current word (number).
1435
1436@item Z
1437Turn Calc on in a user-defined way, as defined by a @kbd{Z I} command.
1438
1439@item X
1440Quit Calc; turn off standard, Keypad, or Embedded mode if on.
1441(This is like @kbd{q} or @key{OFF} inside of Calc.)
1442@end table
1443@iftex
1444@sp 2
1445@end iftex
1446
d7b8e6c6
EZ
1447@noindent
1448Commands for moving data into and out of the Calculator:
1449
1450@table @kbd
1451@item G
1452Grab the region into the Calculator as a vector.
1453
1454@item R
1455Grab the rectangular region into the Calculator as a matrix.
1456
1457@item :
1458Grab the rectangular region and compute the sums of its columns.
1459
1460@item _
1461Grab the rectangular region and compute the sums of its rows.
1462
1463@item Y
1464Yank a value from the Calculator into the current editing buffer.
1465@end table
1466@iftex
1467@sp 2
1468@end iftex
d7b8e6c6 1469
d7b8e6c6 1470@noindent
07ce2eb3 1471Commands for use with Embedded mode:
d7b8e6c6
EZ
1472
1473@table @kbd
1474@item A
1475``Activate'' the current buffer. Locate all formulas that
1476contain @samp{:=} or @samp{=>} symbols and record their locations
1477so that they can be updated automatically as variables are changed.
1478
1479@item D
1480Duplicate the current formula immediately below and select
1481the duplicate.
1482
1483@item F
1484Insert a new formula at the current point.
1485
1486@item N
1487Move the cursor to the next active formula in the buffer.
1488
1489@item P
1490Move the cursor to the previous active formula in the buffer.
1491
1492@item U
1493Update (i.e., as if by the @kbd{=} key) the formula at the current point.
1494
1495@item `
1496Edit (as if by @code{calc-edit}) the formula at the current point.
1497@end table
1498@iftex
1499@sp 2
1500@end iftex
d7b8e6c6 1501
d7b8e6c6
EZ
1502@noindent
1503Miscellaneous commands:
1504
1505@table @kbd
1506@item I
1507Run the Emacs Info system to read the Calc manual.
1508(This is the same as @kbd{h i} inside of Calc.)
1509
1510@item T
1511Run the Emacs Info system to read the Calc Tutorial.
1512
1513@item S
1514Run the Emacs Info system to read the Calc Summary.
1515
1516@item L
1517Load Calc entirely into memory. (Normally the various parts
1518are loaded only as they are needed.)
1519
1520@item M
5d67986c 1521Read a region of written keystroke names (like @kbd{C-n a b c @key{RET}})
d7b8e6c6
EZ
1522and record them as the current keyboard macro.
1523
1524@item 0
1525(This is the ``zero'' digit key.) Reset the Calculator to
d7059a75 1526its initial state: Empty stack, and initial mode settings.
d7b8e6c6 1527@end table
d7b8e6c6
EZ
1528
1529@node History and Acknowledgements, , Using Calc, Getting Started
1530@section History and Acknowledgements
1531
1532@noindent
1533Calc was originally started as a two-week project to occupy a lull
1534in the author's schedule. Basically, a friend asked if I remembered
a4231b04 1535the value of
8e04863e 1536@texline @math{2^{32}}.
a4231b04
JB
1537@infoline @expr{2^32}.
1538I didn't offhand, but I said, ``that's easy, just call up an
1539@code{xcalc}.'' @code{Xcalc} duly reported that the answer to our
1540question was @samp{4.294967e+09}---with no way to see the full ten
1541digits even though we knew they were there in the program's memory! I
1542was so annoyed, I vowed to write a calculator of my own, once and for
1543all.
d7b8e6c6
EZ
1544
1545I chose Emacs Lisp, a) because I had always been curious about it
1546and b) because, being only a text editor extension language after
1547all, Emacs Lisp would surely reach its limits long before the project
1548got too far out of hand.
1549
1550To make a long story short, Emacs Lisp turned out to be a distressingly
1551solid implementation of Lisp, and the humble task of calculating
1552turned out to be more open-ended than one might have expected.
1553
1554Emacs Lisp doesn't have built-in floating point math, so it had to be
1555simulated in software. In fact, Emacs integers will only comfortably
1556fit six decimal digits or so---not enough for a decent calculator. So
1557I had to write my own high-precision integer code as well, and once I had
1558this I figured that arbitrary-size integers were just as easy as large
1559integers. Arbitrary floating-point precision was the logical next step.
1560Also, since the large integer arithmetic was there anyway it seemed only
1561fair to give the user direct access to it, which in turn made it practical
1562to support fractions as well as floats. All these features inspired me
1563to look around for other data types that might be worth having.
1564
1565Around this time, my friend Rick Koshi showed me his nifty new HP-28
1566calculator. It allowed the user to manipulate formulas as well as
87101b33
RS
1567numerical quantities, and it could also operate on matrices. I
1568decided that these would be good for Calc to have, too. And once
1569things had gone this far, I figured I might as well take a look at
1570serious algebra systems for further ideas. Since these systems did
1571far more than I could ever hope to implement, I decided to focus on
1572rewrite rules and other programming features so that users could
1573implement what they needed for themselves.
d7b8e6c6
EZ
1574
1575Rick complained that matrices were hard to read, so I put in code to
1576format them in a 2D style. Once these routines were in place, Big mode
1577was obligatory. Gee, what other language modes would be useful?
1578
1579Scott Hemphill and Allen Knutson, two friends with a strong mathematical
1580bent, contributed ideas and algorithms for a number of Calc features
1581including modulo forms, primality testing, and float-to-fraction conversion.
1582
1583Units were added at the eager insistence of Mass Sivilotti. Later,
1584Ulrich Mueller at CERN and Przemek Klosowski at NIST provided invaluable
1585expert assistance with the units table. As far as I can remember, the
1586idea of using algebraic formulas and variables to represent units dates
1587back to an ancient article in Byte magazine about muMath, an early
1588algebra system for microcomputers.
1589
1590Many people have contributed to Calc by reporting bugs and suggesting
1591features, large and small. A few deserve special mention: Tim Peters,
1592who helped develop the ideas that led to the selection commands, rewrite
a4231b04 1593rules, and many other algebra features;
d7059a75 1594@texline Fran\c{c}ois
a4231b04
JB
1595@infoline Francois
1596Pinard, who contributed an early prototype of the Calc Summary appendix
1597as well as providing valuable suggestions in many other areas of Calc;
1598Carl Witty, whose eagle eyes discovered many typographical and factual
1599errors in the Calc manual; Tim Kay, who drove the development of
1600Embedded mode; Ove Ewerlid, who made many suggestions relating to the
1601algebra commands and contributed some code for polynomial operations;
1602Randal Schwartz, who suggested the @code{calc-eval} function; Robert
1603J. Chassell, who suggested the Calc Tutorial and exercises; and Juha
1604Sarlin, who first worked out how to split Calc into quickly-loading
1605parts. Bob Weiner helped immensely with the Lucid Emacs port.
d7b8e6c6
EZ
1606
1607@cindex Bibliography
1608@cindex Knuth, Art of Computer Programming
1609@cindex Numerical Recipes
1610@c Should these be expanded into more complete references?
1611Among the books used in the development of Calc were Knuth's @emph{Art
1612of Computer Programming} (especially volume II, @emph{Seminumerical
1613Algorithms}); @emph{Numerical Recipes} by Press, Flannery, Teukolsky,
87101b33
RS
1614and Vetterling; Bevington's @emph{Data Reduction and Error Analysis
1615for the Physical Sciences}; @emph{Concrete Mathematics} by Graham,
1616Knuth, and Patashnik; Steele's @emph{Common Lisp, the Language}; the
1617@emph{CRC Standard Math Tables} (William H. Beyer, ed.); and
1618Abramowitz and Stegun's venerable @emph{Handbook of Mathematical
1619Functions}. Also, of course, Calc could not have been written without
1620the excellent @emph{GNU Emacs Lisp Reference Manual}, by Bil Lewis and
1621Dan LaLiberte.
d7b8e6c6
EZ
1622
1623Final thanks go to Richard Stallman, without whose fine implementations
1624of the Emacs editor, language, and environment, Calc would have been
1625finished in two weeks.
1626
1627@c [tutorial]
1628
1629@ifinfo
1630@c This node is accessed by the `M-# t' command.
1631@node Interactive Tutorial, , , Top
1632@chapter Tutorial
1633
1634@noindent
1635Some brief instructions on using the Emacs Info system for this tutorial:
1636
1637Press the space bar and Delete keys to go forward and backward in a
1638section by screenfuls (or use the regular Emacs scrolling commands
1639for this).
1640
1641Press @kbd{n} or @kbd{p} to go to the Next or Previous section.
1642If the section has a @dfn{menu}, press a digit key like @kbd{1}
1643or @kbd{2} to go to a sub-section from the menu. Press @kbd{u} to
1644go back up from a sub-section to the menu it is part of.
1645
1646Exercises in the tutorial all have cross-references to the
1647appropriate page of the ``answers'' section. Press @kbd{f}, then
1648the exercise number, to see the answer to an exercise. After
1649you have followed a cross-reference, you can press the letter
1650@kbd{l} to return to where you were before.
1651
1652You can press @kbd{?} at any time for a brief summary of Info commands.
1653
1654Press @kbd{1} now to enter the first section of the Tutorial.
1655
1656@menu
1657* Tutorial::
1658@end menu
1659@end ifinfo
1660
1661@node Tutorial, Introduction, Getting Started, Top
1662@chapter Tutorial
1663
1664@noindent
1665This chapter explains how to use Calc and its many features, in
1666a step-by-step, tutorial way. You are encouraged to run Calc and
1667work along with the examples as you read (@pxref{Starting Calc}).
1668If you are already familiar with advanced calculators, you may wish
1669@c [not-split]
1670to skip on to the rest of this manual.
1671@c [when-split]
1672@c to skip on to volume II of this manual, the @dfn{Calc Reference}.
1673
1674@c [fix-ref Embedded Mode]
1675This tutorial describes the standard user interface of Calc only.
07ce2eb3 1676The Quick mode and Keypad mode interfaces are fairly
d7b8e6c6 1677self-explanatory. @xref{Embedded Mode}, for a description of
07ce2eb3 1678the Embedded mode interface.
d7b8e6c6
EZ
1679
1680@ifinfo
1681The easiest way to read this tutorial on-line is to have two windows on
1682your Emacs screen, one with Calc and one with the Info system. (If you
1683have a printed copy of the manual you can use that instead.) Press
1684@kbd{M-# c} to turn Calc on or to switch into the Calc window, and
1685press @kbd{M-# i} to start the Info system or to switch into its window.
1686Or, you may prefer to use the tutorial in printed form.
1687@end ifinfo
1688@iftex
1689The easiest way to read this tutorial on-line is to have two windows on
1690your Emacs screen, one with Calc and one with the Info system. (If you
1691have a printed copy of the manual you can use that instead.) Press
1692@kbd{M-# c} to turn Calc on or to switch into the Calc window, and
1693press @kbd{M-# i} to start the Info system or to switch into its window.
1694@end iftex
1695
1696This tutorial is designed to be done in sequence. But the rest of this
1697manual does not assume you have gone through the tutorial. The tutorial
1698does not cover everything in the Calculator, but it touches on most
1699general areas.
1700
1701@ifinfo
1702You may wish to print out a copy of the Calc Summary and keep notes on
029b2a44
JB
1703it as you learn Calc. @xref{About This Manual}, to see how to make a
1704printed summary. @xref{Summary}.
d7b8e6c6
EZ
1705@end ifinfo
1706@iftex
1707The Calc Summary at the end of the reference manual includes some blank
1708space for your own use. You may wish to keep notes there as you learn
1709Calc.
1710@end iftex
1711
1712@menu
1713* Basic Tutorial::
1714* Arithmetic Tutorial::
1715* Vector/Matrix Tutorial::
1716* Types Tutorial::
1717* Algebra Tutorial::
1718* Programming Tutorial::
1719
1720* Answers to Exercises::
1721@end menu
1722
1723@node Basic Tutorial, Arithmetic Tutorial, Tutorial, Tutorial
1724@section Basic Tutorial
1725
1726@noindent
1727In this section, we learn how RPN and algebraic-style calculations
1728work, how to undo and redo an operation done by mistake, and how
1729to control various modes of the Calculator.
1730
1731@menu
1732* RPN Tutorial:: Basic operations with the stack.
1733* Algebraic Tutorial:: Algebraic entry; variables.
1734* Undo Tutorial:: If you make a mistake: Undo and the trail.
1735* Modes Tutorial:: Common mode-setting commands.
1736@end menu
1737
1738@node RPN Tutorial, Algebraic Tutorial, Basic Tutorial, Basic Tutorial
1739@subsection RPN Calculations and the Stack
1740
1741@cindex RPN notation
1742@ifinfo
1743@noindent
1744Calc normally uses RPN notation. You may be familiar with the RPN
1745system from Hewlett-Packard calculators, FORTH, or PostScript.
1746(Reverse Polish Notation, RPN, is named after the Polish mathematician
1747Jan Lukasiewicz.)
1748@end ifinfo
1749@tex
1750\noindent
1751Calc normally uses RPN notation. You may be familiar with the RPN
1752system from Hewlett-Packard calculators, FORTH, or PostScript.
1753(Reverse Polish Notation, RPN, is named after the Polish mathematician
1754Jan \L ukasiewicz.)
1755@end tex
1756
1757The central component of an RPN calculator is the @dfn{stack}. A
1758calculator stack is like a stack of dishes. New dishes (numbers) are
1759added at the top of the stack, and numbers are normally only removed
1760from the top of the stack.
1761
1762@cindex Operators
1763@cindex Operands
a4231b04
JB
1764In an operation like @expr{2+3}, the 2 and 3 are called the @dfn{operands}
1765and the @expr{+} is the @dfn{operator}. In an RPN calculator you always
d7b8e6c6
EZ
1766enter the operands first, then the operator. Each time you type a
1767number, Calc adds or @dfn{pushes} it onto the top of the Stack.
1768When you press an operator key like @kbd{+}, Calc @dfn{pops} the appropriate
1769number of operands from the stack and pushes back the result.
1770
1771Thus we could add the numbers 2 and 3 in an RPN calculator by typing:
1772@kbd{2 @key{RET} 3 @key{RET} +}. (The @key{RET} key, Return, corresponds to
1773the @key{ENTER} key on traditional RPN calculators.) Try this now if
1774you wish; type @kbd{M-# c} to switch into the Calc window (you can type
1775@kbd{M-# c} again or @kbd{M-# o} to switch back to the Tutorial window).
1776The first four keystrokes ``push'' the numbers 2 and 3 onto the stack.
1777The @kbd{+} key ``pops'' the top two numbers from the stack, adds them,
1778and pushes the result (5) back onto the stack. Here's how the stack
a4231b04 1779will look at various points throughout the calculation:
d7b8e6c6 1780
d7b8e6c6 1781@smallexample
5d67986c 1782@group
d7b8e6c6
EZ
1783 . 1: 2 2: 2 1: 5 .
1784 . 1: 3 .
1785 .
1786
5d67986c 1787 M-# c 2 @key{RET} 3 @key{RET} + @key{DEL}
d7b8e6c6 1788@end group
5d67986c 1789@end smallexample
d7b8e6c6
EZ
1790
1791The @samp{.} symbol is a marker that represents the top of the stack.
1792Note that the ``top'' of the stack is really shown at the bottom of
1793the Stack window. This may seem backwards, but it turns out to be
1794less distracting in regular use.
1795
1796@cindex Stack levels
1797@cindex Levels of stack
1798The numbers @samp{1:} and @samp{2:} on the left are @dfn{stack level
1799numbers}. Old RPN calculators always had four stack levels called
a4231b04 1800@expr{x}, @expr{y}, @expr{z}, and @expr{t}. Calc's stack can grow
d7b8e6c6
EZ
1801as large as you like, so it uses numbers instead of letters. Some
1802stack-manipulation commands accept a numeric argument that says
1803which stack level to work on. Normal commands like @kbd{+} always
a4231b04 1804work on the top few levels of the stack.
d7b8e6c6
EZ
1805
1806@c [fix-ref Truncating the Stack]
1807The Stack buffer is just an Emacs buffer, and you can move around in
1808it using the regular Emacs motion commands. But no matter where the
1809cursor is, even if you have scrolled the @samp{.} marker out of
1810view, most Calc commands always move the cursor back down to level 1
1811before doing anything. It is possible to move the @samp{.} marker
1812upwards through the stack, temporarily ``hiding'' some numbers from
1813commands like @kbd{+}. This is called @dfn{stack truncation} and
1814we will not cover it in this tutorial; @pxref{Truncating the Stack},
1815if you are interested.
1816
1817You don't really need the second @key{RET} in @kbd{2 @key{RET} 3
1818@key{RET} +}. That's because if you type any operator name or
1819other non-numeric key when you are entering a number, the Calculator
1820automatically enters that number and then does the requested command.
a4231b04 1821Thus @kbd{2 @key{RET} 3 +} will work just as well.
d7b8e6c6
EZ
1822
1823Examples in this tutorial will often omit @key{RET} even when the
1824stack displays shown would only happen if you did press @key{RET}:
1825
d7b8e6c6 1826@smallexample
5d67986c 1827@group
d7b8e6c6
EZ
18281: 2 2: 2 1: 5
1829 . 1: 3 .
1830 .
1831
5d67986c 1832 2 @key{RET} 3 +
d7b8e6c6 1833@end group
5d67986c 1834@end smallexample
d7b8e6c6
EZ
1835
1836@noindent
1837Here, after pressing @kbd{3} the stack would really show @samp{1: 2}
1838with @samp{Calc:@: 3} in the minibuffer. In these situations, you can
1839press the optional @key{RET} to see the stack as the figure shows.
1840
1841(@bullet{}) @strong{Exercise 1.} (This tutorial will include exercises
1842at various points. Try them if you wish. Answers to all the exercises
1843are located at the end of the Tutorial chapter. Each exercise will
1844include a cross-reference to its particular answer. If you are
1845reading with the Emacs Info system, press @kbd{f} and the
1846exercise number to go to the answer, then the letter @kbd{l} to
1847return to where you were.)
1848
1849@noindent
1850Here's the first exercise: What will the keystrokes @kbd{1 @key{RET} 2
1851@key{RET} 3 @key{RET} 4 + * -} compute? (@samp{*} is the symbol for
1852multiplication.) Figure it out by hand, then try it with Calc to see
1853if you're right. @xref{RPN Answer 1, 1}. (@bullet{})
1854
a4231b04 1855(@bullet{}) @strong{Exercise 2.} Compute
8e04863e 1856@texline @math{(2\times4) + (7\times9.4) + {5\over4}}
a4231b04
JB
1857@infoline @expr{2*4 + 7*9.5 + 5/4}
1858using the stack. @xref{RPN Answer 2, 2}. (@bullet{})
d7b8e6c6
EZ
1859
1860The @key{DEL} key is called Backspace on some keyboards. It is
1861whatever key you would use to correct a simple typing error when
1862regularly using Emacs. The @key{DEL} key pops and throws away the
1863top value on the stack. (You can still get that value back from
1864the Trail if you should need it later on.) There are many places
1865in this tutorial where we assume you have used @key{DEL} to erase the
1866results of the previous example at the beginning of a new example.
1867In the few places where it is really important to use @key{DEL} to
1868clear away old results, the text will remind you to do so.
1869
1870(It won't hurt to let things accumulate on the stack, except that
1871whenever you give a display-mode-changing command Calc will have to
1872spend a long time reformatting such a large stack.)
1873
1874Since the @kbd{-} key is also an operator (it subtracts the top two
1875stack elements), how does one enter a negative number? Calc uses
1876the @kbd{_} (underscore) key to act like the minus sign in a number.
1877So, typing @kbd{-5 @key{RET}} won't work because the @kbd{-} key
1878will try to do a subtraction, but @kbd{_5 @key{RET}} works just fine.
1879
1880You can also press @kbd{n}, which means ``change sign.'' It changes
1881the number at the top of the stack (or the number being entered)
1882from positive to negative or vice-versa: @kbd{5 n @key{RET}}.
1883
1884@cindex Duplicating a stack entry
1885If you press @key{RET} when you're not entering a number, the effect
1886is to duplicate the top number on the stack. Consider this calculation:
1887
d7b8e6c6 1888@smallexample
5d67986c 1889@group
d7b8e6c6
EZ
18901: 3 2: 3 1: 9 2: 9 1: 81
1891 . 1: 3 . 1: 9 .
1892 . .
1893
5d67986c 1894 3 @key{RET} @key{RET} * @key{RET} *
d7b8e6c6 1895@end group
5d67986c 1896@end smallexample
d7b8e6c6
EZ
1897
1898@noindent
1899(Of course, an easier way to do this would be @kbd{3 @key{RET} 4 ^},
1900to raise 3 to the fourth power.)
1901
1902The space-bar key (denoted @key{SPC} here) performs the same function
1903as @key{RET}; you could replace all three occurrences of @key{RET} in
1904the above example with @key{SPC} and the effect would be the same.
1905
1906@cindex Exchanging stack entries
1907Another stack manipulation key is @key{TAB}. This exchanges the top
1908two stack entries. Suppose you have computed @kbd{2 @key{RET} 3 +}
1909to get 5, and then you realize what you really wanted to compute
a4231b04 1910was @expr{20 / (2+3)}.
d7b8e6c6 1911
d7b8e6c6 1912@smallexample
5d67986c 1913@group
d7b8e6c6
EZ
19141: 5 2: 5 2: 20 1: 4
1915 . 1: 20 1: 5 .
1916 . .
1917
5d67986c 1918 2 @key{RET} 3 + 20 @key{TAB} /
d7b8e6c6 1919@end group
5d67986c 1920@end smallexample
d7b8e6c6
EZ
1921
1922@noindent
1923Planning ahead, the calculation would have gone like this:
1924
d7b8e6c6 1925@smallexample
5d67986c 1926@group
d7b8e6c6
EZ
19271: 20 2: 20 3: 20 2: 20 1: 4
1928 . 1: 2 2: 2 1: 5 .
1929 . 1: 3 .
1930 .
1931
5d67986c 1932 20 @key{RET} 2 @key{RET} 3 + /
d7b8e6c6 1933@end group
5d67986c 1934@end smallexample
d7b8e6c6
EZ
1935
1936A related stack command is @kbd{M-@key{TAB}} (hold @key{META} and type
1937@key{TAB}). It rotates the top three elements of the stack upward,
1938bringing the object in level 3 to the top.
1939
d7b8e6c6 1940@smallexample
5d67986c 1941@group
d7b8e6c6
EZ
19421: 10 2: 10 3: 10 3: 20 3: 30
1943 . 1: 20 2: 20 2: 30 2: 10
1944 . 1: 30 1: 10 1: 20
1945 . . .
1946
5d67986c 1947 10 @key{RET} 20 @key{RET} 30 @key{RET} M-@key{TAB} M-@key{TAB}
d7b8e6c6 1948@end group
5d67986c 1949@end smallexample
d7b8e6c6
EZ
1950
1951(@bullet{}) @strong{Exercise 3.} Suppose the numbers 10, 20, and 30 are
1952on the stack. Figure out how to add one to the number in level 2
1953without affecting the rest of the stack. Also figure out how to add
1954one to the number in level 3. @xref{RPN Answer 3, 3}. (@bullet{})
1955
1956Operations like @kbd{+}, @kbd{-}, @kbd{*}, @kbd{/}, and @kbd{^} pop two
1957arguments from the stack and push a result. Operations like @kbd{n} and
1958@kbd{Q} (square root) pop a single number and push the result. You can
1959think of them as simply operating on the top element of the stack.
1960
d7b8e6c6 1961@smallexample
5d67986c 1962@group
d7b8e6c6
EZ
19631: 3 1: 9 2: 9 1: 25 1: 5
1964 . . 1: 16 . .
1965 .
1966
5d67986c 1967 3 @key{RET} @key{RET} * 4 @key{RET} @key{RET} * + Q
d7b8e6c6 1968@end group
5d67986c 1969@end smallexample
d7b8e6c6
EZ
1970
1971@noindent
1972(Note that capital @kbd{Q} means to hold down the Shift key while
1973typing @kbd{q}. Remember, plain unshifted @kbd{q} is the Quit command.)
1974
1975@cindex Pythagorean Theorem
1976Here we've used the Pythagorean Theorem to determine the hypotenuse of a
1977right triangle. Calc actually has a built-in command for that called
1978@kbd{f h}, but let's suppose we can't remember the necessary keystrokes.
1979We can still enter it by its full name using @kbd{M-x} notation:
1980
d7b8e6c6 1981@smallexample
5d67986c 1982@group
d7b8e6c6
EZ
19831: 3 2: 3 1: 5
1984 . 1: 4 .
1985 .
1986
5d67986c 1987 3 @key{RET} 4 @key{RET} M-x calc-hypot
d7b8e6c6 1988@end group
5d67986c 1989@end smallexample
d7b8e6c6
EZ
1990
1991All Calculator commands begin with the word @samp{calc-}. Since it
1992gets tiring to type this, Calc provides an @kbd{x} key which is just
1993like the regular Emacs @kbd{M-x} key except that it types the @samp{calc-}
1994prefix for you:
1995
d7b8e6c6 1996@smallexample
5d67986c 1997@group
d7b8e6c6
EZ
19981: 3 2: 3 1: 5
1999 . 1: 4 .
2000 .
2001
5d67986c 2002 3 @key{RET} 4 @key{RET} x hypot
d7b8e6c6 2003@end group
5d67986c 2004@end smallexample
d7b8e6c6
EZ
2005
2006What happens if you take the square root of a negative number?
2007
d7b8e6c6 2008@smallexample
5d67986c 2009@group
d7b8e6c6
EZ
20101: 4 1: -4 1: (0, 2)
2011 . . .
2012
5d67986c 2013 4 @key{RET} n Q
d7b8e6c6 2014@end group
5d67986c 2015@end smallexample
d7b8e6c6
EZ
2016
2017@noindent
a4231b04
JB
2018The notation @expr{(a, b)} represents a complex number.
2019Complex numbers are more traditionally written @expr{a + b i};
d7b8e6c6 2020Calc can display in this format, too, but for now we'll stick to the
a4231b04 2021@expr{(a, b)} notation.
d7b8e6c6
EZ
2022
2023If you don't know how complex numbers work, you can safely ignore this
2024feature. Complex numbers only arise from operations that would be
2025errors in a calculator that didn't have complex numbers. (For example,
2026taking the square root or logarithm of a negative number produces a
2027complex result.)
2028
2029Complex numbers are entered in the notation shown. The @kbd{(} and
2030@kbd{,} and @kbd{)} keys manipulate ``incomplete complex numbers.''
2031
d7b8e6c6 2032@smallexample
5d67986c 2033@group
d7b8e6c6
EZ
20341: ( ... 2: ( ... 1: (2, ... 1: (2, ... 1: (2, 3)
2035 . 1: 2 . 3 .
2036 . .
2037
2038 ( 2 , 3 )
d7b8e6c6 2039@end group
5d67986c 2040@end smallexample
d7b8e6c6
EZ
2041
2042You can perform calculations while entering parts of incomplete objects.
2043However, an incomplete object cannot actually participate in a calculation:
2044
d7b8e6c6 2045@smallexample
5d67986c 2046@group
d7b8e6c6
EZ
20471: ( ... 2: ( ... 3: ( ... 1: ( ... 1: ( ...
2048 . 1: 2 2: 2 5 5
2049 . 1: 3 . .
2050 .
2051 (error)
5d67986c 2052 ( 2 @key{RET} 3 + +
d7b8e6c6 2053@end group
5d67986c 2054@end smallexample
d7b8e6c6
EZ
2055
2056@noindent
2057Adding 5 to an incomplete object makes no sense, so the last command
2058produces an error message and leaves the stack the same.
2059
2060Incomplete objects can't participate in arithmetic, but they can be
2061moved around by the regular stack commands.
2062
d7b8e6c6 2063@smallexample
5d67986c 2064@group
d7b8e6c6
EZ
20652: 2 3: 2 3: 3 1: ( ... 1: (2, 3)
20661: 3 2: 3 2: ( ... 2 .
2067 . 1: ( ... 1: 2 3
2068 . . .
2069
5d67986c 20702 @key{RET} 3 @key{RET} ( M-@key{TAB} M-@key{TAB} )
d7b8e6c6 2071@end group
5d67986c 2072@end smallexample
d7b8e6c6
EZ
2073
2074@noindent
2075Note that the @kbd{,} (comma) key did not have to be used here.
2076When you press @kbd{)} all the stack entries between the incomplete
2077entry and the top are collected, so there's never really a reason
2078to use the comma. It's up to you.
2079
a4231b04 2080(@bullet{}) @strong{Exercise 4.} To enter the complex number @expr{(2, 3)},
d7b8e6c6
EZ
2081your friend Joe typed @kbd{( 2 , @key{SPC} 3 )}. What happened?
2082(Joe thought of a clever way to correct his mistake in only two
2083keystrokes, but it didn't quite work. Try it to find out why.)
2084@xref{RPN Answer 4, 4}. (@bullet{})
2085
2086Vectors are entered the same way as complex numbers, but with square
2087brackets in place of parentheses. We'll meet vectors again later in
2088the tutorial.
2089
2090Any Emacs command can be given a @dfn{numeric prefix argument} by
2091typing a series of @key{META}-digits beforehand. If @key{META} is
2092awkward for you, you can instead type @kbd{C-u} followed by the
2093necessary digits. Numeric prefix arguments can be negative, as in
2094@kbd{M-- M-3 M-5} or @w{@kbd{C-u - 3 5}}. Calc commands use numeric
2095prefix arguments in a variety of ways. For example, a numeric prefix
2096on the @kbd{+} operator adds any number of stack entries at once:
2097
d7b8e6c6 2098@smallexample
5d67986c 2099@group
d7b8e6c6
EZ
21001: 10 2: 10 3: 10 3: 10 1: 60
2101 . 1: 20 2: 20 2: 20 .
2102 . 1: 30 1: 30
2103 . .
2104
5d67986c 2105 10 @key{RET} 20 @key{RET} 30 @key{RET} C-u 3 +
d7b8e6c6 2106@end group
5d67986c 2107@end smallexample
d7b8e6c6
EZ
2108
2109For stack manipulation commands like @key{RET}, a positive numeric
2110prefix argument operates on the top @var{n} stack entries at once. A
2111negative argument operates on the entry in level @var{n} only. An
2112argument of zero operates on the entire stack. In this example, we copy
2113the second-to-top element of the stack:
2114
d7b8e6c6 2115@smallexample
5d67986c 2116@group
d7b8e6c6
EZ
21171: 10 2: 10 3: 10 3: 10 4: 10
2118 . 1: 20 2: 20 2: 20 3: 20
2119 . 1: 30 1: 30 2: 30
2120 . . 1: 20
2121 .
2122
5d67986c 2123 10 @key{RET} 20 @key{RET} 30 @key{RET} C-u -2 @key{RET}
d7b8e6c6 2124@end group
5d67986c 2125@end smallexample
d7b8e6c6
EZ
2126
2127@cindex Clearing the stack
2128@cindex Emptying the stack
5d67986c 2129Another common idiom is @kbd{M-0 @key{DEL}}, which clears the stack.
d7b8e6c6
EZ
2130(The @kbd{M-0} numeric prefix tells @key{DEL} to operate on the
2131entire stack.)
2132
2133@node Algebraic Tutorial, Undo Tutorial, RPN Tutorial, Basic Tutorial
2134@subsection Algebraic-Style Calculations
2135
2136@noindent
2137If you are not used to RPN notation, you may prefer to operate the
07ce2eb3
JB
2138Calculator in Algebraic mode, which is closer to the way
2139non-RPN calculators work. In Algebraic mode, you enter formulas
a4231b04 2140in traditional @expr{2+3} notation.
d7b8e6c6
EZ
2141
2142You don't really need any special ``mode'' to enter algebraic formulas.
2143You can enter a formula at any time by pressing the apostrophe (@kbd{'})
2144key. Answer the prompt with the desired formula, then press @key{RET}.
2145The formula is evaluated and the result is pushed onto the RPN stack.
2146If you don't want to think in RPN at all, you can enter your whole
2147computation as a formula, read the result from the stack, then press
2148@key{DEL} to delete it from the stack.
2149
2150Try pressing the apostrophe key, then @kbd{2+3+4}, then @key{RET}.
2151The result should be the number 9.
2152
2153Algebraic formulas use the operators @samp{+}, @samp{-}, @samp{*},
2154@samp{/}, and @samp{^}. You can use parentheses to make the order
2155of evaluation clear. In the absence of parentheses, @samp{^} is
2156evaluated first, then @samp{*}, then @samp{/}, then finally
2157@samp{+} and @samp{-}. For example, the expression
2158
2159@example
21602 + 3*4*5 / 6*7^8 - 9
2161@end example
2162
2163@noindent
2164is equivalent to
2165
2166@example
21672 + ((3*4*5) / (6*(7^8)) - 9
2168@end example
2169
2170@noindent
2171or, in large mathematical notation,
2172
2173@ifinfo
d7b8e6c6 2174@example
5d67986c 2175@group
d7b8e6c6
EZ
2176 3 * 4 * 5
21772 + --------- - 9
2178 8
2179 6 * 7
d7b8e6c6 2180@end group
5d67986c 2181@end example
d7b8e6c6
EZ
2182@end ifinfo
2183@tex
2184\turnoffactive
2185\beforedisplay
2186$$ 2 + { 3 \times 4 \times 5 \over 6 \times 7^8 } - 9 $$
2187\afterdisplay
2188@end tex
2189
2190@noindent
8e04863e 2191The result of this expression will be the number @mathit{-6.99999826533}.
d7b8e6c6
EZ
2192
2193Calc's order of evaluation is the same as for most computer languages,
2194except that @samp{*} binds more strongly than @samp{/}, as the above
2195example shows. As in normal mathematical notation, the @samp{*} symbol
2196can often be omitted: @samp{2 a} is the same as @samp{2*a}.
2197
2198Operators at the same level are evaluated from left to right, except
2199that @samp{^} is evaluated from right to left. Thus, @samp{2-3-4} is
8e04863e 2200equivalent to @samp{(2-3)-4} or @mathit{-5}, whereas @samp{2^3^4} is equivalent
d7b8e6c6
EZ
2201to @samp{2^(3^4)} (a very large integer; try it!).
2202
07ce2eb3
JB
2203If you tire of typing the apostrophe all the time, there is
2204Algebraic mode, where Calc automatically senses
d7b8e6c6
EZ
2205when you are about to type an algebraic expression. To enter this
2206mode, press the two letters @w{@kbd{m a}}. (An @samp{Alg} indicator
2207should appear in the Calc window's mode line.)
2208
2209Press @kbd{m a}, then @kbd{2+3+4} with no apostrophe, then @key{RET}.
2210
07ce2eb3 2211In Algebraic mode, when you press any key that would normally begin
d7b8e6c6
EZ
2212entering a number (such as a digit, a decimal point, or the @kbd{_}
2213key), or if you press @kbd{(} or @kbd{[}, Calc automatically begins
2214an algebraic entry.
2215
2216Functions which do not have operator symbols like @samp{+} and @samp{*}
2217must be entered in formulas using function-call notation. For example,
2218the function name corresponding to the square-root key @kbd{Q} is
2219@code{sqrt}. To compute a square root in a formula, you would use
2220the notation @samp{sqrt(@var{x})}.
2221
2222Press the apostrophe, then type @kbd{sqrt(5*2) - 3}. The result should
a4231b04 2223be @expr{0.16227766017}.
d7b8e6c6
EZ
2224
2225Note that if the formula begins with a function name, you need to use
07ce2eb3 2226the apostrophe even if you are in Algebraic mode. If you type @kbd{arcsin}
d7b8e6c6
EZ
2227out of the blue, the @kbd{a r} will be taken as an Algebraic Rewrite
2228command, and the @kbd{csin} will be taken as the name of the rewrite
2229rule to use!
2230
2231Some people prefer to enter complex numbers and vectors in algebraic
2232form because they find RPN entry with incomplete objects to be too
2233distracting, even though they otherwise use Calc as an RPN calculator.
2234
07ce2eb3 2235Still in Algebraic mode, type:
d7b8e6c6 2236
d7b8e6c6 2237@smallexample
5d67986c 2238@group
d7b8e6c6
EZ
22391: (2, 3) 2: (2, 3) 1: (8, -1) 2: (8, -1) 1: (9, -1)
2240 . 1: (1, -2) . 1: 1 .
2241 . .
2242
5d67986c 2243 (2,3) @key{RET} (1,-2) @key{RET} * 1 @key{RET} +
d7b8e6c6 2244@end group
5d67986c 2245@end smallexample
d7b8e6c6
EZ
2246
2247Algebraic mode allows us to enter complex numbers without pressing
2248an apostrophe first, but it also means we need to press @key{RET}
a4231b04 2249after every entry, even for a simple number like @expr{1}.
d7b8e6c6 2250
07ce2eb3
JB
2251(You can type @kbd{C-u m a} to enable a special Incomplete Algebraic
2252mode in which the @kbd{(} and @kbd{[} keys use algebraic entry even
d7b8e6c6 2253though regular numeric keys still use RPN numeric entry. There is also
07ce2eb3 2254Total Algebraic mode, started by typing @kbd{m t}, in which all
d7b8e6c6 2255normal keys begin algebraic entry. You must then use the @key{META} key
07ce2eb3 2256to type Calc commands: @kbd{M-m t} to get back out of Total Algebraic
bdfe3dc0 2257mode, @kbd{M-q} to quit, etc.)
d7b8e6c6 2258
07ce2eb3 2259If you're still in Algebraic mode, press @kbd{m a} again to turn it off.
d7b8e6c6
EZ
2260
2261Actual non-RPN calculators use a mixture of algebraic and RPN styles.
2262In general, operators of two numbers (like @kbd{+} and @kbd{*})
2263use algebraic form, but operators of one number (like @kbd{n} and @kbd{Q})
2264use RPN form. Also, a non-RPN calculator allows you to see the
2265intermediate results of a calculation as you go along. You can
2266accomplish this in Calc by performing your calculation as a series
2267of algebraic entries, using the @kbd{$} sign to tie them together.
2268In an algebraic formula, @kbd{$} represents the number on the top
a4231b04 2269of the stack. Here, we perform the calculation
8e04863e 2270@texline @math{\sqrt{2\times4+1}},
a4231b04 2271@infoline @expr{sqrt(2*4+1)},
d7b8e6c6
EZ
2272which on a traditional calculator would be done by pressing
2273@kbd{2 * 4 + 1 =} and then the square-root key.
2274
d7b8e6c6 2275@smallexample
5d67986c 2276@group
d7b8e6c6
EZ
22771: 8 1: 9 1: 3
2278 . . .
2279
5d67986c 2280 ' 2*4 @key{RET} $+1 @key{RET} Q
d7b8e6c6 2281@end group
5d67986c 2282@end smallexample
d7b8e6c6
EZ
2283
2284@noindent
2285Notice that we didn't need to press an apostrophe for the @kbd{$+1},
2286because the dollar sign always begins an algebraic entry.
2287
2288(@bullet{}) @strong{Exercise 1.} How could you get the same effect as
2289pressing @kbd{Q} but using an algebraic entry instead? How about
2290if the @kbd{Q} key on your keyboard were broken?
2291@xref{Algebraic Answer 1, 1}. (@bullet{})
2292
2293The notations @kbd{$$}, @kbd{$$$}, and so on stand for higher stack
5d67986c 2294entries. For example, @kbd{' $$+$ @key{RET}} is just like typing @kbd{+}.
d7b8e6c6
EZ
2295
2296Algebraic formulas can include @dfn{variables}. To store in a
2297variable, press @kbd{s s}, then type the variable name, then press
2298@key{RET}. (There are actually two flavors of store command:
2299@kbd{s s} stores a number in a variable but also leaves the number
2300on the stack, while @w{@kbd{s t}} removes a number from the stack and
2301stores it in the variable.) A variable name should consist of one
2302or more letters or digits, beginning with a letter.
2303
d7b8e6c6 2304@smallexample
5d67986c 2305@group
d7b8e6c6
EZ
23061: 17 . 1: a + a^2 1: 306
2307 . . .
2308
5d67986c 2309 17 s t a @key{RET} ' a+a^2 @key{RET} =
d7b8e6c6 2310@end group
5d67986c 2311@end smallexample
d7b8e6c6
EZ
2312
2313@noindent
2314The @kbd{=} key @dfn{evaluates} a formula by replacing all its
2315variables by the values that were stored in them.
2316
2317For RPN calculations, you can recall a variable's value on the
2318stack either by entering its name as a formula and pressing @kbd{=},
2319or by using the @kbd{s r} command.
2320
d7b8e6c6 2321@smallexample
5d67986c 2322@group
d7b8e6c6
EZ
23231: 17 2: 17 3: 17 2: 17 1: 306
2324 . 1: 17 2: 17 1: 289 .
2325 . 1: 2 .
2326 .
2327
5d67986c 2328 s r a @key{RET} ' a @key{RET} = 2 ^ +
d7b8e6c6 2329@end group
5d67986c 2330@end smallexample
d7b8e6c6
EZ
2331
2332If you press a single digit for a variable name (as in @kbd{s t 3}, you
2333get one of ten @dfn{quick variables} @code{q0} through @code{q9}.
2334They are ``quick'' simply because you don't have to type the letter
2335@code{q} or the @key{RET} after their names. In fact, you can type
2336simply @kbd{s 3} as a shorthand for @kbd{s s 3}, and likewise for
2337@kbd{t 3} and @w{@kbd{r 3}}.
2338
2339Any variables in an algebraic formula for which you have not stored
2340values are left alone, even when you evaluate the formula.
2341
d7b8e6c6 2342@smallexample
5d67986c 2343@group
d7b8e6c6
EZ
23441: 2 a + 2 b 1: 34 + 2 b
2345 . .
2346
5d67986c 2347 ' 2a+2b @key{RET} =
d7b8e6c6 2348@end group
5d67986c 2349@end smallexample
d7b8e6c6
EZ
2350
2351Calls to function names which are undefined in Calc are also left
2352alone, as are calls for which the value is undefined.
2353
d7b8e6c6 2354@smallexample
5d67986c 2355@group
d7b8e6c6
EZ
23561: 2 + log10(0) + log10(x) + log10(5, 6) + foo(3)
2357 .
2358
5d67986c 2359 ' log10(100) + log10(0) + log10(x) + log10(5,6) + foo(3) @key{RET}
d7b8e6c6 2360@end group
5d67986c 2361@end smallexample
d7b8e6c6
EZ
2362
2363@noindent
2364In this example, the first call to @code{log10} works, but the other
2365calls are not evaluated. In the second call, the logarithm is
2366undefined for that value of the argument; in the third, the argument
2367is symbolic, and in the fourth, there are too many arguments. In the
2368fifth case, there is no function called @code{foo}. You will see a
2369``Wrong number of arguments'' message referring to @samp{log10(5,6)}.
2370Press the @kbd{w} (``why'') key to see any other messages that may
2371have arisen from the last calculation. In this case you will get
2372``logarithm of zero,'' then ``number expected: @code{x}''. Calc
2373automatically displays the first message only if the message is
2374sufficiently important; for example, Calc considers ``wrong number
2375of arguments'' and ``logarithm of zero'' to be important enough to
2376report automatically, while a message like ``number expected: @code{x}''
2377will only show up if you explicitly press the @kbd{w} key.
2378
2379(@bullet{}) @strong{Exercise 2.} Joe entered the formula @samp{2 x y},
2380stored 5 in @code{x}, pressed @kbd{=}, and got the expected result,
2381@samp{10 y}. He then tried the same for the formula @samp{2 x (1+y)},
2382expecting @samp{10 (1+y)}, but it didn't work. Why not?
2383@xref{Algebraic Answer 2, 2}. (@bullet{})
2384
2385(@bullet{}) @strong{Exercise 3.} What result would you expect
2386@kbd{1 @key{RET} 0 /} to give? What if you then type @kbd{0 *}?
2387@xref{Algebraic Answer 3, 3}. (@bullet{})
2388
2389One interesting way to work with variables is to use the
2390@dfn{evaluates-to} (@samp{=>}) operator. It works like this:
2391Enter a formula algebraically in the usual way, but follow
2392the formula with an @samp{=>} symbol. (There is also an @kbd{s =}
2393command which builds an @samp{=>} formula using the stack.) On
2394the stack, you will see two copies of the formula with an @samp{=>}
2395between them. The lefthand formula is exactly like you typed it;
2396the righthand formula has been evaluated as if by typing @kbd{=}.
2397
d7b8e6c6 2398@smallexample
5d67986c 2399@group
d7b8e6c6
EZ
24002: 2 + 3 => 5 2: 2 + 3 => 5
24011: 2 a + 2 b => 34 + 2 b 1: 2 a + 2 b => 20 + 2 b
2402 . .
2403
5d67986c 2404' 2+3 => @key{RET} ' 2a+2b @key{RET} s = 10 s t a @key{RET}
d7b8e6c6 2405@end group
5d67986c 2406@end smallexample
d7b8e6c6
EZ
2407
2408@noindent
2409Notice that the instant we stored a new value in @code{a}, all
a4231b04 2410@samp{=>} operators already on the stack that referred to @expr{a}
d7b8e6c6
EZ
2411were updated to use the new value. With @samp{=>}, you can push a
2412set of formulas on the stack, then change the variables experimentally
2413to see the effects on the formulas' values.
2414
2415You can also ``unstore'' a variable when you are through with it:
2416
d7b8e6c6 2417@smallexample
5d67986c 2418@group
d7b8e6c6
EZ
24192: 2 + 5 => 5
24201: 2 a + 2 b => 2 a + 2 b
2421 .
2422
5d67986c 2423 s u a @key{RET}
d7b8e6c6 2424@end group
5d67986c 2425@end smallexample
d7b8e6c6
EZ
2426
2427We will encounter formulas involving variables and functions again
2428when we discuss the algebra and calculus features of the Calculator.
2429
2430@node Undo Tutorial, Modes Tutorial, Algebraic Tutorial, Basic Tutorial
2431@subsection Undo and Redo
2432
2433@noindent
2434If you make a mistake, you can usually correct it by pressing shift-@kbd{U},
5d67986c 2435the ``undo'' command. First, clear the stack (@kbd{M-0 @key{DEL}}) and exit
d7b8e6c6
EZ
2436and restart Calc (@kbd{M-# M-# M-# M-#}) to make sure things start off
2437with a clean slate. Now:
2438
d7b8e6c6 2439@smallexample
5d67986c 2440@group
d7b8e6c6
EZ
24411: 2 2: 2 1: 8 2: 2 1: 6
2442 . 1: 3 . 1: 3 .
2443 . .
2444
5d67986c 2445 2 @key{RET} 3 ^ U *
d7b8e6c6 2446@end group
5d67986c 2447@end smallexample
d7b8e6c6
EZ
2448
2449You can undo any number of times. Calc keeps a complete record of
2450all you have done since you last opened the Calc window. After the
2451above example, you could type:
2452
d7b8e6c6 2453@smallexample
5d67986c 2454@group
d7b8e6c6
EZ
24551: 6 2: 2 1: 2 . .
2456 . 1: 3 .
2457 .
2458 (error)
2459 U U U U
d7b8e6c6 2460@end group
5d67986c 2461@end smallexample
d7b8e6c6
EZ
2462
2463You can also type @kbd{D} to ``redo'' a command that you have undone
2464mistakenly.
2465
d7b8e6c6 2466@smallexample
5d67986c 2467@group
d7b8e6c6
EZ
2468 . 1: 2 2: 2 1: 6 1: 6
2469 . 1: 3 . .
2470 .
2471 (error)
2472 D D D D
d7b8e6c6 2473@end group
5d67986c 2474@end smallexample
d7b8e6c6
EZ
2475
2476@noindent
a4231b04 2477It was not possible to redo past the @expr{6}, since that was placed there
d7b8e6c6
EZ
2478by something other than an undo command.
2479
2480@cindex Time travel
2481You can think of undo and redo as a sort of ``time machine.'' Press
2482@kbd{U} to go backward in time, @kbd{D} to go forward. If you go
2483backward and do something (like @kbd{*}) then, as any science fiction
2484reader knows, you have changed your future and you cannot go forward
a4231b04 2485again. Thus, the inability to redo past the @expr{6} even though there
d7b8e6c6
EZ
2486was an earlier undo command.
2487
2488You can always recall an earlier result using the Trail. We've ignored
2489the trail so far, but it has been faithfully recording everything we
2490did since we loaded the Calculator. If the Trail is not displayed,
2491press @kbd{t d} now to turn it on.
2492
a4231b04 2493Let's try grabbing an earlier result. The @expr{8} we computed was
d7b8e6c6
EZ
2494undone by a @kbd{U} command, and was lost even to Redo when we pressed
2495@kbd{*}, but it's still there in the trail. There should be a little
2496@samp{>} arrow (the @dfn{trail pointer}) resting on the last trail
2497entry. If there isn't, press @kbd{t ]} to reset the trail pointer.
2498Now, press @w{@kbd{t p}} to move the arrow onto the line containing
a4231b04 2499@expr{8}, and press @w{@kbd{t y}} to ``yank'' that number back onto the
d7b8e6c6
EZ
2500stack.
2501
2502If you press @kbd{t ]} again, you will see that even our Yank command
2503went into the trail.
2504
2505Let's go further back in time. Earlier in the tutorial we computed
2506a huge integer using the formula @samp{2^3^4}. We don't remember
2507what it was, but the first digits were ``241''. Press @kbd{t r}
2508(which stands for trail-search-reverse), then type @kbd{241}.
2509The trail cursor will jump back to the next previous occurrence of
2510the string ``241'' in the trail. This is just a regular Emacs
2511incremental search; you can now press @kbd{C-s} or @kbd{C-r} to
2512continue the search forwards or backwards as you like.
2513
2514To finish the search, press @key{RET}. This halts the incremental
2515search and leaves the trail pointer at the thing we found. Now we
2516can type @kbd{t y} to yank that number onto the stack. If we hadn't
2517remembered the ``241'', we could simply have searched for @kbd{2^3^4},
2518then pressed @kbd{@key{RET} t n} to halt and then move to the next item.
2519
2520You may have noticed that all the trail-related commands begin with
2521the letter @kbd{t}. (The store-and-recall commands, on the other hand,
2522all began with @kbd{s}.) Calc has so many commands that there aren't
2523enough keys for all of them, so various commands are grouped into
2524two-letter sequences where the first letter is called the @dfn{prefix}
2525key. If you type a prefix key by accident, you can press @kbd{C-g}
2526to cancel it. (In fact, you can press @kbd{C-g} to cancel almost
2527anything in Emacs.) To get help on a prefix key, press that key
2528followed by @kbd{?}. Some prefixes have several lines of help,
a4338f51
JB
2529so you need to press @kbd{?} repeatedly to see them all.
2530You can also type @kbd{h h} to see all the help at once.
d7b8e6c6
EZ
2531
2532Try pressing @kbd{t ?} now. You will see a line of the form,
2533
2534@smallexample
2535trail/time: Display; Fwd, Back; Next, Prev, Here, [, ]; Yank: [MORE] t-
2536@end smallexample
2537
2538@noindent
2539The word ``trail'' indicates that the @kbd{t} prefix key contains
2540trail-related commands. Each entry on the line shows one command,
2541with a single capital letter showing which letter you press to get
2542that command. We have used @kbd{t n}, @kbd{t p}, @kbd{t ]}, and
2543@kbd{t y} so far. The @samp{[MORE]} means you can press @kbd{?}
28665d46 2544again to see more @kbd{t}-prefix commands. Notice that the commands
d7b8e6c6
EZ
2545are roughly divided (by semicolons) into related groups.
2546
2547When you are in the help display for a prefix key, the prefix is
2548still active. If you press another key, like @kbd{y} for example,
2549it will be interpreted as a @kbd{t y} command. If all you wanted
2550was to look at the help messages, press @kbd{C-g} afterwards to cancel
2551the prefix.
2552
2553One more way to correct an error is by editing the stack entries.
2554The actual Stack buffer is marked read-only and must not be edited
2555directly, but you can press @kbd{`} (the backquote or accent grave)
2556to edit a stack entry.
2557
2558Try entering @samp{3.141439} now. If this is supposed to represent
a4231b04 2559@cpi{}, it's got several errors. Press @kbd{`} to edit this number.
d7b8e6c6
EZ
2560Now use the normal Emacs cursor motion and editing keys to change
2561the second 4 to a 5, and to transpose the 3 and the 9. When you
2562press @key{RET}, the number on the stack will be replaced by your
2563new number. This works for formulas, vectors, and all other types
2564of values you can put on the stack. The @kbd{`} key also works
2565during entry of a number or algebraic formula.
2566
2567@node Modes Tutorial, , Undo Tutorial, Basic Tutorial
2568@subsection Mode-Setting Commands
2569
2570@noindent
2571Calc has many types of @dfn{modes} that affect the way it interprets
2572your commands or the way it displays data. We have already seen one
07ce2eb3 2573mode, namely Algebraic mode. There are many others, too; we'll
d7b8e6c6
EZ
2574try some of the most common ones here.
2575
2576Perhaps the most fundamental mode in Calc is the current @dfn{precision}.
2577Notice the @samp{12} on the Calc window's mode line:
2578
2579@smallexample
2580--%%-Calc: 12 Deg (Calculator)----All------
2581@end smallexample
2582
2583@noindent
2584Most of the symbols there are Emacs things you don't need to worry
2585about, but the @samp{12} and the @samp{Deg} are mode indicators.
2586The @samp{12} means that calculations should always be carried to
258712 significant figures. That is why, when we type @kbd{1 @key{RET} 7 /},
a4231b04 2588we get @expr{0.142857142857} with exactly 12 digits, not counting
d7b8e6c6
EZ
2589leading and trailing zeros.
2590
2591You can set the precision to anything you like by pressing @kbd{p},
2592then entering a suitable number. Try pressing @kbd{p 30 @key{RET}},
2593then doing @kbd{1 @key{RET} 7 /} again:
2594
d7b8e6c6 2595@smallexample
5d67986c 2596@group
d7b8e6c6
EZ
25971: 0.142857142857
25982: 0.142857142857142857142857142857
2599 .
d7b8e6c6 2600@end group
5d67986c 2601@end smallexample
d7b8e6c6
EZ
2602
2603Although the precision can be set arbitrarily high, Calc always
2604has to have @emph{some} value for the current precision. After
a4231b04 2605all, the true value @expr{1/7} is an infinitely repeating decimal;
d7b8e6c6
EZ
2606Calc has to stop somewhere.
2607
2608Of course, calculations are slower the more digits you request.
2609Press @w{@kbd{p 12}} now to set the precision back down to the default.
2610
2611Calculations always use the current precision. For example, even
a4231b04 2612though we have a 30-digit value for @expr{1/7} on the stack, if
d7b8e6c6
EZ
2613we use it in a calculation in 12-digit mode it will be rounded
2614down to 12 digits before it is used. Try it; press @key{RET} to
2615duplicate the number, then @w{@kbd{1 +}}. Notice that the @key{RET}
2616key didn't round the number, because it doesn't do any calculation.
2617But the instant we pressed @kbd{+}, the number was rounded down.
2618
d7b8e6c6 2619@smallexample
5d67986c 2620@group
d7b8e6c6
EZ
26211: 0.142857142857
26222: 0.142857142857142857142857142857
26233: 1.14285714286
2624 .
d7b8e6c6 2625@end group
5d67986c 2626@end smallexample
d7b8e6c6
EZ
2627
2628@noindent
2629In fact, since we added a digit on the left, we had to lose one
a4231b04 2630digit on the right from even the 12-digit value of @expr{1/7}.
d7b8e6c6
EZ
2631
2632How did we get more than 12 digits when we computed @samp{2^3^4}? The
2633answer is that Calc makes a distinction between @dfn{integers} and
2634@dfn{floating-point} numbers, or @dfn{floats}. An integer is a number
2635that does not contain a decimal point. There is no such thing as an
2636``infinitely repeating fraction integer,'' so Calc doesn't have to limit
2637itself. If you asked for @samp{2^10000} (don't try this!), you would
2638have to wait a long time but you would eventually get an exact answer.
2639If you ask for @samp{2.^10000}, you will quickly get an answer which is
2640correct only to 12 places. The decimal point tells Calc that it should
2641use floating-point arithmetic to get the answer, not exact integer
2642arithmetic.
2643
2644You can use the @kbd{F} (@code{calc-floor}) command to convert a
2645floating-point value to an integer, and @kbd{c f} (@code{calc-float})
2646to convert an integer to floating-point form.
2647
2648Let's try entering that last calculation:
2649
d7b8e6c6 2650@smallexample
5d67986c 2651@group
d7b8e6c6
EZ
26521: 2. 2: 2. 1: 1.99506311689e3010
2653 . 1: 10000 .
2654 .
2655
5d67986c 2656 2.0 @key{RET} 10000 @key{RET} ^
d7b8e6c6 2657@end group
5d67986c 2658@end smallexample
d7b8e6c6
EZ
2659
2660@noindent
2661@cindex Scientific notation, entry of
2662Notice the letter @samp{e} in there. It represents ``times ten to the
2663power of,'' and is used by Calc automatically whenever writing the
2664number out fully would introduce more extra zeros than you probably
2665want to see. You can enter numbers in this notation, too.
2666
d7b8e6c6 2667@smallexample
5d67986c 2668@group
d7b8e6c6
EZ
26691: 2. 2: 2. 1: 1.99506311678e3010
2670 . 1: 10000. .
2671 .
2672
5d67986c 2673 2.0 @key{RET} 1e4 @key{RET} ^
d7b8e6c6 2674@end group
5d67986c 2675@end smallexample
d7b8e6c6
EZ
2676
2677@cindex Round-off errors
2678@noindent
2679Hey, the answer is different! Look closely at the middle columns
2680of the two examples. In the first, the stack contained the
a4231b04 2681exact integer @expr{10000}, but in the second it contained
d7b8e6c6
EZ
2682a floating-point value with a decimal point. When you raise a
2683number to an integer power, Calc uses repeated squaring and
2684multiplication to get the answer. When you use a floating-point
2685power, Calc uses logarithms and exponentials. As you can see,
2686a slight error crept in during one of these methods. Which
2687one should we trust? Let's raise the precision a bit and find
2688out:
2689
d7b8e6c6 2690@smallexample
5d67986c 2691@group
d7b8e6c6
EZ
2692 . 1: 2. 2: 2. 1: 1.995063116880828e3010
2693 . 1: 10000. .
2694 .
2695
5d67986c 2696 p 16 @key{RET} 2. @key{RET} 1e4 ^ p 12 @key{RET}
d7b8e6c6 2697@end group
5d67986c 2698@end smallexample
d7b8e6c6
EZ
2699
2700@noindent
2701@cindex Guard digits
2702Presumably, it doesn't matter whether we do this higher-precision
2703calculation using an integer or floating-point power, since we
2704have added enough ``guard digits'' to trust the first 12 digits
2705no matter what. And the verdict is@dots{} Integer powers were more
2706accurate; in fact, the result was only off by one unit in the
2707last place.
2708
2709@cindex Guard digits
2710Calc does many of its internal calculations to a slightly higher
2711precision, but it doesn't always bump the precision up enough.
2712In each case, Calc added about two digits of precision during
2713its calculation and then rounded back down to 12 digits
269b7745 2714afterward. In one case, it was enough; in the other, it
d7b8e6c6
EZ
2715wasn't. If you really need @var{x} digits of precision, it
2716never hurts to do the calculation with a few extra guard digits.
2717
2718What if we want guard digits but don't want to look at them?
2719We can set the @dfn{float format}. Calc supports four major
2720formats for floating-point numbers, called @dfn{normal},
2721@dfn{fixed-point}, @dfn{scientific notation}, and @dfn{engineering
2722notation}. You get them by pressing @w{@kbd{d n}}, @kbd{d f},
2723@kbd{d s}, and @kbd{d e}, respectively. In each case, you can
2724supply a numeric prefix argument which says how many digits
2725should be displayed. As an example, let's put a few numbers
2726onto the stack and try some different display modes. First,
5d67986c 2727use @kbd{M-0 @key{DEL}} to clear the stack, then enter the four
d7b8e6c6
EZ
2728numbers shown here:
2729
d7b8e6c6 2730@smallexample
5d67986c 2731@group
d7b8e6c6
EZ
27324: 12345 4: 12345 4: 12345 4: 12345 4: 12345
27333: 12345. 3: 12300. 3: 1.2345e4 3: 1.23e4 3: 12345.000
27342: 123.45 2: 123. 2: 1.2345e2 2: 1.23e2 2: 123.450
27351: 12.345 1: 12.3 1: 1.2345e1 1: 1.23e1 1: 12.345
2736 . . . . .
2737
2738 d n M-3 d n d s M-3 d s M-3 d f
d7b8e6c6 2739@end group
5d67986c 2740@end smallexample
d7b8e6c6
EZ
2741
2742@noindent
2743Notice that when we typed @kbd{M-3 d n}, the numbers were rounded down
2744to three significant digits, but then when we typed @kbd{d s} all
2745five significant figures reappeared. The float format does not
2746affect how numbers are stored, it only affects how they are
2747displayed. Only the current precision governs the actual rounding
2748of numbers in the Calculator's memory.
2749
2750Engineering notation, not shown here, is like scientific notation
2751except the exponent (the power-of-ten part) is always adjusted to be
2752a multiple of three (as in ``kilo,'' ``micro,'' etc.). As a result
2753there will be one, two, or three digits before the decimal point.
2754
2755Whenever you change a display-related mode, Calc redraws everything
2756in the stack. This may be slow if there are many things on the stack,
2757so Calc allows you to type shift-@kbd{H} before any mode command to
2758prevent it from updating the stack. Anything Calc displays after the
2759mode-changing command will appear in the new format.
2760
d7b8e6c6 2761@smallexample
5d67986c 2762@group
d7b8e6c6
EZ
27634: 12345 4: 12345 4: 12345 4: 12345 4: 12345
27643: 12345.000 3: 12345.000 3: 12345.000 3: 1.2345e4 3: 12345.
27652: 123.450 2: 123.450 2: 1.2345e1 2: 1.2345e1 2: 123.45
27661: 12.345 1: 1.2345e1 1: 1.2345e2 1: 1.2345e2 1: 12.345
2767 . . . . .
2768
5d67986c 2769 H d s @key{DEL} U @key{TAB} d @key{SPC} d n
d7b8e6c6 2770@end group
5d67986c 2771@end smallexample
d7b8e6c6
EZ
2772
2773@noindent
2774Here the @kbd{H d s} command changes to scientific notation but without
2775updating the screen. Deleting the top stack entry and undoing it back
2776causes it to show up in the new format; swapping the top two stack
5d67986c 2777entries reformats both entries. The @kbd{d @key{SPC}} command refreshes the
d7b8e6c6
EZ
2778whole stack. The @kbd{d n} command changes back to the normal float
2779format; since it doesn't have an @kbd{H} prefix, it also updates all
2780the stack entries to be in @kbd{d n} format.
2781
a4231b04 2782Notice that the integer @expr{12345} was not affected by any
d7b8e6c6
EZ
2783of the float formats. Integers are integers, and are always
2784displayed exactly.
2785
2786@cindex Large numbers, readability
2787Large integers have their own problems. Let's look back at
2788the result of @kbd{2^3^4}.
2789
2790@example
27912417851639229258349412352
2792@end example
2793
2794@noindent
2795Quick---how many digits does this have? Try typing @kbd{d g}:
2796
2797@example
27982,417,851,639,229,258,349,412,352
2799@end example
2800
2801@noindent
2802Now how many digits does this have? It's much easier to tell!
2803We can actually group digits into clumps of any size. Some
2804people prefer @kbd{M-5 d g}:
2805
2806@example
280724178,51639,22925,83494,12352
2808@end example
2809
2810Let's see what happens to floating-point numbers when they are grouped.
2811First, type @kbd{p 25 @key{RET}} to make sure we have enough precision
2812to get ourselves into trouble. Now, type @kbd{1e13 /}:
2813
2814@example
281524,17851,63922.9258349412352
2816@end example
2817
2818@noindent
2819The integer part is grouped but the fractional part isn't. Now try
2820@kbd{M-- M-5 d g} (that's meta-minus-sign, meta-five):
2821
2822@example
282324,17851,63922.92583,49412,352
2824@end example
2825
2826If you find it hard to tell the decimal point from the commas, try
2827changing the grouping character to a space with @kbd{d , @key{SPC}}:
2828
2829@example
283024 17851 63922.92583 49412 352
2831@end example
2832
2833Type @kbd{d , ,} to restore the normal grouping character, then
2834@kbd{d g} again to turn grouping off. Also, press @kbd{p 12} to
2835restore the default precision.
2836
2837Press @kbd{U} enough times to get the original big integer back.
2838(Notice that @kbd{U} does not undo each mode-setting command; if
2839you want to undo a mode-setting command, you have to do it yourself.)
2840Now, type @kbd{d r 16 @key{RET}}:
2841
2842@example
284316#200000000000000000000
2844@end example
2845
2846@noindent
2847The number is now displayed in @dfn{hexadecimal}, or ``base-16'' form.
2848Suddenly it looks pretty simple; this should be no surprise, since we
2849got this number by computing a power of two, and 16 is a power of 2.
2850In fact, we can use @w{@kbd{d r 2 @key{RET}}} to see it in actual binary
2851form:
2852
2853@example
28542#1000000000000000000000000000000000000000000000000000000 @dots{}
2855@end example
2856
2857@noindent
2858We don't have enough space here to show all the zeros! They won't
2859fit on a typical screen, either, so you will have to use horizontal
2860scrolling to see them all. Press @kbd{<} and @kbd{>} to scroll the
2861stack window left and right by half its width. Another way to view
2862something large is to press @kbd{`} (back-quote) to edit the top of
33108698 2863stack in a separate window. (Press @kbd{C-c C-c} when you are done.)
d7b8e6c6
EZ
2864
2865You can enter non-decimal numbers using the @kbd{#} symbol, too.
2866Let's see what the hexadecimal number @samp{5FE} looks like in
2867binary. Type @kbd{16#5FE} (the letters can be typed in upper or
2868lower case; they will always appear in upper case). It will also
2869help to turn grouping on with @kbd{d g}:
2870
2871@example
28722#101,1111,1110
2873@end example
2874
2875Notice that @kbd{d g} groups by fours by default if the display radix
2876is binary or hexadecimal, but by threes if it is decimal, octal, or any
2877other radix.
2878
2879Now let's see that number in decimal; type @kbd{d r 10}:
2880
2881@example
28821,534
2883@end example
2884
2885Numbers are not @emph{stored} with any particular radix attached. They're
2886just numbers; they can be entered in any radix, and are always displayed
2887in whatever radix you've chosen with @kbd{d r}. The current radix applies
2888to integers, fractions, and floats.
2889
2890@cindex Roundoff errors, in non-decimal numbers
2891(@bullet{}) @strong{Exercise 1.} Your friend Joe tried to enter one-third
2892as @samp{3#0.1} in @kbd{d r 3} mode with a precision of 12. He got
2893@samp{3#0.0222222...} (with 25 2's) in the display. When he multiplied
2894that by three, he got @samp{3#0.222222...} instead of the expected
2895@samp{3#1}. Next, Joe entered @samp{3#0.2} and, to his great relief,
2896saw @samp{3#0.2} on the screen. But when he typed @kbd{2 /}, he got
2897@samp{3#0.10000001} (some zeros omitted). What's going on here?
2898@xref{Modes Answer 1, 1}. (@bullet{})
2899
2900@cindex Scientific notation, in non-decimal numbers
2901(@bullet{}) @strong{Exercise 2.} Scientific notation works in non-decimal
2902modes in the natural way (the exponent is a power of the radix instead of
2903a power of ten, although the exponent itself is always written in decimal).
2904Thus @samp{8#1.23e3 = 8#1230.0}. Suppose we have the hexadecimal number
2905@samp{f.e8f} times 16 to the 15th power: We write @samp{16#f.e8fe15}.
2906What is wrong with this picture? What could we write instead that would
2907work better? @xref{Modes Answer 2, 2}. (@bullet{})
2908
2909The @kbd{m} prefix key has another set of modes, relating to the way
2910Calc interprets your inputs and does computations. Whereas @kbd{d}-prefix
2911modes generally affect the way things look, @kbd{m}-prefix modes affect
2912the way they are actually computed.
2913
2914The most popular @kbd{m}-prefix mode is the @dfn{angular mode}. Notice
2915the @samp{Deg} indicator in the mode line. This means that if you use
2916a command that interprets a number as an angle, it will assume the
2917angle is measured in degrees. For example,
2918
d7b8e6c6 2919@smallexample
5d67986c 2920@group
d7b8e6c6
EZ
29211: 45 1: 0.707106781187 1: 0.500000000001 1: 0.5
2922 . . . .
2923
2924 45 S 2 ^ c 1
d7b8e6c6 2925@end group
5d67986c 2926@end smallexample
d7b8e6c6
EZ
2927
2928@noindent
2929The shift-@kbd{S} command computes the sine of an angle. The sine
a4231b04 2930of 45 degrees is
8e04863e 2931@texline @math{\sqrt{2}/2};
a4231b04
JB
2932@infoline @expr{sqrt(2)/2};
2933squaring this yields @expr{2/4 = 0.5}. However, there has been a slight
2934roundoff error because the representation of
8e04863e 2935@texline @math{\sqrt{2}/2}
a4231b04
JB
2936@infoline @expr{sqrt(2)/2}
2937wasn't exact. The @kbd{c 1} command is a handy way to clean up numbers
2938in this case; it temporarily reduces the precision by one digit while it
d7b8e6c6
EZ
2939re-rounds the number on the top of the stack.
2940
2941@cindex Roundoff errors, examples
2942(@bullet{}) @strong{Exercise 3.} Your friend Joe computed the sine
2943of 45 degrees as shown above, then, hoping to avoid an inexact
2944result, he increased the precision to 16 digits before squaring.
2945What happened? @xref{Modes Answer 3, 3}. (@bullet{})
2946
2947To do this calculation in radians, we would type @kbd{m r} first.
2948(The indicator changes to @samp{Rad}.) 45 degrees corresponds to
a4231b04 2949@cpiover{4} radians. To get @cpi{}, press the @kbd{P} key. (Once
d7b8e6c6
EZ
2950again, this is a shifted capital @kbd{P}. Remember, unshifted
2951@kbd{p} sets the precision.)
2952
d7b8e6c6 2953@smallexample
5d67986c 2954@group
d7b8e6c6
EZ
29551: 3.14159265359 1: 0.785398163398 1: 0.707106781187
2956 . . .
2957
2958 P 4 / m r S
d7b8e6c6 2959@end group
5d67986c 2960@end smallexample
d7b8e6c6
EZ
2961
2962Likewise, inverse trigonometric functions generate results in
2963either radians or degrees, depending on the current angular mode.
2964
d7b8e6c6 2965@smallexample
5d67986c 2966@group
d7b8e6c6
EZ
29671: 0.707106781187 1: 0.785398163398 1: 45.
2968 . . .
2969
2970 .5 Q m r I S m d U I S
d7b8e6c6 2971@end group
5d67986c 2972@end smallexample
d7b8e6c6
EZ
2973
2974@noindent
a4231b04 2975Here we compute the Inverse Sine of
8e04863e 2976@texline @math{\sqrt{0.5}},
a4231b04
JB
2977@infoline @expr{sqrt(0.5)},
2978first in radians, then in degrees.
d7b8e6c6
EZ
2979
2980Use @kbd{c d} and @kbd{c r} to convert a number from radians to degrees
2981and vice-versa.
2982
d7b8e6c6 2983@smallexample
5d67986c 2984@group
d7b8e6c6
EZ
29851: 45 1: 0.785398163397 1: 45.
2986 . . .
2987
2988 45 c r c d
d7b8e6c6 2989@end group
5d67986c 2990@end smallexample
d7b8e6c6 2991
07ce2eb3 2992Another interesting mode is @dfn{Fraction mode}. Normally,
d7b8e6c6
EZ
2993dividing two integers produces a floating-point result if the
2994quotient can't be expressed as an exact integer. Fraction mode
2995causes integer division to produce a fraction, i.e., a rational
2996number, instead.
2997
d7b8e6c6 2998@smallexample
5d67986c 2999@group
d7b8e6c6
EZ
30002: 12 1: 1.33333333333 1: 4:3
30011: 9 . .
3002 .
3003
5d67986c 3004 12 @key{RET} 9 / m f U / m f
d7b8e6c6 3005@end group
5d67986c 3006@end smallexample
d7b8e6c6
EZ
3007
3008@noindent
3009In the first case, we get an approximate floating-point result.
3010In the second case, we get an exact fractional result (four-thirds).
3011
3012You can enter a fraction at any time using @kbd{:} notation.
3013(Calc uses @kbd{:} instead of @kbd{/} as the fraction separator
3014because @kbd{/} is already used to divide the top two stack
3015elements.) Calculations involving fractions will always
07ce2eb3 3016produce exact fractional results; Fraction mode only says
d7b8e6c6
EZ
3017what to do when dividing two integers.
3018
3019@cindex Fractions vs. floats
3020@cindex Floats vs. fractions
3021(@bullet{}) @strong{Exercise 4.} If fractional arithmetic is exact,
3022why would you ever use floating-point numbers instead?
3023@xref{Modes Answer 4, 4}. (@bullet{})
3024
3025Typing @kbd{m f} doesn't change any existing values in the stack.
3026In the above example, we had to Undo the division and do it over
07ce2eb3 3027again when we changed to Fraction mode. But if you use the
d7b8e6c6
EZ
3028evaluates-to operator you can get commands like @kbd{m f} to
3029recompute for you.
3030
d7b8e6c6 3031@smallexample
5d67986c 3032@group
d7b8e6c6
EZ
30331: 12 / 9 => 1.33333333333 1: 12 / 9 => 1.333 1: 12 / 9 => 4:3
3034 . . .
3035
5d67986c 3036 ' 12/9 => @key{RET} p 4 @key{RET} m f
d7b8e6c6 3037@end group
5d67986c 3038@end smallexample
d7b8e6c6
EZ
3039
3040@noindent
3041In this example, the righthand side of the @samp{=>} operator
3042on the stack is recomputed when we change the precision, then
07ce2eb3 3043again when we change to Fraction mode. All @samp{=>} expressions
d7b8e6c6
EZ
3044on the stack are recomputed every time you change any mode that
3045might affect their values.
3046
3047@node Arithmetic Tutorial, Vector/Matrix Tutorial, Basic Tutorial, Tutorial
3048@section Arithmetic Tutorial
3049
3050@noindent
3051In this section, we explore the arithmetic and scientific functions
3052available in the Calculator.
3053
3054The standard arithmetic commands are @kbd{+}, @kbd{-}, @kbd{*}, @kbd{/},
3055and @kbd{^}. Each normally takes two numbers from the top of the stack
3056and pushes back a result. The @kbd{n} and @kbd{&} keys perform
3057change-sign and reciprocal operations, respectively.
3058
d7b8e6c6 3059@smallexample
5d67986c 3060@group
d7b8e6c6
EZ
30611: 5 1: 0.2 1: 5. 1: -5. 1: 5.
3062 . . . . .
3063
3064 5 & & n n
d7b8e6c6 3065@end group
5d67986c 3066@end smallexample
d7b8e6c6
EZ
3067
3068@cindex Binary operators
3069You can apply a ``binary operator'' like @kbd{+} across any number of
3070stack entries by giving it a numeric prefix. You can also apply it
3071pairwise to several stack elements along with the top one if you use
3072a negative prefix.
3073
d7b8e6c6 3074@smallexample
5d67986c 3075@group
d7b8e6c6
EZ
30763: 2 1: 9 3: 2 4: 2 3: 12
30772: 3 . 2: 3 3: 3 2: 13
30781: 4 1: 4 2: 4 1: 14
3079 . . 1: 10 .
3080 .
3081
5d67986c 30822 @key{RET} 3 @key{RET} 4 M-3 + U 10 M-- M-3 +
d7b8e6c6 3083@end group
5d67986c 3084@end smallexample
d7b8e6c6
EZ
3085
3086@cindex Unary operators
3087You can apply a ``unary operator'' like @kbd{&} to the top @var{n}
3088stack entries with a numeric prefix, too.
3089
d7b8e6c6 3090@smallexample
5d67986c 3091@group
d7b8e6c6
EZ
30923: 2 3: 0.5 3: 0.5
30932: 3 2: 0.333333333333 2: 3.
30941: 4 1: 0.25 1: 4.
3095 . . .
3096
5d67986c 30972 @key{RET} 3 @key{RET} 4 M-3 & M-2 &
d7b8e6c6 3098@end group
5d67986c 3099@end smallexample
d7b8e6c6
EZ
3100
3101Notice that the results here are left in floating-point form.
3102We can convert them back to integers by pressing @kbd{F}, the
3103``floor'' function. This function rounds down to the next lower
3104integer. There is also @kbd{R}, which rounds to the nearest
3105integer.
3106
d7b8e6c6 3107@smallexample
5d67986c 3108@group
d7b8e6c6
EZ
31097: 2. 7: 2 7: 2
31106: 2.4 6: 2 6: 2
31115: 2.5 5: 2 5: 3
31124: 2.6 4: 2 4: 3
31133: -2. 3: -2 3: -2
31142: -2.4 2: -3 2: -2
31151: -2.6 1: -3 1: -3
3116 . . .
3117
3118 M-7 F U M-7 R
d7b8e6c6 3119@end group
5d67986c 3120@end smallexample
d7b8e6c6
EZ
3121
3122Since dividing-and-flooring (i.e., ``integer quotient'') is such a
3123common operation, Calc provides a special command for that purpose, the
3124backslash @kbd{\}. Another common arithmetic operator is @kbd{%}, which
3125computes the remainder that would arise from a @kbd{\} operation, i.e.,
3126the ``modulo'' of two numbers. For example,
3127
d7b8e6c6 3128@smallexample
5d67986c 3129@group
d7b8e6c6
EZ
31302: 1234 1: 12 2: 1234 1: 34
31311: 100 . 1: 100 .
3132 . .
3133
5d67986c 31341234 @key{RET} 100 \ U %
d7b8e6c6 3135@end group
5d67986c 3136@end smallexample
d7b8e6c6
EZ
3137
3138These commands actually work for any real numbers, not just integers.
3139
d7b8e6c6 3140@smallexample
5d67986c 3141@group
d7b8e6c6
EZ
31422: 3.1415 1: 3 2: 3.1415 1: 0.1415
31431: 1 . 1: 1 .
3144 . .
3145
5d67986c 31463.1415 @key{RET} 1 \ U %
d7b8e6c6 3147@end group
5d67986c 3148@end smallexample
d7b8e6c6
EZ
3149
3150(@bullet{}) @strong{Exercise 1.} The @kbd{\} command would appear to be a
3151frill, since you could always do the same thing with @kbd{/ F}. Think
3152of a situation where this is not true---@kbd{/ F} would be inadequate.
3153Now think of a way you could get around the problem if Calc didn't
3154provide a @kbd{\} command. @xref{Arithmetic Answer 1, 1}. (@bullet{})
3155
3156We've already seen the @kbd{Q} (square root) and @kbd{S} (sine)
3157commands. Other commands along those lines are @kbd{C} (cosine),
a4231b04 3158@kbd{T} (tangent), @kbd{E} (@expr{e^x}) and @kbd{L} (natural
d7b8e6c6
EZ
3159logarithm). These can be modified by the @kbd{I} (inverse) and
3160@kbd{H} (hyperbolic) prefix keys.
3161
3162Let's compute the sine and cosine of an angle, and verify the
a4231b04 3163identity
8e04863e 3164@texline @math{\sin^2x + \cos^2x = 1}.
a4231b04 3165@infoline @expr{sin(x)^2 + cos(x)^2 = 1}.
8e04863e 3166We'll arbitrarily pick @mathit{-64} degrees as a good value for @expr{x}.
a4231b04 3167With the angular mode set to degrees (type @w{@kbd{m d}}), do:
d7b8e6c6 3168
d7b8e6c6 3169@smallexample
5d67986c 3170@group
d7b8e6c6
EZ
31712: -64 2: -64 2: -0.89879 2: -0.89879 1: 1.
31721: -64 1: -0.89879 1: -64 1: 0.43837 .
3173 . . . .
3174
5d67986c 3175 64 n @key{RET} @key{RET} S @key{TAB} C f h
d7b8e6c6 3176@end group
5d67986c 3177@end smallexample
d7b8e6c6
EZ
3178
3179@noindent
3180(For brevity, we're showing only five digits of the results here.
3181You can of course do these calculations to any precision you like.)
3182
3183Remember, @kbd{f h} is the @code{calc-hypot}, or square-root of sum
3184of squares, command.
3185
a4231b04 3186Another identity is
8e04863e 3187@texline @math{\displaystyle\tan x = {\sin x \over \cos x}}.
a4231b04 3188@infoline @expr{tan(x) = sin(x) / cos(x)}.
d7b8e6c6 3189@smallexample
5d67986c 3190@group
d7b8e6c6
EZ
3191
31922: -0.89879 1: -2.0503 1: -64.
31931: 0.43837 . .
3194 .
3195
3196 U / I T
d7b8e6c6 3197@end group
5d67986c 3198@end smallexample
d7b8e6c6
EZ
3199
3200A physical interpretation of this calculation is that if you move
a4231b04 3201@expr{0.89879} units downward and @expr{0.43837} units to the right,
8e04863e 3202your direction of motion is @mathit{-64} degrees from horizontal. Suppose
d7b8e6c6
EZ
3203we move in the opposite direction, up and to the left:
3204
d7b8e6c6 3205@smallexample
5d67986c 3206@group
d7b8e6c6
EZ
32072: -0.89879 2: 0.89879 1: -2.0503 1: -64.
32081: 0.43837 1: -0.43837 . .
3209 . .
3210
3211 U U M-2 n / I T
d7b8e6c6 3212@end group
5d67986c 3213@end smallexample
d7b8e6c6
EZ
3214
3215@noindent
3216How can the angle be the same? The answer is that the @kbd{/} operation
3217loses information about the signs of its inputs. Because the quotient
3218is negative, we know exactly one of the inputs was negative, but we
3219can't tell which one. There is an @kbd{f T} [@code{arctan2}] function which
3220computes the inverse tangent of the quotient of a pair of numbers.
3221Since you feed it the two original numbers, it has enough information
3222to give you a full 360-degree answer.
3223
d7b8e6c6 3224@smallexample
5d67986c 3225@group
d7b8e6c6
EZ
32262: 0.89879 1: 116. 3: 116. 2: 116. 1: 180.
32271: -0.43837 . 2: -0.89879 1: -64. .
3228 . 1: 0.43837 .
3229 .
3230
5d67986c 3231 U U f T M-@key{RET} M-2 n f T -
d7b8e6c6 3232@end group
5d67986c 3233@end smallexample
d7b8e6c6
EZ
3234
3235@noindent
3236The resulting angles differ by 180 degrees; in other words, they
3237point in opposite directions, just as we would expect.
3238
3239The @key{META}-@key{RET} we used in the third step is the
3240``last-arguments'' command. It is sort of like Undo, except that it
3241restores the arguments of the last command to the stack without removing
3242the command's result. It is useful in situations like this one,
3243where we need to do several operations on the same inputs. We could
3244have accomplished the same thing by using @kbd{M-2 @key{RET}} to duplicate
3245the top two stack elements right after the @kbd{U U}, then a pair of
3246@kbd{M-@key{TAB}} commands to cycle the 116 up around the duplicates.
3247
3248A similar identity is supposed to hold for hyperbolic sines and cosines,
3249except that it is the @emph{difference}
8e04863e 3250@texline @math{\cosh^2x - \sinh^2x}
a4231b04
JB
3251@infoline @expr{cosh(x)^2 - sinh(x)^2}
3252that always equals one. Let's try to verify this identity.
d7b8e6c6 3253
d7b8e6c6 3254@smallexample
5d67986c 3255@group
d7b8e6c6
EZ
32562: -64 2: -64 2: -64 2: 9.7192e54 2: 9.7192e54
32571: -64 1: -3.1175e27 1: 9.7192e54 1: -64 1: 9.7192e54
3258 . . . . .
3259
5d67986c 3260 64 n @key{RET} @key{RET} H C 2 ^ @key{TAB} H S 2 ^
d7b8e6c6 3261@end group
5d67986c 3262@end smallexample
d7b8e6c6
EZ
3263
3264@noindent
3265@cindex Roundoff errors, examples
3266Something's obviously wrong, because when we subtract these numbers
3267the answer will clearly be zero! But if you think about it, if these
3268numbers @emph{did} differ by one, it would be in the 55th decimal
3269place. The difference we seek has been lost entirely to roundoff
3270error.
3271
3272We could verify this hypothesis by doing the actual calculation with,
3273say, 60 decimal places of precision. This will be slow, but not
3274enormously so. Try it if you wish; sure enough, the answer is
32750.99999, reasonably close to 1.
3276
3277Of course, a more reasonable way to verify the identity is to use
a4231b04 3278a more reasonable value for @expr{x}!
d7b8e6c6
EZ
3279
3280@cindex Common logarithm
3281Some Calculator commands use the Hyperbolic prefix for other purposes.
3282The logarithm and exponential functions, for example, work to the base
a4231b04 3283@expr{e} normally but use base-10 instead if you use the Hyperbolic
d7b8e6c6
EZ
3284prefix.
3285
d7b8e6c6 3286@smallexample
5d67986c 3287@group
d7b8e6c6
EZ
32881: 1000 1: 6.9077 1: 1000 1: 3
3289 . . . .
3290
3291 1000 L U H L
d7b8e6c6 3292@end group
5d67986c 3293@end smallexample
d7b8e6c6
EZ
3294
3295@noindent
3296First, we mistakenly compute a natural logarithm. Then we undo
3297and compute a common logarithm instead.
3298
3299The @kbd{B} key computes a general base-@var{b} logarithm for any
3300value of @var{b}.
3301
d7b8e6c6 3302@smallexample
5d67986c 3303@group
d7b8e6c6
EZ
33042: 1000 1: 3 1: 1000. 2: 1000. 1: 6.9077
33051: 10 . . 1: 2.71828 .
3306 . .
3307
5d67986c 3308 1000 @key{RET} 10 B H E H P B
d7b8e6c6 3309@end group
5d67986c 3310@end smallexample
d7b8e6c6
EZ
3311
3312@noindent
3313Here we first use @kbd{B} to compute the base-10 logarithm, then use
3314the ``hyperbolic'' exponential as a cheap hack to recover the number
33151000, then use @kbd{B} again to compute the natural logarithm. Note
a4231b04 3316that @kbd{P} with the hyperbolic prefix pushes the constant @expr{e}
d7b8e6c6
EZ
3317onto the stack.
3318
3319You may have noticed that both times we took the base-10 logarithm
3320of 1000, we got an exact integer result. Calc always tries to give
3321an exact rational result for calculations involving rational numbers
3322where possible. But when we used @kbd{H E}, the result was a
3323floating-point number for no apparent reason. In fact, if we had
3324computed @kbd{10 @key{RET} 3 ^} we @emph{would} have gotten an
3325exact integer 1000. But the @kbd{H E} command is rigged to generate
3326a floating-point result all of the time so that @kbd{1000 H E} will
3327not waste time computing a thousand-digit integer when all you
3328probably wanted was @samp{1e1000}.
3329
3330(@bullet{}) @strong{Exercise 2.} Find a pair of integer inputs to
3331the @kbd{B} command for which Calc could find an exact rational
3332result but doesn't. @xref{Arithmetic Answer 2, 2}. (@bullet{})
3333
3334The Calculator also has a set of functions relating to combinatorics
3335and statistics. You may be familiar with the @dfn{factorial} function,
3336which computes the product of all the integers up to a given number.
3337
d7b8e6c6 3338@smallexample
5d67986c 3339@group
d7b8e6c6
EZ
33401: 100 1: 93326215443... 1: 100. 1: 9.3326e157
3341 . . . .
3342
3343 100 ! U c f !
d7b8e6c6 3344@end group
5d67986c 3345@end smallexample
d7b8e6c6
EZ
3346
3347@noindent
3348Recall, the @kbd{c f} command converts the integer or fraction at the
3349top of the stack to floating-point format. If you take the factorial
3350of a floating-point number, you get a floating-point result
3351accurate to the current precision. But if you give @kbd{!} an
3352exact integer, you get an exact integer result (158 digits long
3353in this case).
3354
3355If you take the factorial of a non-integer, Calc uses a generalized
3356factorial function defined in terms of Euler's Gamma function
8e04863e 3357@texline @math{\Gamma(n)}
a4231b04 3358@infoline @expr{gamma(n)}
d7b8e6c6
EZ
3359(which is itself available as the @kbd{f g} command).
3360
d7b8e6c6 3361@smallexample
5d67986c 3362@group
d7b8e6c6
EZ
33633: 4. 3: 24. 1: 5.5 1: 52.342777847
33642: 4.5 2: 52.3427777847 . .
33651: 5. 1: 120.
3366 . .
3367
5d67986c 3368 M-3 ! M-0 @key{DEL} 5.5 f g
d7b8e6c6 3369@end group
5d67986c 3370@end smallexample
d7b8e6c6
EZ
3371
3372@noindent
a4231b04 3373Here we verify the identity
8e04863e 3374@texline @math{n! = \Gamma(n+1)}.
a4231b04 3375@infoline @expr{@var{n}!@: = gamma(@var{n}+1)}.
d7b8e6c6 3376
a4231b04 3377The binomial coefficient @var{n}-choose-@var{m}
8e04863e 3378@texline or @math{\displaystyle {n \choose m}}
a4231b04 3379is defined by
8e04863e 3380@texline @math{\displaystyle {n! \over m! \, (n-m)!}}
a4231b04
JB
3381@infoline @expr{n!@: / m!@: (n-m)!}
3382for all reals @expr{n} and @expr{m}. The intermediate results in this
3383formula can become quite large even if the final result is small; the
3384@kbd{k c} command computes a binomial coefficient in a way that avoids
3385large intermediate values.
d7b8e6c6
EZ
3386
3387The @kbd{k} prefix key defines several common functions out of
3388combinatorics and number theory. Here we compute the binomial
3389coefficient 30-choose-20, then determine its prime factorization.
3390
d7b8e6c6 3391@smallexample
5d67986c 3392@group
d7b8e6c6
EZ
33932: 30 1: 30045015 1: [3, 3, 5, 7, 11, 13, 23, 29]
33941: 20 . .
3395 .
3396
5d67986c 3397 30 @key{RET} 20 k c k f
d7b8e6c6 3398@end group
5d67986c 3399@end smallexample
d7b8e6c6
EZ
3400
3401@noindent
3402You can verify these prime factors by using @kbd{v u} to ``unpack''
3403this vector into 8 separate stack entries, then @kbd{M-8 *} to
3404multiply them back together. The result is the original number,
340530045015.
3406
3407@cindex Hash tables
3408Suppose a program you are writing needs a hash table with at least
340910000 entries. It's best to use a prime number as the actual size
3410of a hash table. Calc can compute the next prime number after 10000:
3411
d7b8e6c6 3412@smallexample
5d67986c 3413@group
d7b8e6c6
EZ
34141: 10000 1: 10007 1: 9973
3415 . . .
3416
3417 10000 k n I k n
d7b8e6c6 3418@end group
5d67986c 3419@end smallexample
d7b8e6c6
EZ
3420
3421@noindent
3422Just for kicks we've also computed the next prime @emph{less} than
342310000.
3424
3425@c [fix-ref Financial Functions]
3426@xref{Financial Functions}, for a description of the Calculator
3427commands that deal with business and financial calculations (functions
3428like @code{pv}, @code{rate}, and @code{sln}).
3429
3430@c [fix-ref Binary Number Functions]
3431@xref{Binary Functions}, to read about the commands for operating
3432on binary numbers (like @code{and}, @code{xor}, and @code{lsh}).
3433
3434@node Vector/Matrix Tutorial, Types Tutorial, Arithmetic Tutorial, Tutorial
3435@section Vector/Matrix Tutorial
3436
3437@noindent
3438A @dfn{vector} is a list of numbers or other Calc data objects.
3439Calc provides a large set of commands that operate on vectors. Some
3440are familiar operations from vector analysis. Others simply treat
3441a vector as a list of objects.
3442
3443@menu
3444* Vector Analysis Tutorial::
3445* Matrix Tutorial::
3446* List Tutorial::
3447@end menu
3448
3449@node Vector Analysis Tutorial, Matrix Tutorial, Vector/Matrix Tutorial, Vector/Matrix Tutorial
3450@subsection Vector Analysis
3451
3452@noindent
3453If you add two vectors, the result is a vector of the sums of the
3454elements, taken pairwise.
3455
d7b8e6c6 3456@smallexample
5d67986c 3457@group
d7b8e6c6
EZ
34581: [1, 2, 3] 2: [1, 2, 3] 1: [8, 8, 3]
3459 . 1: [7, 6, 0] .
3460 .
3461
3462 [1,2,3] s 1 [7 6 0] s 2 +
d7b8e6c6 3463@end group
5d67986c 3464@end smallexample
d7b8e6c6
EZ
3465
3466@noindent
3467Note that we can separate the vector elements with either commas or
3468spaces. This is true whether we are using incomplete vectors or
3469algebraic entry. The @kbd{s 1} and @kbd{s 2} commands save these
3470vectors so we can easily reuse them later.
3471
3472If you multiply two vectors, the result is the sum of the products
3473of the elements taken pairwise. This is called the @dfn{dot product}
3474of the vectors.
3475
d7b8e6c6 3476@smallexample
5d67986c 3477@group
d7b8e6c6
EZ
34782: [1, 2, 3] 1: 19
34791: [7, 6, 0] .
3480 .
3481
3482 r 1 r 2 *
d7b8e6c6 3483@end group
5d67986c 3484@end smallexample
d7b8e6c6
EZ
3485
3486@cindex Dot product
3487The dot product of two vectors is equal to the product of their
3488lengths times the cosine of the angle between them. (Here the vector
a4231b04 3489is interpreted as a line from the origin @expr{(0,0,0)} to the
d7b8e6c6
EZ
3490specified point in three-dimensional space.) The @kbd{A}
3491(absolute value) command can be used to compute the length of a
3492vector.
3493
d7b8e6c6 3494@smallexample
5d67986c 3495@group
d7b8e6c6
EZ
34963: 19 3: 19 1: 0.550782 1: 56.579
34972: [1, 2, 3] 2: 3.741657 . .
34981: [7, 6, 0] 1: 9.219544
3499 . .
3500
5d67986c 3501 M-@key{RET} M-2 A * / I C
d7b8e6c6 3502@end group
5d67986c 3503@end smallexample
d7b8e6c6
EZ
3504
3505@noindent
3506First we recall the arguments to the dot product command, then
3507we compute the absolute values of the top two stack entries to
3508obtain the lengths of the vectors, then we divide the dot product
3509by the product of the lengths to get the cosine of the angle.
3510The inverse cosine finds that the angle between the vectors
3511is about 56 degrees.
3512
3513@cindex Cross product
3514@cindex Perpendicular vectors
3515The @dfn{cross product} of two vectors is a vector whose length
3516is the product of the lengths of the inputs times the sine of the
3517angle between them, and whose direction is perpendicular to both
3518input vectors. Unlike the dot product, the cross product is
3519defined only for three-dimensional vectors. Let's double-check
3520our computation of the angle using the cross product.
3521
d7b8e6c6 3522@smallexample
5d67986c 3523@group
d7b8e6c6
EZ
35242: [1, 2, 3] 3: [-18, 21, -8] 1: [-0.52, 0.61, -0.23] 1: 56.579
35251: [7, 6, 0] 2: [1, 2, 3] . .
3526 . 1: [7, 6, 0]
3527 .
3528
5d67986c 3529 r 1 r 2 V C s 3 M-@key{RET} M-2 A * / A I S
d7b8e6c6 3530@end group
5d67986c 3531@end smallexample
d7b8e6c6
EZ
3532
3533@noindent
3534First we recall the original vectors and compute their cross product,
3535which we also store for later reference. Now we divide the vector
3536by the product of the lengths of the original vectors. The length of
3537this vector should be the sine of the angle; sure enough, it is!
3538
3539@c [fix-ref General Mode Commands]
3540Vector-related commands generally begin with the @kbd{v} prefix key.
3541Some are uppercase letters and some are lowercase. To make it easier
3542to type these commands, the shift-@kbd{V} prefix key acts the same as
3543the @kbd{v} key. (@xref{General Mode Commands}, for a way to make all
3544prefix keys have this property.)
3545
3546If we take the dot product of two perpendicular vectors we expect
3547to get zero, since the cosine of 90 degrees is zero. Let's check
3548that the cross product is indeed perpendicular to both inputs:
3549
d7b8e6c6 3550@smallexample
5d67986c 3551@group
d7b8e6c6
EZ
35522: [1, 2, 3] 1: 0 2: [7, 6, 0] 1: 0
35531: [-18, 21, -8] . 1: [-18, 21, -8] .
3554 . .
3555
5d67986c 3556 r 1 r 3 * @key{DEL} r 2 r 3 *
d7b8e6c6 3557@end group
5d67986c 3558@end smallexample
d7b8e6c6
EZ
3559
3560@cindex Normalizing a vector
3561@cindex Unit vectors
3562(@bullet{}) @strong{Exercise 1.} Given a vector on the top of the
3563stack, what keystrokes would you use to @dfn{normalize} the
3564vector, i.e., to reduce its length to one without changing its
3565direction? @xref{Vector Answer 1, 1}. (@bullet{})
3566
3567(@bullet{}) @strong{Exercise 2.} Suppose a certain particle can be
3568at any of several positions along a ruler. You have a list of
3569those positions in the form of a vector, and another list of the
3570probabilities for the particle to be at the corresponding positions.
3571Find the average position of the particle.
3572@xref{Vector Answer 2, 2}. (@bullet{})
3573
3574@node Matrix Tutorial, List Tutorial, Vector Analysis Tutorial, Vector/Matrix Tutorial
3575@subsection Matrices
3576
3577@noindent
3578A @dfn{matrix} is just a vector of vectors, all the same length.
3579This means you can enter a matrix using nested brackets. You can
3580also use the semicolon character to enter a matrix. We'll show
3581both methods here:
3582
d7b8e6c6 3583@smallexample
5d67986c 3584@group
d7b8e6c6
EZ
35851: [ [ 1, 2, 3 ] 1: [ [ 1, 2, 3 ]
3586 [ 4, 5, 6 ] ] [ 4, 5, 6 ] ]
3587 . .
3588
5d67986c 3589 [[1 2 3] [4 5 6]] ' [1 2 3; 4 5 6] @key{RET}
d7b8e6c6 3590@end group
5d67986c 3591@end smallexample
d7b8e6c6
EZ
3592
3593@noindent
3594We'll be using this matrix again, so type @kbd{s 4} to save it now.
3595
3596Note that semicolons work with incomplete vectors, but they work
3597better in algebraic entry. That's why we use the apostrophe in
3598the second example.
3599
3600When two matrices are multiplied, the lefthand matrix must have
3601the same number of columns as the righthand matrix has rows.
a4231b04
JB
3602Row @expr{i}, column @expr{j} of the result is effectively the
3603dot product of row @expr{i} of the left matrix by column @expr{j}
d7b8e6c6
EZ
3604of the right matrix.
3605
3606If we try to duplicate this matrix and multiply it by itself,
3607the dimensions are wrong and the multiplication cannot take place:
3608
d7b8e6c6 3609@smallexample
5d67986c 3610@group
d7b8e6c6
EZ
36111: [ [ 1, 2, 3 ] * [ [ 1, 2, 3 ]
3612 [ 4, 5, 6 ] ] [ 4, 5, 6 ] ]
3613 .
3614
5d67986c 3615 @key{RET} *
d7b8e6c6 3616@end group
5d67986c 3617@end smallexample
d7b8e6c6
EZ
3618
3619@noindent
3620Though rather hard to read, this is a formula which shows the product
3621of two matrices. The @samp{*} function, having invalid arguments, has
3622been left in symbolic form.
3623
3624We can multiply the matrices if we @dfn{transpose} one of them first.
3625
d7b8e6c6 3626@smallexample
5d67986c 3627@group
d7b8e6c6
EZ
36282: [ [ 1, 2, 3 ] 1: [ [ 14, 32 ] 1: [ [ 17, 22, 27 ]
3629 [ 4, 5, 6 ] ] [ 32, 77 ] ] [ 22, 29, 36 ]
36301: [ [ 1, 4 ] . [ 27, 36, 45 ] ]
3631 [ 2, 5 ] .
3632 [ 3, 6 ] ]
3633 .
3634
5d67986c 3635 U v t * U @key{TAB} *
d7b8e6c6 3636@end group
5d67986c 3637@end smallexample
d7b8e6c6
EZ
3638
3639Matrix multiplication is not commutative; indeed, switching the
3640order of the operands can even change the dimensions of the result
3641matrix, as happened here!
3642
3643If you multiply a plain vector by a matrix, it is treated as a
3644single row or column depending on which side of the matrix it is
3645on. The result is a plain vector which should also be interpreted
3646as a row or column as appropriate.
3647
d7b8e6c6 3648@smallexample
5d67986c 3649@group
d7b8e6c6
EZ
36502: [ [ 1, 2, 3 ] 1: [14, 32]
3651 [ 4, 5, 6 ] ] .
36521: [1, 2, 3]
3653 .
3654
3655 r 4 r 1 *
d7b8e6c6 3656@end group
5d67986c 3657@end smallexample
d7b8e6c6
EZ
3658
3659Multiplying in the other order wouldn't work because the number of
3660rows in the matrix is different from the number of elements in the
3661vector.
3662
3663(@bullet{}) @strong{Exercise 1.} Use @samp{*} to sum along the rows
a4231b04 3664of the above
8e04863e 3665@texline @math{2\times3}
a4231b04
JB
3666@infoline 2x3
3667matrix to get @expr{[6, 15]}. Now use @samp{*} to sum along the columns
3668to get @expr{[5, 7, 9]}.
d7b8e6c6
EZ
3669@xref{Matrix Answer 1, 1}. (@bullet{})
3670
3671@cindex Identity matrix
3672An @dfn{identity matrix} is a square matrix with ones along the
3673diagonal and zeros elsewhere. It has the property that multiplication
3674by an identity matrix, on the left or on the right, always produces
3675the original matrix.
3676
d7b8e6c6 3677@smallexample
5d67986c 3678@group
d7b8e6c6
EZ
36791: [ [ 1, 2, 3 ] 2: [ [ 1, 2, 3 ] 1: [ [ 1, 2, 3 ]
3680 [ 4, 5, 6 ] ] [ 4, 5, 6 ] ] [ 4, 5, 6 ] ]
3681 . 1: [ [ 1, 0, 0 ] .
3682 [ 0, 1, 0 ]
3683 [ 0, 0, 1 ] ]
3684 .
3685
5d67986c 3686 r 4 v i 3 @key{RET} *
d7b8e6c6 3687@end group
5d67986c 3688@end smallexample
d7b8e6c6
EZ
3689
3690If a matrix is square, it is often possible to find its @dfn{inverse},
3691that is, a matrix which, when multiplied by the original matrix, yields
3692an identity matrix. The @kbd{&} (reciprocal) key also computes the
3693inverse of a matrix.
3694
d7b8e6c6 3695@smallexample
5d67986c 3696@group
d7b8e6c6
EZ
36971: [ [ 1, 2, 3 ] 1: [ [ -2.4, 1.2, -0.2 ]
3698 [ 4, 5, 6 ] [ 2.8, -1.4, 0.4 ]
3699 [ 7, 6, 0 ] ] [ -0.73333, 0.53333, -0.2 ] ]
3700 . .
3701
3702 r 4 r 2 | s 5 &
d7b8e6c6 3703@end group
5d67986c 3704@end smallexample
d7b8e6c6
EZ
3705
3706@noindent
3707The vertical bar @kbd{|} @dfn{concatenates} numbers, vectors, and
3708matrices together. Here we have used it to add a new row onto
3709our matrix to make it square.
3710
3711We can multiply these two matrices in either order to get an identity.
3712
d7b8e6c6 3713@smallexample
5d67986c 3714@group
d7b8e6c6
EZ
37151: [ [ 1., 0., 0. ] 1: [ [ 1., 0., 0. ]
3716 [ 0., 1., 0. ] [ 0., 1., 0. ]
3717 [ 0., 0., 1. ] ] [ 0., 0., 1. ] ]
3718 . .
3719
5d67986c 3720 M-@key{RET} * U @key{TAB} *
d7b8e6c6 3721@end group
5d67986c 3722@end smallexample
d7b8e6c6
EZ
3723
3724@cindex Systems of linear equations
3725@cindex Linear equations, systems of
3726Matrix inverses are related to systems of linear equations in algebra.
3727Suppose we had the following set of equations:
3728
3729@ifinfo
3730@group
3731@example
3732 a + 2b + 3c = 6
3733 4a + 5b + 6c = 2
3734 7a + 6b = 3
3735@end example
3736@end group
3737@end ifinfo
3738@tex
3739\turnoffactive
3740\beforedisplayh
3741$$ \openup1\jot \tabskip=0pt plus1fil
3742\halign to\displaywidth{\tabskip=0pt
3743 $\hfil#$&$\hfil{}#{}$&
3744 $\hfil#$&$\hfil{}#{}$&
3745 $\hfil#$&${}#\hfil$\tabskip=0pt plus1fil\cr
3746 a&+&2b&+&3c&=6 \cr
3747 4a&+&5b&+&6c&=2 \cr
3748 7a&+&6b& & &=3 \cr}
3749$$
3750\afterdisplayh
3751@end tex
3752
3753@noindent
3754This can be cast into the matrix equation,
3755
3756@ifinfo
3757@group
3758@example
3759 [ [ 1, 2, 3 ] [ [ a ] [ [ 6 ]
3760 [ 4, 5, 6 ] * [ b ] = [ 2 ]
3761 [ 7, 6, 0 ] ] [ c ] ] [ 3 ] ]
3762@end example
3763@end group
3764@end ifinfo
3765@tex
3766\turnoffactive
3767\beforedisplay
3768$$ \pmatrix{ 1 & 2 & 3 \cr 4 & 5 & 6 \cr 7 & 6 & 0 }
3769 \times
3770 \pmatrix{ a \cr b \cr c } = \pmatrix{ 6 \cr 2 \cr 3 }
3771$$
3772\afterdisplay
3773@end tex
3774
3775We can solve this system of equations by multiplying both sides by the
3776inverse of the matrix. Calc can do this all in one step:
3777
d7b8e6c6 3778@smallexample
5d67986c 3779@group
d7b8e6c6
EZ
37802: [6, 2, 3] 1: [-12.6, 15.2, -3.93333]
37811: [ [ 1, 2, 3 ] .
3782 [ 4, 5, 6 ]
3783 [ 7, 6, 0 ] ]
3784 .
3785
3786 [6,2,3] r 5 /
d7b8e6c6 3787@end group
5d67986c 3788@end smallexample
d7b8e6c6
EZ
3789
3790@noindent
a4231b04 3791The result is the @expr{[a, b, c]} vector that solves the equations.
d7b8e6c6
EZ
3792(Dividing by a square matrix is equivalent to multiplying by its
3793inverse.)
3794
3795Let's verify this solution:
3796
d7b8e6c6 3797@smallexample
5d67986c 3798@group
d7b8e6c6
EZ
37992: [ [ 1, 2, 3 ] 1: [6., 2., 3.]
3800 [ 4, 5, 6 ] .
3801 [ 7, 6, 0 ] ]
38021: [-12.6, 15.2, -3.93333]
3803 .
3804
5d67986c 3805 r 5 @key{TAB} *
d7b8e6c6 3806@end group
5d67986c 3807@end smallexample
d7b8e6c6
EZ
3808
3809@noindent
3810Note that we had to be careful about the order in which we multiplied
3811the matrix and vector. If we multiplied in the other order, Calc would
3812assume the vector was a row vector in order to make the dimensions
3813come out right, and the answer would be incorrect. If you
3814don't feel safe letting Calc take either interpretation of your
a4231b04 3815vectors, use explicit
8e04863e 3816@texline @math{N\times1}
a4231b04
JB
3817@infoline Nx1
3818or
8e04863e 3819@texline @math{1\times N}
a4231b04
JB
3820@infoline 1xN
3821matrices instead. In this case, you would enter the original column
3822vector as @samp{[[6], [2], [3]]} or @samp{[6; 2; 3]}.
d7b8e6c6
EZ
3823
3824(@bullet{}) @strong{Exercise 2.} Algebraic entry allows you to make
3825vectors and matrices that include variables. Solve the following
a4231b04
JB
3826system of equations to get expressions for @expr{x} and @expr{y}
3827in terms of @expr{a} and @expr{b}.
d7b8e6c6
EZ
3828
3829@ifinfo
3830@group
3831@example
3832 x + a y = 6
3833 x + b y = 10
3834@end example
3835@end group
3836@end ifinfo
3837@tex
3838\turnoffactive
3839\beforedisplay
3840$$ \eqalign{ x &+ a y = 6 \cr
3841 x &+ b y = 10}
3842$$
3843\afterdisplay
3844@end tex
3845
3846@noindent
3847@xref{Matrix Answer 2, 2}. (@bullet{})
3848
3849@cindex Least-squares for over-determined systems
3850@cindex Over-determined systems of equations
3851(@bullet{}) @strong{Exercise 3.} A system of equations is ``over-determined''
3852if it has more equations than variables. It is often the case that
3853there are no values for the variables that will satisfy all the
3854equations at once, but it is still useful to find a set of values
3855which ``nearly'' satisfy all the equations. In terms of matrix equations,
a4231b04 3856you can't solve @expr{A X = B} directly because the matrix @expr{A}
d7b8e6c6
EZ
3857is not square for an over-determined system. Matrix inversion works
3858only for square matrices. One common trick is to multiply both sides
a4231b04 3859on the left by the transpose of @expr{A}:
d7b8e6c6
EZ
3860@ifinfo
3861@samp{trn(A)*A*X = trn(A)*B}.
3862@end ifinfo
3863@tex
3864\turnoffactive
3865$A^T A \, X = A^T B$, where $A^T$ is the transpose \samp{trn(A)}.
3866@end tex
a4231b04 3867Now
8e04863e 3868@texline @math{A^T A}
a4231b04
JB
3869@infoline @expr{trn(A)*A}
3870is a square matrix so a solution is possible. It turns out that the
3871@expr{X} vector you compute in this way will be a ``least-squares''
3872solution, which can be regarded as the ``closest'' solution to the set
3873of equations. Use Calc to solve the following over-determined
3874system:
d7b8e6c6
EZ
3875
3876@ifinfo
3877@group
3878@example
3879 a + 2b + 3c = 6
3880 4a + 5b + 6c = 2
3881 7a + 6b = 3
3882 2a + 4b + 6c = 11
3883@end example
3884@end group
3885@end ifinfo
3886@tex
3887\turnoffactive
3888\beforedisplayh
3889$$ \openup1\jot \tabskip=0pt plus1fil
3890\halign to\displaywidth{\tabskip=0pt
3891 $\hfil#$&$\hfil{}#{}$&
3892 $\hfil#$&$\hfil{}#{}$&
3893 $\hfil#$&${}#\hfil$\tabskip=0pt plus1fil\cr
3894 a&+&2b&+&3c&=6 \cr
3895 4a&+&5b&+&6c&=2 \cr
3896 7a&+&6b& & &=3 \cr
3897 2a&+&4b&+&6c&=11 \cr}
3898$$
3899\afterdisplayh
3900@end tex
3901
3902@noindent
3903@xref{Matrix Answer 3, 3}. (@bullet{})
3904
3905@node List Tutorial, , Matrix Tutorial, Vector/Matrix Tutorial
3906@subsection Vectors as Lists
3907
3908@noindent
3909@cindex Lists
3910Although Calc has a number of features for manipulating vectors and
3911matrices as mathematical objects, you can also treat vectors as
3912simple lists of values. For example, we saw that the @kbd{k f}
3913command returns a vector which is a list of the prime factors of a
3914number.
3915
3916You can pack and unpack stack entries into vectors:
3917
d7b8e6c6 3918@smallexample
5d67986c 3919@group
d7b8e6c6
EZ
39203: 10 1: [10, 20, 30] 3: 10
39212: 20 . 2: 20
39221: 30 1: 30
3923 . .
3924
3925 M-3 v p v u
d7b8e6c6 3926@end group
5d67986c 3927@end smallexample
d7b8e6c6
EZ
3928
3929You can also build vectors out of consecutive integers, or out
3930of many copies of a given value:
3931
d7b8e6c6 3932@smallexample
5d67986c 3933@group
d7b8e6c6
EZ
39341: [1, 2, 3, 4] 2: [1, 2, 3, 4] 2: [1, 2, 3, 4]
3935 . 1: 17 1: [17, 17, 17, 17]
3936 . .
3937
5d67986c 3938 v x 4 @key{RET} 17 v b 4 @key{RET}
d7b8e6c6 3939@end group
5d67986c 3940@end smallexample
d7b8e6c6
EZ
3941
3942You can apply an operator to every element of a vector using the
3943@dfn{map} command.
3944
d7b8e6c6 3945@smallexample
5d67986c 3946@group
d7b8e6c6
EZ
39471: [17, 34, 51, 68] 1: [289, 1156, 2601, 4624] 1: [17, 34, 51, 68]
3948 . . .
3949
3950 V M * 2 V M ^ V M Q
d7b8e6c6 3951@end group
5d67986c 3952@end smallexample
d7b8e6c6
EZ
3953
3954@noindent
3955In the first step, we multiply the vector of integers by the vector
3956of 17's elementwise. In the second step, we raise each element to
3957the power two. (The general rule is that both operands must be
3958vectors of the same length, or else one must be a vector and the
3959other a plain number.) In the final step, we take the square root
3960of each element.
3961
3962(@bullet{}) @strong{Exercise 1.} Compute a vector of powers of two
a4231b04 3963from
8e04863e 3964@texline @math{2^{-4}}
a4231b04
JB
3965@infoline @expr{2^-4}
3966to @expr{2^4}. @xref{List Answer 1, 1}. (@bullet{})
d7b8e6c6
EZ
3967
3968You can also @dfn{reduce} a binary operator across a vector.
3969For example, reducing @samp{*} computes the product of all the
3970elements in the vector:
3971
d7b8e6c6 3972@smallexample
5d67986c 3973@group
d7b8e6c6
EZ
39741: 123123 1: [3, 7, 11, 13, 41] 1: 123123
3975 . . .
3976
3977 123123 k f V R *
d7b8e6c6 3978@end group
5d67986c 3979@end smallexample
d7b8e6c6
EZ
3980
3981@noindent
3982In this example, we decompose 123123 into its prime factors, then
3983multiply those factors together again to yield the original number.
3984
3985We could compute a dot product ``by hand'' using mapping and
3986reduction:
3987
d7b8e6c6 3988@smallexample
5d67986c 3989@group
d7b8e6c6
EZ
39902: [1, 2, 3] 1: [7, 12, 0] 1: 19
39911: [7, 6, 0] . .
3992 .
3993
3994 r 1 r 2 V M * V R +
d7b8e6c6 3995@end group
5d67986c 3996@end smallexample
d7b8e6c6
EZ
3997
3998@noindent
3999Recalling two vectors from the previous section, we compute the
4000sum of pairwise products of the elements to get the same answer
4001for the dot product as before.
4002
4003A slight variant of vector reduction is the @dfn{accumulate} operation,
4004@kbd{V U}. This produces a vector of the intermediate results from
4005a corresponding reduction. Here we compute a table of factorials:
4006
d7b8e6c6 4007@smallexample
5d67986c 4008@group
d7b8e6c6
EZ
40091: [1, 2, 3, 4, 5, 6] 1: [1, 2, 6, 24, 120, 720]
4010 . .
4011
5d67986c 4012 v x 6 @key{RET} V U *
d7b8e6c6 4013@end group
5d67986c 4014@end smallexample
d7b8e6c6
EZ
4015
4016Calc allows vectors to grow as large as you like, although it gets
4017rather slow if vectors have more than about a hundred elements.
4018Actually, most of the time is spent formatting these large vectors
4019for display, not calculating on them. Try the following experiment
4020(if your computer is very fast you may need to substitute a larger
4021vector size).
4022
d7b8e6c6 4023@smallexample
5d67986c 4024@group
d7b8e6c6
EZ
40251: [1, 2, 3, 4, ... 1: [2, 3, 4, 5, ...
4026 . .
4027
5d67986c 4028 v x 500 @key{RET} 1 V M +
d7b8e6c6 4029@end group
5d67986c 4030@end smallexample
d7b8e6c6
EZ
4031
4032Now press @kbd{v .} (the letter @kbd{v}, then a period) and try the
4033experiment again. In @kbd{v .} mode, long vectors are displayed
4034``abbreviated'' like this:
4035
d7b8e6c6 4036@smallexample
5d67986c 4037@group
d7b8e6c6
EZ
40381: [1, 2, 3, ..., 500] 1: [2, 3, 4, ..., 501]
4039 . .
4040
5d67986c 4041 v x 500 @key{RET} 1 V M +
d7b8e6c6 4042@end group
5d67986c 4043@end smallexample
d7b8e6c6
EZ
4044
4045@noindent
4046(where now the @samp{...} is actually part of the Calc display).
4047You will find both operations are now much faster. But notice that
4048even in @w{@kbd{v .}} mode, the full vectors are still shown in the Trail.
4049Type @w{@kbd{t .}} to cause the trail to abbreviate as well, and try the
4050experiment one more time. Operations on long vectors are now quite
4051fast! (But of course if you use @kbd{t .} you will lose the ability
4052to get old vectors back using the @kbd{t y} command.)
4053
4054An easy way to view a full vector when @kbd{v .} mode is active is
4055to press @kbd{`} (back-quote) to edit the vector; editing always works
4056with the full, unabbreviated value.
4057
4058@cindex Least-squares for fitting a straight line
4059@cindex Fitting data to a line
4060@cindex Line, fitting data to
4061@cindex Data, extracting from buffers
4062@cindex Columns of data, extracting
4063As a larger example, let's try to fit a straight line to some data,
4064using the method of least squares. (Calc has a built-in command for
4065least-squares curve fitting, but we'll do it by hand here just to
4066practice working with vectors.) Suppose we have the following list
4067of values in a file we have loaded into Emacs:
4068
4069@smallexample
4070 x y
4071 --- ---
4072 1.34 0.234
4073 1.41 0.298
4074 1.49 0.402
4075 1.56 0.412
4076 1.64 0.466
4077 1.73 0.473
4078 1.82 0.601
4079 1.91 0.519
4080 2.01 0.603
4081 2.11 0.637
4082 2.22 0.645
4083 2.33 0.705
4084 2.45 0.917
4085 2.58 1.009
4086 2.71 0.971
4087 2.85 1.062
4088 3.00 1.148
4089 3.15 1.157
4090 3.32 1.354
4091@end smallexample
4092
4093@noindent
4094If you are reading this tutorial in printed form, you will find it
4095easiest to press @kbd{M-# i} to enter the on-line Info version of
4096the manual and find this table there. (Press @kbd{g}, then type
4097@kbd{List Tutorial}, to jump straight to this section.)
4098
4099Position the cursor at the upper-left corner of this table, just
a4231b04 4100to the left of the @expr{1.34}. Press @kbd{C-@@} to set the mark.
5d67986c 4101(On your system this may be @kbd{C-2}, @kbd{C-@key{SPC}}, or @kbd{NUL}.)
a4231b04 4102Now position the cursor to the lower-right, just after the @expr{1.354}.
d7b8e6c6
EZ
4103You have now defined this region as an Emacs ``rectangle.'' Still
4104in the Info buffer, type @kbd{M-# r}. This command
4105(@code{calc-grab-rectangle}) will pop you back into the Calculator, with
a4231b04 4106the contents of the rectangle you specified in the form of a matrix.
d7b8e6c6 4107
d7b8e6c6 4108@smallexample
5d67986c 4109@group
d7b8e6c6
EZ
41101: [ [ 1.34, 0.234 ]
4111 [ 1.41, 0.298 ]
4112 @dots{}
d7b8e6c6 4113@end group
5d67986c 4114@end smallexample
d7b8e6c6
EZ
4115
4116@noindent
4117(You may wish to use @kbd{v .} mode to abbreviate the display of this
4118large matrix.)
4119
4120We want to treat this as a pair of lists. The first step is to
4121transpose this matrix into a pair of rows. Remember, a matrix is
4122just a vector of vectors. So we can unpack the matrix into a pair
4123of row vectors on the stack.
4124
d7b8e6c6 4125@smallexample
5d67986c 4126@group
d7b8e6c6
EZ
41271: [ [ 1.34, 1.41, 1.49, ... ] 2: [1.34, 1.41, 1.49, ... ]
4128 [ 0.234, 0.298, 0.402, ... ] ] 1: [0.234, 0.298, 0.402, ... ]
4129 . .
4130
4131 v t v u
d7b8e6c6 4132@end group
5d67986c 4133@end smallexample
d7b8e6c6
EZ
4134
4135@noindent
4136Let's store these in quick variables 1 and 2, respectively.
4137
d7b8e6c6 4138@smallexample
5d67986c 4139@group
d7b8e6c6
EZ
41401: [1.34, 1.41, 1.49, ... ] .
4141 .
4142
4143 t 2 t 1
d7b8e6c6 4144@end group
5d67986c 4145@end smallexample
d7b8e6c6
EZ
4146
4147@noindent
4148(Recall that @kbd{t 2} is a variant of @kbd{s 2} that removes the
4149stored value from the stack.)
4150
a4231b04 4151In a least squares fit, the slope @expr{m} is given by the formula
d7b8e6c6
EZ
4152
4153@ifinfo
4154@example
4155m = (N sum(x y) - sum(x) sum(y)) / (N sum(x^2) - sum(x)^2)
4156@end example
4157@end ifinfo
4158@tex
4159\turnoffactive
4160\beforedisplay
4161$$ m = {N \sum x y - \sum x \sum y \over
4162 N \sum x^2 - \left( \sum x \right)^2} $$
4163\afterdisplay
4164@end tex
4165
4166@noindent
a4231b04 4167where
8e04863e 4168@texline @math{\sum x}
a4231b04
JB
4169@infoline @expr{sum(x)}
4170represents the sum of all the values of @expr{x}. While there is an
4171actual @code{sum} function in Calc, it's easier to sum a vector using a
4172simple reduction. First, let's compute the four different sums that
4173this formula uses.
d7b8e6c6 4174
d7b8e6c6 4175@smallexample
5d67986c 4176@group
d7b8e6c6
EZ
41771: 41.63 1: 98.0003
4178 . .
4179
4180 r 1 V R + t 3 r 1 2 V M ^ V R + t 4
4181
d7b8e6c6 4182@end group
5d67986c 4183@end smallexample
d7b8e6c6 4184@noindent
d7b8e6c6 4185@smallexample
5d67986c 4186@group
d7b8e6c6
EZ
41871: 13.613 1: 33.36554
4188 . .
4189
4190 r 2 V R + t 5 r 1 r 2 V M * V R + t 6
d7b8e6c6 4191@end group
5d67986c 4192@end smallexample
d7b8e6c6
EZ
4193
4194@ifinfo
4195@noindent
4196These are @samp{sum(x)}, @samp{sum(x^2)}, @samp{sum(y)}, and @samp{sum(x y)},
4197respectively. (We could have used @kbd{*} to compute @samp{sum(x^2)} and
4198@samp{sum(x y)}.)
4199@end ifinfo
4200@tex
4201\turnoffactive
4202These are $\sum x$, $\sum x^2$, $\sum y$, and $\sum x y$,
4203respectively. (We could have used \kbd{*} to compute $\sum x^2$ and
4204$\sum x y$.)
4205@end tex
4206
a4231b04 4207Finally, we also need @expr{N}, the number of data points. This is just
d7b8e6c6
EZ
4208the length of either of our lists.
4209
d7b8e6c6 4210@smallexample
5d67986c 4211@group
d7b8e6c6
EZ
42121: 19
4213 .
4214
4215 r 1 v l t 7
d7b8e6c6 4216@end group
5d67986c 4217@end smallexample
d7b8e6c6
EZ
4218
4219@noindent
4220(That's @kbd{v} followed by a lower-case @kbd{l}.)
4221
4222Now we grind through the formula:
4223
d7b8e6c6 4224@smallexample
5d67986c 4225@group
d7b8e6c6
EZ
42261: 633.94526 2: 633.94526 1: 67.23607
4227 . 1: 566.70919 .
4228 .
4229
4230 r 7 r 6 * r 3 r 5 * -
4231
d7b8e6c6 4232@end group
5d67986c 4233@end smallexample
d7b8e6c6 4234@noindent
d7b8e6c6 4235@smallexample
5d67986c 4236@group
d7b8e6c6
EZ
42372: 67.23607 3: 67.23607 2: 67.23607 1: 0.52141679
42381: 1862.0057 2: 1862.0057 1: 128.9488 .
4239 . 1: 1733.0569 .
4240 .
4241
4242 r 7 r 4 * r 3 2 ^ - / t 8
d7b8e6c6 4243@end group
5d67986c 4244@end smallexample
d7b8e6c6 4245
a4231b04 4246That gives us the slope @expr{m}. The y-intercept @expr{b} can now
d7b8e6c6
EZ
4247be found with the simple formula,
4248
4249@ifinfo
4250@example
4251b = (sum(y) - m sum(x)) / N
4252@end example
4253@end ifinfo
4254@tex
4255\turnoffactive
4256\beforedisplay
4257$$ b = {\sum y - m \sum x \over N} $$
4258\afterdisplay
4259\vskip10pt
4260@end tex
4261
d7b8e6c6 4262@smallexample
5d67986c 4263@group
d7b8e6c6
EZ
42641: 13.613 2: 13.613 1: -8.09358 1: -0.425978
4265 . 1: 21.70658 . .
4266 .
4267
4268 r 5 r 8 r 3 * - r 7 / t 9
d7b8e6c6 4269@end group
5d67986c 4270@end smallexample
d7b8e6c6 4271
a4231b04 4272Let's ``plot'' this straight line approximation,
8e04863e 4273@texline @math{y \approx m x + b},
a4231b04
JB
4274@infoline @expr{m x + b},
4275and compare it with the original data.
d7b8e6c6 4276
d7b8e6c6 4277@smallexample
5d67986c 4278@group
d7b8e6c6
EZ
42791: [0.699, 0.735, ... ] 1: [0.273, 0.309, ... ]
4280 . .
4281
4282 r 1 r 8 * r 9 + s 0
d7b8e6c6 4283@end group
5d67986c 4284@end smallexample
d7b8e6c6
EZ
4285
4286@noindent
4287Notice that multiplying a vector by a constant, and adding a constant
4288to a vector, can be done without mapping commands since these are
4289common operations from vector algebra. As far as Calc is concerned,
4290we've just been doing geometry in 19-dimensional space!
4291
a4231b04 4292We can subtract this vector from our original @expr{y} vector to get
d7b8e6c6
EZ
4293a feel for the error of our fit. Let's find the maximum error:
4294
d7b8e6c6 4295@smallexample
5d67986c 4296@group
d7b8e6c6
EZ
42971: [0.0387, 0.0112, ... ] 1: [0.0387, 0.0112, ... ] 1: 0.0897
4298 . . .
4299
4300 r 2 - V M A V R X
d7b8e6c6 4301@end group
5d67986c 4302@end smallexample
d7b8e6c6
EZ
4303
4304@noindent
4305First we compute a vector of differences, then we take the absolute
4306values of these differences, then we reduce the @code{max} function
4307across the vector. (The @code{max} function is on the two-key sequence
4308@kbd{f x}; because it is so common to use @code{max} in a vector
4309operation, the letters @kbd{X} and @kbd{N} are also accepted for
4310@code{max} and @code{min} in this context. In general, you answer
4311the @kbd{V M} or @kbd{V R} prompt with the actual key sequence that
4312invokes the function you want. You could have typed @kbd{V R f x} or
4313even @kbd{V R x max @key{RET}} if you had preferred.)
4314
4315If your system has the GNUPLOT program, you can see graphs of your
4316data and your straight line to see how well they match. (If you have
4317GNUPLOT 3.0, the following instructions will work regardless of the
4318kind of display you have. Some GNUPLOT 2.0, non-X-windows systems
4319may require additional steps to view the graphs.)
4320
5d67986c 4321Let's start by plotting the original data. Recall the ``@var{x}'' and ``@var{y}''
d7b8e6c6
EZ
4322vectors onto the stack and press @kbd{g f}. This ``fast'' graphing
4323command does everything you need to do for simple, straightforward
4324plotting of data.
4325
d7b8e6c6 4326@smallexample
5d67986c 4327@group
d7b8e6c6
EZ
43282: [1.34, 1.41, 1.49, ... ]
43291: [0.234, 0.298, 0.402, ... ]
4330 .
4331
4332 r 1 r 2 g f
d7b8e6c6 4333@end group
5d67986c 4334@end smallexample
d7b8e6c6
EZ
4335
4336If all goes well, you will shortly get a new window containing a graph
4337of the data. (If not, contact your GNUPLOT or Calc installer to find
4338out what went wrong.) In the X window system, this will be a separate
4339graphics window. For other kinds of displays, the default is to
4340display the graph in Emacs itself using rough character graphics.
4341Press @kbd{q} when you are done viewing the character graphics.
4342
2fcdfa83
JB
4343Next, let's add the line we got from our least-squares fit.
4344@ifinfo
4345(If you are reading this tutorial on-line while running Calc, typing
4346@kbd{g a} may cause the tutorial to disappear from its window and be
4347replaced by a buffer named @samp{*Gnuplot Commands*}. The tutorial
4348will reappear when you terminate GNUPLOT by typing @kbd{g q}.)
4349@end ifinfo
d7b8e6c6 4350
d7b8e6c6 4351@smallexample
5d67986c 4352@group
d7b8e6c6
EZ
43532: [1.34, 1.41, 1.49, ... ]
43541: [0.273, 0.309, 0.351, ... ]
4355 .
4356
5d67986c 4357 @key{DEL} r 0 g a g p
d7b8e6c6 4358@end group
5d67986c 4359@end smallexample
d7b8e6c6
EZ
4360
4361It's not very useful to get symbols to mark the data points on this
4362second curve; you can type @kbd{g S g p} to remove them. Type @kbd{g q}
4363when you are done to remove the X graphics window and terminate GNUPLOT.
4364
4365(@bullet{}) @strong{Exercise 2.} An earlier exercise showed how to do
4366least squares fitting to a general system of equations. Our 19 data
a4231b04
JB
4367points are really 19 equations of the form @expr{y_i = m x_i + b} for
4368different pairs of @expr{(x_i,y_i)}. Use the matrix-transpose method
4369to solve for @expr{m} and @expr{b}, duplicating the above result.
d7b8e6c6
EZ
4370@xref{List Answer 2, 2}. (@bullet{})
4371
4372@cindex Geometric mean
4373(@bullet{}) @strong{Exercise 3.} If the input data do not form a
4374rectangle, you can use @w{@kbd{M-# g}} (@code{calc-grab-region})
4375to grab the data the way Emacs normally works with regions---it reads
4376left-to-right, top-to-bottom, treating line breaks the same as spaces.
4377Use this command to find the geometric mean of the following numbers.
4378(The geometric mean is the @var{n}th root of the product of @var{n} numbers.)
4379
4380@example
43812.3 6 22 15.1 7
4382 15 14 7.5
4383 2.5
4384@end example
4385
4386@noindent
4387The @kbd{M-# g} command accepts numbers separated by spaces or commas,
4388with or without surrounding vector brackets.
4389@xref{List Answer 3, 3}. (@bullet{})
4390
4391@ifinfo
4392As another example, a theorem about binomial coefficients tells
4393us that the alternating sum of binomial coefficients
4394@var{n}-choose-0 minus @var{n}-choose-1 plus @var{n}-choose-2, and so
4395on up to @var{n}-choose-@var{n},
4396always comes out to zero. Let's verify this
a4231b04 4397for @expr{n=6}.
d7b8e6c6
EZ
4398@end ifinfo
4399@tex
4400As another example, a theorem about binomial coefficients tells
4401us that the alternating sum of binomial coefficients
4402${n \choose 0} - {n \choose 1} + {n \choose 2} - \cdots \pm {n \choose n}$
4403always comes out to zero. Let's verify this
4404for \cite{n=6}.
4405@end tex
4406
d7b8e6c6 4407@smallexample
5d67986c 4408@group
d7b8e6c6
EZ
44091: [1, 2, 3, 4, 5, 6, 7] 1: [0, 1, 2, 3, 4, 5, 6]
4410 . .
4411
5d67986c 4412 v x 7 @key{RET} 1 -
d7b8e6c6 4413
d7b8e6c6 4414@end group
5d67986c 4415@end smallexample
d7b8e6c6 4416@noindent
d7b8e6c6 4417@smallexample
5d67986c 4418@group
d7b8e6c6
EZ
44191: [1, -6, 15, -20, 15, -6, 1] 1: 0
4420 . .
4421
5d67986c 4422 V M ' (-1)^$ choose(6,$) @key{RET} V R +
d7b8e6c6 4423@end group
5d67986c 4424@end smallexample
d7b8e6c6
EZ
4425
4426The @kbd{V M '} command prompts you to enter any algebraic expression
4427to define the function to map over the vector. The symbol @samp{$}
4428inside this expression represents the argument to the function.
4429The Calculator applies this formula to each element of the vector,
4430substituting each element's value for the @samp{$} sign(s) in turn.
4431
4432To define a two-argument function, use @samp{$$} for the first
5d67986c 4433argument and @samp{$} for the second: @kbd{V M ' $$-$ @key{RET}} is
d7b8e6c6
EZ
4434equivalent to @kbd{V M -}. This is analogous to regular algebraic
4435entry, where @samp{$$} would refer to the next-to-top stack entry
5d67986c 4436and @samp{$} would refer to the top stack entry, and @kbd{' $$-$ @key{RET}}
d7b8e6c6
EZ
4437would act exactly like @kbd{-}.
4438
4439Notice that the @kbd{V M '} command has recorded two things in the
4440trail: The result, as usual, and also a funny-looking thing marked
4441@samp{oper} that represents the operator function you typed in.
4442The function is enclosed in @samp{< >} brackets, and the argument is
4443denoted by a @samp{#} sign. If there were several arguments, they
4444would be shown as @samp{#1}, @samp{#2}, and so on. (For example,
4445@kbd{V M ' $$-$} will put the function @samp{<#1 - #2>} on the
4446trail.) This object is a ``nameless function''; you can use nameless
4447@w{@samp{< >}} notation to answer the @kbd{V M '} prompt if you like.
4448Nameless function notation has the interesting, occasionally useful
4449property that a nameless function is not actually evaluated until
4450it is used. For example, @kbd{V M ' $+random(2.0)} evaluates
4451@samp{random(2.0)} once and adds that random number to all elements
4452of the vector, but @kbd{V M ' <#+random(2.0)>} evaluates the
4453@samp{random(2.0)} separately for each vector element.
4454
4455Another group of operators that are often useful with @kbd{V M} are
4456the relational operators: @kbd{a =}, for example, compares two numbers
4457and gives the result 1 if they are equal, or 0 if not. Similarly,
4458@w{@kbd{a <}} checks for one number being less than another.
4459
4460Other useful vector operations include @kbd{v v}, to reverse a
4461vector end-for-end; @kbd{V S}, to sort the elements of a vector
4462into increasing order; and @kbd{v r} and @w{@kbd{v c}}, to extract
4463one row or column of a matrix, or (in both cases) to extract one
4464element of a plain vector. With a negative argument, @kbd{v r}
4465and @kbd{v c} instead delete one row, column, or vector element.
4466
4467@cindex Divisor functions
a4231b04 4468(@bullet{}) @strong{Exercise 4.} The @expr{k}th @dfn{divisor function}
d7b8e6c6
EZ
4469@tex
4470$\sigma_k(n)$
4471@end tex
a4231b04
JB
4472is the sum of the @expr{k}th powers of all the divisors of an
4473integer @expr{n}. Figure out a method for computing the divisor
4474function for reasonably small values of @expr{n}. As a test,
d7b8e6c6
EZ
4475the 0th and 1st divisor functions of 30 are 8 and 72, respectively.
4476@xref{List Answer 4, 4}. (@bullet{})
4477
4478@cindex Square-free numbers
4479@cindex Duplicate values in a list
4480(@bullet{}) @strong{Exercise 5.} The @kbd{k f} command produces a
4481list of prime factors for a number. Sometimes it is important to
4482know that a number is @dfn{square-free}, i.e., that no prime occurs
4483more than once in its list of prime factors. Find a sequence of
4484keystrokes to tell if a number is square-free; your method should
4485leave 1 on the stack if it is, or 0 if it isn't.
4486@xref{List Answer 5, 5}. (@bullet{})
4487
4488@cindex Triangular lists
4489(@bullet{}) @strong{Exercise 6.} Build a list of lists that looks
4490like the following diagram. (You may wish to use the @kbd{v /}
4491command to enable multi-line display of vectors.)
4492
d7b8e6c6 4493@smallexample
5d67986c 4494@group
d7b8e6c6
EZ
44951: [ [1],
4496 [1, 2],
4497 [1, 2, 3],
4498 [1, 2, 3, 4],
4499 [1, 2, 3, 4, 5],
4500 [1, 2, 3, 4, 5, 6] ]
d7b8e6c6 4501@end group
5d67986c 4502@end smallexample
d7b8e6c6
EZ
4503
4504@noindent
4505@xref{List Answer 6, 6}. (@bullet{})
4506
4507(@bullet{}) @strong{Exercise 7.} Build the following list of lists.
4508
d7b8e6c6 4509@smallexample
5d67986c 4510@group
d7b8e6c6
EZ
45111: [ [0],
4512 [1, 2],
4513 [3, 4, 5],
4514 [6, 7, 8, 9],
4515 [10, 11, 12, 13, 14],
4516 [15, 16, 17, 18, 19, 20] ]
d7b8e6c6 4517@end group
5d67986c 4518@end smallexample
d7b8e6c6
EZ
4519
4520@noindent
4521@xref{List Answer 7, 7}. (@bullet{})
4522
4523@cindex Maximizing a function over a list of values
4524@c [fix-ref Numerical Solutions]
4525(@bullet{}) @strong{Exercise 8.} Compute a list of values of Bessel's
8e04863e 4526@texline @math{J_1(x)}
a4231b04
JB
4527@infoline @expr{J1}
4528function @samp{besJ(1,x)} for @expr{x} from 0 to 5 in steps of 0.25.
4529Find the value of @expr{x} (from among the above set of values) for
d7b8e6c6
EZ
4530which @samp{besJ(1,x)} is a maximum. Use an ``automatic'' method,
4531i.e., just reading along the list by hand to find the largest value
4532is not allowed! (There is an @kbd{a X} command which does this kind
4533of thing automatically; @pxref{Numerical Solutions}.)
a4231b04 4534@xref{List Answer 8, 8}. (@bullet{})
d7b8e6c6
EZ
4535
4536@cindex Digits, vectors of
4537(@bullet{}) @strong{Exercise 9.} You are given an integer in the range
8e04863e 4538@texline @math{0 \le N < 10^m}
a4231b04
JB
4539@infoline @expr{0 <= N < 10^m}
4540for @expr{m=12} (i.e., an integer of less than
4541twelve digits). Convert this integer into a vector of @expr{m}
d7b8e6c6 4542digits, each in the range from 0 to 9. In vector-of-digits notation,
a4231b04 4543add one to this integer to produce a vector of @expr{m+1} digits
d7b8e6c6
EZ
4544(since there could be a carry out of the most significant digit).
4545Convert this vector back into a regular integer. A good integer
4546to try is 25129925999. @xref{List Answer 9, 9}. (@bullet{})
4547
4548(@bullet{}) @strong{Exercise 10.} Your friend Joe tried to use
4549@kbd{V R a =} to test if all numbers in a list were equal. What
4550happened? How would you do this test? @xref{List Answer 10, 10}. (@bullet{})
4551
4552(@bullet{}) @strong{Exercise 11.} The area of a circle of radius one
a4231b04 4553is @cpi{}. The area of the
8e04863e 4554@texline @math{2\times2}
a4231b04
JB
4555@infoline 2x2
4556square that encloses that circle is 4. So if we throw @var{n} darts at
4557random points in the square, about @cpiover{4} of them will land inside
4558the circle. This gives us an entertaining way to estimate the value of
4559@cpi{}. The @w{@kbd{k r}}
d7b8e6c6 4560command picks a random number between zero and the value on the stack.
8e04863e 4561We could get a random floating-point number between @mathit{-1} and 1 by typing
a4231b04 4562@w{@kbd{2.0 k r 1 -}}. Build a vector of 100 random @expr{(x,y)} points in
d7b8e6c6
EZ
4563this square, then use vector mapping and reduction to count how many
4564points lie inside the unit circle. Hint: Use the @kbd{v b} command.
4565@xref{List Answer 11, 11}. (@bullet{})
4566
4567@cindex Matchstick problem
4568(@bullet{}) @strong{Exercise 12.} The @dfn{matchstick problem} provides
a4231b04 4569another way to calculate @cpi{}. Say you have an infinite field
d7b8e6c6
EZ
4570of vertical lines with a spacing of one inch. Toss a one-inch matchstick
4571onto the field. The probability that the matchstick will land crossing
a4231b04 4572a line turns out to be
8e04863e 4573@texline @math{2/\pi}.
a4231b04
JB
4574@infoline @expr{2/pi}.
4575Toss 100 matchsticks to estimate @cpi{}. (If you want still more fun,
4576the probability that the GCD (@w{@kbd{k g}}) of two large integers is
4577one turns out to be
8e04863e 4578@texline @math{6/\pi^2}.
a4231b04
JB
4579@infoline @expr{6/pi^2}.
4580That provides yet another way to estimate @cpi{}.)
d7b8e6c6
EZ
4581@xref{List Answer 12, 12}. (@bullet{})
4582
4583(@bullet{}) @strong{Exercise 13.} An algebraic entry of a string in
4584double-quote marks, @samp{"hello"}, creates a vector of the numerical
a4231b04 4585(ASCII) codes of the characters (here, @expr{[104, 101, 108, 108, 111]}).
d7b8e6c6
EZ
4586Sometimes it is convenient to compute a @dfn{hash code} of a string,
4587which is just an integer that represents the value of that string.
4588Two equal strings have the same hash code; two different strings
4589@dfn{probably} have different hash codes. (For example, Calc has
4590over 400 function names, but Emacs can quickly find the definition for
4591any given name because it has sorted the functions into ``buckets'' by
4592their hash codes. Sometimes a few names will hash into the same bucket,
4593but it is easier to search among a few names than among all the names.)
a4231b04
JB
4594One popular hash function is computed as follows: First set @expr{h = 0}.
4595Then, for each character from the string in turn, set @expr{h = 3h + c_i}
4596where @expr{c_i} is the character's ASCII code. If we have 511 buckets,
d7b8e6c6
EZ
4597we then take the hash code modulo 511 to get the bucket number. Develop a
4598simple command or commands for converting string vectors into hash codes.
4599The hash code for @samp{"Testing, 1, 2, 3"} is 1960915098, which modulo
4600511 is 121. @xref{List Answer 13, 13}. (@bullet{})
4601
4602(@bullet{}) @strong{Exercise 14.} The @kbd{H V R} and @kbd{H V U}
4603commands do nested function evaluations. @kbd{H V U} takes a starting
4604value and a number of steps @var{n} from the stack; it then applies the
4605function you give to the starting value 0, 1, 2, up to @var{n} times
4606and returns a vector of the results. Use this command to create a
4607``random walk'' of 50 steps. Start with the two-dimensional point
8e04863e 4608@expr{(0,0)}; then take one step a random distance between @mathit{-1} and 1
a4231b04 4609in both @expr{x} and @expr{y}; then take another step, and so on. Use the
d7b8e6c6
EZ
4610@kbd{g f} command to display this random walk. Now modify your random
4611walk to walk a unit distance, but in a random direction, at each step.
4612(Hint: The @code{sincos} function returns a vector of the cosine and
4613sine of an angle.) @xref{List Answer 14, 14}. (@bullet{})
4614
4615@node Types Tutorial, Algebra Tutorial, Vector/Matrix Tutorial, Tutorial
4616@section Types Tutorial
4617
4618@noindent
4619Calc understands a variety of data types as well as simple numbers.
4620In this section, we'll experiment with each of these types in turn.
4621
4622The numbers we've been using so far have mainly been either @dfn{integers}
4623or @dfn{floats}. We saw that floats are usually a good approximation to
4624the mathematical concept of real numbers, but they are only approximations
4625and are susceptible to roundoff error. Calc also supports @dfn{fractions},
4626which can exactly represent any rational number.
4627
d7b8e6c6 4628@smallexample
5d67986c 4629@group
d7b8e6c6
EZ
46301: 3628800 2: 3628800 1: 518400:7 1: 518414:7 1: 7:518414
4631 . 1: 49 . . .
4632 .
4633
5d67986c 4634 10 ! 49 @key{RET} : 2 + &
d7b8e6c6 4635@end group
5d67986c 4636@end smallexample
d7b8e6c6
EZ
4637
4638@noindent
4639The @kbd{:} command divides two integers to get a fraction; @kbd{/}
4640would normally divide integers to get a floating-point result.
4641Notice we had to type @key{RET} between the @kbd{49} and the @kbd{:}
4642since the @kbd{:} would otherwise be interpreted as part of a
4643fraction beginning with 49.
4644
4645You can convert between floating-point and fractional format using
4646@kbd{c f} and @kbd{c F}:
4647
d7b8e6c6 4648@smallexample
5d67986c 4649@group
d7b8e6c6
EZ
46501: 1.35027217629e-5 1: 7:518414
4651 . .
4652
4653 c f c F
d7b8e6c6 4654@end group
5d67986c 4655@end smallexample
d7b8e6c6
EZ
4656
4657The @kbd{c F} command replaces a floating-point number with the
4658``simplest'' fraction whose floating-point representation is the
4659same, to within the current precision.
4660
d7b8e6c6 4661@smallexample
5d67986c 4662@group
d7b8e6c6
EZ
46631: 3.14159265359 1: 1146408:364913 1: 3.1416 1: 355:113
4664 . . . .
4665
5d67986c 4666 P c F @key{DEL} p 5 @key{RET} P c F
d7b8e6c6 4667@end group
5d67986c 4668@end smallexample
d7b8e6c6
EZ
4669
4670(@bullet{}) @strong{Exercise 1.} A calculation has produced the
4671result 1.26508260337. You suspect it is the square root of the
a4231b04 4672product of @cpi{} and some rational number. Is it? (Be sure
d7b8e6c6
EZ
4673to allow for roundoff error!) @xref{Types Answer 1, 1}. (@bullet{})
4674
4675@dfn{Complex numbers} can be stored in both rectangular and polar form.
4676
d7b8e6c6 4677@smallexample
5d67986c 4678@group
d7b8e6c6
EZ
46791: -9 1: (0, 3) 1: (3; 90.) 1: (6; 90.) 1: (2.4495; 45.)
4680 . . . . .
4681
4682 9 n Q c p 2 * Q
d7b8e6c6 4683@end group
5d67986c 4684@end smallexample
d7b8e6c6
EZ
4685
4686@noindent
8e04863e 4687The square root of @mathit{-9} is by default rendered in rectangular form
a4231b04 4688(@w{@expr{0 + 3i}}), but we can convert it to polar form (3 with a
d7b8e6c6
EZ
4689phase angle of 90 degrees). All the usual arithmetic and scientific
4690operations are defined on both types of complex numbers.
4691
4692Another generalized kind of number is @dfn{infinity}. Infinity
4693isn't really a number, but it can sometimes be treated like one.
4694Calc uses the symbol @code{inf} to represent positive infinity,
4695i.e., a value greater than any real number. Naturally, you can
4696also write @samp{-inf} for minus infinity, a value less than any
4697real number. The word @code{inf} can only be input using
4698algebraic entry.
4699
d7b8e6c6 4700@smallexample
5d67986c 4701@group
d7b8e6c6
EZ
47022: inf 2: -inf 2: -inf 2: -inf 1: nan
47031: -17 1: -inf 1: -inf 1: inf .
4704 . . . .
4705
5d67986c 4706' inf @key{RET} 17 n * @key{RET} 72 + A +
d7b8e6c6 4707@end group
5d67986c 4708@end smallexample
d7b8e6c6
EZ
4709
4710@noindent
4711Since infinity is infinitely large, multiplying it by any finite
8e04863e 4712number (like @mathit{-17}) has no effect, except that since @mathit{-17}
d7b8e6c6 4713is negative, it changes a plus infinity to a minus infinity.
8e04863e 4714(``A huge positive number, multiplied by @mathit{-17}, yields a huge
d7b8e6c6
EZ
4715negative number.'') Adding any finite number to infinity also
4716leaves it unchanged. Taking an absolute value gives us plus
4717infinity again. Finally, we add this plus infinity to the minus
4718infinity we had earlier. If you work it out, you might expect
8e04863e 4719the answer to be @mathit{-72} for this. But the 72 has been completely
d7b8e6c6 4720lost next to the infinities; by the time we compute @w{@samp{inf - inf}}
28665d46 4721the finite difference between them, if any, is undetectable.
d7b8e6c6
EZ
4722So we say the result is @dfn{indeterminate}, which Calc writes
4723with the symbol @code{nan} (for Not A Number).
4724
4725Dividing by zero is normally treated as an error, but you can get
4726Calc to write an answer in terms of infinity by pressing @kbd{m i}
07ce2eb3 4727to turn on Infinite mode.
d7b8e6c6 4728
d7b8e6c6 4729@smallexample
5d67986c 4730@group
d7b8e6c6
EZ
47313: nan 2: nan 2: nan 2: nan 1: nan
47322: 1 1: 1 / 0 1: uinf 1: uinf .
47331: 0 . . .
4734 .
4735
5d67986c 4736 1 @key{RET} 0 / m i U / 17 n * +
d7b8e6c6 4737@end group
5d67986c 4738@end smallexample
d7b8e6c6
EZ
4739
4740@noindent
4741Dividing by zero normally is left unevaluated, but after @kbd{m i}
4742it instead gives an infinite result. The answer is actually
4743@code{uinf}, ``undirected infinity.'' If you look at a graph of
a4231b04 4744@expr{1 / x} around @w{@expr{x = 0}}, you'll see that it goes toward
d7b8e6c6 4745plus infinity as you approach zero from above, but toward minus
a4231b04 4746infinity as you approach from below. Since we said only @expr{1 / 0},
d7b8e6c6
EZ
4747Calc knows that the answer is infinite but not in which direction.
4748That's what @code{uinf} means. Notice that multiplying @code{uinf}
4749by a negative number still leaves plain @code{uinf}; there's no
4750point in saying @samp{-uinf} because the sign of @code{uinf} is
4751unknown anyway. Finally, we add @code{uinf} to our @code{nan},
4752yielding @code{nan} again. It's easy to see that, because
4753@code{nan} means ``totally unknown'' while @code{uinf} means
4754``unknown sign but known to be infinite,'' the more mysterious
4755@code{nan} wins out when it is combined with @code{uinf}, or, for
4756that matter, with anything else.
4757
4758(@bullet{}) @strong{Exercise 2.} Predict what Calc will answer
4759for each of these formulas: @samp{inf / inf}, @samp{exp(inf)},
4760@samp{exp(-inf)}, @samp{sqrt(-inf)}, @samp{sqrt(uinf)},
4761@samp{abs(uinf)}, @samp{ln(0)}.
4762@xref{Types Answer 2, 2}. (@bullet{})
4763
4764(@bullet{}) @strong{Exercise 3.} We saw that @samp{inf - inf = nan},
4765which stands for an unknown value. Can @code{nan} stand for
4766a complex number? Can it stand for infinity?
4767@xref{Types Answer 3, 3}. (@bullet{})
4768
4769@dfn{HMS forms} represent a value in terms of hours, minutes, and
4770seconds.
4771
d7b8e6c6 4772@smallexample
5d67986c 4773@group
d7b8e6c6
EZ
47741: 2@@ 30' 0" 1: 3@@ 30' 0" 2: 3@@ 30' 0" 1: 2.
4775 . . 1: 1@@ 45' 0." .
4776 .
4777
5d67986c 4778 2@@ 30' @key{RET} 1 + @key{RET} 2 / /
d7b8e6c6 4779@end group
5d67986c 4780@end smallexample
d7b8e6c6
EZ
4781
4782HMS forms can also be used to hold angles in degrees, minutes, and
4783seconds.
4784
d7b8e6c6 4785@smallexample
5d67986c 4786@group
d7b8e6c6
EZ
47871: 0.5 1: 26.56505 1: 26@@ 33' 54.18" 1: 0.44721
4788 . . . .
4789
4790 0.5 I T c h S
d7b8e6c6 4791@end group
5d67986c 4792@end smallexample
d7b8e6c6
EZ
4793
4794@noindent
4795First we convert the inverse tangent of 0.5 to degrees-minutes-seconds
4796form, then we take the sine of that angle. Note that the trigonometric
4797functions will accept HMS forms directly as input.
4798
4799@cindex Beatles
4800(@bullet{}) @strong{Exercise 4.} The Beatles' @emph{Abbey Road} is
480147 minutes and 26 seconds long, and contains 17 songs. What is the
4802average length of a song on @emph{Abbey Road}? If the Extended Disco
4803Version of @emph{Abbey Road} added 20 seconds to the length of each
4804song, how long would the album be? @xref{Types Answer 4, 4}. (@bullet{})
4805
4806A @dfn{date form} represents a date, or a date and time. Dates must
4807be entered using algebraic entry. Date forms are surrounded by
4808@samp{< >} symbols; most standard formats for dates are recognized.
4809
d7b8e6c6 4810@smallexample
5d67986c 4811@group
d7b8e6c6
EZ
48122: <Sun Jan 13, 1991> 1: 2.25
48131: <6:00pm Thu Jan 10, 1991> .
4814 .
4815
5d67986c 4816' <13 Jan 1991>, <1/10/91, 6pm> @key{RET} -
d7b8e6c6 4817@end group
5d67986c 4818@end smallexample
d7b8e6c6
EZ
4819
4820@noindent
4821In this example, we enter two dates, then subtract to find the
4822number of days between them. It is also possible to add an
4823HMS form or a number (of days) to a date form to get another
4824date form.
4825
d7b8e6c6 4826@smallexample
5d67986c 4827@group
d7b8e6c6
EZ
48281: <4:45:59pm Mon Jan 14, 1991> 1: <2:50:59am Thu Jan 17, 1991>
4829 . .
4830
4831 t N 2 + 10@@ 5' +
d7b8e6c6 4832@end group
5d67986c 4833@end smallexample
d7b8e6c6
EZ
4834
4835@c [fix-ref Date Arithmetic]
4836@noindent
4837The @kbd{t N} (``now'') command pushes the current date and time on the
4838stack; then we add two days, ten hours and five minutes to the date and
4839time. Other date-and-time related commands include @kbd{t J}, which
4840does Julian day conversions, @kbd{t W}, which finds the beginning of
4841the week in which a date form lies, and @kbd{t I}, which increments a
4842date by one or several months. @xref{Date Arithmetic}, for more.
4843
4844(@bullet{}) @strong{Exercise 5.} How many days until the next
4845Friday the 13th? @xref{Types Answer 5, 5}. (@bullet{})
4846
4847(@bullet{}) @strong{Exercise 6.} How many leap years will there be
4848between now and the year 10001 A.D.? @xref{Types Answer 6, 6}. (@bullet{})
4849
4850@cindex Slope and angle of a line
4851@cindex Angle and slope of a line
4852An @dfn{error form} represents a mean value with an attached standard
4853deviation, or error estimate. Suppose our measurements indicate that
4854a certain telephone pole is about 30 meters away, with an estimated
4855error of 1 meter, and 8 meters tall, with an estimated error of 0.2
4856meters. What is the slope of a line from here to the top of the
4857pole, and what is the equivalent angle in degrees?
4858
d7b8e6c6 4859@smallexample
5d67986c 4860@group
d7b8e6c6
EZ
48611: 8 +/- 0.2 2: 8 +/- 0.2 1: 0.266 +/- 0.011 1: 14.93 +/- 0.594
4862 . 1: 30 +/- 1 . .
4863 .
4864
5d67986c 4865 8 p .2 @key{RET} 30 p 1 / I T
d7b8e6c6 4866@end group
5d67986c 4867@end smallexample
d7b8e6c6
EZ
4868
4869@noindent
4870This means that the angle is about 15 degrees, and, assuming our
4871original error estimates were valid standard deviations, there is about
4872a 60% chance that the result is correct within 0.59 degrees.
4873
4874@cindex Torus, volume of
4875(@bullet{}) @strong{Exercise 7.} The volume of a torus (a donut shape) is
8e04863e 4876@texline @math{2 \pi^2 R r^2}
a4231b04
JB
4877@infoline @w{@expr{2 pi^2 R r^2}}
4878where @expr{R} is the radius of the circle that
4879defines the center of the tube and @expr{r} is the radius of the tube
4880itself. Suppose @expr{R} is 20 cm and @expr{r} is 4 cm, each known to
d7b8e6c6
EZ
4881within 5 percent. What is the volume and the relative uncertainty of
4882the volume? @xref{Types Answer 7, 7}. (@bullet{})
4883
4884An @dfn{interval form} represents a range of values. While an
4885error form is best for making statistical estimates, intervals give
4886you exact bounds on an answer. Suppose we additionally know that
4887our telephone pole is definitely between 28 and 31 meters away,
4888and that it is between 7.7 and 8.1 meters tall.
4889
d7b8e6c6 4890@smallexample
5d67986c 4891@group
d7b8e6c6
EZ
48921: [7.7 .. 8.1] 2: [7.7 .. 8.1] 1: [0.24 .. 0.28] 1: [13.9 .. 16.1]
4893 . 1: [28 .. 31] . .
4894 .
4895
4896 [ 7.7 .. 8.1 ] [ 28 .. 31 ] / I T
d7b8e6c6 4897@end group
5d67986c 4898@end smallexample
d7b8e6c6
EZ
4899
4900@noindent
4901If our bounds were correct, then the angle to the top of the pole
4902is sure to lie in the range shown.
4903
4904The square brackets around these intervals indicate that the endpoints
4905themselves are allowable values. In other words, the distance to the
4906telephone pole is between 28 and 31, @emph{inclusive}. You can also
4907make an interval that is exclusive of its endpoints by writing
4908parentheses instead of square brackets. You can even make an interval
4909which is inclusive (``closed'') on one end and exclusive (``open'') on
4910the other.
4911
d7b8e6c6 4912@smallexample
5d67986c 4913@group
d7b8e6c6
EZ
49141: [1 .. 10) 1: (0.1 .. 1] 2: (0.1 .. 1] 1: (0.2 .. 3)
4915 . . 1: [2 .. 3) .
4916 .
4917
4918 [ 1 .. 10 ) & [ 2 .. 3 ) *
d7b8e6c6 4919@end group
5d67986c 4920@end smallexample
d7b8e6c6
EZ
4921
4922@noindent
4923The Calculator automatically keeps track of which end values should
4924be open and which should be closed. You can also make infinite or
4925semi-infinite intervals by using @samp{-inf} or @samp{inf} for one
4926or both endpoints.
4927
4928(@bullet{}) @strong{Exercise 8.} What answer would you expect from
4929@samp{@w{1 /} @w{(0 .. 10)}}? What about @samp{@w{1 /} @w{(-10 .. 0)}}? What
4930about @samp{@w{1 /} @w{[0 .. 10]}} (where the interval actually includes
4931zero)? What about @samp{@w{1 /} @w{(-10 .. 10)}}?
4932@xref{Types Answer 8, 8}. (@bullet{})
4933
4934(@bullet{}) @strong{Exercise 9.} Two easy ways of squaring a number
5d67986c 4935are @kbd{@key{RET} *} and @w{@kbd{2 ^}}. Normally these produce the same
d7b8e6c6
EZ
4936answer. Would you expect this still to hold true for interval forms?
4937If not, which of these will result in a larger interval?
4938@xref{Types Answer 9, 9}. (@bullet{})
4939
5d67986c 4940A @dfn{modulo form} is used for performing arithmetic modulo @var{m}.
d7b8e6c6
EZ
4941For example, arithmetic involving time is generally done modulo 12
4942or 24 hours.
4943
d7b8e6c6 4944@smallexample
5d67986c 4945@group
d7b8e6c6
EZ
49461: 17 mod 24 1: 3 mod 24 1: 21 mod 24 1: 9 mod 24
4947 . . . .
4948
5d67986c 4949 17 M 24 @key{RET} 10 + n 5 /
d7b8e6c6 4950@end group
5d67986c 4951@end smallexample
d7b8e6c6
EZ
4952
4953@noindent
e9a2654a
JB
4954In this last step, Calc has divided by 5 modulo 24; i.e., it has found a
4955new number which, when multiplied by 5 modulo 24, produces the original
4956number, 21. If @var{m} is prime and the divisor is not a multiple of
4957@var{m}, it is always possible to find such a number. For non-prime
4958@var{m} like 24, it is only sometimes possible.
d7b8e6c6 4959
d7b8e6c6 4960@smallexample
5d67986c 4961@group
d7b8e6c6
EZ
49621: 10 mod 24 1: 16 mod 24 1: 1000000... 1: 16
4963 . . . .
4964
5d67986c 4965 10 M 24 @key{RET} 100 ^ 10 @key{RET} 100 ^ 24 %
d7b8e6c6 4966@end group
5d67986c 4967@end smallexample
d7b8e6c6
EZ
4968
4969@noindent
4970These two calculations get the same answer, but the first one is
4971much more efficient because it avoids the huge intermediate value
4972that arises in the second one.
4973
4974@cindex Fermat, primality test of
4975(@bullet{}) @strong{Exercise 10.} A theorem of Pierre de Fermat
a4231b04 4976says that
8e04863e 4977@texline @w{@math{x^{n-1} \bmod n = 1}}
a4231b04
JB
4978@infoline @expr{x^(n-1) mod n = 1}
4979if @expr{n} is a prime number and @expr{x} is an integer less than
4980@expr{n}. If @expr{n} is @emph{not} a prime number, this will
4981@emph{not} be true for most values of @expr{x}. Thus we can test
4982informally if a number is prime by trying this formula for several
4983values of @expr{x}. Use this test to tell whether the following numbers
4984are prime: 811749613, 15485863. @xref{Types Answer 10, 10}. (@bullet{})
d7b8e6c6
EZ
4985
4986It is possible to use HMS forms as parts of error forms, intervals,
4987modulo forms, or as the phase part of a polar complex number.
4988For example, the @code{calc-time} command pushes the current time
4989of day on the stack as an HMS/modulo form.
4990
d7b8e6c6 4991@smallexample
5d67986c 4992@group
d7b8e6c6
EZ
49931: 17@@ 34' 45" mod 24@@ 0' 0" 1: 6@@ 22' 15" mod 24@@ 0' 0"
4994 . .
4995
5d67986c 4996 x time @key{RET} n
d7b8e6c6 4997@end group
5d67986c 4998@end smallexample
d7b8e6c6
EZ
4999
5000@noindent
5001This calculation tells me it is six hours and 22 minutes until midnight.
5002
5003(@bullet{}) @strong{Exercise 11.} A rule of thumb is that one year
a4231b04 5004is about
8e04863e 5005@texline @math{\pi \times 10^7}
a4231b04
JB
5006@infoline @w{@expr{pi * 10^7}}
5007seconds. What time will it be that many seconds from right now?
5008@xref{Types Answer 11, 11}. (@bullet{})
d7b8e6c6
EZ
5009
5010(@bullet{}) @strong{Exercise 12.} You are preparing to order packaging
5011for the CD release of the Extended Disco Version of @emph{Abbey Road}.
5012You are told that the songs will actually be anywhere from 20 to 60
5013seconds longer than the originals. One CD can hold about 75 minutes
5014of music. Should you order single or double packages?
5015@xref{Types Answer 12, 12}. (@bullet{})
5016
5017Another kind of data the Calculator can manipulate is numbers with
5018@dfn{units}. This isn't strictly a new data type; it's simply an
5019application of algebraic expressions, where we use variables with
5020suggestive names like @samp{cm} and @samp{in} to represent units
5021like centimeters and inches.
5022
d7b8e6c6 5023@smallexample
5d67986c 5024@group
d7b8e6c6
EZ
50251: 2 in 1: 5.08 cm 1: 0.027778 fath 1: 0.0508 m
5026 . . . .
5027
5d67986c 5028 ' 2in @key{RET} u c cm @key{RET} u c fath @key{RET} u b
d7b8e6c6 5029@end group
5d67986c 5030@end smallexample
d7b8e6c6
EZ
5031
5032@noindent
5033We enter the quantity ``2 inches'' (actually an algebraic expression
5034which means two times the variable @samp{in}), then we convert it
5035first to centimeters, then to fathoms, then finally to ``base'' units,
5036which in this case means meters.
5037
d7b8e6c6 5038@smallexample
5d67986c 5039@group
d7b8e6c6
EZ
50401: 9 acre 1: 3 sqrt(acre) 1: 190.84 m 1: 190.84 m + 30 cm
5041 . . . .
5042
5d67986c 5043 ' 9 acre @key{RET} Q u s ' $+30 cm @key{RET}
d7b8e6c6 5044
d7b8e6c6 5045@end group
5d67986c 5046@end smallexample
d7b8e6c6 5047@noindent
d7b8e6c6 5048@smallexample
5d67986c 5049@group
d7b8e6c6
EZ
50501: 191.14 m 1: 36536.3046 m^2 1: 365363046 cm^2
5051 . . .
5052
5053 u s 2 ^ u c cgs
d7b8e6c6 5054@end group
5d67986c 5055@end smallexample
d7b8e6c6
EZ
5056
5057@noindent
5058Since units expressions are really just formulas, taking the square
5059root of @samp{acre} is undefined. After all, @code{acre} might be an
5060algebraic variable that you will someday assign a value. We use the
5061``units-simplify'' command to simplify the expression with variables
5062being interpreted as unit names.
5063
5064In the final step, we have converted not to a particular unit, but to a
5065units system. The ``cgs'' system uses centimeters instead of meters
5066as its standard unit of length.
5067
5068There is a wide variety of units defined in the Calculator.
5069
d7b8e6c6 5070@smallexample
5d67986c 5071@group
d7b8e6c6
EZ
50721: 55 mph 1: 88.5139 kph 1: 88.5139 km / hr 1: 8.201407e-8 c
5073 . . . .
5074
5d67986c 5075 ' 55 mph @key{RET} u c kph @key{RET} u c km/hr @key{RET} u c c @key{RET}
d7b8e6c6 5076@end group
5d67986c 5077@end smallexample
d7b8e6c6
EZ
5078
5079@noindent
5080We express a speed first in miles per hour, then in kilometers per
5081hour, then again using a slightly more explicit notation, then
5082finally in terms of fractions of the speed of light.
5083
5084Temperature conversions are a bit more tricky. There are two ways to
5085interpret ``20 degrees Fahrenheit''---it could mean an actual
5086temperature, or it could mean a change in temperature. For normal
5087units there is no difference, but temperature units have an offset
5088as well as a scale factor and so there must be two explicit commands
5089for them.
5090
d7b8e6c6 5091@smallexample
5d67986c 5092@group
d7b8e6c6
EZ
50931: 20 degF 1: 11.1111 degC 1: -20:3 degC 1: -6.666 degC
5094 . . . .
5095
5d67986c 5096 ' 20 degF @key{RET} u c degC @key{RET} U u t degC @key{RET} c f
d7b8e6c6 5097@end group
5d67986c 5098@end smallexample
d7b8e6c6
EZ
5099
5100@noindent
5101First we convert a change of 20 degrees Fahrenheit into an equivalent
5102change in degrees Celsius (or Centigrade). Then, we convert the
5103absolute temperature 20 degrees Fahrenheit into Celsius. Since
5104this comes out as an exact fraction, we then convert to floating-point
5105for easier comparison with the other result.
5106
5107For simple unit conversions, you can put a plain number on the stack.
5108Then @kbd{u c} and @kbd{u t} will prompt for both old and new units.
5109When you use this method, you're responsible for remembering which
5110numbers are in which units:
5111
d7b8e6c6 5112@smallexample
5d67986c 5113@group
d7b8e6c6
EZ
51141: 55 1: 88.5139 1: 8.201407e-8
5115 . . .
5116
5d67986c 5117 55 u c mph @key{RET} kph @key{RET} u c km/hr @key{RET} c @key{RET}
d7b8e6c6 5118@end group
5d67986c 5119@end smallexample
d7b8e6c6
EZ
5120
5121To see a complete list of built-in units, type @kbd{u v}. Press
5122@w{@kbd{M-# c}} again to re-enter the Calculator when you're done looking
5123at the units table.
5124
5125(@bullet{}) @strong{Exercise 13.} How many seconds are there really
5126in a year? @xref{Types Answer 13, 13}. (@bullet{})
5127
5128@cindex Speed of light
5129(@bullet{}) @strong{Exercise 14.} Supercomputer designs are limited by
5130the speed of light (and of electricity, which is nearly as fast).
5131Suppose a computer has a 4.1 ns (nanosecond) clock cycle, and its
5132cabinet is one meter across. Is speed of light going to be a
5133significant factor in its design? @xref{Types Answer 14, 14}. (@bullet{})
5134
5135(@bullet{}) @strong{Exercise 15.} Sam the Slug normally travels about
5136five yards in an hour. He has obtained a supply of Power Pills; each
5137Power Pill he eats doubles his speed. How many Power Pills can he
5138swallow and still travel legally on most US highways?
5139@xref{Types Answer 15, 15}. (@bullet{})
5140
5141@node Algebra Tutorial, Programming Tutorial, Types Tutorial, Tutorial
5142@section Algebra and Calculus Tutorial
5143
5144@noindent
5145This section shows how to use Calc's algebra facilities to solve
5146equations, do simple calculus problems, and manipulate algebraic
5147formulas.
5148
5149@menu
5150* Basic Algebra Tutorial::
5151* Rewrites Tutorial::
5152@end menu
5153
5154@node Basic Algebra Tutorial, Rewrites Tutorial, Algebra Tutorial, Algebra Tutorial
5155@subsection Basic Algebra
5156
5157@noindent
07ce2eb3 5158If you enter a formula in Algebraic mode that refers to variables,
d7b8e6c6
EZ
5159the formula itself is pushed onto the stack. You can manipulate
5160formulas as regular data objects.
5161
d7b8e6c6 5162@smallexample
5d67986c 5163@group
d7b8e6c6
EZ
51641: 2 x^2 - 6 1: 6 - 2 x^2 1: (6 - 2 x^2) (3 x^2 + y)
5165 . . .
5166
5d67986c 5167 ' 2x^2-6 @key{RET} n ' 3x^2+y @key{RET} *
d7b8e6c6 5168@end group
5d67986c 5169@end smallexample
d7b8e6c6 5170
5d67986c
RS
5171(@bullet{}) @strong{Exercise 1.} Do @kbd{' x @key{RET} Q 2 ^} and
5172@kbd{' x @key{RET} 2 ^ Q} both wind up with the same result (@samp{x})?
d7b8e6c6
EZ
5173Why or why not? @xref{Algebra Answer 1, 1}. (@bullet{})
5174
5175There are also commands for doing common algebraic operations on
5176formulas. Continuing with the formula from the last example,
5177
d7b8e6c6 5178@smallexample
5d67986c 5179@group
d7b8e6c6
EZ
51801: 18 x^2 + 6 y - 6 x^4 - 2 x^2 y 1: (18 - 2 y) x^2 - 6 x^4 + 6 y
5181 . .
5182
5d67986c 5183 a x a c x @key{RET}
d7b8e6c6 5184@end group
5d67986c 5185@end smallexample
d7b8e6c6
EZ
5186
5187@noindent
5188First we ``expand'' using the distributive law, then we ``collect''
a4231b04 5189terms involving like powers of @expr{x}.
d7b8e6c6 5190
a4231b04 5191Let's find the value of this expression when @expr{x} is 2 and @expr{y}
d7b8e6c6
EZ
5192is one-half.
5193
d7b8e6c6 5194@smallexample
5d67986c 5195@group
d7b8e6c6
EZ
51961: 17 x^2 - 6 x^4 + 3 1: -25
5197 . .
5198
5d67986c 5199 1:2 s l y @key{RET} 2 s l x @key{RET}
d7b8e6c6 5200@end group
5d67986c 5201@end smallexample
d7b8e6c6
EZ
5202
5203@noindent
5204The @kbd{s l} command means ``let''; it takes a number from the top of
5205the stack and temporarily assigns it as the value of the variable
5206you specify. It then evaluates (as if by the @kbd{=} key) the
5207next expression on the stack. After this command, the variable goes
5208back to its original value, if any.
5209
5210(An earlier exercise in this tutorial involved storing a value in the
5211variable @code{x}; if this value is still there, you will have to
5d67986c 5212unstore it with @kbd{s u x @key{RET}} before the above example will work
d7b8e6c6
EZ
5213properly.)
5214
5215@cindex Maximum of a function using Calculus
a4231b04
JB
5216Let's find the maximum value of our original expression when @expr{y}
5217is one-half and @expr{x} ranges over all possible values. We can
5218do this by taking the derivative with respect to @expr{x} and examining
5219values of @expr{x} for which the derivative is zero. If the second
5220derivative of the function at that value of @expr{x} is negative,
d7b8e6c6
EZ
5221the function has a local maximum there.
5222
d7b8e6c6 5223@smallexample
5d67986c 5224@group
d7b8e6c6
EZ
52251: 17 x^2 - 6 x^4 + 3 1: 34 x - 24 x^3
5226 . .
5227
5d67986c 5228 U @key{DEL} s 1 a d x @key{RET} s 2
d7b8e6c6 5229@end group
5d67986c 5230@end smallexample
d7b8e6c6
EZ
5231
5232@noindent
a4231b04
JB
5233Well, the derivative is clearly zero when @expr{x} is zero. To find
5234the other root(s), let's divide through by @expr{x} and then solve:
d7b8e6c6 5235
d7b8e6c6 5236@smallexample
5d67986c 5237@group
d7b8e6c6
EZ
52381: (34 x - 24 x^3) / x 1: 34 x / x - 24 x^3 / x 1: 34 - 24 x^2
5239 . . .
5240
5d67986c 5241 ' x @key{RET} / a x a s
d7b8e6c6 5242
d7b8e6c6 5243@end group
5d67986c 5244@end smallexample
d7b8e6c6 5245@noindent
d7b8e6c6 5246@smallexample
5d67986c 5247@group
d7b8e6c6
EZ
52481: 34 - 24 x^2 = 0 1: x = 1.19023
5249 . .
5250
5d67986c 5251 0 a = s 3 a S x @key{RET}
d7b8e6c6 5252@end group
5d67986c 5253@end smallexample
d7b8e6c6
EZ
5254
5255@noindent
5256Notice the use of @kbd{a s} to ``simplify'' the formula. When the
5257default algebraic simplifications don't do enough, you can use
5258@kbd{a s} to tell Calc to spend more time on the job.
5259
a4231b04 5260Now we compute the second derivative and plug in our values of @expr{x}:
d7b8e6c6 5261
d7b8e6c6 5262@smallexample
5d67986c 5263@group
d7b8e6c6
EZ
52641: 1.19023 2: 1.19023 2: 1.19023
5265 . 1: 34 x - 24 x^3 1: 34 - 72 x^2
5266 . .
5267
5d67986c 5268 a . r 2 a d x @key{RET} s 4
d7b8e6c6 5269@end group
5d67986c 5270@end smallexample
d7b8e6c6
EZ
5271
5272@noindent
5273(The @kbd{a .} command extracts just the righthand side of an equation.
5274Another method would have been to use @kbd{v u} to unpack the equation
5d67986c 5275@w{@samp{x = 1.19}} to @samp{x} and @samp{1.19}, then use @kbd{M-- M-2 @key{DEL}}
d7b8e6c6
EZ
5276to delete the @samp{x}.)
5277
d7b8e6c6 5278@smallexample
5d67986c 5279@group
d7b8e6c6
EZ
52802: 34 - 72 x^2 1: -68. 2: 34 - 72 x^2 1: 34
52811: 1.19023 . 1: 0 .
5282 . .
5283
5d67986c 5284 @key{TAB} s l x @key{RET} U @key{DEL} 0 s l x @key{RET}
d7b8e6c6 5285@end group
5d67986c 5286@end smallexample
d7b8e6c6
EZ
5287
5288@noindent
5289The first of these second derivatives is negative, so we know the function
a4231b04
JB
5290has a maximum value at @expr{x = 1.19023}. (The function also has a
5291local @emph{minimum} at @expr{x = 0}.)
d7b8e6c6 5292
a4231b04
JB
5293When we solved for @expr{x}, we got only one value even though
5294@expr{34 - 24 x^2 = 0} is a quadratic equation that ought to have
d7b8e6c6
EZ
5295two solutions. The reason is that @w{@kbd{a S}} normally returns a
5296single ``principal'' solution. If it needs to come up with an
a4231b04 5297arbitrary sign (as occurs in the quadratic formula) it picks @expr{+}.
d7b8e6c6
EZ
5298If it needs an arbitrary integer, it picks zero. We can get a full
5299solution by pressing @kbd{H} (the Hyperbolic flag) before @kbd{a S}.
5300
d7b8e6c6 5301@smallexample
5d67986c 5302@group
d7b8e6c6
EZ
53031: 34 - 24 x^2 = 0 1: x = 1.19023 s1 1: x = -1.19023
5304 . . .
5305
5d67986c 5306 r 3 H a S x @key{RET} s 5 1 n s l s1 @key{RET}
d7b8e6c6 5307@end group
5d67986c 5308@end smallexample
d7b8e6c6
EZ
5309
5310@noindent
5311Calc has invented the variable @samp{s1} to represent an unknown sign;
8e04863e 5312it is supposed to be either @mathit{+1} or @mathit{-1}. Here we have used
d7b8e6c6
EZ
5313the ``let'' command to evaluate the expression when the sign is negative.
5314If we plugged this into our second derivative we would get the same,
a4231b04 5315negative, answer, so @expr{x = -1.19023} is also a maximum.
d7b8e6c6 5316
a4231b04 5317To find the actual maximum value, we must plug our two values of @expr{x}
d7b8e6c6
EZ
5318into the original formula.
5319
d7b8e6c6 5320@smallexample
5d67986c 5321@group
d7b8e6c6
EZ
53222: 17 x^2 - 6 x^4 + 3 1: 24.08333 s1^2 - 12.04166 s1^4 + 3
53231: x = 1.19023 s1 .
5324 .
5325
5d67986c 5326 r 1 r 5 s l @key{RET}
d7b8e6c6 5327@end group
5d67986c 5328@end smallexample
d7b8e6c6
EZ
5329
5330@noindent
5331(Here we see another way to use @kbd{s l}; if its input is an equation
5332with a variable on the lefthand side, then @kbd{s l} treats the equation
5333like an assignment to that variable if you don't give a variable name.)
5334
5335It's clear that this will have the same value for either sign of
5336@code{s1}, but let's work it out anyway, just for the exercise:
5337
d7b8e6c6 5338@smallexample
5d67986c 5339@group
d7b8e6c6
EZ
53402: [-1, 1] 1: [15.04166, 15.04166]
53411: 24.08333 s1^2 ... .
5342 .
5343
5d67986c 5344 [ 1 n , 1 ] @key{TAB} V M $ @key{RET}
d7b8e6c6 5345@end group
5d67986c 5346@end smallexample
d7b8e6c6
EZ
5347
5348@noindent
5349Here we have used a vector mapping operation to evaluate the function
5350at several values of @samp{s1} at once. @kbd{V M $} is like @kbd{V M '}
5351except that it takes the formula from the top of the stack. The
5352formula is interpreted as a function to apply across the vector at the
5353next-to-top stack level. Since a formula on the stack can't contain
5354@samp{$} signs, Calc assumes the variables in the formula stand for
5355different arguments. It prompts you for an @dfn{argument list}, giving
5356the list of all variables in the formula in alphabetical order as the
5357default list. In this case the default is @samp{(s1)}, which is just
5358what we want so we simply press @key{RET} at the prompt.
5359
5360If there had been several different values, we could have used
5361@w{@kbd{V R X}} to find the global maximum.
5362
5363Calc has a built-in @kbd{a P} command that solves an equation using
5364@w{@kbd{H a S}} and returns a vector of all the solutions. It simply
5365automates the job we just did by hand. Applied to our original
5366cubic polynomial, it would produce the vector of solutions
a4231b04 5367@expr{[1.19023, -1.19023, 0]}. (There is also an @kbd{a X} command
d7b8e6c6
EZ
5368which finds a local maximum of a function. It uses a numerical search
5369method rather than examining the derivatives, and thus requires you
5370to provide some kind of initial guess to show it where to look.)
5371
5372(@bullet{}) @strong{Exercise 2.} Given a vector of the roots of a
5373polynomial (such as the output of an @kbd{a P} command), what
5374sequence of commands would you use to reconstruct the original
5375polynomial? (The answer will be unique to within a constant
5376multiple; choose the solution where the leading coefficient is one.)
5377@xref{Algebra Answer 2, 2}. (@bullet{})
5378
07ce2eb3 5379The @kbd{m s} command enables Symbolic mode, in which formulas
d7b8e6c6
EZ
5380like @samp{sqrt(5)} that can't be evaluated exactly are left in
5381symbolic form rather than giving a floating-point approximate answer.
5382Fraction mode (@kbd{m f}) is also useful when doing algebra.
5383
d7b8e6c6 5384@smallexample
5d67986c 5385@group
d7b8e6c6
EZ
53862: 34 x - 24 x^3 2: 34 x - 24 x^3
53871: 34 x - 24 x^3 1: [sqrt(51) / 6, sqrt(51) / -6, 0]
5388 . .
5389
5d67986c 5390 r 2 @key{RET} m s m f a P x @key{RET}
d7b8e6c6 5391@end group
5d67986c 5392@end smallexample
d7b8e6c6 5393
07ce2eb3 5394One more mode that makes reading formulas easier is Big mode.
d7b8e6c6 5395
d7b8e6c6 5396@smallexample
5d67986c 5397@group
d7b8e6c6
EZ
5398 3
53992: 34 x - 24 x
5400
5401 ____ ____
5402 V 51 V 51
54031: [-----, -----, 0]
5404 6 -6
5405
5406 .
5407
5408 d B
d7b8e6c6 5409@end group
5d67986c 5410@end smallexample
d7b8e6c6
EZ
5411
5412Here things like powers, square roots, and quotients and fractions
5413are displayed in a two-dimensional pictorial form. Calc has other
8ed713c6 5414language modes as well, such as C mode, FORTRAN mode, @TeX{} mode
053bc283 5415and La@TeX{} mode.
d7b8e6c6 5416
d7b8e6c6 5417@smallexample
5d67986c 5418@group
d7b8e6c6
EZ
54192: 34*x - 24*pow(x, 3) 2: 34*x - 24*x**3
54201: @{sqrt(51) / 6, sqrt(51) / -6, 0@} 1: /sqrt(51) / 6, sqrt(51) / -6, 0/
5421 . .
5422
5423 d C d F
5424
d7b8e6c6 5425@end group
5d67986c 5426@end smallexample
d7b8e6c6 5427@noindent
d7b8e6c6 5428@smallexample
5d67986c 5429@group
d7b8e6c6
EZ
54303: 34 x - 24 x^3
54312: [@{\sqrt@{51@} \over 6@}, @{\sqrt@{51@} \over -6@}, 0]
54321: @{2 \over 3@} \sqrt@{5@}
5433 .
5434
5d67986c 5435 d T ' 2 \sqrt@{5@} \over 3 @key{RET}
d7b8e6c6 5436@end group
5d67986c 5437@end smallexample
d7b8e6c6
EZ
5438
5439@noindent
5440As you can see, language modes affect both entry and display of
5441formulas. They affect such things as the names used for built-in
5442functions, the set of arithmetic operators and their precedences,
5443and notations for vectors and matrices.
5444
5445Notice that @samp{sqrt(51)} may cause problems with older
5446implementations of C and FORTRAN, which would require something more
5447like @samp{sqrt(51.0)}. It is always wise to check over the formulas
5448produced by the various language modes to make sure they are fully
5449correct.
5450
5451Type @kbd{m s}, @kbd{m f}, and @kbd{d N} to reset these modes. (You
5452may prefer to remain in Big mode, but all the examples in the tutorial
5453are shown in normal mode.)
5454
5455@cindex Area under a curve
a4231b04 5456What is the area under the portion of this curve from @expr{x = 1} to @expr{2}?
d7b8e6c6
EZ
5457This is simply the integral of the function:
5458
d7b8e6c6 5459@smallexample
5d67986c 5460@group
d7b8e6c6
EZ
54611: 17 x^2 - 6 x^4 + 3 1: 5.6666 x^3 - 1.2 x^5 + 3 x
5462 . .
5463
5464 r 1 a i x
d7b8e6c6 5465@end group
5d67986c 5466@end smallexample
d7b8e6c6
EZ
5467
5468@noindent
a4231b04 5469We want to evaluate this at our two values for @expr{x} and subtract.
d7b8e6c6
EZ
5470One way to do it is again with vector mapping and reduction:
5471
d7b8e6c6 5472@smallexample
5d67986c 5473@group
d7b8e6c6
EZ
54742: [2, 1] 1: [12.93333, 7.46666] 1: 5.46666
54751: 5.6666 x^3 ... . .
5476
5d67986c 5477 [ 2 , 1 ] @key{TAB} V M $ @key{RET} V R -
d7b8e6c6 5478@end group
5d67986c 5479@end smallexample
d7b8e6c6 5480
a4231b04
JB
5481(@bullet{}) @strong{Exercise 3.} Find the integral from 1 to @expr{y}
5482of
8e04863e 5483@texline @math{x \sin \pi x}
a4231b04
JB
5484@infoline @w{@expr{x sin(pi x)}}
5485(where the sine is calculated in radians). Find the values of the
5486integral for integers @expr{y} from 1 to 5. @xref{Algebra Answer 3,
54873}. (@bullet{})
d7b8e6c6
EZ
5488
5489Calc's integrator can do many simple integrals symbolically, but many
5490others are beyond its capabilities. Suppose we wish to find the area
a4231b04 5491under the curve
8e04863e 5492@texline @math{\sin x \ln x}
a4231b04
JB
5493@infoline @expr{sin(x) ln(x)}
5494over the same range of @expr{x}. If you entered this formula and typed
5495@kbd{a i x @key{RET}} (don't bother to try this), Calc would work for a
5496long time but would be unable to find a solution. In fact, there is no
5497closed-form solution to this integral. Now what do we do?
d7b8e6c6
EZ
5498
5499@cindex Integration, numerical
5500@cindex Numerical integration
5501One approach would be to do the integral numerically. It is not hard
5502to do this by hand using vector mapping and reduction. It is rather
5503slow, though, since the sine and logarithm functions take a long time.
5504We can save some time by reducing the working precision.
5505
d7b8e6c6 5506@smallexample
5d67986c 5507@group
d7b8e6c6
EZ
55083: 10 1: [1, 1.1, 1.2, ... , 1.8, 1.9]
55092: 1 .
55101: 0.1
5511 .
5512
5d67986c 5513 10 @key{RET} 1 @key{RET} .1 @key{RET} C-u v x
d7b8e6c6 5514@end group
5d67986c 5515@end smallexample
d7b8e6c6
EZ
5516
5517@noindent
5518(Note that we have used the extended version of @kbd{v x}; we could
5d67986c 5519also have used plain @kbd{v x} as follows: @kbd{v x 10 @key{RET} 9 + .1 *}.)
d7b8e6c6 5520
d7b8e6c6 5521@smallexample
5d67986c 5522@group
d7b8e6c6
EZ
55232: [1, 1.1, ... ] 1: [0., 0.084941, 0.16993, ... ]
55241: sin(x) ln(x) .
5525 .
5526
5d67986c 5527 ' sin(x) ln(x) @key{RET} s 1 m r p 5 @key{RET} V M $ @key{RET}
d7b8e6c6 5528
d7b8e6c6 5529@end group
5d67986c 5530@end smallexample
d7b8e6c6 5531@noindent
d7b8e6c6 5532@smallexample
5d67986c 5533@group
d7b8e6c6
EZ
55341: 3.4195 0.34195
5535 . .
5536
5537 V R + 0.1 *
d7b8e6c6 5538@end group
5d67986c 5539@end smallexample
d7b8e6c6
EZ
5540
5541@noindent
5542(If you got wildly different results, did you remember to switch
07ce2eb3 5543to Radians mode?)
d7b8e6c6
EZ
5544
5545Here we have divided the curve into ten segments of equal width;
5546approximating these segments as rectangular boxes (i.e., assuming
5547the curve is nearly flat at that resolution), we compute the areas
5548of the boxes (height times width), then sum the areas. (It is
5549faster to sum first, then multiply by the width, since the width
5550is the same for every box.)
5551
5552The true value of this integral turns out to be about 0.374, so
5553we're not doing too well. Let's try another approach.
5554
d7b8e6c6 5555@smallexample
5d67986c 5556@group
d7b8e6c6
EZ
55571: sin(x) ln(x) 1: 0.84147 x - 0.84147 + 0.11957 (x - 1)^2 - ...
5558 . .
5559
5d67986c 5560 r 1 a t x=1 @key{RET} 4 @key{RET}
d7b8e6c6 5561@end group
5d67986c 5562@end smallexample
d7b8e6c6
EZ
5563
5564@noindent
5565Here we have computed the Taylor series expansion of the function
a4231b04 5566about the point @expr{x=1}. We can now integrate this polynomial
d7b8e6c6
EZ
5567approximation, since polynomials are easy to integrate.
5568
d7b8e6c6 5569@smallexample
5d67986c 5570@group
d7b8e6c6
EZ
55711: 0.42074 x^2 + ... 1: [-0.0446, -0.42073] 1: 0.3761
5572 . . .
5573
5d67986c 5574 a i x @key{RET} [ 2 , 1 ] @key{TAB} V M $ @key{RET} V R -
d7b8e6c6 5575@end group
5d67986c 5576@end smallexample
d7b8e6c6
EZ
5577
5578@noindent
5579Better! By increasing the precision and/or asking for more terms
5580in the Taylor series, we can get a result as accurate as we like.
5581(Taylor series converge better away from singularities in the
5582function such as the one at @code{ln(0)}, so it would also help to
a4231b04
JB
5583expand the series about the points @expr{x=2} or @expr{x=1.5} instead
5584of @expr{x=1}.)
d7b8e6c6
EZ
5585
5586@cindex Simpson's rule
5587@cindex Integration by Simpson's rule
5588(@bullet{}) @strong{Exercise 4.} Our first method approximated the
5589curve by stairsteps of width 0.1; the total area was then the sum
5590of the areas of the rectangles under these stairsteps. Our second
5591method approximated the function by a polynomial, which turned out
5592to be a better approximation than stairsteps. A third method is
5593@dfn{Simpson's rule}, which is like the stairstep method except
5594that the steps are not required to be flat. Simpson's rule boils
5595down to the formula,
5596
5597@ifinfo
5598@example
5599(h/3) * (f(a) + 4 f(a+h) + 2 f(a+2h) + 4 f(a+3h) + ...
5600 + 2 f(a+(n-2)*h) + 4 f(a+(n-1)*h) + f(a+n*h))
5601@end example
5602@end ifinfo
5603@tex
5604\turnoffactive
5605\beforedisplay
5606$$ \displaylines{
5607 \qquad {h \over 3} (f(a) + 4 f(a+h) + 2 f(a+2h) + 4 f(a+3h) + \cdots
5608 \hfill \cr \hfill {} + 2 f(a+(n-2)h) + 4 f(a+(n-1)h) + f(a+n h)) \qquad
5609} $$
5610\afterdisplay
5611@end tex
5612
5613@noindent
a4231b04 5614where @expr{n} (which must be even) is the number of slices and @expr{h}
d7b8e6c6
EZ
5615is the width of each slice. These are 10 and 0.1 in our example.
5616For reference, here is the corresponding formula for the stairstep
5617method:
5618
5619@ifinfo
5620@example
5621h * (f(a) + f(a+h) + f(a+2h) + f(a+3h) + ...
5622 + f(a+(n-2)*h) + f(a+(n-1)*h))
5623@end example
5624@end ifinfo
5625@tex
5626\turnoffactive
5627\beforedisplay
5628$$ h (f(a) + f(a+h) + f(a+2h) + f(a+3h) + \cdots
5629 + f(a+(n-2)h) + f(a+(n-1)h)) $$
5630\afterdisplay
5631@end tex
5632
a4231b04 5633Compute the integral from 1 to 2 of
8e04863e 5634@texline @math{\sin x \ln x}
a4231b04
JB
5635@infoline @expr{sin(x) ln(x)}
5636using Simpson's rule with 10 slices.
5637@xref{Algebra Answer 4, 4}. (@bullet{})
d7b8e6c6
EZ
5638
5639Calc has a built-in @kbd{a I} command for doing numerical integration.
5640It uses @dfn{Romberg's method}, which is a more sophisticated cousin
5641of Simpson's rule. In particular, it knows how to keep refining the
5642result until the current precision is satisfied.
5643
5644@c [fix-ref Selecting Sub-Formulas]
5645Aside from the commands we've seen so far, Calc also provides a
5646large set of commands for operating on parts of formulas. You
5647indicate the desired sub-formula by placing the cursor on any part
5648of the formula before giving a @dfn{selection} command. Selections won't
5649be covered in the tutorial; @pxref{Selecting Subformulas}, for
5650details and examples.
5651
5652@c hard exercise: simplify (2^(n r) - 2^(r*(n - 1))) / (2^r - 1) 2^(n - 1)
5653@c to 2^((n-1)*(r-1)).
5654
5655@node Rewrites Tutorial, , Basic Algebra Tutorial, Algebra Tutorial
5656@subsection Rewrite Rules
5657
5658@noindent
5659No matter how many built-in commands Calc provided for doing algebra,
5660there would always be something you wanted to do that Calc didn't have
5661in its repertoire. So Calc also provides a @dfn{rewrite rule} system
5662that you can use to define your own algebraic manipulations.
5663
5664Suppose we want to simplify this trigonometric formula:
5665
d7b8e6c6 5666@smallexample
5d67986c 5667@group
d7b8e6c6
EZ
56681: 1 / cos(x) - sin(x) tan(x)
5669 .
5670
5d67986c 5671 ' 1/cos(x) - sin(x) tan(x) @key{RET} s 1
d7b8e6c6 5672@end group
5d67986c 5673@end smallexample
d7b8e6c6
EZ
5674
5675@noindent
5676If we were simplifying this by hand, we'd probably replace the
5677@samp{tan} with a @samp{sin/cos} first, then combine over a common
5678denominator. There is no Calc command to do the former; the @kbd{a n}
5679algebra command will do the latter but we'll do both with rewrite
5680rules just for practice.
5681
5682Rewrite rules are written with the @samp{:=} symbol.
5683
d7b8e6c6 5684@smallexample
5d67986c 5685@group
d7b8e6c6
EZ
56861: 1 / cos(x) - sin(x)^2 / cos(x)
5687 .
5688
5d67986c 5689 a r tan(a) := sin(a)/cos(a) @key{RET}
d7b8e6c6 5690@end group
5d67986c 5691@end smallexample
d7b8e6c6
EZ
5692
5693@noindent
5694(The ``assignment operator'' @samp{:=} has several uses in Calc. All
5695by itself the formula @samp{tan(a) := sin(a)/cos(a)} doesn't do anything,
5696but when it is given to the @kbd{a r} command, that command interprets
5697it as a rewrite rule.)
5698
5699The lefthand side, @samp{tan(a)}, is called the @dfn{pattern} of the
5700rewrite rule. Calc searches the formula on the stack for parts that
5701match the pattern. Variables in a rewrite pattern are called
5702@dfn{meta-variables}, and when matching the pattern each meta-variable
5703can match any sub-formula. Here, the meta-variable @samp{a} matched
5704the actual variable @samp{x}.
5705
5706When the pattern part of a rewrite rule matches a part of the formula,
5707that part is replaced by the righthand side with all the meta-variables
5708substituted with the things they matched. So the result is
5709@samp{sin(x) / cos(x)}. Calc's normal algebraic simplifications then
5710mix this in with the rest of the original formula.
5711
5712To merge over a common denominator, we can use another simple rule:
5713
d7b8e6c6 5714@smallexample
5d67986c 5715@group
d7b8e6c6
EZ
57161: (1 - sin(x)^2) / cos(x)
5717 .
5718
5d67986c 5719 a r a/x + b/x := (a+b)/x @key{RET}
d7b8e6c6 5720@end group
5d67986c 5721@end smallexample
d7b8e6c6
EZ
5722
5723This rule points out several interesting features of rewrite patterns.
5724First, if a meta-variable appears several times in a pattern, it must
5725match the same thing everywhere. This rule detects common denominators
5726because the same meta-variable @samp{x} is used in both of the
5727denominators.
5728
5729Second, meta-variable names are independent from variables in the
5730target formula. Notice that the meta-variable @samp{x} here matches
5731the subformula @samp{cos(x)}; Calc never confuses the two meanings of
5732@samp{x}.
5733
5734And third, rewrite patterns know a little bit about the algebraic
5735properties of formulas. The pattern called for a sum of two quotients;
5736Calc was able to match a difference of two quotients by matching
5737@samp{a = 1}, @samp{b = -sin(x)^2}, and @samp{x = cos(x)}.
5738
5739@c [fix-ref Algebraic Properties of Rewrite Rules]
5740We could just as easily have written @samp{a/x - b/x := (a-b)/x} for
5741the rule. It would have worked just the same in all cases. (If we
5742really wanted the rule to apply only to @samp{+} or only to @samp{-},
5743we could have used the @code{plain} symbol. @xref{Algebraic Properties
5744of Rewrite Rules}, for some examples of this.)
5745
5746One more rewrite will complete the job. We want to use the identity
5747@samp{sin(x)^2 + cos(x)^2 = 1}, but of course we must first rearrange
5748the identity in a way that matches our formula. The obvious rule
5749would be @samp{@w{1 - sin(x)^2} := cos(x)^2}, but a little thought shows
5750that the rule @samp{sin(x)^2 := 1 - cos(x)^2} will also work. The
5751latter rule has a more general pattern so it will work in many other
5752situations, too.
5753
d7b8e6c6 5754@smallexample
5d67986c 5755@group
d7b8e6c6
EZ
57561: (1 + cos(x)^2 - 1) / cos(x) 1: cos(x)
5757 . .
5758
5d67986c 5759 a r sin(x)^2 := 1 - cos(x)^2 @key{RET} a s
d7b8e6c6 5760@end group
5d67986c 5761@end smallexample
d7b8e6c6
EZ
5762
5763You may ask, what's the point of using the most general rule if you
5764have to type it in every time anyway? The answer is that Calc allows
5765you to store a rewrite rule in a variable, then give the variable
5766name in the @kbd{a r} command. In fact, this is the preferred way to
5767use rewrites. For one, if you need a rule once you'll most likely
5768need it again later. Also, if the rule doesn't work quite right you
5769can simply Undo, edit the variable, and run the rule again without
5770having to retype it.
5771
d7b8e6c6 5772@smallexample
5d67986c
RS
5773@group
5774' tan(x) := sin(x)/cos(x) @key{RET} s t tsc @key{RET}
5775' a/x + b/x := (a+b)/x @key{RET} s t merge @key{RET}
5776' sin(x)^2 := 1 - cos(x)^2 @key{RET} s t sinsqr @key{RET}
d7b8e6c6
EZ
5777
57781: 1 / cos(x) - sin(x) tan(x) 1: cos(x)
5779 . .
5780
5d67986c 5781 r 1 a r tsc @key{RET} a r merge @key{RET} a r sinsqr @key{RET} a s
d7b8e6c6 5782@end group
5d67986c 5783@end smallexample
d7b8e6c6
EZ
5784
5785To edit a variable, type @kbd{s e} and the variable name, use regular
33108698
JB
5786Emacs editing commands as necessary, then type @kbd{C-c C-c} to store
5787the edited value back into the variable.
d7b8e6c6
EZ
5788You can also use @w{@kbd{s e}} to create a new variable if you wish.
5789
5790Notice that the first time you use each rule, Calc puts up a ``compiling''
5791message briefly. The pattern matcher converts rules into a special
5792optimized pattern-matching language rather than using them directly.
5793This allows @kbd{a r} to apply even rather complicated rules very
5794efficiently. If the rule is stored in a variable, Calc compiles it
5795only once and stores the compiled form along with the variable. That's
5796another good reason to store your rules in variables rather than
5797entering them on the fly.
5798
07ce2eb3 5799(@bullet{}) @strong{Exercise 1.} Type @kbd{m s} to get Symbolic
d7b8e6c6 5800mode, then enter the formula @samp{@w{(2 + sqrt(2))} / @w{(1 + sqrt(2))}}.
029b2a44
JB
5801Using a rewrite rule, simplify this formula by multiplying the top and
5802bottom by the conjugate @w{@samp{1 - sqrt(2)}}. The result will have
d7b8e6c6
EZ
5803to be expanded by the distributive law; do this with another
5804rewrite. @xref{Rewrites Answer 1, 1}. (@bullet{})
5805
5806The @kbd{a r} command can also accept a vector of rewrite rules, or
5807a variable containing a vector of rules.
5808
d7b8e6c6 5809@smallexample
5d67986c 5810@group
d7b8e6c6
EZ
58111: [tsc, merge, sinsqr] 1: [tan(x) := sin(x) / cos(x), ... ]
5812 . .
5813
5d67986c 5814 ' [tsc,merge,sinsqr] @key{RET} =
d7b8e6c6 5815
d7b8e6c6 5816@end group
5d67986c 5817@end smallexample
d7b8e6c6 5818@noindent
d7b8e6c6 5819@smallexample
5d67986c 5820@group
d7b8e6c6
EZ
58211: 1 / cos(x) - sin(x) tan(x) 1: cos(x)
5822 . .
5823
5d67986c 5824 s t trig @key{RET} r 1 a r trig @key{RET} a s
d7b8e6c6 5825@end group
5d67986c 5826@end smallexample
d7b8e6c6
EZ
5827
5828@c [fix-ref Nested Formulas with Rewrite Rules]
5829Calc tries all the rules you give against all parts of the formula,
5830repeating until no further change is possible. (The exact order in
5831which things are tried is rather complex, but for simple rules like
5832the ones we've used here the order doesn't really matter.
5833@xref{Nested Formulas with Rewrite Rules}.)
5834
5835Calc actually repeats only up to 100 times, just in case your rule set
5836has gotten into an infinite loop. You can give a numeric prefix argument
5837to @kbd{a r} to specify any limit. In particular, @kbd{M-1 a r} does
5838only one rewrite at a time.
5839
d7b8e6c6 5840@smallexample
5d67986c 5841@group
d7b8e6c6
EZ
58421: 1 / cos(x) - sin(x)^2 / cos(x) 1: (1 - sin(x)^2) / cos(x)
5843 . .
5844
5d67986c 5845 r 1 M-1 a r trig @key{RET} M-1 a r trig @key{RET}
d7b8e6c6 5846@end group
5d67986c 5847@end smallexample
d7b8e6c6
EZ
5848
5849You can type @kbd{M-0 a r} if you want no limit at all on the number
5850of rewrites that occur.
5851
5852Rewrite rules can also be @dfn{conditional}. Simply follow the rule
5853with a @samp{::} symbol and the desired condition. For example,
5854
d7b8e6c6 5855@smallexample
5d67986c 5856@group
d7b8e6c6
EZ
58571: exp(2 pi i) + exp(3 pi i) + exp(4 pi i)
5858 .
5859
5d67986c 5860 ' exp(2 pi i) + exp(3 pi i) + exp(4 pi i) @key{RET}
d7b8e6c6 5861
d7b8e6c6 5862@end group
5d67986c 5863@end smallexample
d7b8e6c6 5864@noindent
d7b8e6c6 5865@smallexample
5d67986c 5866@group
d7b8e6c6
EZ
58671: 1 + exp(3 pi i) + 1
5868 .
5869
5d67986c 5870 a r exp(k pi i) := 1 :: k % 2 = 0 @key{RET}
d7b8e6c6 5871@end group
5d67986c 5872@end smallexample
d7b8e6c6
EZ
5873
5874@noindent
5875(Recall, @samp{k % 2} is the remainder from dividing @samp{k} by 2,
5876which will be zero only when @samp{k} is an even integer.)
5877
5878An interesting point is that the variables @samp{pi} and @samp{i}
5879were matched literally rather than acting as meta-variables.
5880This is because they are special-constant variables. The special
5881constants @samp{e}, @samp{phi}, and so on also match literally.
5882A common error with rewrite
5883rules is to write, say, @samp{f(a,b,c,d,e) := g(a+b+c+d+e)}, expecting
5884to match any @samp{f} with five arguments but in fact matching
a4231b04 5885only when the fifth argument is literally @samp{e}!
d7b8e6c6
EZ
5886
5887@cindex Fibonacci numbers
5d67986c
RS
5888@ignore
5889@starindex
5890@end ignore
d7b8e6c6
EZ
5891@tindex fib
5892Rewrite rules provide an interesting way to define your own functions.
5893Suppose we want to define @samp{fib(n)} to produce the @var{n}th
5894Fibonacci number. The first two Fibonacci numbers are each 1;
5895later numbers are formed by summing the two preceding numbers in
5896the sequence. This is easy to express in a set of three rules:
5897
d7b8e6c6 5898@smallexample
5d67986c
RS
5899@group
5900' [fib(1) := 1, fib(2) := 1, fib(n) := fib(n-1) + fib(n-2)] @key{RET} s t fib
d7b8e6c6
EZ
5901
59021: fib(7) 1: 13
5903 . .
5904
5d67986c 5905 ' fib(7) @key{RET} a r fib @key{RET}
d7b8e6c6 5906@end group
5d67986c 5907@end smallexample
d7b8e6c6
EZ
5908
5909One thing that is guaranteed about the order that rewrites are tried
5910is that, for any given subformula, earlier rules in the rule set will
5911be tried for that subformula before later ones. So even though the
5912first and third rules both match @samp{fib(1)}, we know the first will
5913be used preferentially.
5914
5915This rule set has one dangerous bug: Suppose we apply it to the
5916formula @samp{fib(x)}? (Don't actually try this.) The third rule
5917will match @samp{fib(x)} and replace it with @w{@samp{fib(x-1) + fib(x-2)}}.
5918Each of these will then be replaced to get @samp{fib(x-2) + 2 fib(x-3) +
5919fib(x-4)}, and so on, expanding forever. What we really want is to apply
5920the third rule only when @samp{n} is an integer greater than two. Type
5d67986c 5921@w{@kbd{s e fib @key{RET}}}, then edit the third rule to:
d7b8e6c6
EZ
5922
5923@smallexample
5924fib(n) := fib(n-1) + fib(n-2) :: integer(n) :: n > 2
5925@end smallexample
5926
5927@noindent
5928Now:
5929
d7b8e6c6 5930@smallexample
5d67986c 5931@group
d7b8e6c6
EZ
59321: fib(6) + fib(x) + fib(0) 1: 8 + fib(x) + fib(0)
5933 . .
5934
5d67986c 5935 ' fib(6)+fib(x)+fib(0) @key{RET} a r fib @key{RET}
d7b8e6c6 5936@end group
5d67986c 5937@end smallexample
d7b8e6c6
EZ
5938
5939@noindent
5940We've created a new function, @code{fib}, and a new command,
5d67986c 5941@w{@kbd{a r fib @key{RET}}}, which means ``evaluate all @code{fib} calls in
d7b8e6c6
EZ
5942this formula.'' To make things easier still, we can tell Calc to
5943apply these rules automatically by storing them in the special
5944variable @code{EvalRules}.
5945
d7b8e6c6 5946@smallexample
5d67986c 5947@group
d7b8e6c6
EZ
59481: [fib(1) := ...] . 1: [8, 13]
5949 . .
5950
5d67986c 5951 s r fib @key{RET} s t EvalRules @key{RET} ' [fib(6), fib(7)] @key{RET}
d7b8e6c6 5952@end group
5d67986c 5953@end smallexample
d7b8e6c6
EZ
5954
5955It turns out that this rule set has the problem that it does far
5956more work than it needs to when @samp{n} is large. Consider the
5957first few steps of the computation of @samp{fib(6)}:
5958
d7b8e6c6 5959@smallexample
5d67986c 5960@group
d7b8e6c6
EZ
5961fib(6) =
5962fib(5) + fib(4) =
5963fib(4) + fib(3) + fib(3) + fib(2) =
5964fib(3) + fib(2) + fib(2) + fib(1) + fib(2) + fib(1) + 1 = ...
d7b8e6c6 5965@end group
5d67986c 5966@end smallexample
d7b8e6c6
EZ
5967
5968@noindent
5969Note that @samp{fib(3)} appears three times here. Unless Calc's
5970algebraic simplifier notices the multiple @samp{fib(3)}s and combines
5971them (and, as it happens, it doesn't), this rule set does lots of
5972needless recomputation. To cure the problem, type @code{s e EvalRules}
5973to edit the rules (or just @kbd{s E}, a shorthand command for editing
5974@code{EvalRules}) and add another condition:
5975
5976@smallexample
5977fib(n) := fib(n-1) + fib(n-2) :: integer(n) :: n > 2 :: remember
5978@end smallexample
5979
5980@noindent
5981If a @samp{:: remember} condition appears anywhere in a rule, then if
5982that rule succeeds Calc will add another rule that describes that match
5983to the front of the rule set. (Remembering works in any rule set, but
5984for technical reasons it is most effective in @code{EvalRules}.) For
5985example, if the rule rewrites @samp{fib(7)} to something that evaluates
5986to 13, then the rule @samp{fib(7) := 13} will be added to the rule set.
5987
5d67986c 5988Type @kbd{' fib(8) @key{RET}} to compute the eighth Fibonacci number, then
d7b8e6c6
EZ
5989type @kbd{s E} again to see what has happened to the rule set.
5990
5991With the @code{remember} feature, our rule set can now compute
5992@samp{fib(@var{n})} in just @var{n} steps. In the process it builds
5993up a table of all Fibonacci numbers up to @var{n}. After we have
5994computed the result for a particular @var{n}, we can get it back
5995(and the results for all smaller @var{n}) later in just one step.
5996
5997All Calc operations will run somewhat slower whenever @code{EvalRules}
5d67986c 5998contains any rules. You should type @kbd{s u EvalRules @key{RET}} now to
d7b8e6c6
EZ
5999un-store the variable.
6000
6001(@bullet{}) @strong{Exercise 2.} Sometimes it is possible to reformulate
6002a problem to reduce the amount of recursion necessary to solve it.
6003Create a rule that, in about @var{n} simple steps and without recourse
6004to the @code{remember} option, replaces @samp{fib(@var{n}, 1, 1)} with
6005@samp{fib(1, @var{x}, @var{y})} where @var{x} and @var{y} are the
6006@var{n}th and @var{n+1}st Fibonacci numbers, respectively. This rule is
6007rather clunky to use, so add a couple more rules to make the ``user
6008interface'' the same as for our first version: enter @samp{fib(@var{n})},
6009get back a plain number. @xref{Rewrites Answer 2, 2}. (@bullet{})
6010
6011There are many more things that rewrites can do. For example, there
6012are @samp{&&&} and @samp{|||} pattern operators that create ``and''
6013and ``or'' combinations of rules. As one really simple example, we
6014could combine our first two Fibonacci rules thusly:
6015
6016@example
6017[fib(1 ||| 2) := 1, fib(n) := ... ]
6018@end example
6019
6020@noindent
6021That means ``@code{fib} of something matching either 1 or 2 rewrites
6022to 1.''
6023
6024You can also make meta-variables optional by enclosing them in @code{opt}.
6025For example, the pattern @samp{a + b x} matches @samp{2 + 3 x} but not
6026@samp{2 + x} or @samp{3 x} or @samp{x}. The pattern @samp{opt(a) + opt(b) x}
6027matches all of these forms, filling in a default of zero for @samp{a}
6028and one for @samp{b}.
6029
6030(@bullet{}) @strong{Exercise 3.} Your friend Joe had @samp{2 + 3 x}
6031on the stack and tried to use the rule
6032@samp{opt(a) + opt(b) x := f(a, b, x)}. What happened?
6033@xref{Rewrites Answer 3, 3}. (@bullet{})
6034
a4231b04
JB
6035(@bullet{}) @strong{Exercise 4.} Starting with a positive integer @expr{a},
6036divide @expr{a} by two if it is even, otherwise compute @expr{3 a + 1}.
d7b8e6c6 6037Now repeat this step over and over. A famous unproved conjecture
a4231b04 6038is that for any starting @expr{a}, the sequence always eventually
d7b8e6c6
EZ
6039reaches 1. Given the formula @samp{seq(@var{a}, 0)}, write a set of
6040rules that convert this into @samp{seq(1, @var{n})} where @var{n}
6041is the number of steps it took the sequence to reach the value 1.
6042Now enhance the rules to accept @samp{seq(@var{a})} as a starting
6043configuration, and to stop with just the number @var{n} by itself.
6044Now make the result be a vector of values in the sequence, from @var{a}
6045to 1. (The formula @samp{@var{x}|@var{y}} appends the vectors @var{x}
6046and @var{y}.) For example, rewriting @samp{seq(6)} should yield the
a4231b04 6047vector @expr{[6, 3, 10, 5, 16, 8, 4, 2, 1]}.
d7b8e6c6
EZ
6048@xref{Rewrites Answer 4, 4}. (@bullet{})
6049
6050(@bullet{}) @strong{Exercise 5.} Define, using rewrite rules, a function
6051@samp{nterms(@var{x})} that returns the number of terms in the sum
6052@var{x}, or 1 if @var{x} is not a sum. (A @dfn{sum} for our purposes
6053is one or more non-sum terms separated by @samp{+} or @samp{-} signs,
a4231b04 6054so that @expr{2 - 3 (x + y) + x y} is a sum of three terms.)
d7b8e6c6
EZ
6055@xref{Rewrites Answer 5, 5}. (@bullet{})
6056
8c399bc1 6057(@bullet{}) @strong{Exercise 6.} A Taylor series for a function is an
d7b8e6c6 6058infinite series that exactly equals the value of that function at
a4231b04 6059values of @expr{x} near zero.
d7b8e6c6
EZ
6060
6061@ifinfo
6062@example
6063cos(x) = 1 - x^2 / 2! + x^4 / 4! - x^6 / 6! + ...
6064@end example
6065@end ifinfo
6066@tex
a4231b04 6067\turnoffactive
d7b8e6c6
EZ
6068\beforedisplay
6069$$ \cos x = 1 - {x^2 \over 2!} + {x^4 \over 4!} - {x^6 \over 6!} + \cdots $$
6070\afterdisplay
6071@end tex
6072
6073The @kbd{a t} command produces a @dfn{truncated Taylor series} which
a4231b04
JB
6074is obtained by dropping all the terms higher than, say, @expr{x^2}.
6075Calc represents the truncated Taylor series as a polynomial in @expr{x}.
d7b8e6c6
EZ
6076Mathematicians often write a truncated series using a ``big-O'' notation
6077that records what was the lowest term that was truncated.
6078
6079@ifinfo
6080@example
6081cos(x) = 1 - x^2 / 2! + O(x^3)
6082@end example
6083@end ifinfo
6084@tex
a4231b04 6085\turnoffactive
d7b8e6c6
EZ
6086\beforedisplay
6087$$ \cos x = 1 - {x^2 \over 2!} + O(x^3) $$
6088\afterdisplay
6089@end tex
6090
6091@noindent
a4231b04
JB
6092The meaning of @expr{O(x^3)} is ``a quantity which is negligibly small
6093if @expr{x^3} is considered negligibly small as @expr{x} goes to zero.''
d7b8e6c6
EZ
6094
6095The exercise is to create rewrite rules that simplify sums and products of
6096power series represented as @samp{@var{polynomial} + O(@var{var}^@var{n})}.
6097For example, given @samp{1 - x^2 / 2 + O(x^3)} and @samp{x - x^3 / 6 + O(x^4)}
6098on the stack, we want to be able to type @kbd{*} and get the result
6099@samp{x - 2:3 x^3 + O(x^4)}. Don't worry if the terms of the sum are
6100rearranged or if @kbd{a s} needs to be typed after rewriting. (This one
6101is rather tricky; the solution at the end of this chapter uses 6 rewrite
6102rules. Hint: The @samp{constant(x)} condition tests whether @samp{x} is
8c399bc1
JB
6103a number.) @xref{Rewrites Answer 6, 6}. (@bullet{})
6104
6105Just for kicks, try adding the rule @code{2+3 := 6} to @code{EvalRules}.
6106What happens? (Be sure to remove this rule afterward, or you might get
6107a nasty surprise when you use Calc to balance your checkbook!)
d7b8e6c6 6108
d7b8e6c6
EZ
6109@xref{Rewrite Rules}, for the whole story on rewrite rules.
6110
6111@node Programming Tutorial, Answers to Exercises, Algebra Tutorial, Tutorial
6112@section Programming Tutorial
6113
6114@noindent
6115The Calculator is written entirely in Emacs Lisp, a highly extensible
6116language. If you know Lisp, you can program the Calculator to do
6117anything you like. Rewrite rules also work as a powerful programming
6118system. But Lisp and rewrite rules take a while to master, and often
6119all you want to do is define a new function or repeat a command a few
6120times. Calc has features that allow you to do these things easily.
6121
d7b8e6c6
EZ
6122One very limited form of programming is defining your own functions.
6123Calc's @kbd{Z F} command allows you to define a function name and
6124key sequence to correspond to any formula. Programming commands use
6125the shift-@kbd{Z} prefix; the user commands they create use the lower
6126case @kbd{z} prefix.
6127
d7b8e6c6 6128@smallexample
5d67986c 6129@group
d7b8e6c6
EZ
61301: 1 + x + x^2 / 2 + x^3 / 6 1: 1 + x + x^2 / 2 + x^3 / 6
6131 . .
6132
5d67986c 6133 ' 1 + x + x^2/2! + x^3/3! @key{RET} Z F e myexp @key{RET} @key{RET} @key{RET} y
d7b8e6c6 6134@end group
5d67986c 6135@end smallexample
d7b8e6c6
EZ
6136
6137This polynomial is a Taylor series approximation to @samp{exp(x)}.
6138The @kbd{Z F} command asks a number of questions. The above answers
6139say that the key sequence for our function should be @kbd{z e}; the
6140@kbd{M-x} equivalent should be @code{calc-myexp}; the name of the
6141function in algebraic formulas should also be @code{myexp}; the
6142default argument list @samp{(x)} is acceptable; and finally @kbd{y}
6143answers the question ``leave it in symbolic form for non-constant
6144arguments?''
6145
d7b8e6c6 6146@smallexample
5d67986c 6147@group
d7b8e6c6
EZ
61481: 1.3495 2: 1.3495 3: 1.3495
6149 . 1: 1.34986 2: 1.34986
6150 . 1: myexp(a + 1)
6151 .
6152
5d67986c 6153 .3 z e .3 E ' a+1 @key{RET} z e
d7b8e6c6 6154@end group
5d67986c 6155@end smallexample
d7b8e6c6
EZ
6156
6157@noindent
6158First we call our new @code{exp} approximation with 0.3 as an
6159argument, and compare it with the true @code{exp} function. Then
6160we note that, as requested, if we try to give @kbd{z e} an
6161argument that isn't a plain number, it leaves the @code{myexp}
6162function call in symbolic form. If we had answered @kbd{n} to the
6163final question, @samp{myexp(a + 1)} would have evaluated by plugging
6164in @samp{a + 1} for @samp{x} in the defining formula.
6165
6166@cindex Sine integral Si(x)
5d67986c
RS
6167@ignore
6168@starindex
6169@end ignore
d7b8e6c6
EZ
6170@tindex Si
6171(@bullet{}) @strong{Exercise 1.} The ``sine integral'' function
8e04863e 6172@texline @math{{\rm Si}(x)}
a4231b04
JB
6173@infoline @expr{Si(x)}
6174is defined as the integral of @samp{sin(t)/t} for
6175@expr{t = 0} to @expr{x} in radians. (It was invented because this
d7b8e6c6
EZ
6176integral has no solution in terms of basic functions; if you give it
6177to Calc's @kbd{a i} command, it will ponder it for a long time and then
6178give up.) We can use the numerical integration command, however,
6179which in algebraic notation is written like @samp{ninteg(f(t), t, 0, x)}
6180with any integrand @samp{f(t)}. Define a @kbd{z s} command and
6181@code{Si} function that implement this. You will need to edit the
6182default argument list a bit. As a test, @samp{Si(1)} should return
59b568a7
JB
61830.946083. (If you don't get this answer, you might want to check that
6184Calc is in Radians mode. Also, @code{ninteg} will run a lot faster if
6185you reduce the precision to, say, six digits beforehand.)
d7b8e6c6
EZ
6186@xref{Programming Answer 1, 1}. (@bullet{})
6187
6188The simplest way to do real ``programming'' of Emacs is to define a
6189@dfn{keyboard macro}. A keyboard macro is simply a sequence of
6190keystrokes which Emacs has stored away and can play back on demand.
6191For example, if you find yourself typing @kbd{H a S x @key{RET}} often,
6192you may wish to program a keyboard macro to type this for you.
6193
d7b8e6c6 6194@smallexample
5d67986c 6195@group
d7b8e6c6
EZ
61961: y = sqrt(x) 1: x = y^2
6197 . .
6198
5d67986c 6199 ' y=sqrt(x) @key{RET} C-x ( H a S x @key{RET} C-x )
d7b8e6c6
EZ
6200
62011: y = cos(x) 1: x = s1 arccos(y) + 2 pi n1
6202 . .
6203
5d67986c 6204 ' y=cos(x) @key{RET} X
d7b8e6c6 6205@end group
5d67986c 6206@end smallexample
d7b8e6c6
EZ
6207
6208@noindent
6209When you type @kbd{C-x (}, Emacs begins recording. But it is also
6210still ready to execute your keystrokes, so you're really ``training''
6211Emacs by walking it through the procedure once. When you type
6212@w{@kbd{C-x )}}, the macro is recorded. You can now type @kbd{X} to
6213re-execute the same keystrokes.
6214
6215You can give a name to your macro by typing @kbd{Z K}.
6216
d7b8e6c6 6217@smallexample
5d67986c 6218@group
d7b8e6c6
EZ
62191: . 1: y = x^4 1: x = s2 sqrt(s1 sqrt(y))
6220 . .
6221
5d67986c 6222 Z K x @key{RET} ' y=x^4 @key{RET} z x
d7b8e6c6 6223@end group
5d67986c 6224@end smallexample
d7b8e6c6
EZ
6225
6226@noindent
6227Notice that we use shift-@kbd{Z} to define the command, and lower-case
6228@kbd{z} to call it up.
6229
6230Keyboard macros can call other macros.
6231
d7b8e6c6 6232@smallexample
5d67986c 6233@group
d7b8e6c6
EZ
62341: abs(x) 1: x = s1 y 1: 2 / x 1: x = 2 / y
6235 . . . .
6236
5d67986c 6237 ' abs(x) @key{RET} C-x ( ' y @key{RET} a = z x C-x ) ' 2/x @key{RET} X
d7b8e6c6 6238@end group
5d67986c 6239@end smallexample
d7b8e6c6
EZ
6240
6241(@bullet{}) @strong{Exercise 2.} Define a keyboard macro to negate
6242the item in level 3 of the stack, without disturbing the rest of
6243the stack. @xref{Programming Answer 2, 2}. (@bullet{})
6244
6245(@bullet{}) @strong{Exercise 3.} Define keyboard macros to compute
6246the following functions:
6247
6248@enumerate
6249@item
a4231b04 6250Compute
8e04863e 6251@texline @math{\displaystyle{\sin x \over x}},
a4231b04
JB
6252@infoline @expr{sin(x) / x},
6253where @expr{x} is the number on the top of the stack.
d7b8e6c6
EZ
6254
6255@item
a4231b04 6256Compute the base-@expr{b} logarithm, just like the @kbd{B} key except
d7b8e6c6
EZ
6257the arguments are taken in the opposite order.
6258
6259@item
6260Produce a vector of integers from 1 to the integer on the top of
6261the stack.
6262@end enumerate
6263@noindent
6264@xref{Programming Answer 3, 3}. (@bullet{})
6265
6266(@bullet{}) @strong{Exercise 4.} Define a keyboard macro to compute
6267the average (mean) value of a list of numbers.
6268@xref{Programming Answer 4, 4}. (@bullet{})
6269
6270In many programs, some of the steps must execute several times.
6271Calc has @dfn{looping} commands that allow this. Loops are useful
6272inside keyboard macros, but actually work at any time.
6273
d7b8e6c6 6274@smallexample
5d67986c 6275@group
d7b8e6c6
EZ
62761: x^6 2: x^6 1: 360 x^2
6277 . 1: 4 .
6278 .
6279
5d67986c 6280 ' x^6 @key{RET} 4 Z < a d x @key{RET} Z >
d7b8e6c6 6281@end group
5d67986c 6282@end smallexample
d7b8e6c6
EZ
6283
6284@noindent
a4231b04 6285Here we have computed the fourth derivative of @expr{x^6} by
d7b8e6c6
EZ
6286enclosing a derivative command in a ``repeat loop'' structure.
6287This structure pops a repeat count from the stack, then
6288executes the body of the loop that many times.
6289
6290If you make a mistake while entering the body of the loop,
6291type @w{@kbd{Z C-g}} to cancel the loop command.
6292
6293@cindex Fibonacci numbers
6294Here's another example:
6295
d7b8e6c6 6296@smallexample
5d67986c 6297@group
d7b8e6c6
EZ
62983: 1 2: 10946
62992: 1 1: 17711
63001: 20 .
6301 .
6302
5d67986c 63031 @key{RET} @key{RET} 20 Z < @key{TAB} C-j + Z >
d7b8e6c6 6304@end group
5d67986c 6305@end smallexample
d7b8e6c6
EZ
6306
6307@noindent
6308The numbers in levels 2 and 1 should be the 21st and 22nd Fibonacci
6309numbers, respectively. (To see what's going on, try a few repetitions
6310of the loop body by hand; @kbd{C-j}, also on the Line-Feed or @key{LFD}
6311key if you have one, makes a copy of the number in level 2.)
6312
6313@cindex Golden ratio
6314@cindex Phi, golden ratio
a4231b04
JB
6315A fascinating property of the Fibonacci numbers is that the @expr{n}th
6316Fibonacci number can be found directly by computing
8e04863e 6317@texline @math{\phi^n / \sqrt{5}}
a4231b04
JB
6318@infoline @expr{phi^n / sqrt(5)}
6319and then rounding to the nearest integer, where
8e04863e 6320@texline @math{\phi} (``phi''),
a4231b04
JB
6321@infoline @expr{phi},
6322the ``golden ratio,'' is
8e04863e 6323@texline @math{(1 + \sqrt{5}) / 2}.
a4231b04
JB
6324@infoline @expr{(1 + sqrt(5)) / 2}.
6325(For convenience, this constant is available from the @code{phi}
6326variable, or the @kbd{I H P} command.)
d7b8e6c6 6327
d7b8e6c6 6328@smallexample
5d67986c 6329@group
d7b8e6c6
EZ
63301: 1.61803 1: 24476.0000409 1: 10945.9999817 1: 10946
6331 . . . .
6332
6333 I H P 21 ^ 5 Q / R
d7b8e6c6 6334@end group
5d67986c 6335@end smallexample
d7b8e6c6
EZ
6336
6337@cindex Continued fractions
6338(@bullet{}) @strong{Exercise 5.} The @dfn{continued fraction}
a4231b04 6339representation of
8e04863e 6340@texline @math{\phi}
a4231b04
JB
6341@infoline @expr{phi}
6342is
8e04863e 6343@texline @math{1 + 1/(1 + 1/(1 + 1/( \ldots )))}.
a4231b04 6344@infoline @expr{1 + 1/(1 + 1/(1 + 1/( ...@: )))}.
d7b8e6c6 6345We can compute an approximate value by carrying this however far
a4231b04 6346and then replacing the innermost
8e04863e 6347@texline @math{1/( \ldots )}
a4231b04
JB
6348@infoline @expr{1/( ...@: )}
6349by 1. Approximate
8e04863e 6350@texline @math{\phi}
a4231b04
JB
6351@infoline @expr{phi}
6352using a twenty-term continued fraction.
d7b8e6c6
EZ
6353@xref{Programming Answer 5, 5}. (@bullet{})
6354
6355(@bullet{}) @strong{Exercise 6.} Linear recurrences like the one for
6356Fibonacci numbers can be expressed in terms of matrices. Given a
a4231b04
JB
6357vector @w{@expr{[a, b]}} determine a matrix which, when multiplied by this
6358vector, produces the vector @expr{[b, c]}, where @expr{a}, @expr{b} and
6359@expr{c} are three successive Fibonacci numbers. Now write a program
6360that, given an integer @expr{n}, computes the @expr{n}th Fibonacci number
d7b8e6c6
EZ
6361using matrix arithmetic. @xref{Programming Answer 6, 6}. (@bullet{})
6362
6363@cindex Harmonic numbers
6364A more sophisticated kind of loop is the @dfn{for} loop. Suppose
6365we wish to compute the 20th ``harmonic'' number, which is equal to
6366the sum of the reciprocals of the integers from 1 to 20.
6367
d7b8e6c6 6368@smallexample
5d67986c 6369@group
d7b8e6c6
EZ
63703: 0 1: 3.597739
63712: 1 .
63721: 20
6373 .
6374
5d67986c 63750 @key{RET} 1 @key{RET} 20 Z ( & + 1 Z )
d7b8e6c6 6376@end group
5d67986c 6377@end smallexample
d7b8e6c6
EZ
6378
6379@noindent
6380The ``for'' loop pops two numbers, the lower and upper limits, then
6381repeats the body of the loop as an internal counter increases from
6382the lower limit to the upper one. Just before executing the loop
6383body, it pushes the current loop counter. When the loop body
6384finishes, it pops the ``step,'' i.e., the amount by which to
6385increment the loop counter. As you can see, our loop always
6386uses a step of one.
6387
6388This harmonic number function uses the stack to hold the running
6389total as well as for the various loop housekeeping functions. If
6390you find this disorienting, you can sum in a variable instead:
6391
d7b8e6c6 6392@smallexample
5d67986c 6393@group
d7b8e6c6
EZ
63941: 0 2: 1 . 1: 3.597739
6395 . 1: 20 .
6396 .
6397
5d67986c 6398 0 t 7 1 @key{RET} 20 Z ( & s + 7 1 Z ) r 7
d7b8e6c6 6399@end group
5d67986c 6400@end smallexample
d7b8e6c6
EZ
6401
6402@noindent
6403The @kbd{s +} command adds the top-of-stack into the value in a
6404variable (and removes that value from the stack).
6405
6406It's worth noting that many jobs that call for a ``for'' loop can
6407also be done more easily by Calc's high-level operations. Two
6408other ways to compute harmonic numbers are to use vector mapping
6409and reduction (@kbd{v x 20}, then @w{@kbd{V M &}}, then @kbd{V R +}),
6410or to use the summation command @kbd{a +}. Both of these are
6411probably easier than using loops. However, there are some
6412situations where loops really are the way to go:
6413
6414(@bullet{}) @strong{Exercise 7.} Use a ``for'' loop to find the first
6415harmonic number which is greater than 4.0.
6416@xref{Programming Answer 7, 7}. (@bullet{})
6417
6418Of course, if we're going to be using variables in our programs,
6419we have to worry about the programs clobbering values that the
6420caller was keeping in those same variables. This is easy to
6421fix, though:
6422
d7b8e6c6 6423@smallexample
5d67986c 6424@group
d7b8e6c6
EZ
6425 . 1: 0.6667 1: 0.6667 3: 0.6667
6426 . . 2: 3.597739
6427 1: 0.6667
6428 .
6429
5d67986c 6430 Z ` p 4 @key{RET} 2 @key{RET} 3 / s 7 s s a @key{RET} Z ' r 7 s r a @key{RET}
d7b8e6c6 6431@end group
5d67986c 6432@end smallexample
d7b8e6c6
EZ
6433
6434@noindent
6435When we type @kbd{Z `} (that's a back-quote character), Calc saves
6436its mode settings and the contents of the ten ``quick variables''
6437for later reference. When we type @kbd{Z '} (that's an apostrophe
6438now), Calc restores those saved values. Thus the @kbd{p 4} and
6439@kbd{s 7} commands have no effect outside this sequence. Wrapping
6440this around the body of a keyboard macro ensures that it doesn't
6441interfere with what the user of the macro was doing. Notice that
6442the contents of the stack, and the values of named variables,
6443survive past the @kbd{Z '} command.
6444
6445@cindex Bernoulli numbers, approximate
6446The @dfn{Bernoulli numbers} are a sequence with the interesting
6447property that all of the odd Bernoulli numbers are zero, and the
6448even ones, while difficult to compute, can be roughly approximated
a4231b04 6449by the formula
8e04863e 6450@texline @math{\displaystyle{2 n! \over (2 \pi)^n}}.
a4231b04
JB
6451@infoline @expr{2 n!@: / (2 pi)^n}.
6452Let's write a keyboard macro to compute (approximate) Bernoulli numbers.
6453(Calc has a command, @kbd{k b}, to compute exact Bernoulli numbers, but
6454this command is very slow for large @expr{n} since the higher Bernoulli
6455numbers are very large fractions.)
d7b8e6c6 6456
d7b8e6c6 6457@smallexample
5d67986c 6458@group
d7b8e6c6
EZ
64591: 10 1: 0.0756823
6460 . .
6461
5d67986c 6462 10 C-x ( @key{RET} 2 % Z [ @key{DEL} 0 Z : ' 2 $! / (2 pi)^$ @key{RET} = Z ] C-x )
d7b8e6c6 6463@end group
5d67986c 6464@end smallexample
d7b8e6c6
EZ
6465
6466@noindent
6467You can read @kbd{Z [} as ``then,'' @kbd{Z :} as ``else,'' and
6468@kbd{Z ]} as ``end-if.'' There is no need for an explicit ``if''
6469command. For the purposes of @w{@kbd{Z [}}, the condition is ``true''
6470if the value it pops from the stack is a nonzero number, or ``false''
6471if it pops zero or something that is not a number (like a formula).
6472Here we take our integer argument modulo 2; this will be nonzero
6473if we're asking for an odd Bernoulli number.
6474
a4231b04 6475The actual tenth Bernoulli number is @expr{5/66}.
d7b8e6c6 6476
d7b8e6c6 6477@smallexample
5d67986c 6478@group
d7b8e6c6
EZ
64793: 0.0756823 1: 0 1: 0.25305 1: 0 1: 1.16659
64802: 5:66 . . . .
64811: 0.0757575
6482 .
6483
5d67986c 648410 k b @key{RET} c f M-0 @key{DEL} 11 X @key{DEL} 12 X @key{DEL} 13 X @key{DEL} 14 X
d7b8e6c6 6485@end group
5d67986c 6486@end smallexample
d7b8e6c6
EZ
6487
6488Just to exercise loops a bit more, let's compute a table of even
6489Bernoulli numbers.
6490
d7b8e6c6 6491@smallexample
5d67986c 6492@group
d7b8e6c6
EZ
64933: [] 1: [0.10132, 0.03079, 0.02340, 0.033197, ...]
64942: 2 .
64951: 30
6496 .
6497
5d67986c 6498 [ ] 2 @key{RET} 30 Z ( X | 2 Z )
d7b8e6c6 6499@end group
5d67986c 6500@end smallexample
d7b8e6c6
EZ
6501
6502@noindent
6503The vertical-bar @kbd{|} is the vector-concatenation command. When
6504we execute it, the list we are building will be in stack level 2
6505(initially this is an empty list), and the next Bernoulli number
6506will be in level 1. The effect is to append the Bernoulli number
6507onto the end of the list. (To create a table of exact fractional
6508Bernoulli numbers, just replace @kbd{X} with @kbd{k b} in the above
6509sequence of keystrokes.)
6510
6511With loops and conditionals, you can program essentially anything
6512in Calc. One other command that makes looping easier is @kbd{Z /},
6513which takes a condition from the stack and breaks out of the enclosing
6514loop if the condition is true (non-zero). You can use this to make
6515``while'' and ``until'' style loops.
6516
6517If you make a mistake when entering a keyboard macro, you can edit
6518it using @kbd{Z E}. First, you must attach it to a key with @kbd{Z K}.
6519One technique is to enter a throwaway dummy definition for the macro,
6520then enter the real one in the edit command.
6521
d7b8e6c6 6522@smallexample
5d67986c 6523@group
74857f83
JB
65241: 3 1: 3 Calc Macro Edit Mode.
6525 . . Original keys: 1 <return> 2 +
d7b8e6c6 6526
74857f83
JB
6527 1 ;; calc digits
6528 RET ;; calc-enter
6529 2 ;; calc digits
6530 + ;; calc-plus
d7b8e6c6 6531
5d67986c 6532C-x ( 1 @key{RET} 2 + C-x ) Z K h @key{RET} Z E h
d7b8e6c6 6533@end group
5d67986c 6534@end smallexample
d7b8e6c6
EZ
6535
6536@noindent
d7b8e6c6 6537A keyboard macro is stored as a pure keystroke sequence. The
74857f83 6538@file{edmacro} package (invoked by @kbd{Z E}) scans along the
d7b8e6c6 6539macro and tries to decode it back into human-readable steps.
74857f83
JB
6540Descriptions of the keystrokes are given as comments, which begin with
6541@samp{;;}, and which are ignored when the edited macro is saved.
6542Spaces and line breaks are also ignored when the edited macro is saved.
6543To enter a space into the macro, type @code{SPC}. All the special
6544characters @code{RET}, @code{LFD}, @code{TAB}, @code{SPC}, @code{DEL},
6545and @code{NUL} must be written in all uppercase, as must the prefixes
6546@code{C-} and @code{M-}.
d7b8e6c6
EZ
6547
6548Let's edit in a new definition, for computing harmonic numbers.
74857f83 6549First, erase the four lines of the old definition. Then, type
d7b8e6c6 6550in the new definition (or use Emacs @kbd{M-w} and @kbd{C-y} commands
74857f83
JB
6551to copy it from this page of the Info file; you can of course skip
6552typing the comments, which begin with @samp{;;}).
d7b8e6c6
EZ
6553
6554@smallexample
74857f83
JB
6555Z` ;; calc-kbd-push (Save local values)
65560 ;; calc digits (Push a zero onto the stack)
6557st ;; calc-store-into (Store it in the following variable)
65581 ;; calc quick variable (Quick variable q1)
65591 ;; calc digits (Initial value for the loop)
6560TAB ;; calc-roll-down (Swap initial and final)
6561Z( ;; calc-kbd-for (Begin the "for" loop)
6562& ;; calc-inv (Take the reciprocal)
6563s+ ;; calc-store-plus (Add to the following variable)
65641 ;; calc quick variable (Quick variable q1)
65651 ;; calc digits (The loop step is 1)
6566Z) ;; calc-kbd-end-for (End the "for" loop)
6567sr ;; calc-recall (Recall the final accumulated value)
65681 ;; calc quick variable (Quick variable q1)
6569Z' ;; calc-kbd-pop (Restore values)
d7b8e6c6
EZ
6570@end smallexample
6571
6572@noindent
33108698 6573Press @kbd{C-c C-c} to finish editing and return to the Calculator.
d7b8e6c6 6574
d7b8e6c6 6575@smallexample
5d67986c 6576@group
d7b8e6c6
EZ
65771: 20 1: 3.597739
6578 . .
6579
6580 20 z h
d7b8e6c6 6581@end group
5d67986c 6582@end smallexample
d7b8e6c6 6583
74857f83
JB
6584The @file{edmacro} package defines a handy @code{read-kbd-macro} command
6585which reads the current region of the current buffer as a sequence of
6586keystroke names, and defines that sequence on the @kbd{X}
6587(and @kbd{C-x e}) key. Because this is so useful, Calc puts this
6588command on the @kbd{M-# m} key. Try reading in this macro in the
6589following form: Press @kbd{C-@@} (or @kbd{C-@key{SPC}}) at
d7b8e6c6
EZ
6590one end of the text below, then type @kbd{M-# m} at the other.
6591
d7b8e6c6 6592@example
5d67986c 6593@group
d7b8e6c6 6594Z ` 0 t 1
aed79377 6595 1 TAB
d7b8e6c6
EZ
6596 Z ( & s + 1 1 Z )
6597 r 1
6598Z '
d7b8e6c6 6599@end group
5d67986c 6600@end example
d7b8e6c6
EZ
6601
6602(@bullet{}) @strong{Exercise 8.} A general algorithm for solving
6603equations numerically is @dfn{Newton's Method}. Given the equation
a4231b04
JB
6604@expr{f(x) = 0} for any function @expr{f}, and an initial guess
6605@expr{x_0} which is reasonably close to the desired solution, apply
d7b8e6c6
EZ
6606this formula over and over:
6607
6608@ifinfo
6609@example
6610new_x = x - f(x)/f'(x)
6611@end example
6612@end ifinfo
6613@tex
6614\beforedisplay
a4231b04 6615$$ x_{\rm new} = x - {f(x) \over f'(x)} $$
d7b8e6c6
EZ
6616\afterdisplay
6617@end tex
6618
6619@noindent
a4231b04 6620where @expr{f'(x)} is the derivative of @expr{f}. The @expr{x}
d7b8e6c6 6621values will quickly converge to a solution, i.e., eventually
8e04863e 6622@texline @math{x_{\rm new}}
a4231b04
JB
6623@infoline @expr{new_x}
6624and @expr{x} will be equal to within the limits
d7b8e6c6 6625of the current precision. Write a program which takes a formula
a4231b04
JB
6626involving the variable @expr{x}, and an initial guess @expr{x_0},
6627on the stack, and produces a value of @expr{x} for which the formula
6628is zero. Use it to find a solution of
8e04863e 6629@texline @math{\sin(\cos x) = 0.5}
a4231b04
JB
6630@infoline @expr{sin(cos(x)) = 0.5}
6631near @expr{x = 4.5}. (Use angles measured in radians.) Note that
d7b8e6c6
EZ
6632the built-in @w{@kbd{a R}} (@code{calc-find-root}) command uses Newton's
6633method when it is able. @xref{Programming Answer 8, 8}. (@bullet{})
6634
6635@cindex Digamma function
6636@cindex Gamma constant, Euler's
6637@cindex Euler's gamma constant
a4231b04 6638(@bullet{}) @strong{Exercise 9.} The @dfn{digamma} function
8e04863e 6639@texline @math{\psi(z) (``psi'')}
a4231b04
JB
6640@infoline @expr{psi(z)}
6641is defined as the derivative of
8e04863e 6642@texline @math{\ln \Gamma(z)}.
a4231b04
JB
6643@infoline @expr{ln(gamma(z))}.
6644For large values of @expr{z}, it can be approximated by the infinite sum
d7b8e6c6
EZ
6645
6646@ifinfo
6647@example
6648psi(z) ~= ln(z) - 1/2z - sum(bern(2 n) / 2 n z^(2 n), n, 1, inf)
6649@end example
6650@end ifinfo
6651@tex
d7b8e6c6
EZ
6652\beforedisplay
6653$$ \psi(z) \approx \ln z - {1\over2z} -
6654 \sum_{n=1}^\infty {\code{bern}(2 n) \over 2 n z^{2n}}
6655$$
6656\afterdisplay
6657@end tex
6658
6659@noindent
a4231b04 6660where
8e04863e 6661@texline @math{\sum}
a4231b04
JB
6662@infoline @expr{sum}
6663represents the sum over @expr{n} from 1 to infinity
d7b8e6c6
EZ
6664(or to some limit high enough to give the desired accuracy), and
6665the @code{bern} function produces (exact) Bernoulli numbers.
6666While this sum is not guaranteed to converge, in practice it is safe.
6667An interesting mathematical constant is Euler's gamma, which is equal
6668to about 0.5772. One way to compute it is by the formula,
8e04863e 6669@texline @math{\gamma = -\psi(1)}.
a4231b04
JB
6670@infoline @expr{gamma = -psi(1)}.
6671Unfortunately, 1 isn't a large enough argument
6672for the above formula to work (5 is a much safer value for @expr{z}).
6673Fortunately, we can compute
8e04863e 6674@texline @math{\psi(1)}
a4231b04
JB
6675@infoline @expr{psi(1)}
6676from
8e04863e 6677@texline @math{\psi(5)}
a4231b04
JB
6678@infoline @expr{psi(5)}
6679using the recurrence
8e04863e 6680@texline @math{\psi(z+1) = \psi(z) + {1 \over z}}.
a4231b04
JB
6681@infoline @expr{psi(z+1) = psi(z) + 1/z}.
6682Your task: Develop a program to compute
8e04863e 6683@texline @math{\psi(z)};
a4231b04
JB
6684@infoline @expr{psi(z)};
6685it should ``pump up'' @expr{z}
d7b8e6c6
EZ
6686if necessary to be greater than 5, then use the above summation
6687formula. Use looping commands to compute the sum. Use your function
a4231b04 6688to compute
8e04863e 6689@texline @math{\gamma}
a4231b04
JB
6690@infoline @expr{gamma}
6691to twelve decimal places. (Calc has a built-in command
d7b8e6c6
EZ
6692for Euler's constant, @kbd{I P}, which you can use to check your answer.)
6693@xref{Programming Answer 9, 9}. (@bullet{})
6694
6695@cindex Polynomial, list of coefficients
a4231b04
JB
6696(@bullet{}) @strong{Exercise 10.} Given a polynomial in @expr{x} and
6697a number @expr{m} on the stack, where the polynomial is of degree
6698@expr{m} or less (i.e., does not have any terms higher than @expr{x^m}),
d7b8e6c6 6699write a program to convert the polynomial into a list-of-coefficients
a4231b04
JB
6700notation. For example, @expr{5 x^4 + (x + 1)^2} with @expr{m = 6}
6701should produce the list @expr{[1, 2, 1, 0, 5, 0, 0]}. Also develop
d7b8e6c6
EZ
6702a way to convert from this form back to the standard algebraic form.
6703@xref{Programming Answer 10, 10}. (@bullet{})
6704
6705@cindex Recursion
6706(@bullet{}) @strong{Exercise 11.} The @dfn{Stirling numbers of the
6707first kind} are defined by the recurrences,
6708
6709@ifinfo
6710@example
6711s(n,n) = 1 for n >= 0,
6712s(n,0) = 0 for n > 0,
6713s(n+1,m) = s(n,m-1) - n s(n,m) for n >= m >= 1.
6714@end example
6715@end ifinfo
6716@tex
6717\turnoffactive
6718\beforedisplay
6719$$ \eqalign{ s(n,n) &= 1 \qquad \hbox{for } n \ge 0, \cr
6720 s(n,0) &= 0 \qquad \hbox{for } n > 0, \cr
6721 s(n+1,m) &= s(n,m-1) - n \, s(n,m) \qquad
6722 \hbox{for } n \ge m \ge 1.}
6723$$
6724\afterdisplay
6725\vskip5pt
6726(These numbers are also sometimes written $\displaystyle{n \brack m}$.)
6727@end tex
6728
6729This can be implemented using a @dfn{recursive} program in Calc; the
6730program must invoke itself in order to calculate the two righthand
6731terms in the general formula. Since it always invokes itself with
6732``simpler'' arguments, it's easy to see that it must eventually finish
6733the computation. Recursion is a little difficult with Emacs keyboard
6734macros since the macro is executed before its definition is complete.
6735So here's the recommended strategy: Create a ``dummy macro'' and assign
6736it to a key with, e.g., @kbd{Z K s}. Now enter the true definition,
6737using the @kbd{z s} command to call itself recursively, then assign it
6738to the same key with @kbd{Z K s}. Now the @kbd{z s} command will run
6739the complete recursive program. (Another way is to use @w{@kbd{Z E}}
6740or @kbd{M-# m} (@code{read-kbd-macro}) to read the whole macro at once,
6741thus avoiding the ``training'' phase.) The task: Write a program
a4231b04
JB
6742that computes Stirling numbers of the first kind, given @expr{n} and
6743@expr{m} on the stack. Test it with @emph{small} inputs like
6744@expr{s(4,2)}. (There is a built-in command for Stirling numbers,
d7b8e6c6
EZ
6745@kbd{k s}, which you can use to check your answers.)
6746@xref{Programming Answer 11, 11}. (@bullet{})
6747
6748The programming commands we've seen in this part of the tutorial
6749are low-level, general-purpose operations. Often you will find
6750that a higher-level function, such as vector mapping or rewrite
6751rules, will do the job much more easily than a detailed, step-by-step
6752program can:
6753
6754(@bullet{}) @strong{Exercise 12.} Write another program for
6755computing Stirling numbers of the first kind, this time using
a4231b04 6756rewrite rules. Once again, @expr{n} and @expr{m} should be taken
d7b8e6c6
EZ
6757from the stack. @xref{Programming Answer 12, 12}. (@bullet{})
6758
6759@example
6760
6761@end example
6762This ends the tutorial section of the Calc manual. Now you know enough
6763about Calc to use it effectively for many kinds of calculations. But
6764Calc has many features that were not even touched upon in this tutorial.
6765@c [not-split]
6766The rest of this manual tells the whole story.
6767@c [when-split]
6768@c Volume II of this manual, the @dfn{Calc Reference}, tells the whole story.
6769
6770@page
6771@node Answers to Exercises, , Programming Tutorial, Tutorial
6772@section Answers to Exercises
6773
6774@noindent
6775This section includes answers to all the exercises in the Calc tutorial.
6776
6777@menu
5d67986c 6778* RPN Answer 1:: 1 @key{RET} 2 @key{RET} 3 @key{RET} 4 + * -
d7b8e6c6
EZ
6779* RPN Answer 2:: 2*4 + 7*9.5 + 5/4
6780* RPN Answer 3:: Operating on levels 2 and 3
6781* RPN Answer 4:: Joe's complex problems
6782* Algebraic Answer 1:: Simulating Q command
6783* Algebraic Answer 2:: Joe's algebraic woes
6784* Algebraic Answer 3:: 1 / 0
6785* Modes Answer 1:: 3#0.1 = 3#0.0222222?
6786* Modes Answer 2:: 16#f.e8fe15
6787* Modes Answer 3:: Joe's rounding bug
6788* Modes Answer 4:: Why floating point?
6789* Arithmetic Answer 1:: Why the \ command?
6790* Arithmetic Answer 2:: Tripping up the B command
6791* Vector Answer 1:: Normalizing a vector
6792* Vector Answer 2:: Average position
6793* Matrix Answer 1:: Row and column sums
6794* Matrix Answer 2:: Symbolic system of equations
6795* Matrix Answer 3:: Over-determined system
6796* List Answer 1:: Powers of two
6797* List Answer 2:: Least-squares fit with matrices
6798* List Answer 3:: Geometric mean
6799* List Answer 4:: Divisor function
6800* List Answer 5:: Duplicate factors
6801* List Answer 6:: Triangular list
6802* List Answer 7:: Another triangular list
6803* List Answer 8:: Maximum of Bessel function
6804* List Answer 9:: Integers the hard way
6805* List Answer 10:: All elements equal
6806* List Answer 11:: Estimating pi with darts
6807* List Answer 12:: Estimating pi with matchsticks
6808* List Answer 13:: Hash codes
6809* List Answer 14:: Random walk
6810* Types Answer 1:: Square root of pi times rational
6811* Types Answer 2:: Infinities
6812* Types Answer 3:: What can "nan" be?
6813* Types Answer 4:: Abbey Road
6814* Types Answer 5:: Friday the 13th
6815* Types Answer 6:: Leap years
6816* Types Answer 7:: Erroneous donut
6817* Types Answer 8:: Dividing intervals
6818* Types Answer 9:: Squaring intervals
6819* Types Answer 10:: Fermat's primality test
6820* Types Answer 11:: pi * 10^7 seconds
6821* Types Answer 12:: Abbey Road on CD
6822* Types Answer 13:: Not quite pi * 10^7 seconds
6823* Types Answer 14:: Supercomputers and c
6824* Types Answer 15:: Sam the Slug
6825* Algebra Answer 1:: Squares and square roots
6826* Algebra Answer 2:: Building polynomial from roots
6827* Algebra Answer 3:: Integral of x sin(pi x)
6828* Algebra Answer 4:: Simpson's rule
6829* Rewrites Answer 1:: Multiplying by conjugate
6830* Rewrites Answer 2:: Alternative fib rule
6831* Rewrites Answer 3:: Rewriting opt(a) + opt(b) x
6832* Rewrites Answer 4:: Sequence of integers
6833* Rewrites Answer 5:: Number of terms in sum
8c399bc1 6834* Rewrites Answer 6:: Truncated Taylor series
d7b8e6c6
EZ
6835* Programming Answer 1:: Fresnel's C(x)
6836* Programming Answer 2:: Negate third stack element
6837* Programming Answer 3:: Compute sin(x) / x, etc.
6838* Programming Answer 4:: Average value of a list
6839* Programming Answer 5:: Continued fraction phi
6840* Programming Answer 6:: Matrix Fibonacci numbers
6841* Programming Answer 7:: Harmonic number greater than 4
6842* Programming Answer 8:: Newton's method
6843* Programming Answer 9:: Digamma function
6844* Programming Answer 10:: Unpacking a polynomial
6845* Programming Answer 11:: Recursive Stirling numbers
6846* Programming Answer 12:: Stirling numbers with rewrites
6847@end menu
6848
6849@c The following kludgery prevents the individual answers from
6850@c being entered on the table of contents.
6851@tex
6852\global\let\oldwrite=\write
6853\gdef\skipwrite#1#2{\let\write=\oldwrite}
6854\global\let\oldchapternofonts=\chapternofonts
6855\gdef\chapternofonts{\let\write=\skipwrite\oldchapternofonts}
6856@end tex
6857
6858@node RPN Answer 1, RPN Answer 2, Answers to Exercises, Answers to Exercises
6859@subsection RPN Tutorial Exercise 1
6860
6861@noindent
6862@kbd{1 @key{RET} 2 @key{RET} 3 @key{RET} 4 + * -}
6863
a4231b04 6864The result is
8e04863e 6865@texline @math{1 - (2 \times (3 + 4)) = -13}.
a4231b04 6866@infoline @expr{1 - (2 * (3 + 4)) = -13}.
d7b8e6c6
EZ
6867
6868@node RPN Answer 2, RPN Answer 3, RPN Answer 1, Answers to Exercises
6869@subsection RPN Tutorial Exercise 2
6870
6871@noindent
8e04863e 6872@texline @math{2\times4 + 7\times9.5 + {5\over4} = 75.75}
a4231b04 6873@infoline @expr{2*4 + 7*9.5 + 5/4 = 75.75}
d7b8e6c6 6874
a4231b04 6875After computing the intermediate term
8e04863e 6876@texline @math{2\times4 = 8},
a4231b04
JB
6877@infoline @expr{2*4 = 8},
6878you can leave that result on the stack while you compute the second
6879term. With both of these results waiting on the stack you can then
6880compute the final term, then press @kbd{+ +} to add everything up.
d7b8e6c6 6881
d7b8e6c6 6882@smallexample
5d67986c 6883@group
d7b8e6c6
EZ
68842: 2 1: 8 3: 8 2: 8
68851: 4 . 2: 7 1: 66.5
6886 . 1: 9.5 .
6887 .
6888
5d67986c 6889 2 @key{RET} 4 * 7 @key{RET} 9.5 *
d7b8e6c6 6890
d7b8e6c6 6891@end group
5d67986c 6892@end smallexample
d7b8e6c6 6893@noindent
d7b8e6c6 6894@smallexample
5d67986c 6895@group
d7b8e6c6
EZ
68964: 8 3: 8 2: 8 1: 75.75
68973: 66.5 2: 66.5 1: 67.75 .
68982: 5 1: 1.25 .
68991: 4 .
6900 .
6901
5d67986c 6902 5 @key{RET} 4 / + +
d7b8e6c6 6903@end group
5d67986c 6904@end smallexample
d7b8e6c6
EZ
6905
6906Alternatively, you could add the first two terms before going on
6907with the third term.
6908
d7b8e6c6 6909@smallexample
5d67986c 6910@group
d7b8e6c6
EZ
69112: 8 1: 74.5 3: 74.5 2: 74.5 1: 75.75
69121: 66.5 . 2: 5 1: 1.25 .
6913 . 1: 4 .
6914 .
6915
5d67986c 6916 ... + 5 @key{RET} 4 / +
d7b8e6c6 6917@end group
5d67986c 6918@end smallexample
d7b8e6c6
EZ
6919
6920On an old-style RPN calculator this second method would have the
6921advantage of using only three stack levels. But since Calc's stack
6922can grow arbitrarily large this isn't really an issue. Which method
6923you choose is purely a matter of taste.
6924
6925@node RPN Answer 3, RPN Answer 4, RPN Answer 2, Answers to Exercises
6926@subsection RPN Tutorial Exercise 3
6927
6928@noindent
6929The @key{TAB} key provides a way to operate on the number in level 2.
6930
d7b8e6c6 6931@smallexample
5d67986c 6932@group
d7b8e6c6
EZ
69333: 10 3: 10 4: 10 3: 10 3: 10
69342: 20 2: 30 3: 30 2: 30 2: 21
69351: 30 1: 20 2: 20 1: 21 1: 30
6936 . . 1: 1 . .
6937 .
6938
5d67986c 6939 @key{TAB} 1 + @key{TAB}
d7b8e6c6 6940@end group
5d67986c 6941@end smallexample
d7b8e6c6 6942
5d67986c 6943Similarly, @kbd{M-@key{TAB}} gives you access to the number in level 3.
d7b8e6c6 6944
d7b8e6c6 6945@smallexample
5d67986c 6946@group
d7b8e6c6
EZ
69473: 10 3: 21 3: 21 3: 30 3: 11
69482: 21 2: 30 2: 30 2: 11 2: 21
69491: 30 1: 10 1: 11 1: 21 1: 30
6950 . . . . .
6951
5d67986c 6952 M-@key{TAB} 1 + M-@key{TAB} M-@key{TAB}
d7b8e6c6 6953@end group
5d67986c 6954@end smallexample
d7b8e6c6
EZ
6955
6956@node RPN Answer 4, Algebraic Answer 1, RPN Answer 3, Answers to Exercises
6957@subsection RPN Tutorial Exercise 4
6958
6959@noindent
6960Either @kbd{( 2 , 3 )} or @kbd{( 2 @key{SPC} 3 )} would have worked,
6961but using both the comma and the space at once yields:
6962
d7b8e6c6 6963@smallexample
5d67986c 6964@group
d7b8e6c6
EZ
69651: ( ... 2: ( ... 1: (2, ... 2: (2, ... 2: (2, ...
6966 . 1: 2 . 1: (2, ... 1: (2, 3)
6967 . . .
6968
5d67986c 6969 ( 2 , @key{SPC} 3 )
d7b8e6c6 6970@end group
5d67986c 6971@end smallexample
d7b8e6c6
EZ
6972
6973Joe probably tried to type @kbd{@key{TAB} @key{DEL}} to swap the
6974extra incomplete object to the top of the stack and delete it.
6975But a feature of Calc is that @key{DEL} on an incomplete object
6976deletes just one component out of that object, so he had to press
6977@key{DEL} twice to finish the job.
6978
d7b8e6c6 6979@smallexample
5d67986c 6980@group
d7b8e6c6
EZ
69812: (2, ... 2: (2, 3) 2: (2, 3) 1: (2, 3)
69821: (2, 3) 1: (2, ... 1: ( ... .
6983 . . .
6984
5d67986c 6985 @key{TAB} @key{DEL} @key{DEL}
d7b8e6c6 6986@end group
5d67986c 6987@end smallexample
d7b8e6c6
EZ
6988
6989(As it turns out, deleting the second-to-top stack entry happens often
5d67986c
RS
6990enough that Calc provides a special key, @kbd{M-@key{DEL}}, to do just that.
6991@kbd{M-@key{DEL}} is just like @kbd{@key{TAB} @key{DEL}}, except that it doesn't exhibit
d7b8e6c6
EZ
6992the ``feature'' that tripped poor Joe.)
6993
6994@node Algebraic Answer 1, Algebraic Answer 2, RPN Answer 4, Answers to Exercises
6995@subsection Algebraic Entry Tutorial Exercise 1
6996
6997@noindent
6998Type @kbd{' sqrt($) @key{RET}}.
6999
7000If the @kbd{Q} key is broken, you could use @kbd{' $^0.5 @key{RET}}.
7001Or, RPN style, @kbd{0.5 ^}.
7002
7003(Actually, @samp{$^1:2}, using the fraction one-half as the power, is
a4231b04
JB
7004a closer equivalent, since @samp{9^0.5} yields @expr{3.0} whereas
7005@samp{sqrt(9)} and @samp{9^1:2} yield the exact integer @expr{3}.)
d7b8e6c6
EZ
7006
7007@node Algebraic Answer 2, Algebraic Answer 3, Algebraic Answer 1, Answers to Exercises
7008@subsection Algebraic Entry Tutorial Exercise 2
7009
7010@noindent
7011In the formula @samp{2 x (1+y)}, @samp{x} was interpreted as a function
7012name with @samp{1+y} as its argument. Assigning a value to a variable
7013has no relation to a function by the same name. Joe needed to use an
7014explicit @samp{*} symbol here: @samp{2 x*(1+y)}.
7015
7016@node Algebraic Answer 3, Modes Answer 1, Algebraic Answer 2, Answers to Exercises
7017@subsection Algebraic Entry Tutorial Exercise 3
7018
7019@noindent
a4231b04 7020The result from @kbd{1 @key{RET} 0 /} will be the formula @expr{1 / 0}.
d7b8e6c6
EZ
7021The ``function'' @samp{/} cannot be evaluated when its second argument
7022is zero, so it is left in symbolic form. When you now type @kbd{0 *},
7023the result will be zero because Calc uses the general rule that ``zero
7024times anything is zero.''
7025
7026@c [fix-ref Infinities]
07ce2eb3 7027The @kbd{m i} command enables an @dfn{Infinite mode} in which @expr{1 / 0}
d7b8e6c6
EZ
7028results in a special symbol that represents ``infinity.'' If you
7029multiply infinity by zero, Calc uses another special new symbol to
7030show that the answer is ``indeterminate.'' @xref{Infinities}, for
7031further discussion of infinite and indeterminate values.
7032
7033@node Modes Answer 1, Modes Answer 2, Algebraic Answer 3, Answers to Exercises
7034@subsection Modes Tutorial Exercise 1
7035
7036@noindent
7037Calc always stores its numbers in decimal, so even though one-third has
7038an exact base-3 representation (@samp{3#0.1}), it is still stored as
70390.3333333 (chopped off after 12 or however many decimal digits) inside
7040the calculator's memory. When this inexact number is converted back
7041to base 3 for display, it may still be slightly inexact. When we
7042multiply this number by 3, we get 0.999999, also an inexact value.
7043
7044When Calc displays a number in base 3, it has to decide how many digits
7045to show. If the current precision is 12 (decimal) digits, that corresponds
7046to @samp{12 / log10(3) = 25.15} base-3 digits. Because 25.15 is not an
7047exact integer, Calc shows only 25 digits, with the result that stored
7048numbers carry a little bit of extra information that may not show up on
7049the screen. When Joe entered @samp{3#0.2}, the stored number 0.666666
7050happened to round to a pleasing value when it lost that last 0.15 of a
7051digit, but it was still inexact in Calc's memory. When he divided by 2,
7052he still got the dreaded inexact value 0.333333. (Actually, he divided
70530.666667 by 2 to get 0.333334, which is why he got something a little
7054higher than @code{3#0.1} instead of a little lower.)
7055
7056If Joe didn't want to be bothered with all this, he could have typed
7057@kbd{M-24 d n} to display with one less digit than the default. (If
7058you give @kbd{d n} a negative argument, it uses default-minus-that,
7059so @kbd{M-- d n} would be an easier way to get the same effect.) Those
7060inexact results would still be lurking there, but they would now be
7061rounded to nice, natural-looking values for display purposes. (Remember,
7062@samp{0.022222} in base 3 is like @samp{0.099999} in base 10; rounding
7063off one digit will round the number up to @samp{0.1}.) Depending on the
7064nature of your work, this hiding of the inexactness may be a benefit or
7065a danger. With the @kbd{d n} command, Calc gives you the choice.
7066
7067Incidentally, another consequence of all this is that if you type
7068@kbd{M-30 d n} to display more digits than are ``really there,''
7069you'll see garbage digits at the end of the number. (In decimal
7070display mode, with decimally-stored numbers, these garbage digits are
7071always zero so they vanish and you don't notice them.) Because Calc
7072rounds off that 0.15 digit, there is the danger that two numbers could
7073be slightly different internally but still look the same. If you feel
7074uneasy about this, set the @kbd{d n} precision to be a little higher
7075than normal; you'll get ugly garbage digits, but you'll always be able
7076to tell two distinct numbers apart.
7077
7078An interesting side note is that most computers store their
7079floating-point numbers in binary, and convert to decimal for display.
7080Thus everyday programs have the same problem: Decimal 0.1 cannot be
7081represented exactly in binary (try it: @kbd{0.1 d 2}), so @samp{0.1 * 10}
7082comes out as an inexact approximation to 1 on some machines (though
7083they generally arrange to hide it from you by rounding off one digit as
7084we did above). Because Calc works in decimal instead of binary, you can
7085be sure that numbers that look exact @emph{are} exact as long as you stay
7086in decimal display mode.
7087
7088It's not hard to show that any number that can be represented exactly
7089in binary, octal, or hexadecimal is also exact in decimal, so the kinds
7090of problems we saw in this exercise are likely to be severe only when
7091you use a relatively unusual radix like 3.
7092
7093@node Modes Answer 2, Modes Answer 3, Modes Answer 1, Answers to Exercises
7094@subsection Modes Tutorial Exercise 2
7095
7096If the radix is 15 or higher, we can't use the letter @samp{e} to mark
7097the exponent because @samp{e} is interpreted as a digit. When Calc
7098needs to display scientific notation in a high radix, it writes
7099@samp{16#F.E8F*16.^15}. You can enter a number like this as an
7100algebraic entry. Also, pressing @kbd{e} without any digits before it
7101normally types @kbd{1e}, but in a high radix it types @kbd{16.^} and
5d67986c 7102puts you in algebraic entry: @kbd{16#f.e8f @key{RET} e 15 @key{RET} *} is another
d7b8e6c6
EZ
7103way to enter this number.
7104
7105The reason Calc puts a decimal point in the @samp{16.^} is to prevent
7106huge integers from being generated if the exponent is large (consider
7107@samp{16#1.23*16^1000}, where we compute @samp{16^1000} as a giant
7108exact integer and then throw away most of the digits when we multiply
7109it by the floating-point @samp{16#1.23}). While this wouldn't normally
7110matter for display purposes, it could give you a nasty surprise if you
7111copied that number into a file and later moved it back into Calc.
7112
7113@node Modes Answer 3, Modes Answer 4, Modes Answer 2, Answers to Exercises
7114@subsection Modes Tutorial Exercise 3
7115
7116@noindent
a4231b04 7117The answer he got was @expr{0.5000000000006399}.
d7b8e6c6
EZ
7118
7119The problem is not that the square operation is inexact, but that the
7120sine of 45 that was already on the stack was accurate to only 12 places.
7121Arbitrary-precision calculations still only give answers as good as
7122their inputs.
7123
7124The real problem is that there is no 12-digit number which, when
7125squared, comes out to 0.5 exactly. The @kbd{f [} and @kbd{f ]}
7126commands decrease or increase a number by one unit in the last
7127place (according to the current precision). They are useful for
7128determining facts like this.
7129
d7b8e6c6 7130@smallexample
5d67986c 7131@group
d7b8e6c6
EZ
71321: 0.707106781187 1: 0.500000000001
7133 . .
7134
7135 45 S 2 ^
7136
d7b8e6c6 7137@end group
5d67986c 7138@end smallexample
d7b8e6c6 7139@noindent
d7b8e6c6 7140@smallexample
5d67986c 7141@group
d7b8e6c6
EZ
71421: 0.707106781187 1: 0.707106781186 1: 0.499999999999
7143 . . .
7144
5d67986c 7145 U @key{DEL} f [ 2 ^
d7b8e6c6 7146@end group
5d67986c 7147@end smallexample
d7b8e6c6
EZ
7148
7149A high-precision calculation must be carried out in high precision
7150all the way. The only number in the original problem which was known
7151exactly was the quantity 45 degrees, so the precision must be raised
7152before anything is done after the number 45 has been entered in order
7153for the higher precision to be meaningful.
7154
7155@node Modes Answer 4, Arithmetic Answer 1, Modes Answer 3, Answers to Exercises
7156@subsection Modes Tutorial Exercise 4
7157
7158@noindent
7159Many calculations involve real-world quantities, like the width and
7160height of a piece of wood or the volume of a jar. Such quantities
7161can't be measured exactly anyway, and if the data that is input to
7162a calculation is inexact, doing exact arithmetic on it is a waste
7163of time.
7164
7165Fractions become unwieldy after too many calculations have been
7166done with them. For example, the sum of the reciprocals of the
7167integers from 1 to 10 is 7381:2520. The sum from 1 to 30 is
71689304682830147:2329089562800. After a point it will take a long
7169time to add even one more term to this sum, but a floating-point
7170calculation of the sum will not have this problem.
7171
7172Also, rational numbers cannot express the results of all calculations.
7173There is no fractional form for the square root of two, so if you type
7174@w{@kbd{2 Q}}, Calc has no choice but to give you a floating-point answer.
7175
7176@node Arithmetic Answer 1, Arithmetic Answer 2, Modes Answer 4, Answers to Exercises
7177@subsection Arithmetic Tutorial Exercise 1
7178
7179@noindent
7180Dividing two integers that are larger than the current precision may
7181give a floating-point result that is inaccurate even when rounded
a4231b04
JB
7182down to an integer. Consider @expr{123456789 / 2} when the current
7183precision is 6 digits. The true answer is @expr{61728394.5}, but
7184with a precision of 6 this will be rounded to
8e04863e 7185@texline @math{12345700.0/2.0 = 61728500.0}.
a4231b04 7186@infoline @expr{12345700.@: / 2.@: = 61728500.}.
d7b8e6c6
EZ
7187The result, when converted to an integer, will be off by 106.
7188
7189Here are two solutions: Raise the precision enough that the
7190floating-point round-off error is strictly to the right of the
07ce2eb3 7191decimal point. Or, convert to Fraction mode so that @expr{123456789 / 2}
a4231b04 7192produces the exact fraction @expr{123456789:2}, which can be rounded
d7b8e6c6
EZ
7193down by the @kbd{F} command without ever switching to floating-point
7194format.
7195
7196@node Arithmetic Answer 2, Vector Answer 1, Arithmetic Answer 1, Answers to Exercises
7197@subsection Arithmetic Tutorial Exercise 2
7198
7199@noindent
a4231b04
JB
7200@kbd{27 @key{RET} 9 B} could give the exact result @expr{3:2}, but it
7201does a floating-point calculation instead and produces @expr{1.5}.
d7b8e6c6
EZ
7202
7203Calc will find an exact result for a logarithm if the result is an integer
07ce2eb3
JB
7204or (when in Fraction mode) the reciprocal of an integer. But there is
7205no efficient way to search the space of all possible rational numbers
7206for an exact answer, so Calc doesn't try.
d7b8e6c6
EZ
7207
7208@node Vector Answer 1, Vector Answer 2, Arithmetic Answer 2, Answers to Exercises
7209@subsection Vector Tutorial Exercise 1
7210
7211@noindent
7212Duplicate the vector, compute its length, then divide the vector
7213by its length: @kbd{@key{RET} A /}.
7214
d7b8e6c6 7215@smallexample
5d67986c 7216@group
d7b8e6c6
EZ
72171: [1, 2, 3] 2: [1, 2, 3] 1: [0.27, 0.53, 0.80] 1: 1.
7218 . 1: 3.74165738677 . .
7219 .
7220
5d67986c 7221 r 1 @key{RET} A / A
d7b8e6c6 7222@end group
5d67986c 7223@end smallexample
d7b8e6c6
EZ
7224
7225The final @kbd{A} command shows that the normalized vector does
7226indeed have unit length.
7227
7228@node Vector Answer 2, Matrix Answer 1, Vector Answer 1, Answers to Exercises
7229@subsection Vector Tutorial Exercise 2
7230
7231@noindent
7232The average position is equal to the sum of the products of the
7233positions times their corresponding probabilities. This is the
7234definition of the dot product operation. So all you need to do
7235is to put the two vectors on the stack and press @kbd{*}.
7236
7237@node Matrix Answer 1, Matrix Answer 2, Vector Answer 2, Answers to Exercises
7238@subsection Matrix Tutorial Exercise 1
7239
7240@noindent
7241The trick is to multiply by a vector of ones. Use @kbd{r 4 [1 1 1] *} to
7242get the row sum. Similarly, use @kbd{[1 1] r 4 *} to get the column sum.
7243
7244@node Matrix Answer 2, Matrix Answer 3, Matrix Answer 1, Answers to Exercises
7245@subsection Matrix Tutorial Exercise 2
7246
7247@ifinfo
d7b8e6c6 7248@example
5d67986c 7249@group
d7b8e6c6
EZ
7250 x + a y = 6
7251 x + b y = 10
d7b8e6c6 7252@end group
5d67986c 7253@end example
d7b8e6c6
EZ
7254@end ifinfo
7255@tex
7256\turnoffactive
7257\beforedisplay
7258$$ \eqalign{ x &+ a y = 6 \cr
7259 x &+ b y = 10}
7260$$
7261\afterdisplay
7262@end tex
7263
7264Just enter the righthand side vector, then divide by the lefthand side
7265matrix as usual.
7266
d7b8e6c6 7267@smallexample
5d67986c 7268@group
d7b8e6c6
EZ
72691: [6, 10] 2: [6, 10] 1: [6 - 4 a / (b - a), 4 / (b - a) ]
7270 . 1: [ [ 1, a ] .
7271 [ 1, b ] ]
7272 .
7273
5d67986c 7274' [6 10] @key{RET} ' [1 a; 1 b] @key{RET} /
d7b8e6c6 7275@end group
5d67986c 7276@end smallexample
d7b8e6c6 7277
07ce2eb3 7278This can be made more readable using @kbd{d B} to enable Big display
d7b8e6c6
EZ
7279mode:
7280
d7b8e6c6 7281@smallexample
5d67986c 7282@group
d7b8e6c6
EZ
7283 4 a 4
72841: [6 - -----, -----]
7285 b - a b - a
d7b8e6c6 7286@end group
5d67986c 7287@end smallexample
d7b8e6c6 7288
07ce2eb3 7289Type @kbd{d N} to return to Normal display mode afterwards.
d7b8e6c6
EZ
7290
7291@node Matrix Answer 3, List Answer 1, Matrix Answer 2, Answers to Exercises
7292@subsection Matrix Tutorial Exercise 3
7293
7294@noindent
a4231b04 7295To solve
8e04863e 7296@texline @math{A^T A \, X = A^T B},
a4231b04
JB
7297@infoline @expr{trn(A) * A * X = trn(A) * B},
7298first we compute
8e04863e 7299@texline @math{A' = A^T A}
a4231b04
JB
7300@infoline @expr{A2 = trn(A) * A}
7301and
8e04863e 7302@texline @math{B' = A^T B};
a4231b04
JB
7303@infoline @expr{B2 = trn(A) * B};
7304now, we have a system
8e04863e 7305@texline @math{A' X = B'}
a4231b04
JB
7306@infoline @expr{A2 * X = B2}
7307which we can solve using Calc's @samp{/} command.
d7b8e6c6
EZ
7308
7309@ifinfo
d7b8e6c6 7310@example
5d67986c 7311@group
d7b8e6c6
EZ
7312 a + 2b + 3c = 6
7313 4a + 5b + 6c = 2
7314 7a + 6b = 3
7315 2a + 4b + 6c = 11
d7b8e6c6 7316@end group
5d67986c 7317@end example
d7b8e6c6
EZ
7318@end ifinfo
7319@tex
7320\turnoffactive
7321\beforedisplayh
7322$$ \openup1\jot \tabskip=0pt plus1fil
7323\halign to\displaywidth{\tabskip=0pt
7324 $\hfil#$&$\hfil{}#{}$&
7325 $\hfil#$&$\hfil{}#{}$&
7326 $\hfil#$&${}#\hfil$\tabskip=0pt plus1fil\cr
7327 a&+&2b&+&3c&=6 \cr
7328 4a&+&5b&+&6c&=2 \cr
7329 7a&+&6b& & &=3 \cr
7330 2a&+&4b&+&6c&=11 \cr}
7331$$
7332\afterdisplayh
7333@end tex
7334
7335The first step is to enter the coefficient matrix. We'll store it in
7336quick variable number 7 for later reference. Next, we compute the
8e04863e 7337@texline @math{B'}
a4231b04
JB
7338@infoline @expr{B2}
7339vector.
d7b8e6c6 7340
d7b8e6c6 7341@smallexample
5d67986c 7342@group
d7b8e6c6
EZ
73431: [ [ 1, 2, 3 ] 2: [ [ 1, 4, 7, 2 ] 1: [57, 84, 96]
7344 [ 4, 5, 6 ] [ 2, 5, 6, 4 ] .
7345 [ 7, 6, 0 ] [ 3, 6, 0, 6 ] ]
7346 [ 2, 4, 6 ] ] 1: [6, 2, 3, 11]
7347 . .
7348
5d67986c 7349' [1 2 3; 4 5 6; 7 6 0; 2 4 6] @key{RET} s 7 v t [6 2 3 11] *
d7b8e6c6 7350@end group
5d67986c 7351@end smallexample
d7b8e6c6
EZ
7352
7353@noindent
a4231b04 7354Now we compute the matrix
8e04863e 7355@texline @math{A'}
a4231b04
JB
7356@infoline @expr{A2}
7357and divide.
d7b8e6c6 7358
d7b8e6c6 7359@smallexample
5d67986c 7360@group
d7b8e6c6
EZ
73612: [57, 84, 96] 1: [-11.64, 14.08, -3.64]
73621: [ [ 70, 72, 39 ] .
7363 [ 72, 81, 60 ]
7364 [ 39, 60, 81 ] ]
7365 .
7366
7367 r 7 v t r 7 * /
d7b8e6c6 7368@end group
5d67986c 7369@end smallexample
d7b8e6c6
EZ
7370
7371@noindent
7372(The actual computed answer will be slightly inexact due to
7373round-off error.)
7374
a4231b04 7375Notice that the answers are similar to those for the
8e04863e 7376@texline @math{3\times3}
a4231b04
JB
7377@infoline 3x3
7378system solved in the text. That's because the fourth equation that was
d7b8e6c6
EZ
7379added to the system is almost identical to the first one multiplied
7380by two. (If it were identical, we would have gotten the exact same
a4231b04 7381answer since the
8e04863e 7382@texline @math{4\times3}
a4231b04
JB
7383@infoline 4x3
7384system would be equivalent to the original
8e04863e 7385@texline @math{3\times3}
a4231b04 7386@infoline 3x3
d7b8e6c6
EZ
7387system.)
7388
7389Since the first and fourth equations aren't quite equivalent, they
7390can't both be satisfied at once. Let's plug our answers back into
7391the original system of equations to see how well they match.
7392
d7b8e6c6 7393@smallexample
5d67986c 7394@group
d7b8e6c6
EZ
73952: [-11.64, 14.08, -3.64] 1: [5.6, 2., 3., 11.2]
73961: [ [ 1, 2, 3 ] .
7397 [ 4, 5, 6 ]
7398 [ 7, 6, 0 ]
7399 [ 2, 4, 6 ] ]
7400 .
7401
5d67986c 7402 r 7 @key{TAB} *
d7b8e6c6 7403@end group
5d67986c 7404@end smallexample
d7b8e6c6
EZ
7405
7406@noindent
a4231b04
JB
7407This is reasonably close to our original @expr{B} vector,
7408@expr{[6, 2, 3, 11]}.
d7b8e6c6
EZ
7409
7410@node List Answer 1, List Answer 2, Matrix Answer 3, Answers to Exercises
7411@subsection List Tutorial Exercise 1
7412
7413@noindent
7414We can use @kbd{v x} to build a vector of integers. This needs to be
7415adjusted to get the range of integers we desire. Mapping @samp{-}
7416across the vector will accomplish this, although it turns out the
7417plain @samp{-} key will work just as well.
7418
d7b8e6c6 7419@smallexample
5d67986c 7420@group
d7b8e6c6
EZ
74212: 2 2: 2
74221: [1, 2, 3, 4, 5, 6, 7, 8, 9] 1: [-4, -3, -2, -1, 0, 1, 2, 3, 4]
7423 . .
7424
5d67986c 7425 2 v x 9 @key{RET} 5 V M - or 5 -
d7b8e6c6 7426@end group
5d67986c 7427@end smallexample
d7b8e6c6
EZ
7428
7429@noindent
7430Now we use @kbd{V M ^} to map the exponentiation operator across the
7431vector.
7432
d7b8e6c6 7433@smallexample
5d67986c 7434@group
d7b8e6c6
EZ
74351: [0.0625, 0.125, 0.25, 0.5, 1, 2, 4, 8, 16]
7436 .
7437
7438 V M ^
d7b8e6c6 7439@end group
5d67986c 7440@end smallexample
d7b8e6c6
EZ
7441
7442@node List Answer 2, List Answer 3, List Answer 1, Answers to Exercises
7443@subsection List Tutorial Exercise 2
7444
7445@noindent
a4231b04 7446Given @expr{x} and @expr{y} vectors in quick variables 1 and 2 as before,
d7b8e6c6
EZ
7447the first job is to form the matrix that describes the problem.
7448
7449@ifinfo
7450@example
7451 m*x + b*1 = y
7452@end example
7453@end ifinfo
7454@tex
7455\turnoffactive
7456\beforedisplay
7457$$ m \times x + b \times 1 = y $$
7458\afterdisplay
7459@end tex
7460
a4231b04 7461Thus we want a
8e04863e 7462@texline @math{19\times2}
a4231b04
JB
7463@infoline 19x2
7464matrix with our @expr{x} vector as one column and
d7b8e6c6 7465ones as the other column. So, first we build the column of ones, then
a4231b04 7466we combine the two columns to form our @expr{A} matrix.
d7b8e6c6 7467
d7b8e6c6 7468@smallexample
5d67986c 7469@group
d7b8e6c6
EZ
74702: [1.34, 1.41, 1.49, ... ] 1: [ [ 1.34, 1 ]
74711: [1, 1, 1, ...] [ 1.41, 1 ]
7472 . [ 1.49, 1 ]
7473 @dots{}
7474
5d67986c 7475 r 1 1 v b 19 @key{RET} M-2 v p v t s 3
d7b8e6c6 7476@end group
5d67986c 7477@end smallexample
d7b8e6c6
EZ
7478
7479@noindent
a4231b04 7480Now we compute
8e04863e 7481@texline @math{A^T y}
a4231b04
JB
7482@infoline @expr{trn(A) * y}
7483and
8e04863e 7484@texline @math{A^T A}
a4231b04
JB
7485@infoline @expr{trn(A) * A}
7486and divide.
d7b8e6c6 7487
d7b8e6c6 7488@smallexample
5d67986c 7489@group
d7b8e6c6
EZ
74901: [33.36554, 13.613] 2: [33.36554, 13.613]
7491 . 1: [ [ 98.0003, 41.63 ]
7492 [ 41.63, 19 ] ]
7493 .
7494
7495 v t r 2 * r 3 v t r 3 *
d7b8e6c6 7496@end group
5d67986c 7497@end smallexample
d7b8e6c6
EZ
7498
7499@noindent
7500(Hey, those numbers look familiar!)
7501
d7b8e6c6 7502@smallexample
5d67986c 7503@group
d7b8e6c6
EZ
75041: [0.52141679, -0.425978]
7505 .
7506
7507 /
d7b8e6c6 7508@end group
5d67986c 7509@end smallexample
d7b8e6c6 7510
a4231b04 7511Since we were solving equations of the form
8e04863e 7512@texline @math{m \times x + b \times 1 = y},
a4231b04
JB
7513@infoline @expr{m*x + b*1 = y},
7514these numbers should be @expr{m} and @expr{b}, respectively. Sure
7515enough, they agree exactly with the result computed using @kbd{V M} and
7516@kbd{V R}!
d7b8e6c6
EZ
7517
7518The moral of this story: @kbd{V M} and @kbd{V R} will probably solve
7519your problem, but there is often an easier way using the higher-level
7520arithmetic functions!
7521
7522@c [fix-ref Curve Fitting]
7523In fact, there is a built-in @kbd{a F} command that does least-squares
7524fits. @xref{Curve Fitting}.
7525
7526@node List Answer 3, List Answer 4, List Answer 2, Answers to Exercises
7527@subsection List Tutorial Exercise 3
7528
7529@noindent
5d67986c 7530Move to one end of the list and press @kbd{C-@@} (or @kbd{C-@key{SPC}} or
d7b8e6c6
EZ
7531whatever) to set the mark, then move to the other end of the list
7532and type @w{@kbd{M-# g}}.
7533
d7b8e6c6 7534@smallexample
5d67986c 7535@group
d7b8e6c6
EZ
75361: [2.3, 6, 22, 15.1, 7, 15, 14, 7.5, 2.5]
7537 .
d7b8e6c6 7538@end group
5d67986c 7539@end smallexample
d7b8e6c6
EZ
7540
7541To make things interesting, let's assume we don't know at a glance
7542how many numbers are in this list. Then we could type:
7543
d7b8e6c6 7544@smallexample
5d67986c 7545@group
d7b8e6c6
EZ
75462: [2.3, 6, 22, ... ] 2: [2.3, 6, 22, ... ]
75471: [2.3, 6, 22, ... ] 1: 126356422.5
7548 . .
7549
5d67986c 7550 @key{RET} V R *
d7b8e6c6 7551
d7b8e6c6 7552@end group
5d67986c 7553@end smallexample
d7b8e6c6 7554@noindent
d7b8e6c6 7555@smallexample
5d67986c 7556@group
d7b8e6c6
EZ
75572: 126356422.5 2: 126356422.5 1: 7.94652913734
75581: [2.3, 6, 22, ... ] 1: 9 .
7559 . .
7560
5d67986c 7561 @key{TAB} v l I ^
d7b8e6c6 7562@end group
5d67986c 7563@end smallexample
d7b8e6c6
EZ
7564
7565@noindent
7566(The @kbd{I ^} command computes the @var{n}th root of a number.
7567You could also type @kbd{& ^} to take the reciprocal of 9 and
7568then raise the number to that power.)
7569
7570@node List Answer 4, List Answer 5, List Answer 3, Answers to Exercises
7571@subsection List Tutorial Exercise 4
7572
7573@noindent
a4231b04 7574A number @expr{j} is a divisor of @expr{n} if
8e04863e 7575@texline @math{n \mathbin{\hbox{\code{\%}}} j = 0}.
a4231b04
JB
7576@infoline @samp{n % j = 0}.
7577The first step is to get a vector that identifies the divisors.
d7b8e6c6 7578
d7b8e6c6 7579@smallexample
5d67986c 7580@group
d7b8e6c6
EZ
75812: 30 2: [0, 0, 0, 2, ...] 1: [1, 1, 1, 0, ...]
75821: [1, 2, 3, 4, ...] 1: 0 .
7583 . .
7584
5d67986c 7585 30 @key{RET} v x 30 @key{RET} s 1 V M % 0 V M a = s 2
d7b8e6c6 7586@end group
5d67986c 7587@end smallexample
d7b8e6c6
EZ
7588
7589@noindent
7590This vector has 1's marking divisors of 30 and 0's marking non-divisors.
7591
7592The zeroth divisor function is just the total number of divisors.
7593The first divisor function is the sum of the divisors.
7594
d7b8e6c6 7595@smallexample
5d67986c 7596@group
d7b8e6c6
EZ
75971: 8 3: 8 2: 8 2: 8
7598 2: [1, 2, 3, 4, ...] 1: [1, 2, 3, 0, ...] 1: 72
7599 1: [1, 1, 1, 0, ...] . .
7600 .
7601
7602 V R + r 1 r 2 V M * V R +
d7b8e6c6 7603@end group
5d67986c 7604@end smallexample
d7b8e6c6
EZ
7605
7606@noindent
7607Once again, the last two steps just compute a dot product for which
7608a simple @kbd{*} would have worked equally well.
7609
7610@node List Answer 5, List Answer 6, List Answer 4, Answers to Exercises
7611@subsection List Tutorial Exercise 5
7612
7613@noindent
7614The obvious first step is to obtain the list of factors with @kbd{k f}.
7615This list will always be in sorted order, so if there are duplicates
7616they will be right next to each other. A suitable method is to compare
7617the list with a copy of itself shifted over by one.
7618
d7b8e6c6 7619@smallexample
5d67986c 7620@group
d7b8e6c6
EZ
76211: [3, 7, 7, 7, 19] 2: [3, 7, 7, 7, 19] 2: [3, 7, 7, 7, 19, 0]
7622 . 1: [3, 7, 7, 7, 19, 0] 1: [0, 3, 7, 7, 7, 19]
7623 . .
7624
5d67986c 7625 19551 k f @key{RET} 0 | @key{TAB} 0 @key{TAB} |
d7b8e6c6 7626
d7b8e6c6 7627@end group
5d67986c 7628@end smallexample
d7b8e6c6 7629@noindent
d7b8e6c6 7630@smallexample
5d67986c 7631@group
d7b8e6c6
EZ
76321: [0, 0, 1, 1, 0, 0] 1: 2 1: 0
7633 . . .
7634
7635 V M a = V R + 0 a =
d7b8e6c6 7636@end group
5d67986c 7637@end smallexample
d7b8e6c6
EZ
7638
7639@noindent
7640Note that we have to arrange for both vectors to have the same length
7641so that the mapping operation works; no prime factor will ever be
7642zero, so adding zeros on the left and right is safe. From then on
7643the job is pretty straightforward.
7644
a4231b04 7645Incidentally, Calc provides the
8e04863e 7646@texline @dfn{M@"obius} @math{\mu}
a4231b04
JB
7647@infoline @dfn{Moebius mu}
7648function which is zero if and only if its argument is square-free. It
7649would be a much more convenient way to do the above test in practice.
d7b8e6c6
EZ
7650
7651@node List Answer 6, List Answer 7, List Answer 5, Answers to Exercises
7652@subsection List Tutorial Exercise 6
7653
7654@noindent
5d67986c 7655First use @kbd{v x 6 @key{RET}} to get a list of integers, then @kbd{V M v x}
d7b8e6c6
EZ
7656to get a list of lists of integers!
7657
7658@node List Answer 7, List Answer 8, List Answer 6, Answers to Exercises
7659@subsection List Tutorial Exercise 7
7660
7661@noindent
7662Here's one solution. First, compute the triangular list from the previous
7663exercise and type @kbd{1 -} to subtract one from all the elements.
7664
d7b8e6c6 7665@smallexample
5d67986c 7666@group
d7b8e6c6
EZ
76671: [ [0],
7668 [0, 1],
7669 [0, 1, 2],
7670 @dots{}
7671
7672 1 -
d7b8e6c6 7673@end group
5d67986c 7674@end smallexample
d7b8e6c6
EZ
7675
7676The numbers down the lefthand edge of the list we desire are called
a4231b04
JB
7677the ``triangular numbers'' (now you know why!). The @expr{n}th
7678triangular number is the sum of the integers from 1 to @expr{n}, and
7679can be computed directly by the formula
8e04863e 7680@texline @math{n (n+1) \over 2}.
a4231b04 7681@infoline @expr{n * (n+1) / 2}.
d7b8e6c6 7682
d7b8e6c6 7683@smallexample
5d67986c 7684@group
d7b8e6c6
EZ
76852: [ [0], [0, 1], ... ] 2: [ [0], [0, 1], ... ]
76861: [0, 1, 2, 3, 4, 5] 1: [0, 1, 3, 6, 10, 15]
7687 . .
7688
5d67986c 7689 v x 6 @key{RET} 1 - V M ' $ ($+1)/2 @key{RET}
d7b8e6c6 7690@end group
5d67986c 7691@end smallexample
d7b8e6c6
EZ
7692
7693@noindent
7694Adding this list to the above list of lists produces the desired
7695result:
7696
d7b8e6c6 7697@smallexample
5d67986c 7698@group
d7b8e6c6
EZ
76991: [ [0],
7700 [1, 2],
7701 [3, 4, 5],
7702 [6, 7, 8, 9],
7703 [10, 11, 12, 13, 14],
7704 [15, 16, 17, 18, 19, 20] ]
7705 .
7706
7707 V M +
d7b8e6c6 7708@end group
5d67986c 7709@end smallexample
d7b8e6c6
EZ
7710
7711If we did not know the formula for triangular numbers, we could have
7712computed them using a @kbd{V U +} command. We could also have
7713gotten them the hard way by mapping a reduction across the original
7714triangular list.
7715
d7b8e6c6 7716@smallexample
5d67986c 7717@group
d7b8e6c6
EZ
77182: [ [0], [0, 1], ... ] 2: [ [0], [0, 1], ... ]
77191: [ [0], [0, 1], ... ] 1: [0, 1, 3, 6, 10, 15]
7720 . .
7721
5d67986c 7722 @key{RET} V M V R +
d7b8e6c6 7723@end group
5d67986c 7724@end smallexample
d7b8e6c6
EZ
7725
7726@noindent
7727(This means ``map a @kbd{V R +} command across the vector,'' and
7728since each element of the main vector is itself a small vector,
7729@kbd{V R +} computes the sum of its elements.)
7730
7731@node List Answer 8, List Answer 9, List Answer 7, Answers to Exercises
7732@subsection List Tutorial Exercise 8
7733
7734@noindent
a4231b04 7735The first step is to build a list of values of @expr{x}.
d7b8e6c6 7736
d7b8e6c6 7737@smallexample
5d67986c 7738@group
d7b8e6c6
EZ
77391: [1, 2, 3, ..., 21] 1: [0, 1, 2, ..., 20] 1: [0, 0.25, 0.5, ..., 5]
7740 . . .
7741
5d67986c 7742 v x 21 @key{RET} 1 - 4 / s 1
d7b8e6c6 7743@end group
5d67986c 7744@end smallexample
d7b8e6c6
EZ
7745
7746Next, we compute the Bessel function values.
7747
d7b8e6c6 7748@smallexample
5d67986c 7749@group
d7b8e6c6
EZ
77501: [0., 0.124, 0.242, ..., -0.328]
7751 .
7752
5d67986c 7753 V M ' besJ(1,$) @key{RET}
d7b8e6c6 7754@end group
5d67986c 7755@end smallexample
d7b8e6c6
EZ
7756
7757@noindent
5d67986c 7758(Another way to do this would be @kbd{1 @key{TAB} V M f j}.)
d7b8e6c6
EZ
7759
7760A way to isolate the maximum value is to compute the maximum using
7761@kbd{V R X}, then compare all the Bessel values with that maximum.
7762
d7b8e6c6 7763@smallexample
5d67986c 7764@group
d7b8e6c6
EZ
77652: [0., 0.124, 0.242, ... ] 1: [0, 0, 0, ... ] 2: [0, 0, 0, ... ]
77661: 0.5801562 . 1: 1
7767 . .
7768
5d67986c 7769 @key{RET} V R X V M a = @key{RET} V R + @key{DEL}
d7b8e6c6 7770@end group
5d67986c 7771@end smallexample
d7b8e6c6
EZ
7772
7773@noindent
7774It's a good idea to verify, as in the last step above, that only
a4231b04 7775one value is equal to the maximum. (After all, a plot of
8e04863e 7776@texline @math{\sin x}
a4231b04 7777@infoline @expr{sin(x)}
d7b8e6c6
EZ
7778might have many points all equal to the maximum value, 1.)
7779
7780The vector we have now has a single 1 in the position that indicates
a4231b04 7781the maximum value of @expr{x}. Now it is a simple matter to convert
d7b8e6c6
EZ
7782this back into the corresponding value itself.
7783
d7b8e6c6 7784@smallexample
5d67986c 7785@group
d7b8e6c6
EZ
77862: [0, 0, 0, ... ] 1: [0, 0., 0., ... ] 1: 1.75
77871: [0, 0.25, 0.5, ... ] . .
7788 .
7789
7790 r 1 V M * V R +
d7b8e6c6 7791@end group
5d67986c 7792@end smallexample
d7b8e6c6 7793
a4231b04
JB
7794If @kbd{a =} had produced more than one @expr{1} value, this method
7795would have given the sum of all maximum @expr{x} values; not very
d7b8e6c6
EZ
7796useful! In this case we could have used @kbd{v m} (@code{calc-mask-vector})
7797instead. This command deletes all elements of a ``data'' vector that
7798correspond to zeros in a ``mask'' vector, leaving us with, in this
a4231b04 7799example, a vector of maximum @expr{x} values.
d7b8e6c6
EZ
7800
7801The built-in @kbd{a X} command maximizes a function using more
7802efficient methods. Just for illustration, let's use @kbd{a X}
7803to maximize @samp{besJ(1,x)} over this same interval.
7804
d7b8e6c6 7805@smallexample
5d67986c 7806@group
d7b8e6c6
EZ
78072: besJ(1, x) 1: [1.84115, 0.581865]
78081: [0 .. 5] .
7809 .
7810
5d67986c 7811' besJ(1,x), [0..5] @key{RET} a X x @key{RET}
d7b8e6c6 7812@end group
5d67986c 7813@end smallexample
d7b8e6c6
EZ
7814
7815@noindent
a4231b04 7816The output from @kbd{a X} is a vector containing the value of @expr{x}
d7b8e6c6
EZ
7817that maximizes the function, and the function's value at that maximum.
7818As you can see, our simple search got quite close to the right answer.
7819
7820@node List Answer 9, List Answer 10, List Answer 8, Answers to Exercises
7821@subsection List Tutorial Exercise 9
7822
7823@noindent
7824Step one is to convert our integer into vector notation.
7825
d7b8e6c6 7826@smallexample
5d67986c 7827@group
d7b8e6c6
EZ
78281: 25129925999 3: 25129925999
7829 . 2: 10
7830 1: [11, 10, 9, ..., 1, 0]
7831 .
7832
5d67986c 7833 25129925999 @key{RET} 10 @key{RET} 12 @key{RET} v x 12 @key{RET} -
d7b8e6c6 7834
d7b8e6c6 7835@end group
5d67986c 7836@end smallexample
d7b8e6c6 7837@noindent
d7b8e6c6 7838@smallexample
5d67986c 7839@group
d7b8e6c6
EZ
78401: 25129925999 1: [0, 2, 25, 251, 2512, ... ]
78412: [100000000000, ... ] .
7842 .
7843
7844 V M ^ s 1 V M \
d7b8e6c6 7845@end group
5d67986c 7846@end smallexample
d7b8e6c6
EZ
7847
7848@noindent
7849(Recall, the @kbd{\} command computes an integer quotient.)
7850
d7b8e6c6 7851@smallexample
5d67986c 7852@group
d7b8e6c6
EZ
78531: [0, 2, 5, 1, 2, 9, 9, 2, 5, 9, 9, 9]
7854 .
7855
7856 10 V M % s 2
d7b8e6c6 7857@end group
5d67986c 7858@end smallexample
d7b8e6c6
EZ
7859
7860Next we must increment this number. This involves adding one to
7861the last digit, plus handling carries. There is a carry to the
7862left out of a digit if that digit is a nine and all the digits to
7863the right of it are nines.
7864
d7b8e6c6 7865@smallexample
5d67986c 7866@group
d7b8e6c6
EZ
78671: [0, 0, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1] 1: [1, 1, 1, 0, 0, 1, ... ]
7868 . .
7869
7870 9 V M a = v v
7871
d7b8e6c6 7872@end group
5d67986c 7873@end smallexample
d7b8e6c6 7874@noindent
d7b8e6c6 7875@smallexample
5d67986c 7876@group
d7b8e6c6
EZ
78771: [1, 1, 1, 0, 0, 0, ... ] 1: [0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1]
7878 . .
7879
7880 V U * v v 1 |
d7b8e6c6 7881@end group
5d67986c 7882@end smallexample
d7b8e6c6
EZ
7883
7884@noindent
7885Accumulating @kbd{*} across a vector of ones and zeros will preserve
7886only the initial run of ones. These are the carries into all digits
7887except the rightmost digit. Concatenating a one on the right takes
7888care of aligning the carries properly, and also adding one to the
7889rightmost digit.
7890
d7b8e6c6 7891@smallexample
5d67986c 7892@group
d7b8e6c6
EZ
78932: [0, 0, 0, 0, ... ] 1: [0, 0, 2, 5, 1, 2, 9, 9, 2, 6, 0, 0, 0]
78941: [0, 0, 2, 5, ... ] .
7895 .
7896
7897 0 r 2 | V M + 10 V M %
d7b8e6c6 7898@end group
5d67986c 7899@end smallexample
d7b8e6c6
EZ
7900
7901@noindent
7902Here we have concatenated 0 to the @emph{left} of the original number;
7903this takes care of shifting the carries by one with respect to the
7904digits that generated them.
7905
7906Finally, we must convert this list back into an integer.
7907
d7b8e6c6 7908@smallexample
5d67986c 7909@group
d7b8e6c6
EZ
79103: [0, 0, 2, 5, ... ] 2: [0, 0, 2, 5, ... ]
79112: 1000000000000 1: [1000000000000, 100000000000, ... ]
79121: [100000000000, ... ] .
7913 .
7914
5d67986c 7915 10 @key{RET} 12 ^ r 1 |
d7b8e6c6 7916
d7b8e6c6 7917@end group
5d67986c 7918@end smallexample
d7b8e6c6 7919@noindent
d7b8e6c6 7920@smallexample
5d67986c 7921@group
d7b8e6c6
EZ
79221: [0, 0, 20000000000, 5000000000, ... ] 1: 25129926000
7923 . .
7924
7925 V M * V R +
d7b8e6c6 7926@end group
5d67986c 7927@end smallexample
d7b8e6c6
EZ
7928
7929@noindent
7930Another way to do this final step would be to reduce the formula
7931@w{@samp{10 $$ + $}} across the vector of digits.
7932
d7b8e6c6 7933@smallexample
5d67986c 7934@group
d7b8e6c6
EZ
79351: [0, 0, 2, 5, ... ] 1: 25129926000
7936 . .
7937
5d67986c 7938 V R ' 10 $$ + $ @key{RET}
d7b8e6c6 7939@end group
5d67986c 7940@end smallexample
d7b8e6c6
EZ
7941
7942@node List Answer 10, List Answer 11, List Answer 9, Answers to Exercises
7943@subsection List Tutorial Exercise 10
7944
7945@noindent
a4231b04
JB
7946For the list @expr{[a, b, c, d]}, the result is @expr{((a = b) = c) = d},
7947which will compare @expr{a} and @expr{b} to produce a 1 or 0, which is
7948then compared with @expr{c} to produce another 1 or 0, which is then
7949compared with @expr{d}. This is not at all what Joe wanted.
d7b8e6c6
EZ
7950
7951Here's a more correct method:
7952
d7b8e6c6 7953@smallexample
5d67986c 7954@group
d7b8e6c6
EZ
79551: [7, 7, 7, 8, 7] 2: [7, 7, 7, 8, 7]
7956 . 1: 7
7957 .
7958
5d67986c 7959 ' [7,7,7,8,7] @key{RET} @key{RET} v r 1 @key{RET}
d7b8e6c6 7960
d7b8e6c6 7961@end group
5d67986c 7962@end smallexample
d7b8e6c6 7963@noindent
d7b8e6c6 7964@smallexample
5d67986c 7965@group
d7b8e6c6
EZ
79661: [1, 1, 1, 0, 1] 1: 0
7967 . .
7968
7969 V M a = V R *
d7b8e6c6 7970@end group
5d67986c 7971@end smallexample
d7b8e6c6
EZ
7972
7973@node List Answer 11, List Answer 12, List Answer 10, Answers to Exercises
7974@subsection List Tutorial Exercise 11
7975
7976@noindent
a4231b04
JB
7977The circle of unit radius consists of those points @expr{(x,y)} for which
7978@expr{x^2 + y^2 < 1}. We start by generating a vector of @expr{x^2}
7979and a vector of @expr{y^2}.
d7b8e6c6
EZ
7980
7981We can make this go a bit faster by using the @kbd{v .} and @kbd{t .}
7982commands.
7983
d7b8e6c6 7984@smallexample
5d67986c 7985@group
d7b8e6c6
EZ
79862: [2., 2., ..., 2.] 2: [2., 2., ..., 2.]
79871: [2., 2., ..., 2.] 1: [1.16, 1.98, ..., 0.81]
7988 . .
7989
5d67986c 7990 v . t . 2. v b 100 @key{RET} @key{RET} V M k r
d7b8e6c6 7991
d7b8e6c6 7992@end group
5d67986c 7993@end smallexample
d7b8e6c6 7994@noindent
d7b8e6c6 7995@smallexample
5d67986c 7996@group
d7b8e6c6
EZ
79972: [2., 2., ..., 2.] 1: [0.026, 0.96, ..., 0.036]
79981: [0.026, 0.96, ..., 0.036] 2: [0.53, 0.81, ..., 0.094]
7999 . .
8000
5d67986c 8001 1 - 2 V M ^ @key{TAB} V M k r 1 - 2 V M ^
d7b8e6c6 8002@end group
5d67986c 8003@end smallexample
d7b8e6c6 8004
a4231b04 8005Now we sum the @expr{x^2} and @expr{y^2} values, compare with 1 to
d7b8e6c6
EZ
8006get a vector of 1/0 truth values, then sum the truth values.
8007
d7b8e6c6 8008@smallexample
5d67986c 8009@group
d7b8e6c6
EZ
80101: [0.56, 1.78, ..., 0.13] 1: [1, 0, ..., 1] 1: 84
8011 . . .
8012
8013 + 1 V M a < V R +
d7b8e6c6 8014@end group
5d67986c 8015@end smallexample
d7b8e6c6
EZ
8016
8017@noindent
a4231b04 8018The ratio @expr{84/100} should approximate the ratio @cpiover{4}.
d7b8e6c6 8019
d7b8e6c6 8020@smallexample
5d67986c 8021@group
d7b8e6c6
EZ
80221: 0.84 1: 3.36 2: 3.36 1: 1.0695
8023 . . 1: 3.14159 .
8024
8025 100 / 4 * P /
d7b8e6c6 8026@end group
5d67986c 8027@end smallexample
d7b8e6c6
EZ
8028
8029@noindent
8030Our estimate, 3.36, is off by about 7%. We could get a better estimate
8031by taking more points (say, 1000), but it's clear that this method is
8032not very efficient!
8033
8034(Naturally, since this example uses random numbers your own answer
8035will be slightly different from the one shown here!)
8036
8037If you typed @kbd{v .} and @kbd{t .} before, type them again to
8038return to full-sized display of vectors.
8039
8040@node List Answer 12, List Answer 13, List Answer 11, Answers to Exercises
8041@subsection List Tutorial Exercise 12
8042
8043@noindent
8044This problem can be made a lot easier by taking advantage of some
8045symmetries. First of all, after some thought it's clear that the
a4231b04
JB
8046@expr{y} axis can be ignored altogether. Just pick a random @expr{x}
8047component for one end of the match, pick a random direction
8e04863e 8048@texline @math{\theta},
a4231b04
JB
8049@infoline @expr{theta},
8050and see if @expr{x} and
8e04863e 8051@texline @math{x + \cos \theta}
a4231b04
JB
8052@infoline @expr{x + cos(theta)}
8053(which is the @expr{x} coordinate of the other endpoint) cross a line.
8054The lines are at integer coordinates, so this happens when the two
8055numbers surround an integer.
d7b8e6c6
EZ
8056
8057Since the two endpoints are equivalent, we may as well choose the leftmost
a4231b04 8058of the two endpoints as @expr{x}. Then @expr{theta} is an angle pointing
d7b8e6c6 8059to the right, in the range -90 to 90 degrees. (We could use radians, but
a4231b04
JB
8060it would feel like cheating to refer to @cpiover{2} radians while trying
8061to estimate @cpi{}!)
d7b8e6c6
EZ
8062
8063In fact, since the field of lines is infinite we can choose the
8064coordinates 0 and 1 for the lines on either side of the leftmost
8065endpoint. The rightmost endpoint will be between 0 and 1 if the
8066match does not cross a line, or between 1 and 2 if it does. So:
a4231b04 8067Pick random @expr{x} and
8e04863e 8068@texline @math{\theta},
a4231b04
JB
8069@infoline @expr{theta},
8070compute
8e04863e 8071@texline @math{x + \cos \theta},
a4231b04 8072@infoline @expr{x + cos(theta)},
d7b8e6c6
EZ
8073and count how many of the results are greater than one. Simple!
8074
8075We can make this go a bit faster by using the @kbd{v .} and @kbd{t .}
8076commands.
8077
d7b8e6c6 8078@smallexample
5d67986c 8079@group
d7b8e6c6
EZ
80801: [0.52, 0.71, ..., 0.72] 2: [0.52, 0.71, ..., 0.72]
8081 . 1: [78.4, 64.5, ..., -42.9]
8082 .
8083
5d67986c 8084v . t . 1. v b 100 @key{RET} V M k r 180. v b 100 @key{RET} V M k r 90 -
d7b8e6c6 8085@end group
5d67986c 8086@end smallexample
d7b8e6c6
EZ
8087
8088@noindent
8089(The next step may be slow, depending on the speed of your computer.)
8090
d7b8e6c6 8091@smallexample
5d67986c 8092@group
d7b8e6c6
EZ
80932: [0.52, 0.71, ..., 0.72] 1: [0.72, 1.14, ..., 1.45]
80941: [0.20, 0.43, ..., 0.73] .
8095 .
8096
8097 m d V M C +
8098
d7b8e6c6 8099@end group
5d67986c 8100@end smallexample
d7b8e6c6 8101@noindent
d7b8e6c6 8102@smallexample
5d67986c 8103@group
d7b8e6c6
EZ
81041: [0, 1, ..., 1] 1: 0.64 1: 3.125
8105 . . .
8106
5d67986c 8107 1 V M a > V R + 100 / 2 @key{TAB} /
d7b8e6c6 8108@end group
5d67986c 8109@end smallexample
d7b8e6c6
EZ
8110
8111Let's try the third method, too. We'll use random integers up to
8112one million. The @kbd{k r} command with an integer argument picks
8113a random integer.
8114
d7b8e6c6 8115@smallexample
5d67986c 8116@group
d7b8e6c6
EZ
81172: [1000000, 1000000, ..., 1000000] 2: [78489, 527587, ..., 814975]
81181: [1000000, 1000000, ..., 1000000] 1: [324014, 358783, ..., 955450]
8119 . .
8120
5d67986c 8121 1000000 v b 100 @key{RET} @key{RET} V M k r @key{TAB} V M k r
d7b8e6c6 8122
d7b8e6c6 8123@end group
5d67986c 8124@end smallexample
d7b8e6c6 8125@noindent
d7b8e6c6 8126@smallexample
5d67986c 8127@group
d7b8e6c6
EZ
81281: [1, 1, ..., 25] 1: [1, 1, ..., 0] 1: 0.56
8129 . . .
8130
8131 V M k g 1 V M a = V R + 100 /
8132
d7b8e6c6 8133@end group
5d67986c 8134@end smallexample
d7b8e6c6 8135@noindent
d7b8e6c6 8136@smallexample
5d67986c 8137@group
d7b8e6c6
EZ
81381: 10.714 1: 3.273
8139 . .
8140
5d67986c 8141 6 @key{TAB} / Q
d7b8e6c6 8142@end group
5d67986c 8143@end smallexample
d7b8e6c6
EZ
8144
8145For a proof of this property of the GCD function, see section 4.5.2,
8146exercise 10, of Knuth's @emph{Art of Computer Programming}, volume II.
8147
8148If you typed @kbd{v .} and @kbd{t .} before, type them again to
8149return to full-sized display of vectors.
8150
8151@node List Answer 13, List Answer 14, List Answer 12, Answers to Exercises
8152@subsection List Tutorial Exercise 13
8153
8154@noindent
8155First, we put the string on the stack as a vector of ASCII codes.
8156
d7b8e6c6 8157@smallexample
5d67986c 8158@group
d7b8e6c6
EZ
81591: [84, 101, 115, ..., 51]
8160 .
8161
5d67986c 8162 "Testing, 1, 2, 3 @key{RET}
d7b8e6c6 8163@end group
5d67986c 8164@end smallexample
d7b8e6c6
EZ
8165
8166@noindent
8167Note that the @kbd{"} key, like @kbd{$}, initiates algebraic entry so
8168there was no need to type an apostrophe. Also, Calc didn't mind that
8169we omitted the closing @kbd{"}. (The same goes for all closing delimiters
8170like @kbd{)} and @kbd{]} at the end of a formula.
8171
8172We'll show two different approaches here. In the first, we note that
a4231b04
JB
8173if the input vector is @expr{[a, b, c, d]}, then the hash code is
8174@expr{3 (3 (3a + b) + c) + d = 27a + 9b + 3c + d}. In other words,
d7b8e6c6
EZ
8175it's a sum of descending powers of three times the ASCII codes.
8176
d7b8e6c6 8177@smallexample
5d67986c 8178@group
d7b8e6c6
EZ
81792: [84, 101, 115, ..., 51] 2: [84, 101, 115, ..., 51]
81801: 16 1: [15, 14, 13, ..., 0]
8181 . .
8182
5d67986c 8183 @key{RET} v l v x 16 @key{RET} -
d7b8e6c6 8184
d7b8e6c6 8185@end group
5d67986c 8186@end smallexample
d7b8e6c6 8187@noindent
d7b8e6c6 8188@smallexample
5d67986c 8189@group
d7b8e6c6
EZ
81902: [84, 101, 115, ..., 51] 1: 1960915098 1: 121
81911: [14348907, ..., 1] . .
8192 .
8193
5d67986c 8194 3 @key{TAB} V M ^ * 511 %
d7b8e6c6 8195@end group
5d67986c 8196@end smallexample
d7b8e6c6
EZ
8197
8198@noindent
8199Once again, @kbd{*} elegantly summarizes most of the computation.
8200But there's an even more elegant approach: Reduce the formula
8201@kbd{3 $$ + $} across the vector. Recall that this represents a
8202function of two arguments that computes its first argument times three
8203plus its second argument.
8204
d7b8e6c6 8205@smallexample
5d67986c 8206@group
d7b8e6c6
EZ
82071: [84, 101, 115, ..., 51] 1: 1960915098
8208 . .
8209
5d67986c 8210 "Testing, 1, 2, 3 @key{RET} V R ' 3$$+$ @key{RET}
d7b8e6c6 8211@end group
5d67986c 8212@end smallexample
d7b8e6c6
EZ
8213
8214@noindent
8215If you did the decimal arithmetic exercise, this will be familiar.
8216Basically, we're turning a base-3 vector of digits into an integer,
8217except that our ``digits'' are much larger than real digits.
8218
8219Instead of typing @kbd{511 %} again to reduce the result, we can be
8220cleverer still and notice that rather than computing a huge integer
8221and taking the modulo at the end, we can take the modulo at each step
8222without affecting the result. While this means there are more
8223arithmetic operations, the numbers we operate on remain small so
8224the operations are faster.
8225
d7b8e6c6 8226@smallexample
5d67986c 8227@group
d7b8e6c6
EZ
82281: [84, 101, 115, ..., 51] 1: 121
8229 . .
8230
5d67986c 8231 "Testing, 1, 2, 3 @key{RET} V R ' (3$$+$)%511 @key{RET}
d7b8e6c6 8232@end group
5d67986c 8233@end smallexample
d7b8e6c6
EZ
8234
8235Why does this work? Think about a two-step computation:
a4231b04 8236@w{@expr{3 (3a + b) + c}}. Taking a result modulo 511 basically means
d7b8e6c6
EZ
8237subtracting off enough 511's to put the result in the desired range.
8238So the result when we take the modulo after every step is,
8239
8240@ifinfo
8241@example
82423 (3 a + b - 511 m) + c - 511 n
8243@end example
8244@end ifinfo
8245@tex
8246\turnoffactive
8247\beforedisplay
8248$$ 3 (3 a + b - 511 m) + c - 511 n $$
8249\afterdisplay
8250@end tex
8251
8252@noindent
a4231b04 8253for some suitable integers @expr{m} and @expr{n}. Expanding out by
d7b8e6c6
EZ
8254the distributive law yields
8255
8256@ifinfo
8257@example
82589 a + 3 b + c - 511*3 m - 511 n
8259@end example
8260@end ifinfo
8261@tex
8262\turnoffactive
8263\beforedisplay
8264$$ 9 a + 3 b + c - 511\times3 m - 511 n $$
8265\afterdisplay
8266@end tex
8267
8268@noindent
a4231b04
JB
8269The @expr{m} term in the latter formula is redundant because any
8270contribution it makes could just as easily be made by the @expr{n}
d7b8e6c6 8271term. So we can take it out to get an equivalent formula with
a4231b04 8272@expr{n' = 3m + n},
d7b8e6c6
EZ
8273
8274@ifinfo
8275@example
82769 a + 3 b + c - 511 n'
8277@end example
8278@end ifinfo
8279@tex
8280\turnoffactive
8281\beforedisplay
8282$$ 9 a + 3 b + c - 511 n' $$
8283\afterdisplay
8284@end tex
8285
8286@noindent
8287which is just the formula for taking the modulo only at the end of
8288the calculation. Therefore the two methods are essentially the same.
8289
8290Later in the tutorial we will encounter @dfn{modulo forms}, which
8291basically automate the idea of reducing every intermediate result
5d67986c 8292modulo some value @var{m}.
d7b8e6c6
EZ
8293
8294@node List Answer 14, Types Answer 1, List Answer 13, Answers to Exercises
8295@subsection List Tutorial Exercise 14
8296
8297We want to use @kbd{H V U} to nest a function which adds a random
a4231b04 8298step to an @expr{(x,y)} coordinate. The function is a bit long, but
d7b8e6c6
EZ
8299otherwise the problem is quite straightforward.
8300
d7b8e6c6 8301@smallexample
5d67986c 8302@group
d7b8e6c6
EZ
83032: [0, 0] 1: [ [ 0, 0 ]
83041: 50 [ 0.4288, -0.1695 ]
8305 . [ -0.4787, -0.9027 ]
8306 ...
8307
5d67986c 8308 [0,0] 50 H V U ' <# + [random(2.0)-1, random(2.0)-1]> @key{RET}
d7b8e6c6 8309@end group
5d67986c 8310@end smallexample
d7b8e6c6
EZ
8311
8312Just as the text recommended, we used @samp{< >} nameless function
8313notation to keep the two @code{random} calls from being evaluated
8314before nesting even begins.
8315
a4231b04 8316We now have a vector of @expr{[x, y]} sub-vectors, which by Calc's
d7b8e6c6 8317rules acts like a matrix. We can transpose this matrix and unpack
a4231b04 8318to get a pair of vectors, @expr{x} and @expr{y}, suitable for graphing.
d7b8e6c6 8319
d7b8e6c6 8320@smallexample
5d67986c 8321@group
d7b8e6c6
EZ
83222: [ 0, 0.4288, -0.4787, ... ]
83231: [ 0, -0.1696, -0.9027, ... ]
8324 .
8325
8326 v t v u g f
d7b8e6c6 8327@end group
5d67986c 8328@end smallexample
d7b8e6c6 8329
a4231b04 8330Incidentally, because the @expr{x} and @expr{y} are completely
d7b8e6c6 8331independent in this case, we could have done two separate commands
a4231b04 8332to create our @expr{x} and @expr{y} vectors of numbers directly.
d7b8e6c6
EZ
8333
8334To make a random walk of unit steps, we note that @code{sincos} of
a4231b04 8335a random direction exactly gives us an @expr{[x, y]} step of unit
d7b8e6c6
EZ
8336length; in fact, the new nesting function is even briefer, though
8337we might want to lower the precision a bit for it.
8338
d7b8e6c6 8339@smallexample
5d67986c 8340@group
d7b8e6c6
EZ
83412: [0, 0] 1: [ [ 0, 0 ]
83421: 50 [ 0.1318, 0.9912 ]
8343 . [ -0.5965, 0.3061 ]
8344 ...
8345
5d67986c 8346 [0,0] 50 m d p 6 @key{RET} H V U ' <# + sincos(random(360.0))> @key{RET}
d7b8e6c6 8347@end group
5d67986c 8348@end smallexample
d7b8e6c6
EZ
8349
8350Another @kbd{v t v u g f} sequence will graph this new random walk.
8351
8352An interesting twist on these random walk functions would be to use
8353complex numbers instead of 2-vectors to represent points on the plane.
8354In the first example, we'd use something like @samp{random + random*(0,1)},
8355and in the second we could use polar complex numbers with random phase
8356angles. (This exercise was first suggested in this form by Randal
8357Schwartz.)
8358
8359@node Types Answer 1, Types Answer 2, List Answer 14, Answers to Exercises
8360@subsection Types Tutorial Exercise 1
8361
8362@noindent
a4231b04
JB
8363If the number is the square root of @cpi{} times a rational number,
8364then its square, divided by @cpi{}, should be a rational number.
d7b8e6c6 8365
d7b8e6c6 8366@smallexample
5d67986c 8367@group
d7b8e6c6
EZ
83681: 1.26508260337 1: 0.509433962268 1: 2486645810:4881193627
8369 . . .
8370
8371 2 ^ P / c F
d7b8e6c6 8372@end group
5d67986c 8373@end smallexample
d7b8e6c6
EZ
8374
8375@noindent
8376Technically speaking this is a rational number, but not one that is
8377likely to have arisen in the original problem. More likely, it just
8378happens to be the fraction which most closely represents some
8379irrational number to within 12 digits.
8380
8381But perhaps our result was not quite exact. Let's reduce the
8382precision slightly and try again:
8383
d7b8e6c6 8384@smallexample
5d67986c 8385@group
d7b8e6c6
EZ
83861: 0.509433962268 1: 27:53
8387 . .
8388
5d67986c 8389 U p 10 @key{RET} c F
d7b8e6c6 8390@end group
5d67986c 8391@end smallexample
d7b8e6c6
EZ
8392
8393@noindent
8394Aha! It's unlikely that an irrational number would equal a fraction
8395this simple to within ten digits, so our original number was probably
8e04863e 8396@texline @math{\sqrt{27 \pi / 53}}.
a4231b04 8397@infoline @expr{sqrt(27 pi / 53)}.
d7b8e6c6
EZ
8398
8399Notice that we didn't need to re-round the number when we reduced the
8400precision. Remember, arithmetic operations always round their inputs
8401to the current precision before they begin.
8402
8403@node Types Answer 2, Types Answer 3, Types Answer 1, Answers to Exercises
8404@subsection Types Tutorial Exercise 2
8405
8406@noindent
8407@samp{inf / inf = nan}. Perhaps @samp{1} is the ``obvious'' answer.
8408But if @w{@samp{17 inf = inf}}, then @samp{17 inf / inf = inf / inf = 17}, too.
8409
8410@samp{exp(inf) = inf}. It's tempting to say that the exponential
8411of infinity must be ``bigger'' than ``regular'' infinity, but as
8412far as Calc is concerned all infinities are as just as big.
a4231b04
JB
8413In other words, as @expr{x} goes to infinity, @expr{e^x} also goes
8414to infinity, but the fact the @expr{e^x} grows much faster than
8415@expr{x} is not relevant here.
d7b8e6c6
EZ
8416
8417@samp{exp(-inf) = 0}. Here we have a finite answer even though
8418the input is infinite.
8419
a4231b04
JB
8420@samp{sqrt(-inf) = (0, 1) inf}. Remember that @expr{(0, 1)}
8421represents the imaginary number @expr{i}. Here's a derivation:
d7b8e6c6 8422@samp{sqrt(-inf) = @w{sqrt((-1) * inf)} = sqrt(-1) * sqrt(inf)}.
a4231b04 8423The first part is, by definition, @expr{i}; the second is @code{inf}
d7b8e6c6
EZ
8424because, once again, all infinities are the same size.
8425
8426@samp{sqrt(uinf) = uinf}. In fact, we do know something about the
8427direction because @code{sqrt} is defined to return a value in the
8428right half of the complex plane. But Calc has no notation for this,
8429so it settles for the conservative answer @code{uinf}.
8430
a4231b04 8431@samp{abs(uinf) = inf}. No matter which direction @expr{x} points,
d7b8e6c6
EZ
8432@samp{abs(x)} always points along the positive real axis.
8433
8434@samp{ln(0) = -inf}. Here we have an infinite answer to a finite
a4231b04 8435input. As in the @expr{1 / 0} case, Calc will only use infinities
07ce2eb3 8436here if you have turned on Infinite mode. Otherwise, it will
d7b8e6c6
EZ
8437treat @samp{ln(0)} as an error.
8438
8439@node Types Answer 3, Types Answer 4, Types Answer 2, Answers to Exercises
8440@subsection Types Tutorial Exercise 3
8441
8442@noindent
8443We can make @samp{inf - inf} be any real number we like, say,
a4231b04 8444@expr{a}, just by claiming that we added @expr{a} to the first
d7b8e6c6 8445infinity but not to the second. This is just as true for complex
a4231b04 8446values of @expr{a}, so @code{nan} can stand for a complex number.
d7b8e6c6
EZ
8447(And, similarly, @code{uinf} can stand for an infinity that points
8448in any direction in the complex plane, such as @samp{(0, 1) inf}).
8449
8450In fact, we can multiply the first @code{inf} by two. Surely
8451@w{@samp{2 inf - inf = inf}}, but also @samp{2 inf - inf = inf - inf = nan}.
8452So @code{nan} can even stand for infinity. Obviously it's just
8453as easy to make it stand for minus infinity as for plus infinity.
8454
8455The moral of this story is that ``infinity'' is a slippery fish
8456indeed, and Calc tries to handle it by having a very simple model
8457for infinities (only the direction counts, not the ``size''); but
8458Calc is careful to write @code{nan} any time this simple model is
8459unable to tell what the true answer is.
8460
8461@node Types Answer 4, Types Answer 5, Types Answer 3, Answers to Exercises
8462@subsection Types Tutorial Exercise 4
8463
d7b8e6c6 8464@smallexample
5d67986c 8465@group
d7b8e6c6
EZ
84662: 0@@ 47' 26" 1: 0@@ 2' 47.411765"
84671: 17 .
8468 .
8469
5d67986c 8470 0@@ 47' 26" @key{RET} 17 /
d7b8e6c6 8471@end group
5d67986c 8472@end smallexample
d7b8e6c6
EZ
8473
8474@noindent
8475The average song length is two minutes and 47.4 seconds.
8476
d7b8e6c6 8477@smallexample
5d67986c 8478@group
d7b8e6c6
EZ
84792: 0@@ 2' 47.411765" 1: 0@@ 3' 7.411765" 1: 0@@ 53' 6.000005"
84801: 0@@ 0' 20" . .
8481 .
8482
8483 20" + 17 *
d7b8e6c6 8484@end group
5d67986c 8485@end smallexample
d7b8e6c6
EZ
8486
8487@noindent
8488The album would be 53 minutes and 6 seconds long.
8489
8490@node Types Answer 5, Types Answer 6, Types Answer 4, Answers to Exercises
8491@subsection Types Tutorial Exercise 5
8492
8493@noindent
8494Let's suppose it's January 14, 1991. The easiest thing to do is
8495to keep trying 13ths of months until Calc reports a Friday.
8496We can do this by manually entering dates, or by using @kbd{t I}:
8497
d7b8e6c6 8498@smallexample
5d67986c 8499@group
d7b8e6c6
EZ
85001: <Wed Feb 13, 1991> 1: <Wed Mar 13, 1991> 1: <Sat Apr 13, 1991>
8501 . . .
8502
5d67986c 8503 ' <2/13> @key{RET} @key{DEL} ' <3/13> @key{RET} t I
d7b8e6c6 8504@end group
5d67986c 8505@end smallexample
d7b8e6c6
EZ
8506
8507@noindent
8508(Calc assumes the current year if you don't say otherwise.)
8509
8510This is getting tedious---we can keep advancing the date by typing
8511@kbd{t I} over and over again, but let's automate the job by using
8512vector mapping. The @kbd{t I} command actually takes a second
8513``how-many-months'' argument, which defaults to one. This
8514argument is exactly what we want to map over:
8515
d7b8e6c6 8516@smallexample
5d67986c 8517@group
d7b8e6c6
EZ
85182: <Sat Apr 13, 1991> 1: [<Mon May 13, 1991>, <Thu Jun 13, 1991>,
85191: [1, 2, 3, 4, 5, 6] <Sat Jul 13, 1991>, <Tue Aug 13, 1991>,
8520 . <Fri Sep 13, 1991>, <Sun Oct 13, 1991>]
8521 .
8522
5d67986c 8523 v x 6 @key{RET} V M t I
d7b8e6c6 8524@end group
5d67986c 8525@end smallexample
d7b8e6c6 8526
d7b8e6c6 8527@noindent
28665d46 8528Et voil@`a, September 13, 1991 is a Friday.
d7b8e6c6 8529
d7b8e6c6 8530@smallexample
5d67986c 8531@group
d7b8e6c6
EZ
85321: 242
8533 .
8534
5d67986c 8535' <sep 13> - <jan 14> @key{RET}
d7b8e6c6 8536@end group
5d67986c 8537@end smallexample
d7b8e6c6
EZ
8538
8539@noindent
8540And the answer to our original question: 242 days to go.
8541
8542@node Types Answer 6, Types Answer 7, Types Answer 5, Answers to Exercises
8543@subsection Types Tutorial Exercise 6
8544
8545@noindent
8546The full rule for leap years is that they occur in every year divisible
8547by four, except that they don't occur in years divisible by 100, except
8548that they @emph{do} in years divisible by 400. We could work out the
8549answer by carefully counting the years divisible by four and the
8550exceptions, but there is a much simpler way that works even if we
8551don't know the leap year rule.
8552
8553Let's assume the present year is 1991. Years have 365 days, except
8554that leap years (whenever they occur) have 366 days. So let's count
8555the number of days between now and then, and compare that to the
8556number of years times 365. The number of extra days we find must be
8557equal to the number of leap years there were.
8558
d7b8e6c6 8559@smallexample
5d67986c 8560@group
d7b8e6c6
EZ
85611: <Mon Jan 1, 10001> 2: <Mon Jan 1, 10001> 1: 2925593
8562 . 1: <Tue Jan 1, 1991> .
8563 .
8564
5d67986c 8565 ' <jan 1 10001> @key{RET} ' <jan 1 1991> @key{RET} -
d7b8e6c6 8566
d7b8e6c6 8567@end group
5d67986c 8568@end smallexample
d7b8e6c6 8569@noindent
d7b8e6c6 8570@smallexample
5d67986c 8571@group
d7b8e6c6
EZ
85723: 2925593 2: 2925593 2: 2925593 1: 1943
85732: 10001 1: 8010 1: 2923650 .
85741: 1991 . .
8575 .
8576
5d67986c 8577 10001 @key{RET} 1991 - 365 * -
d7b8e6c6 8578@end group
5d67986c 8579@end smallexample
d7b8e6c6
EZ
8580
8581@c [fix-ref Date Forms]
8582@noindent
8583There will be 1943 leap years before the year 10001. (Assuming,
8584of course, that the algorithm for computing leap years remains
8585unchanged for that long. @xref{Date Forms}, for some interesting
8586background information in that regard.)
8587
8588@node Types Answer 7, Types Answer 8, Types Answer 6, Answers to Exercises
8589@subsection Types Tutorial Exercise 7
8590
8591@noindent
8592The relative errors must be converted to absolute errors so that
8593@samp{+/-} notation may be used.
8594
d7b8e6c6 8595@smallexample
5d67986c 8596@group
d7b8e6c6
EZ
85971: 1. 2: 1.
8598 . 1: 0.2
8599 .
8600
5d67986c 8601 20 @key{RET} .05 * 4 @key{RET} .05 *
d7b8e6c6 8602@end group
5d67986c 8603@end smallexample
d7b8e6c6
EZ
8604
8605Now we simply chug through the formula.
8606
d7b8e6c6 8607@smallexample
5d67986c 8608@group
d7b8e6c6
EZ
86091: 19.7392088022 1: 394.78 +/- 19.739 1: 6316.5 +/- 706.21
8610 . . .
8611
5d67986c 8612 2 P 2 ^ * 20 p 1 * 4 p .2 @key{RET} 2 ^ *
d7b8e6c6 8613@end group
5d67986c 8614@end smallexample
d7b8e6c6
EZ
8615
8616It turns out the @kbd{v u} command will unpack an error form as
8617well as a vector. This saves us some retyping of numbers.
8618
d7b8e6c6 8619@smallexample
5d67986c 8620@group
d7b8e6c6
EZ
86213: 6316.5 +/- 706.21 2: 6316.5 +/- 706.21
86222: 6316.5 1: 0.1118
86231: 706.21 .
8624 .
8625
5d67986c 8626 @key{RET} v u @key{TAB} /
d7b8e6c6 8627@end group
5d67986c 8628@end smallexample
d7b8e6c6
EZ
8629
8630@noindent
8631Thus the volume is 6316 cubic centimeters, within about 11 percent.
8632
8633@node Types Answer 8, Types Answer 9, Types Answer 7, Answers to Exercises
8634@subsection Types Tutorial Exercise 8
8635
8636@noindent
8637The first answer is pretty simple: @samp{1 / (0 .. 10) = (0.1 .. inf)}.
8638Since a number in the interval @samp{(0 .. 10)} can get arbitrarily
8639close to zero, its reciprocal can get arbitrarily large, so the answer
8640is an interval that effectively means, ``any number greater than 0.1''
8641but with no upper bound.
8642
8643The second answer, similarly, is @samp{1 / (-10 .. 0) = (-inf .. -0.1)}.
8644
8645Calc normally treats division by zero as an error, so that the formula
8646@w{@samp{1 / 0}} is left unsimplified. Our third problem,
8647@w{@samp{1 / [0 .. 10]}}, also (potentially) divides by zero because zero
8648is now a member of the interval. So Calc leaves this one unevaluated, too.
8649
07ce2eb3 8650If you turn on Infinite mode by pressing @kbd{m i}, you will
d7b8e6c6
EZ
8651instead get the answer @samp{[0.1 .. inf]}, which includes infinity
8652as a possible value.
8653
8654The fourth calculation, @samp{1 / (-10 .. 10)}, has the same problem.
8655Zero is buried inside the interval, but it's still a possible value.
8656It's not hard to see that the actual result of @samp{1 / (-10 .. 10)}
8e04863e 8657will be either greater than @mathit{0.1}, or less than @mathit{-0.1}. Thus
d7b8e6c6 8658the interval goes from minus infinity to plus infinity, with a ``hole''
8e04863e 8659in it from @mathit{-0.1} to @mathit{0.1}. Calc doesn't have any way to
d7b8e6c6
EZ
8660represent this, so it just reports @samp{[-inf .. inf]} as the answer.
8661It may be disappointing to hear ``the answer lies somewhere between
8662minus infinity and plus infinity, inclusive,'' but that's the best
8663that interval arithmetic can do in this case.
8664
8665@node Types Answer 9, Types Answer 10, Types Answer 8, Answers to Exercises
8666@subsection Types Tutorial Exercise 9
8667
d7b8e6c6 8668@smallexample
5d67986c 8669@group
d7b8e6c6
EZ
86701: [-3 .. 3] 2: [-3 .. 3] 2: [0 .. 9]
8671 . 1: [0 .. 9] 1: [-9 .. 9]
8672 . .
8673
5d67986c 8674 [ 3 n .. 3 ] @key{RET} 2 ^ @key{TAB} @key{RET} *
d7b8e6c6 8675@end group
5d67986c 8676@end smallexample
d7b8e6c6
EZ
8677
8678@noindent
8e04863e 8679In the first case the result says, ``if a number is between @mathit{-3} and
d7b8e6c6 86803, its square is between 0 and 9.'' The second case says, ``the product
8e04863e 8681of two numbers each between @mathit{-3} and 3 is between @mathit{-9} and 9.''
d7b8e6c6
EZ
8682
8683An interval form is not a number; it is a symbol that can stand for
8684many different numbers. Two identical-looking interval forms can stand
8685for different numbers.
8686
8687The same issue arises when you try to square an error form.
8688
8689@node Types Answer 10, Types Answer 11, Types Answer 9, Answers to Exercises
8690@subsection Types Tutorial Exercise 10
8691
8692@noindent
a4231b04 8693Testing the first number, we might arbitrarily choose 17 for @expr{x}.
d7b8e6c6 8694
d7b8e6c6 8695@smallexample
5d67986c 8696@group
d7b8e6c6
EZ
86971: 17 mod 811749613 2: 17 mod 811749613 1: 533694123 mod 811749613
8698 . 811749612 .
8699 .
8700
5d67986c 8701 17 M 811749613 @key{RET} 811749612 ^
d7b8e6c6 8702@end group
5d67986c 8703@end smallexample
d7b8e6c6
EZ
8704
8705@noindent
8706Since 533694123 is (considerably) different from 1, the number 811749613
8707must not be prime.
8708
8709It's awkward to type the number in twice as we did above. There are
8710various ways to avoid this, and algebraic entry is one. In fact, using
8711a vector mapping operation we can perform several tests at once. Let's
8712use this method to test the second number.
8713
d7b8e6c6 8714@smallexample
5d67986c 8715@group
d7b8e6c6
EZ
87162: [17, 42, 100000] 1: [1 mod 15485863, 1 mod ... ]
87171: 15485863 .
8718 .
8719
5d67986c 8720 [17 42 100000] 15485863 @key{RET} V M ' ($$ mod $)^($-1) @key{RET}
d7b8e6c6 8721@end group
5d67986c 8722@end smallexample
d7b8e6c6
EZ
8723
8724@noindent
a4231b04 8725The result is three ones (modulo @expr{n}), so it's very probable that
d7b8e6c6
EZ
872615485863 is prime. (In fact, this number is the millionth prime.)
8727
8728Note that the functions @samp{($$^($-1)) mod $} or @samp{$$^($-1) % $}
8729would have been hopelessly inefficient, since they would have calculated
8730the power using full integer arithmetic.
8731
8732Calc has a @kbd{k p} command that does primality testing. For small
8733numbers it does an exact test; for large numbers it uses a variant
8734of the Fermat test we used here. You can use @kbd{k p} repeatedly
8735to prove that a large integer is prime with any desired probability.
8736
8737@node Types Answer 11, Types Answer 12, Types Answer 10, Answers to Exercises
8738@subsection Types Tutorial Exercise 11
8739
8740@noindent
8741There are several ways to insert a calculated number into an HMS form.
8742One way to convert a number of seconds to an HMS form is simply to
8743multiply the number by an HMS form representing one second:
8744
d7b8e6c6 8745@smallexample
5d67986c 8746@group
d7b8e6c6
EZ
87471: 31415926.5359 2: 31415926.5359 1: 8726@@ 38' 46.5359"
8748 . 1: 0@@ 0' 1" .
8749 .
8750
8751 P 1e7 * 0@@ 0' 1" *
8752
d7b8e6c6 8753@end group
5d67986c 8754@end smallexample
d7b8e6c6 8755@noindent
d7b8e6c6 8756@smallexample
5d67986c 8757@group
d7b8e6c6
EZ
87582: 8726@@ 38' 46.5359" 1: 6@@ 6' 2.5359" mod 24@@ 0' 0"
87591: 15@@ 27' 16" mod 24@@ 0' 0" .
8760 .
8761
5d67986c 8762 x time @key{RET} +
d7b8e6c6 8763@end group
5d67986c 8764@end smallexample
d7b8e6c6
EZ
8765
8766@noindent
8767It will be just after six in the morning.
8768
8769The algebraic @code{hms} function can also be used to build an
8770HMS form:
8771
d7b8e6c6 8772@smallexample
5d67986c 8773@group
d7b8e6c6
EZ
87741: hms(0, 0, 10000000. pi) 1: 8726@@ 38' 46.5359"
8775 . .
8776
5d67986c 8777 ' hms(0, 0, 1e7 pi) @key{RET} =
d7b8e6c6 8778@end group
5d67986c 8779@end smallexample
d7b8e6c6
EZ
8780
8781@noindent
8782The @kbd{=} key is necessary to evaluate the symbol @samp{pi} to
8783the actual number 3.14159...
8784
8785@node Types Answer 12, Types Answer 13, Types Answer 11, Answers to Exercises
8786@subsection Types Tutorial Exercise 12
8787
8788@noindent
8789As we recall, there are 17 songs of about 2 minutes and 47 seconds
8790each.
8791
d7b8e6c6 8792@smallexample
5d67986c 8793@group
d7b8e6c6
EZ
87942: 0@@ 2' 47" 1: [0@@ 3' 7" .. 0@@ 3' 47"]
87951: [0@@ 0' 20" .. 0@@ 1' 0"] .
8796 .
8797
8798 [ 0@@ 20" .. 0@@ 1' ] +
8799
d7b8e6c6 8800@end group
5d67986c 8801@end smallexample
d7b8e6c6 8802@noindent
d7b8e6c6 8803@smallexample
5d67986c 8804@group
d7b8e6c6
EZ
88051: [0@@ 52' 59." .. 1@@ 4' 19."]
8806 .
8807
8808 17 *
d7b8e6c6 8809@end group
5d67986c 8810@end smallexample
d7b8e6c6
EZ
8811
8812@noindent
8813No matter how long it is, the album will fit nicely on one CD.
8814
8815@node Types Answer 13, Types Answer 14, Types Answer 12, Answers to Exercises
8816@subsection Types Tutorial Exercise 13
8817
8818@noindent
5d67986c 8819Type @kbd{' 1 yr @key{RET} u c s @key{RET}}. The answer is 31557600 seconds.
d7b8e6c6
EZ
8820
8821@node Types Answer 14, Types Answer 15, Types Answer 13, Answers to Exercises
8822@subsection Types Tutorial Exercise 14
8823
8824@noindent
8825How long will it take for a signal to get from one end of the computer
8826to the other?
8827
d7b8e6c6 8828@smallexample
5d67986c 8829@group
d7b8e6c6
EZ
88301: m / c 1: 3.3356 ns
8831 . .
8832
5d67986c 8833 ' 1 m / c @key{RET} u c ns @key{RET}
d7b8e6c6 8834@end group
5d67986c 8835@end smallexample
d7b8e6c6
EZ
8836
8837@noindent
8838(Recall, @samp{c} is a ``unit'' corresponding to the speed of light.)
8839
d7b8e6c6 8840@smallexample
5d67986c 8841@group
d7b8e6c6
EZ
88421: 3.3356 ns 1: 0.81356 ns / ns 1: 0.81356
88432: 4.1 ns . .
8844 .
8845
5d67986c 8846 ' 4.1 ns @key{RET} / u s
d7b8e6c6 8847@end group
5d67986c 8848@end smallexample
d7b8e6c6
EZ
8849
8850@noindent
8851Thus a signal could take up to 81 percent of a clock cycle just to
8852go from one place to another inside the computer, assuming the signal
8853could actually attain the full speed of light. Pretty tight!
8854
8855@node Types Answer 15, Algebra Answer 1, Types Answer 14, Answers to Exercises
8856@subsection Types Tutorial Exercise 15
8857
8858@noindent
8859The speed limit is 55 miles per hour on most highways. We want to
8860find the ratio of Sam's speed to the US speed limit.
8861
d7b8e6c6 8862@smallexample
5d67986c 8863@group
d7b8e6c6
EZ
88641: 55 mph 2: 55 mph 3: 11 hr mph / yd
8865 . 1: 5 yd / hr .
8866 .
8867
5d67986c 8868 ' 55 mph @key{RET} ' 5 yd/hr @key{RET} /
d7b8e6c6 8869@end group
5d67986c 8870@end smallexample
d7b8e6c6
EZ
8871
8872The @kbd{u s} command cancels out these units to get a plain
8873number. Now we take the logarithm base two to find the final
8874answer, assuming that each successive pill doubles his speed.
8875
d7b8e6c6 8876@smallexample
5d67986c 8877@group
d7b8e6c6
EZ
88781: 19360. 2: 19360. 1: 14.24
8879 . 1: 2 .
8880 .
8881
8882 u s 2 B
d7b8e6c6 8883@end group
5d67986c 8884@end smallexample
d7b8e6c6
EZ
8885
8886@noindent
8887Thus Sam can take up to 14 pills without a worry.
8888
8889@node Algebra Answer 1, Algebra Answer 2, Types Answer 15, Answers to Exercises
8890@subsection Algebra Tutorial Exercise 1
8891
8892@noindent
8893@c [fix-ref Declarations]
a4231b04 8894The result @samp{sqrt(x)^2} is simplified back to @expr{x} by the
d7b8e6c6 8895Calculator, but @samp{sqrt(x^2)} is not. (Consider what happens
a4231b04 8896if @w{@expr{x = -4}}.) If @expr{x} is real, this formula could be
d7b8e6c6
EZ
8897simplified to @samp{abs(x)}, but for general complex arguments even
8898that is not safe. (@xref{Declarations}, for a way to tell Calc
a4231b04 8899that @expr{x} is known to be real.)
d7b8e6c6
EZ
8900
8901@node Algebra Answer 2, Algebra Answer 3, Algebra Answer 1, Answers to Exercises
8902@subsection Algebra Tutorial Exercise 2
8903
8904@noindent
a4231b04
JB
8905Suppose our roots are @expr{[a, b, c]}. We want a polynomial which
8906is zero when @expr{x} is any of these values. The trivial polynomial
8907@expr{x-a} is zero when @expr{x=a}, so the product @expr{(x-a)(x-b)(x-c)}
d7b8e6c6
EZ
8908will do the job. We can use @kbd{a c x} to write this in a more
8909familiar form.
8910
d7b8e6c6 8911@smallexample
5d67986c 8912@group
d7b8e6c6
EZ
89131: 34 x - 24 x^3 1: [1.19023, -1.19023, 0]
8914 . .
8915
5d67986c 8916 r 2 a P x @key{RET}
d7b8e6c6 8917
d7b8e6c6 8918@end group
5d67986c 8919@end smallexample
d7b8e6c6 8920@noindent
d7b8e6c6 8921@smallexample
5d67986c 8922@group
d7b8e6c6
EZ
89231: [x - 1.19023, x + 1.19023, x] 1: (x - 1.19023) (x + 1.19023) x
8924 . .
8925
5d67986c 8926 V M ' x-$ @key{RET} V R *
d7b8e6c6 8927
d7b8e6c6 8928@end group
5d67986c 8929@end smallexample
d7b8e6c6 8930@noindent
d7b8e6c6 8931@smallexample
5d67986c 8932@group
d7b8e6c6
EZ
89331: x^3 - 1.41666 x 1: 34 x - 24 x^3
8934 . .
8935
5d67986c 8936 a c x @key{RET} 24 n * a x
d7b8e6c6 8937@end group
5d67986c 8938@end smallexample
d7b8e6c6
EZ
8939
8940@noindent
8941Sure enough, our answer (multiplied by a suitable constant) is the
8942same as the original polynomial.
8943
8944@node Algebra Answer 3, Algebra Answer 4, Algebra Answer 2, Answers to Exercises
8945@subsection Algebra Tutorial Exercise 3
8946
d7b8e6c6 8947@smallexample
5d67986c 8948@group
d7b8e6c6
EZ
89491: x sin(pi x) 1: (sin(pi x) - pi x cos(pi x)) / pi^2
8950 . .
8951
5d67986c 8952 ' x sin(pi x) @key{RET} m r a i x @key{RET}
d7b8e6c6 8953
d7b8e6c6 8954@end group
5d67986c 8955@end smallexample
d7b8e6c6 8956@noindent
d7b8e6c6 8957@smallexample
5d67986c 8958@group
d7b8e6c6
EZ
89591: [y, 1]
89602: (sin(pi x) - pi x cos(pi x)) / pi^2
8961 .
8962
5d67986c 8963 ' [y,1] @key{RET} @key{TAB}
d7b8e6c6 8964
d7b8e6c6 8965@end group
5d67986c 8966@end smallexample
d7b8e6c6 8967@noindent
d7b8e6c6 8968@smallexample
5d67986c 8969@group
d7b8e6c6
EZ
89701: [(sin(pi y) - pi y cos(pi y)) / pi^2, (sin(pi) - pi cos(pi)) / pi^2]
8971 .
8972
5d67986c 8973 V M $ @key{RET}
d7b8e6c6 8974
d7b8e6c6 8975@end group
5d67986c 8976@end smallexample
d7b8e6c6 8977@noindent
d7b8e6c6 8978@smallexample
5d67986c 8979@group
d7b8e6c6
EZ
89801: (sin(pi y) - pi y cos(pi y)) / pi^2 + (pi cos(pi) - sin(pi)) / pi^2
8981 .
8982
8983 V R -
8984
d7b8e6c6 8985@end group
5d67986c 8986@end smallexample
d7b8e6c6 8987@noindent
d7b8e6c6 8988@smallexample
5d67986c 8989@group
d7b8e6c6
EZ
89901: (sin(3.14159 y) - 3.14159 y cos(3.14159 y)) / 9.8696 - 0.3183
8991 .
8992
8993 =
8994
d7b8e6c6 8995@end group
5d67986c 8996@end smallexample
d7b8e6c6 8997@noindent
d7b8e6c6 8998@smallexample
5d67986c 8999@group
d7b8e6c6
EZ
90001: [0., -0.95493, 0.63662, -1.5915, 1.2732]
9001 .
9002
5d67986c 9003 v x 5 @key{RET} @key{TAB} V M $ @key{RET}
d7b8e6c6 9004@end group
5d67986c 9005@end smallexample
d7b8e6c6
EZ
9006
9007@node Algebra Answer 4, Rewrites Answer 1, Algebra Answer 3, Answers to Exercises
9008@subsection Algebra Tutorial Exercise 4
9009
9010@noindent
9011The hard part is that @kbd{V R +} is no longer sufficient to add up all
9012the contributions from the slices, since the slices have varying
9013coefficients. So first we must come up with a vector of these
9014coefficients. Here's one way:
9015
d7b8e6c6 9016@smallexample
5d67986c 9017@group
d7b8e6c6
EZ
90182: -1 2: 3 1: [4, 2, ..., 4]
90191: [1, 2, ..., 9] 1: [-1, 1, ..., -1] .
9020 . .
9021
5d67986c 9022 1 n v x 9 @key{RET} V M ^ 3 @key{TAB} -
d7b8e6c6 9023
d7b8e6c6 9024@end group
5d67986c 9025@end smallexample
d7b8e6c6 9026@noindent
d7b8e6c6 9027@smallexample
5d67986c 9028@group
d7b8e6c6
EZ
90291: [4, 2, ..., 4, 1] 1: [1, 4, 2, ..., 4, 1]
9030 . .
9031
5d67986c 9032 1 | 1 @key{TAB} |
d7b8e6c6 9033@end group
5d67986c 9034@end smallexample
d7b8e6c6
EZ
9035
9036@noindent
9037Now we compute the function values. Note that for this method we need
9038eleven values, including both endpoints of the desired interval.
9039
d7b8e6c6 9040@smallexample
5d67986c 9041@group
d7b8e6c6
EZ
90422: [1, 4, 2, ..., 4, 1]
90431: [1, 1.1, 1.2, ... , 1.8, 1.9, 2.]
9044 .
9045
5d67986c 9046 11 @key{RET} 1 @key{RET} .1 @key{RET} C-u v x
d7b8e6c6 9047
d7b8e6c6 9048@end group
5d67986c 9049@end smallexample
d7b8e6c6 9050@noindent
d7b8e6c6 9051@smallexample
5d67986c 9052@group
d7b8e6c6
EZ
90532: [1, 4, 2, ..., 4, 1]
90541: [0., 0.084941, 0.16993, ... ]
9055 .
9056
5d67986c 9057 ' sin(x) ln(x) @key{RET} m r p 5 @key{RET} V M $ @key{RET}
d7b8e6c6 9058@end group
5d67986c 9059@end smallexample
d7b8e6c6
EZ
9060
9061@noindent
9062Once again this calls for @kbd{V M * V R +}; a simple @kbd{*} does the
9063same thing.
9064
d7b8e6c6 9065@smallexample
5d67986c 9066@group
d7b8e6c6
EZ
90671: 11.22 1: 1.122 1: 0.374
9068 . . .
9069
9070 * .1 * 3 /
d7b8e6c6 9071@end group
5d67986c 9072@end smallexample
d7b8e6c6
EZ
9073
9074@noindent
9075Wow! That's even better than the result from the Taylor series method.
9076
9077@node Rewrites Answer 1, Rewrites Answer 2, Algebra Answer 4, Answers to Exercises
9078@subsection Rewrites Tutorial Exercise 1
9079
9080@noindent
9081We'll use Big mode to make the formulas more readable.
9082
d7b8e6c6 9083@smallexample
5d67986c 9084@group
d7b8e6c6
EZ
9085 ___
9086 2 + V 2
90871: (2 + sqrt(2)) / (1 + sqrt(2)) 1: --------
9088 . ___
9089 1 + V 2
9090
9091 .
9092
5d67986c 9093 ' (2+sqrt(2)) / (1+sqrt(2)) @key{RET} d B
d7b8e6c6 9094@end group
5d67986c 9095@end smallexample
d7b8e6c6
EZ
9096
9097@noindent
a4231b04 9098Multiplying by the conjugate helps because @expr{(a+b) (a-b) = a^2 - b^2}.
d7b8e6c6 9099
d7b8e6c6 9100@smallexample
5d67986c 9101@group
d7b8e6c6
EZ
9102 ___ ___
91031: (2 + V 2 ) (V 2 - 1)
9104 .
9105
5d67986c 9106 a r a/(b+c) := a*(b-c) / (b^2-c^2) @key{RET}
d7b8e6c6 9107
d7b8e6c6 9108@end group
5d67986c 9109@end smallexample
d7b8e6c6 9110@noindent
d7b8e6c6 9111@smallexample
5d67986c 9112@group
d7b8e6c6
EZ
9113 ___ ___
91141: 2 + V 2 - 2 1: V 2
9115 . .
9116
9117 a r a*(b+c) := a*b + a*c a s
d7b8e6c6 9118@end group
5d67986c 9119@end smallexample
d7b8e6c6
EZ
9120
9121@noindent
9122(We could have used @kbd{a x} instead of a rewrite rule for the
9123second step.)
9124
9125The multiply-by-conjugate rule turns out to be useful in many
9126different circumstances, such as when the denominator involves
9127sines and cosines or the imaginary constant @code{i}.
9128
9129@node Rewrites Answer 2, Rewrites Answer 3, Rewrites Answer 1, Answers to Exercises
9130@subsection Rewrites Tutorial Exercise 2
9131
9132@noindent
9133Here is the rule set:
9134
d7b8e6c6 9135@smallexample
5d67986c 9136@group
d7b8e6c6
EZ
9137[ fib(n) := fib(n, 1, 1) :: integer(n) :: n >= 1,
9138 fib(1, x, y) := x,
9139 fib(n, x, y) := fib(n-1, y, x+y) ]
d7b8e6c6 9140@end group
5d67986c 9141@end smallexample
d7b8e6c6
EZ
9142
9143@noindent
9144The first rule turns a one-argument @code{fib} that people like to write
9145into a three-argument @code{fib} that makes computation easier. The
9146second rule converts back from three-argument form once the computation
9147is done. The third rule does the computation itself. It basically
a4231b04
JB
9148says that if @expr{x} and @expr{y} are two consecutive Fibonacci numbers,
9149then @expr{y} and @expr{x+y} are the next (overlapping) pair of Fibonacci
d7b8e6c6
EZ
9150numbers.
9151
a4231b04 9152Notice that because the number @expr{n} was ``validated'' by the
d7b8e6c6
EZ
9153conditions on the first rule, there is no need to put conditions on
9154the other rules because the rule set would never get that far unless
9155the input were valid. That further speeds computation, since no
9156extra conditions need to be checked at every step.
9157
9158Actually, a user with a nasty sense of humor could enter a bad
9159three-argument @code{fib} call directly, say, @samp{fib(0, 1, 1)},
9160which would get the rules into an infinite loop. One thing that would
9161help keep this from happening by accident would be to use something like
9162@samp{ZzFib} instead of @code{fib} as the name of the three-argument
9163function.
9164
9165@node Rewrites Answer 3, Rewrites Answer 4, Rewrites Answer 2, Answers to Exercises
9166@subsection Rewrites Tutorial Exercise 3
9167
9168@noindent
9169He got an infinite loop. First, Calc did as expected and rewrote
9170@w{@samp{2 + 3 x}} to @samp{f(2, 3, x)}. Then it looked for ways to
9171apply the rule again, and found that @samp{f(2, 3, x)} looks like
9172@samp{a + b x} with @w{@samp{a = 0}} and @samp{b = 1}, so it rewrote to
9173@samp{f(0, 1, f(2, 3, x))}. It then wrapped another @samp{f(0, 1, ...)}
9174around that, and so on, ad infinitum. Joe should have used @kbd{M-1 a r}
9175to make sure the rule applied only once.
9176
9177(Actually, even the first step didn't work as he expected. What Calc
9178really gives for @kbd{M-1 a r} in this situation is @samp{f(3 x, 1, 2)},
9179treating 2 as the ``variable,'' and @samp{3 x} as a constant being added
9180to it. While this may seem odd, it's just as valid a solution as the
9181``obvious'' one. One way to fix this would be to add the condition
9182@samp{:: variable(x)} to the rule, to make sure the thing that matches
9183@samp{x} is indeed a variable, or to change @samp{x} to @samp{quote(x)}
9184on the lefthand side, so that the rule matches the actual variable
9185@samp{x} rather than letting @samp{x} stand for something else.)
9186
9187@node Rewrites Answer 4, Rewrites Answer 5, Rewrites Answer 3, Answers to Exercises
9188@subsection Rewrites Tutorial Exercise 4
9189
9190@noindent
5d67986c
RS
9191@ignore
9192@starindex
9193@end ignore
d7b8e6c6
EZ
9194@tindex seq
9195Here is a suitable set of rules to solve the first part of the problem:
9196
d7b8e6c6 9197@smallexample
5d67986c 9198@group
d7b8e6c6
EZ
9199[ seq(n, c) := seq(n/2, c+1) :: n%2 = 0,
9200 seq(n, c) := seq(3n+1, c+1) :: n%2 = 1 :: n > 1 ]
d7b8e6c6 9201@end group
5d67986c 9202@end smallexample
d7b8e6c6
EZ
9203
9204Given the initial formula @samp{seq(6, 0)}, application of these
9205rules produces the following sequence of formulas:
9206
9207@example
9208seq( 3, 1)
9209seq(10, 2)
9210seq( 5, 3)
9211seq(16, 4)
9212seq( 8, 5)
9213seq( 4, 6)
9214seq( 2, 7)
9215seq( 1, 8)
9216@end example
9217
9218@noindent
9219whereupon neither of the rules match, and rewriting stops.
9220
9221We can pretty this up a bit with a couple more rules:
9222
d7b8e6c6 9223@smallexample
5d67986c 9224@group
d7b8e6c6
EZ
9225[ seq(n) := seq(n, 0),
9226 seq(1, c) := c,
9227 ... ]
d7b8e6c6 9228@end group
5d67986c 9229@end smallexample
d7b8e6c6
EZ
9230
9231@noindent
9232Now, given @samp{seq(6)} as the starting configuration, we get 8
9233as the result.
9234
9235The change to return a vector is quite simple:
9236
d7b8e6c6 9237@smallexample
5d67986c 9238@group
d7b8e6c6
EZ
9239[ seq(n) := seq(n, []) :: integer(n) :: n > 0,
9240 seq(1, v) := v | 1,
9241 seq(n, v) := seq(n/2, v | n) :: n%2 = 0,
9242 seq(n, v) := seq(3n+1, v | n) :: n%2 = 1 ]
d7b8e6c6 9243@end group
5d67986c 9244@end smallexample
d7b8e6c6
EZ
9245
9246@noindent
9247Given @samp{seq(6)}, the result is @samp{[6, 3, 10, 5, 16, 8, 4, 2, 1]}.
9248
a4231b04
JB
9249Notice that the @expr{n > 1} guard is no longer necessary on the last
9250rule since the @expr{n = 1} case is now detected by another rule.
d7b8e6c6
EZ
9251But a guard has been added to the initial rule to make sure the
9252initial value is suitable before the computation begins.
9253
9254While still a good idea, this guard is not as vitally important as it
9255was for the @code{fib} function, since calling, say, @samp{seq(x, [])}
9256will not get into an infinite loop. Calc will not be able to prove
9257the symbol @samp{x} is either even or odd, so none of the rules will
9258apply and the rewrites will stop right away.
9259
9260@node Rewrites Answer 5, Rewrites Answer 6, Rewrites Answer 4, Answers to Exercises
9261@subsection Rewrites Tutorial Exercise 5
9262
9263@noindent
5d67986c
RS
9264@ignore
9265@starindex
9266@end ignore
d7b8e6c6 9267@tindex nterms
bd712b70
JB
9268If @expr{x} is the sum @expr{a + b}, then `@tfn{nterms(}@var{x}@tfn{)}' must
9269be `@tfn{nterms(}@var{a}@tfn{)}' plus `@tfn{nterms(}@var{b}@tfn{)}'. If @expr{x}
9270is not a sum, then `@tfn{nterms(}@var{x}@tfn{)}' = 1.
d7b8e6c6 9271
d7b8e6c6 9272@smallexample
5d67986c 9273@group
d7b8e6c6
EZ
9274[ nterms(a + b) := nterms(a) + nterms(b),
9275 nterms(x) := 1 ]
d7b8e6c6 9276@end group
5d67986c 9277@end smallexample
d7b8e6c6
EZ
9278
9279@noindent
9280Here we have taken advantage of the fact that earlier rules always
9281match before later rules; @samp{nterms(x)} will only be tried if we
9282already know that @samp{x} is not a sum.
9283
8c399bc1 9284@node Rewrites Answer 6, Programming Answer 1, Rewrites Answer 5, Answers to Exercises
d7b8e6c6
EZ
9285@subsection Rewrites Tutorial Exercise 6
9286
d7b8e6c6
EZ
9287@noindent
9288Here is a rule set that will do the job:
9289
d7b8e6c6 9290@smallexample
5d67986c 9291@group
d7b8e6c6
EZ
9292[ a*(b + c) := a*b + a*c,
9293 opt(a) O(x^n) + opt(b) O(x^m) := O(x^n) :: n <= m
9294 :: constant(a) :: constant(b),
9295 opt(a) O(x^n) + opt(b) x^m := O(x^n) :: n <= m
9296 :: constant(a) :: constant(b),
9297 a O(x^n) := O(x^n) :: constant(a),
9298 x^opt(m) O(x^n) := O(x^(n+m)),
9299 O(x^n) O(x^m) := O(x^(n+m)) ]
d7b8e6c6 9300@end group
5d67986c 9301@end smallexample
d7b8e6c6
EZ
9302
9303If we really want the @kbd{+} and @kbd{*} keys to operate naturally
9304on power series, we should put these rules in @code{EvalRules}. For
9305testing purposes, it is better to put them in a different variable,
9306say, @code{O}, first.
9307
9308The first rule just expands products of sums so that the rest of the
9309rules can assume they have an expanded-out polynomial to work with.
9310Note that this rule does not mention @samp{O} at all, so it will
9311apply to any product-of-sum it encounters---this rule may surprise
9312you if you put it into @code{EvalRules}!
9313
9314In the second rule, the sum of two O's is changed to the smaller O.
9315The optional constant coefficients are there mostly so that
9316@samp{O(x^2) - O(x^3)} and @samp{O(x^3) - O(x^2)} are handled
9317as well as @samp{O(x^2) + O(x^3)}.
9318
9319The third rule absorbs higher powers of @samp{x} into O's.
9320
9321The fourth rule says that a constant times a negligible quantity
9322is still negligible. (This rule will also match @samp{O(x^3) / 4},
9323with @samp{a = 1/4}.)
9324
9325The fifth rule rewrites, for example, @samp{x^2 O(x^3)} to @samp{O(x^5)}.
9326(It is easy to see that if one of these forms is negligible, the other
9327is, too.) Notice the @samp{x^opt(m)} to pick up terms like
9328@w{@samp{x O(x^3)}}. Optional powers will match @samp{x} as @samp{x^1}
9329but not 1 as @samp{x^0}. This turns out to be exactly what we want here.
9330
9331The sixth rule is the corresponding rule for products of two O's.
9332
9333Another way to solve this problem would be to create a new ``data type''
9334that represents truncated power series. We might represent these as
9335function calls @samp{series(@var{coefs}, @var{x})} where @var{coefs} is
a4231b04 9336a vector of coefficients for @expr{x^0}, @expr{x^1}, @expr{x^2}, and so
d7b8e6c6
EZ
9337on. Rules would exist for sums and products of such @code{series}
9338objects, and as an optional convenience could also know how to combine a
9339@code{series} object with a normal polynomial. (With this, and with a
9340rule that rewrites @samp{O(x^n)} to the equivalent @code{series} form,
9341you could still enter power series in exactly the same notation as
9342before.) Operations on such objects would probably be more efficient,
9343although the objects would be a bit harder to read.
9344
9345@c [fix-ref Compositions]
9346Some other symbolic math programs provide a power series data type
9347similar to this. Mathematica, for example, has an object that looks
9348like @samp{PowerSeries[@var{x}, @var{x0}, @var{coefs}, @var{nmin},
9349@var{nmax}, @var{den}]}, where @var{x0} is the point about which the
9350power series is taken (we've been assuming this was always zero),
9351and @var{nmin}, @var{nmax}, and @var{den} allow pseudo-power-series
9352with fractional or negative powers. Also, the @code{PowerSeries}
9353objects have a special display format that makes them look like
9354@samp{2 x^2 + O(x^4)} when they are printed out. (@xref{Compositions},
9355for a way to do this in Calc, although for something as involved as
9356this it would probably be better to write the formatting routine
9357in Lisp.)
9358
8c399bc1 9359@node Programming Answer 1, Programming Answer 2, Rewrites Answer 6, Answers to Exercises
d7b8e6c6
EZ
9360@subsection Programming Tutorial Exercise 1
9361
9362@noindent
9363Just enter the formula @samp{ninteg(sin(t)/t, t, 0, x)}, type
9364@kbd{Z F}, and answer the questions. Since this formula contains two
9365variables, the default argument list will be @samp{(t x)}. We want to
a4231b04 9366change this to @samp{(x)} since @expr{t} is really a dummy variable
d7b8e6c6
EZ
9367to be used within @code{ninteg}.
9368
5d67986c
RS
9369The exact keystrokes are @kbd{Z F s Si @key{RET} @key{RET} C-b C-b @key{DEL} @key{DEL} @key{RET} y}.
9370(The @kbd{C-b C-b @key{DEL} @key{DEL}} are what fix the argument list.)
d7b8e6c6
EZ
9371
9372@node Programming Answer 2, Programming Answer 3, Programming Answer 1, Answers to Exercises
9373@subsection Programming Tutorial Exercise 2
9374
9375@noindent
9376One way is to move the number to the top of the stack, operate on
5d67986c 9377it, then move it back: @kbd{C-x ( M-@key{TAB} n M-@key{TAB} M-@key{TAB} C-x )}.
d7b8e6c6
EZ
9378
9379Another way is to negate the top three stack entries, then negate
9380again the top two stack entries: @kbd{C-x ( M-3 n M-2 n C-x )}.
9381
9382Finally, it turns out that a negative prefix argument causes a
9383command like @kbd{n} to operate on the specified stack entry only,
9384which is just what we want: @kbd{C-x ( M-- 3 n C-x )}.
9385
9386Just for kicks, let's also do it algebraically:
5d67986c 9387@w{@kbd{C-x ( ' -$$$, $$, $ @key{RET} C-x )}}.
d7b8e6c6
EZ
9388
9389@node Programming Answer 3, Programming Answer 4, Programming Answer 2, Answers to Exercises
9390@subsection Programming Tutorial Exercise 3
9391
9392@noindent
9393Each of these functions can be computed using the stack, or using
9394algebraic entry, whichever way you prefer:
9395
9396@noindent
a4231b04 9397Computing
8e04863e 9398@texline @math{\displaystyle{\sin x \over x}}:
a4231b04 9399@infoline @expr{sin(x) / x}:
d7b8e6c6 9400
5d67986c 9401Using the stack: @kbd{C-x ( @key{RET} S @key{TAB} / C-x )}.
d7b8e6c6 9402
5d67986c 9403Using algebraic entry: @kbd{C-x ( ' sin($)/$ @key{RET} C-x )}.
d7b8e6c6
EZ
9404
9405@noindent
9406Computing the logarithm:
9407
5d67986c 9408Using the stack: @kbd{C-x ( @key{TAB} B C-x )}
d7b8e6c6 9409
5d67986c 9410Using algebraic entry: @kbd{C-x ( ' log($,$$) @key{RET} C-x )}.
d7b8e6c6
EZ
9411
9412@noindent
9413Computing the vector of integers:
9414
5d67986c 9415Using the stack: @kbd{C-x ( 1 @key{RET} 1 C-u v x C-x )}. (Recall that
d7b8e6c6
EZ
9416@kbd{C-u v x} takes the vector size, starting value, and increment
9417from the stack.)
9418
9419Alternatively: @kbd{C-x ( ~ v x C-x )}. (The @kbd{~} key pops a
9420number from the stack and uses it as the prefix argument for the
9421next command.)
9422
5d67986c 9423Using algebraic entry: @kbd{C-x ( ' index($) @key{RET} C-x )}.
d7b8e6c6
EZ
9424
9425@node Programming Answer 4, Programming Answer 5, Programming Answer 3, Answers to Exercises
9426@subsection Programming Tutorial Exercise 4
9427
9428@noindent
5d67986c 9429Here's one way: @kbd{C-x ( @key{RET} V R + @key{TAB} v l / C-x )}.
d7b8e6c6
EZ
9430
9431@node Programming Answer 5, Programming Answer 6, Programming Answer 4, Answers to Exercises
9432@subsection Programming Tutorial Exercise 5
9433
d7b8e6c6 9434@smallexample
5d67986c 9435@group
d7b8e6c6
EZ
94362: 1 1: 1.61803398502 2: 1.61803398502
94371: 20 . 1: 1.61803398875
9438 . .
9439
5d67986c 9440 1 @key{RET} 20 Z < & 1 + Z > I H P
d7b8e6c6 9441@end group
5d67986c 9442@end smallexample
d7b8e6c6
EZ
9443
9444@noindent
9445This answer is quite accurate.
9446
9447@node Programming Answer 6, Programming Answer 7, Programming Answer 5, Answers to Exercises
9448@subsection Programming Tutorial Exercise 6
9449
9450@noindent
9451Here is the matrix:
9452
9453@example
9454[ [ 0, 1 ] * [a, b] = [b, a + b]
9455 [ 1, 1 ] ]
9456@end example
9457
9458@noindent
a4231b04
JB
9459Thus @samp{[0, 1; 1, 1]^n * [1, 1]} computes Fibonacci numbers @expr{n+1}
9460and @expr{n+2}. Here's one program that does the job:
d7b8e6c6
EZ
9461
9462@example
5d67986c 9463C-x ( ' [0, 1; 1, 1] ^ ($-1) * [1, 1] @key{RET} v u @key{DEL} C-x )
d7b8e6c6
EZ
9464@end example
9465
9466@noindent
9467This program is quite efficient because Calc knows how to raise a
a4231b04 9468matrix (or other value) to the power @expr{n} in only
8e04863e 9469@texline @math{\log_2 n}
a4231b04 9470@infoline @expr{log(n,2)}
d7b8e6c6
EZ
9471steps. For example, this program can compute the 1000th Fibonacci
9472number (a 209-digit integer!) in about 10 steps; even though the
9473@kbd{Z < ... Z >} solution had much simpler steps, it would have
9474required so many steps that it would not have been practical.
9475
9476@node Programming Answer 7, Programming Answer 8, Programming Answer 6, Answers to Exercises
9477@subsection Programming Tutorial Exercise 7
9478
9479@noindent
9480The trick here is to compute the harmonic numbers differently, so that
9481the loop counter itself accumulates the sum of reciprocals. We use
9482a separate variable to hold the integer counter.
9483
d7b8e6c6 9484@smallexample
5d67986c 9485@group
d7b8e6c6
EZ
94861: 1 2: 1 1: .
9487 . 1: 4
9488 .
9489
5d67986c 9490 1 t 1 1 @key{RET} 4 Z ( t 2 r 1 1 + s 1 & Z )
d7b8e6c6 9491@end group
5d67986c 9492@end smallexample
d7b8e6c6
EZ
9493
9494@noindent
9495The body of the loop goes as follows: First save the harmonic sum
9496so far in variable 2. Then delete it from the stack; the for loop
9497itself will take care of remembering it for us. Next, recall the
9498count from variable 1, add one to it, and feed its reciprocal to
9499the for loop to use as the step value. The for loop will increase
9500the ``loop counter'' by that amount and keep going until the
9501loop counter exceeds 4.
9502
d7b8e6c6 9503@smallexample
5d67986c 9504@group
d7b8e6c6
EZ
95052: 31 3: 31
95061: 3.99498713092 2: 3.99498713092
9507 . 1: 4.02724519544
9508 .
9509
5d67986c 9510 r 1 r 2 @key{RET} 31 & +
d7b8e6c6 9511@end group
5d67986c 9512@end smallexample
d7b8e6c6
EZ
9513
9514Thus we find that the 30th harmonic number is 3.99, and the 31st
9515harmonic number is 4.02.
9516
9517@node Programming Answer 8, Programming Answer 9, Programming Answer 7, Answers to Exercises
9518@subsection Programming Tutorial Exercise 8
9519
9520@noindent
a4231b04
JB
9521The first step is to compute the derivative @expr{f'(x)} and thus
9522the formula
8e04863e 9523@texline @math{\displaystyle{x - {f(x) \over f'(x)}}}.
a4231b04 9524@infoline @expr{x - f(x)/f'(x)}.
d7b8e6c6
EZ
9525
9526(Because this definition is long, it will be repeated in concise form
9527below. You can use @w{@kbd{M-# m}} to load it from there. While you are
9528entering a @kbd{Z ` Z '} body in a macro, Calc simply collects
9529keystrokes without executing them. In the following diagrams we'll
9530pretend Calc actually executed the keystrokes as you typed them,
9531just for purposes of illustration.)
9532
d7b8e6c6 9533@smallexample
5d67986c 9534@group
d7b8e6c6
EZ
95352: sin(cos(x)) - 0.5 3: 4.5
95361: 4.5 2: sin(cos(x)) - 0.5
9537 . 1: -(sin(x) cos(cos(x)))
9538 .
9539
5d67986c 9540' sin(cos(x))-0.5 @key{RET} 4.5 m r C-x ( Z ` @key{TAB} @key{RET} a d x @key{RET}
d7b8e6c6 9541
d7b8e6c6 9542@end group
5d67986c 9543@end smallexample
d7b8e6c6 9544@noindent
d7b8e6c6 9545@smallexample
5d67986c 9546@group
d7b8e6c6
EZ
95472: 4.5
95481: x + (sin(cos(x)) - 0.5) / sin(x) cos(cos(x))
9549 .
9550
5d67986c 9551 / ' x @key{RET} @key{TAB} - t 1
d7b8e6c6 9552@end group
5d67986c 9553@end smallexample
d7b8e6c6
EZ
9554
9555Now, we enter the loop. We'll use a repeat loop with a 20-repetition
9556limit just in case the method fails to converge for some reason.
9557(Normally, the @w{@kbd{Z /}} command will stop the loop before all 20
9558repetitions are done.)
9559
d7b8e6c6 9560@smallexample
5d67986c 9561@group
d7b8e6c6
EZ
95621: 4.5 3: 4.5 2: 4.5
9563 . 2: x + (sin(cos(x)) ... 1: 5.24196456928
9564 1: 4.5 .
9565 .
9566
5d67986c 9567 20 Z < @key{RET} r 1 @key{TAB} s l x @key{RET}
d7b8e6c6 9568@end group
5d67986c 9569@end smallexample
d7b8e6c6 9570
a4231b04 9571This is the new guess for @expr{x}. Now we compare it with the
d7b8e6c6
EZ
9572old one to see if we've converged.
9573
d7b8e6c6 9574@smallexample
5d67986c 9575@group
d7b8e6c6
EZ
95763: 5.24196 2: 5.24196 1: 5.24196 1: 5.26345856348
95772: 5.24196 1: 0 . .
95781: 4.5 .
9579 .
9580
5d67986c 9581 @key{RET} M-@key{TAB} a = Z / Z > Z ' C-x )
d7b8e6c6 9582@end group
5d67986c 9583@end smallexample
d7b8e6c6
EZ
9584
9585The loop converges in just a few steps to this value. To check
9586the result, we can simply substitute it back into the equation.
9587
d7b8e6c6 9588@smallexample
5d67986c 9589@group
d7b8e6c6
EZ
95902: 5.26345856348
95911: 0.499999999997
9592 .
9593
5d67986c 9594 @key{RET} ' sin(cos($)) @key{RET}
d7b8e6c6 9595@end group
5d67986c 9596@end smallexample
d7b8e6c6
EZ
9597
9598Let's test the new definition again:
9599
d7b8e6c6 9600@smallexample
5d67986c 9601@group
d7b8e6c6
EZ
96022: x^2 - 9 1: 3.
96031: 1 .
9604 .
9605
5d67986c 9606 ' x^2-9 @key{RET} 1 X
d7b8e6c6 9607@end group
5d67986c 9608@end smallexample
d7b8e6c6
EZ
9609
9610Once again, here's the full Newton's Method definition:
9611
d7b8e6c6 9612@example
5d67986c
RS
9613@group
9614C-x ( Z ` @key{TAB} @key{RET} a d x @key{RET} / ' x @key{RET} @key{TAB} - t 1
9615 20 Z < @key{RET} r 1 @key{TAB} s l x @key{RET}
9616 @key{RET} M-@key{TAB} a = Z /
d7b8e6c6
EZ
9617 Z >
9618 Z '
9619C-x )
d7b8e6c6 9620@end group
5d67986c 9621@end example
d7b8e6c6
EZ
9622
9623@c [fix-ref Nesting and Fixed Points]
9624It turns out that Calc has a built-in command for applying a formula
9625repeatedly until it converges to a number. @xref{Nesting and Fixed Points},
9626to see how to use it.
9627
9628@c [fix-ref Root Finding]
9629Also, of course, @kbd{a R} is a built-in command that uses Newton's
9630method (among others) to look for numerical solutions to any equation.
9631@xref{Root Finding}.
9632
9633@node Programming Answer 9, Programming Answer 10, Programming Answer 8, Answers to Exercises
9634@subsection Programming Tutorial Exercise 9
9635
9636@noindent
a4231b04
JB
9637The first step is to adjust @expr{z} to be greater than 5. A simple
9638``for'' loop will do the job here. If @expr{z} is less than 5, we
9639reduce the problem using
8e04863e 9640@texline @math{\psi(z) = \psi(z+1) - 1/z}.
a4231b04
JB
9641@infoline @expr{psi(z) = psi(z+1) - 1/z}. We go
9642on to compute
8e04863e 9643@texline @math{\psi(z+1)},
a4231b04
JB
9644@infoline @expr{psi(z+1)},
9645and remember to add back a factor of @expr{-1/z} when we're done. This
9646step is repeated until @expr{z > 5}.
d7b8e6c6
EZ
9647
9648(Because this definition is long, it will be repeated in concise form
9649below. You can use @w{@kbd{M-# m}} to load it from there. While you are
9650entering a @kbd{Z ` Z '} body in a macro, Calc simply collects
9651keystrokes without executing them. In the following diagrams we'll
9652pretend Calc actually executed the keystrokes as you typed them,
9653just for purposes of illustration.)
9654
d7b8e6c6 9655@smallexample
5d67986c 9656@group
d7b8e6c6
EZ
96571: 1. 1: 1.
9658 . .
9659
5d67986c 9660 1.0 @key{RET} C-x ( Z ` s 1 0 t 2
d7b8e6c6 9661@end group
5d67986c 9662@end smallexample
d7b8e6c6 9663
a4231b04
JB
9664Here, variable 1 holds @expr{z} and variable 2 holds the adjustment
9665factor. If @expr{z < 5}, we use a loop to increase it.
d7b8e6c6
EZ
9666
9667(By the way, we started with @samp{1.0} instead of the integer 1 because
9668otherwise the calculation below will try to do exact fractional arithmetic,
9669and will never converge because fractions compare equal only if they
9670are exactly equal, not just equal to within the current precision.)
9671
d7b8e6c6 9672@smallexample
5d67986c 9673@group
d7b8e6c6
EZ
96743: 1. 2: 1. 1: 6.
96752: 1. 1: 1 .
96761: 5 .
9677 .
9678
5d67986c 9679 @key{RET} 5 a < Z [ 5 Z ( & s + 2 1 s + 1 1 Z ) r 1 Z ]
d7b8e6c6 9680@end group
5d67986c 9681@end smallexample
d7b8e6c6 9682
a4231b04 9683Now we compute the initial part of the sum:
8e04863e 9684@texline @math{\ln z - {1 \over 2z}}
a4231b04 9685@infoline @expr{ln(z) - 1/2z}
d7b8e6c6
EZ
9686minus the adjustment factor.
9687
d7b8e6c6 9688@smallexample
5d67986c 9689@group
d7b8e6c6
EZ
96902: 1.79175946923 2: 1.7084261359 1: -0.57490719743
96911: 0.0833333333333 1: 2.28333333333 .
9692 . .
9693
9694 L r 1 2 * & - r 2 -
d7b8e6c6 9695@end group
5d67986c 9696@end smallexample
d7b8e6c6
EZ
9697
9698Now we evaluate the series. We'll use another ``for'' loop counting
a4231b04 9699up the value of @expr{2 n}. (Calc does have a summation command,
d7b8e6c6
EZ
9700@kbd{a +}, but we'll use loops just to get more practice with them.)
9701
d7b8e6c6 9702@smallexample
5d67986c 9703@group
d7b8e6c6
EZ
97043: -0.5749 3: -0.5749 4: -0.5749 2: -0.5749
97052: 2 2: 1:6 3: 1:6 1: 2.3148e-3
97061: 40 1: 2 2: 2 .
9707 . . 1: 36.
9708 .
9709
5d67986c 9710 2 @key{RET} 40 Z ( @key{RET} k b @key{TAB} @key{RET} r 1 @key{TAB} ^ * /
d7b8e6c6 9711
d7b8e6c6 9712@end group
5d67986c 9713@end smallexample
d7b8e6c6 9714@noindent
d7b8e6c6 9715@smallexample
5d67986c 9716@group
d7b8e6c6
EZ
97173: -0.5749 3: -0.5772 2: -0.5772 1: -0.577215664892
97182: -0.5749 2: -0.5772 1: 0 .
97191: 2.3148e-3 1: -0.5749 .
9720 . .
9721
5d67986c 9722 @key{TAB} @key{RET} M-@key{TAB} - @key{RET} M-@key{TAB} a = Z / 2 Z ) Z ' C-x )
d7b8e6c6 9723@end group
5d67986c 9724@end smallexample
d7b8e6c6 9725
a4231b04 9726This is the value of
8e04863e 9727@texline @math{-\gamma},
a4231b04
JB
9728@infoline @expr{- gamma},
9729with a slight bit of roundoff error. To get a full 12 digits, let's use
9730a higher precision:
d7b8e6c6 9731
d7b8e6c6 9732@smallexample
5d67986c 9733@group
d7b8e6c6
EZ
97342: -0.577215664892 2: -0.577215664892
97351: 1. 1: -0.577215664901532
9736
5d67986c 9737 1. @key{RET} p 16 @key{RET} X
d7b8e6c6 9738@end group
5d67986c 9739@end smallexample
d7b8e6c6
EZ
9740
9741Here's the complete sequence of keystrokes:
9742
d7b8e6c6 9743@example
5d67986c 9744@group
d7b8e6c6 9745C-x ( Z ` s 1 0 t 2
5d67986c 9746 @key{RET} 5 a < Z [ 5 Z ( & s + 2 1 s + 1 1 Z ) r 1 Z ]
d7b8e6c6 9747 L r 1 2 * & - r 2 -
5d67986c
RS
9748 2 @key{RET} 40 Z ( @key{RET} k b @key{TAB} @key{RET} r 1 @key{TAB} ^ * /
9749 @key{TAB} @key{RET} M-@key{TAB} - @key{RET} M-@key{TAB} a = Z /
d7b8e6c6
EZ
9750 2 Z )
9751 Z '
9752C-x )
d7b8e6c6 9753@end group
5d67986c 9754@end example
d7b8e6c6
EZ
9755
9756@node Programming Answer 10, Programming Answer 11, Programming Answer 9, Answers to Exercises
9757@subsection Programming Tutorial Exercise 10
9758
9759@noindent
a4231b04
JB
9760Taking the derivative of a term of the form @expr{x^n} will produce
9761a term like
8e04863e 9762@texline @math{n x^{n-1}}.
a4231b04
JB
9763@infoline @expr{n x^(n-1)}.
9764Taking the derivative of a constant
9765produces zero. From this it is easy to see that the @expr{n}th
9766derivative of a polynomial, evaluated at @expr{x = 0}, will equal the
9767coefficient on the @expr{x^n} term times @expr{n!}.
d7b8e6c6
EZ
9768
9769(Because this definition is long, it will be repeated in concise form
9770below. You can use @w{@kbd{M-# m}} to load it from there. While you are
9771entering a @kbd{Z ` Z '} body in a macro, Calc simply collects
9772keystrokes without executing them. In the following diagrams we'll
9773pretend Calc actually executed the keystrokes as you typed them,
9774just for purposes of illustration.)
9775
d7b8e6c6 9776@smallexample
5d67986c 9777@group
d7b8e6c6
EZ
97782: 5 x^4 + (x + 1)^2 3: 5 x^4 + (x + 1)^2
97791: 6 2: 0
9780 . 1: 6
9781 .
9782
5d67986c 9783 ' 5 x^4 + (x+1)^2 @key{RET} 6 C-x ( Z ` [ ] t 1 0 @key{TAB}
d7b8e6c6 9784@end group
5d67986c 9785@end smallexample
d7b8e6c6
EZ
9786
9787@noindent
9788Variable 1 will accumulate the vector of coefficients.
9789
d7b8e6c6 9790@smallexample
5d67986c 9791@group
d7b8e6c6
EZ
97922: 0 3: 0 2: 5 x^4 + ...
97931: 5 x^4 + ... 2: 5 x^4 + ... 1: 1
9794 . 1: 1 .
9795 .
9796
5d67986c 9797 Z ( @key{TAB} @key{RET} 0 s l x @key{RET} M-@key{TAB} ! / s | 1
d7b8e6c6 9798@end group
5d67986c 9799@end smallexample
d7b8e6c6
EZ
9800
9801@noindent
9802Note that @kbd{s | 1} appends the top-of-stack value to the vector
9803in a variable; it is completely analogous to @kbd{s + 1}. We could
5d67986c 9804have written instead, @kbd{r 1 @key{TAB} | t 1}.
d7b8e6c6 9805
d7b8e6c6 9806@smallexample
5d67986c 9807@group
d7b8e6c6
EZ
98081: 20 x^3 + 2 x + 2 1: 0 1: [1, 2, 1, 0, 5, 0, 0]
9809 . . .
9810
5d67986c 9811 a d x @key{RET} 1 Z ) @key{DEL} r 1 Z ' C-x )
d7b8e6c6 9812@end group
5d67986c 9813@end smallexample
d7b8e6c6
EZ
9814
9815To convert back, a simple method is just to map the coefficients
a4231b04 9816against a table of powers of @expr{x}.
d7b8e6c6 9817
d7b8e6c6 9818@smallexample
5d67986c 9819@group
d7b8e6c6
EZ
98202: [1, 2, 1, 0, 5, 0, 0] 2: [1, 2, 1, 0, 5, 0, 0]
98211: 6 1: [0, 1, 2, 3, 4, 5, 6]
9822 . .
9823
5d67986c 9824 6 @key{RET} 1 + 0 @key{RET} 1 C-u v x
d7b8e6c6 9825
d7b8e6c6 9826@end group
5d67986c 9827@end smallexample
d7b8e6c6 9828@noindent
d7b8e6c6 9829@smallexample
5d67986c 9830@group
d7b8e6c6
EZ
98312: [1, 2, 1, 0, 5, 0, 0] 2: 1 + 2 x + x^2 + 5 x^4
98321: [1, x, x^2, x^3, ... ] .
9833 .
9834
5d67986c 9835 ' x @key{RET} @key{TAB} V M ^ *
d7b8e6c6 9836@end group
5d67986c 9837@end smallexample
d7b8e6c6
EZ
9838
9839Once again, here are the whole polynomial to/from vector programs:
9840
d7b8e6c6 9841@example
5d67986c
RS
9842@group
9843C-x ( Z ` [ ] t 1 0 @key{TAB}
9844 Z ( @key{TAB} @key{RET} 0 s l x @key{RET} M-@key{TAB} ! / s | 1
9845 a d x @key{RET}
d7b8e6c6
EZ
9846 1 Z ) r 1
9847 Z '
9848C-x )
9849
5d67986c 9850C-x ( 1 + 0 @key{RET} 1 C-u v x ' x @key{RET} @key{TAB} V M ^ * C-x )
d7b8e6c6 9851@end group
5d67986c 9852@end example
d7b8e6c6
EZ
9853
9854@node Programming Answer 11, Programming Answer 12, Programming Answer 10, Answers to Exercises
9855@subsection Programming Tutorial Exercise 11
9856
9857@noindent
9858First we define a dummy program to go on the @kbd{z s} key. The true
9859@w{@kbd{z s}} key is supposed to take two numbers from the stack and
5d67986c 9860return one number, so @key{DEL} as a dummy definition will make
d7b8e6c6
EZ
9861sure the stack comes out right.
9862
d7b8e6c6 9863@smallexample
5d67986c 9864@group
d7b8e6c6
EZ
98652: 4 1: 4 2: 4
98661: 2 . 1: 2
9867 . .
9868
5d67986c 9869 4 @key{RET} 2 C-x ( @key{DEL} C-x ) Z K s @key{RET} 2
d7b8e6c6 9870@end group
5d67986c 9871@end smallexample
d7b8e6c6
EZ
9872
9873The last step replaces the 2 that was eaten during the creation
9874of the dummy @kbd{z s} command. Now we move on to the real
9875definition. The recurrence needs to be rewritten slightly,
a4231b04 9876to the form @expr{s(n,m) = s(n-1,m-1) - (n-1) s(n-1,m)}.
d7b8e6c6
EZ
9877
9878(Because this definition is long, it will be repeated in concise form
9879below. You can use @kbd{M-# m} to load it from there.)
9880
d7b8e6c6 9881@smallexample
5d67986c 9882@group
d7b8e6c6
EZ
98832: 4 4: 4 3: 4 2: 4
98841: 2 3: 2 2: 2 1: 2
9885 . 2: 4 1: 0 .
9886 1: 2 .
9887 .
9888
5d67986c 9889 C-x ( M-2 @key{RET} a = Z [ @key{DEL} @key{DEL} 1 Z :
d7b8e6c6 9890
d7b8e6c6 9891@end group
5d67986c 9892@end smallexample
d7b8e6c6 9893@noindent
d7b8e6c6 9894@smallexample
5d67986c 9895@group
d7b8e6c6
EZ
98964: 4 2: 4 2: 3 4: 3 4: 3 3: 3
98973: 2 1: 2 1: 2 3: 2 3: 2 2: 2
98982: 2 . . 2: 3 2: 3 1: 3
98991: 0 1: 2 1: 1 .
9900 . . .
9901
5d67986c 9902 @key{RET} 0 a = Z [ @key{DEL} @key{DEL} 0 Z : @key{TAB} 1 - @key{TAB} M-2 @key{RET} 1 - z s
d7b8e6c6 9903@end group
5d67986c 9904@end smallexample
d7b8e6c6
EZ
9905
9906@noindent
9907(Note that the value 3 that our dummy @kbd{z s} produces is not correct;
9908it is merely a placeholder that will do just as well for now.)
9909
d7b8e6c6 9910@smallexample
5d67986c 9911@group
d7b8e6c6
EZ
99123: 3 4: 3 3: 3 2: 3 1: -6
99132: 3 3: 3 2: 3 1: 9 .
99141: 2 2: 3 1: 3 .
9915 . 1: 2 .
9916 .
9917
5d67986c 9918 M-@key{TAB} M-@key{TAB} @key{TAB} @key{RET} M-@key{TAB} z s * -
d7b8e6c6 9919
d7b8e6c6 9920@end group
5d67986c 9921@end smallexample
d7b8e6c6 9922@noindent
d7b8e6c6 9923@smallexample
5d67986c 9924@group
d7b8e6c6
EZ
99251: -6 2: 4 1: 11 2: 11
9926 . 1: 2 . 1: 11
9927 . .
9928
5d67986c 9929 Z ] Z ] C-x ) Z K s @key{RET} @key{DEL} 4 @key{RET} 2 z s M-@key{RET} k s
d7b8e6c6 9930@end group
5d67986c 9931@end smallexample
d7b8e6c6
EZ
9932
9933Even though the result that we got during the definition was highly
9934bogus, once the definition is complete the @kbd{z s} command gets
9935the right answers.
9936
9937Here's the full program once again:
9938
d7b8e6c6 9939@example
5d67986c
RS
9940@group
9941C-x ( M-2 @key{RET} a =
9942 Z [ @key{DEL} @key{DEL} 1
9943 Z : @key{RET} 0 a =
9944 Z [ @key{DEL} @key{DEL} 0
9945 Z : @key{TAB} 1 - @key{TAB} M-2 @key{RET} 1 - z s
9946 M-@key{TAB} M-@key{TAB} @key{TAB} @key{RET} M-@key{TAB} z s * -
d7b8e6c6
EZ
9947 Z ]
9948 Z ]
9949C-x )
d7b8e6c6 9950@end group
5d67986c 9951@end example
d7b8e6c6
EZ
9952
9953You can read this definition using @kbd{M-# m} (@code{read-kbd-macro})
9954followed by @kbd{Z K s}, without having to make a dummy definition
9955first, because @code{read-kbd-macro} doesn't need to execute the
9956definition as it reads it in. For this reason, @code{M-# m} is often
9957the easiest way to create recursive programs in Calc.
9958
9959@node Programming Answer 12, , Programming Answer 11, Answers to Exercises
9960@subsection Programming Tutorial Exercise 12
9961
9962@noindent
9963This turns out to be a much easier way to solve the problem. Let's
9964denote Stirling numbers as calls of the function @samp{s}.
9965
9966First, we store the rewrite rules corresponding to the definition of
9967Stirling numbers in a convenient variable:
9968
9969@smallexample
5d67986c 9970s e StirlingRules @key{RET}
d7b8e6c6
EZ
9971[ s(n,n) := 1 :: n >= 0,
9972 s(n,0) := 0 :: n > 0,
9973 s(n,m) := s(n-1,m-1) - (n-1) s(n-1,m) :: n >= m :: m >= 1 ]
9974C-c C-c
9975@end smallexample
9976
9977Now, it's just a matter of applying the rules:
9978
d7b8e6c6 9979@smallexample
5d67986c 9980@group
d7b8e6c6
EZ
99812: 4 1: s(4, 2) 1: 11
99821: 2 . .
9983 .
9984
5d67986c 9985 4 @key{RET} 2 C-x ( ' s($$,$) @key{RET} a r StirlingRules @key{RET} C-x )
d7b8e6c6 9986@end group
5d67986c 9987@end smallexample
d7b8e6c6
EZ
9988
9989As in the case of the @code{fib} rules, it would be useful to put these
9990rules in @code{EvalRules} and to add a @samp{:: remember} condition to
9991the last rule.
9992
9993@c This ends the table-of-contents kludge from above:
9994@tex
9995\global\let\chapternofonts=\oldchapternofonts
9996@end tex
9997
9998@c [reference]
9999
10000@node Introduction, Data Types, Tutorial, Top
10001@chapter Introduction
10002
10003@noindent
10004This chapter is the beginning of the Calc reference manual.
10005It covers basic concepts such as the stack, algebraic and
10006numeric entry, undo, numeric prefix arguments, etc.
10007
10008@c [when-split]
10009@c (Chapter 2, the Tutorial, has been printed in a separate volume.)
10010
10011@menu
10012* Basic Commands::
10013* Help Commands::
10014* Stack Basics::
10015* Numeric Entry::
10016* Algebraic Entry::
10017* Quick Calculator::
d7b8e6c6
EZ
10018* Prefix Arguments::
10019* Undo::
10020* Error Messages::
10021* Multiple Calculators::
10022* Troubleshooting Commands::
10023@end menu
10024
10025@node Basic Commands, Help Commands, Introduction, Introduction
10026@section Basic Commands
10027
10028@noindent
10029@pindex calc
10030@pindex calc-mode
10031@cindex Starting the Calculator
10032@cindex Running the Calculator
10033To start the Calculator in its standard interface, type @kbd{M-x calc}.
10034By default this creates a pair of small windows, @samp{*Calculator*}
10035and @samp{*Calc Trail*}. The former displays the contents of the
10036Calculator stack and is manipulated exclusively through Calc commands.
10037It is possible (though not usually necessary) to create several Calc
07ce2eb3 10038mode buffers each of which has an independent stack, undo list, and
d7b8e6c6
EZ
10039mode settings. There is exactly one Calc Trail buffer; it records a
10040list of the results of all calculations that have been done. The
07ce2eb3 10041Calc Trail buffer uses a variant of Calc mode, so Calculator commands
d7b8e6c6
EZ
10042still work when the trail buffer's window is selected. It is possible
10043to turn the trail window off, but the @samp{*Calc Trail*} buffer itself
a4231b04 10044still exists and is updated silently. @xref{Trail Commands}.
d7b8e6c6
EZ
10045
10046@kindex M-# c
10047@kindex M-# M-#
5d67986c
RS
10048@ignore
10049@mindex @null
10050@end ignore
d7b8e6c6
EZ
10051@kindex M-# #
10052In most installations, the @kbd{M-# c} key sequence is a more
10053convenient way to start the Calculator. Also, @kbd{M-# M-#} and
10054@kbd{M-# #} are synonyms for @kbd{M-# c} unless you last used Calc
07ce2eb3 10055in its Keypad mode.
d7b8e6c6
EZ
10056
10057@kindex x
10058@kindex M-x
10059@pindex calc-execute-extended-command
10060Most Calc commands use one or two keystrokes. Lower- and upper-case
10061letters are distinct. Commands may also be entered in full @kbd{M-x} form;
10062for some commands this is the only form. As a convenience, the @kbd{x}
10063key (@code{calc-execute-extended-command})
10064is like @kbd{M-x} except that it enters the initial string @samp{calc-}
10065for you. For example, the following key sequences are equivalent:
a4231b04 10066@kbd{S}, @kbd{M-x calc-sin @key{RET}}, @kbd{x sin @key{RET}}.
d7b8e6c6
EZ
10067
10068@cindex Extensions module
10069@cindex @file{calc-ext} module
10070The Calculator exists in many parts. When you type @kbd{M-# c}, the
10071Emacs ``auto-load'' mechanism will bring in only the first part, which
10072contains the basic arithmetic functions. The other parts will be
10073auto-loaded the first time you use the more advanced commands like trig
10074functions or matrix operations. This is done to improve the response time
10075of the Calculator in the common case when all you need to do is a
10076little arithmetic. If for some reason the Calculator fails to load an
10077extension module automatically, you can force it to load all the
10078extensions by using the @kbd{M-# L} (@code{calc-load-everything})
a4231b04 10079command. @xref{Mode Settings}.
d7b8e6c6
EZ
10080
10081If you type @kbd{M-x calc} or @kbd{M-# c} with any numeric prefix argument,
10082the Calculator is loaded if necessary, but it is not actually started.
10083If the argument is positive, the @file{calc-ext} extensions are also
10084loaded if necessary. User-written Lisp code that wishes to make use
10085of Calc's arithmetic routines can use @samp{(calc 0)} or @samp{(calc 1)}
a4231b04 10086to auto-load the Calculator.
d7b8e6c6
EZ
10087
10088@kindex M-# b
10089@pindex full-calc
10090If you type @kbd{M-# b}, then next time you use @kbd{M-# c} you
10091will get a Calculator that uses the full height of the Emacs screen.
10092When full-screen mode is on, @kbd{M-# c} runs the @code{full-calc}
10093command instead of @code{calc}. From the Unix shell you can type
10094@samp{emacs -f full-calc} to start a new Emacs specifically for use
10095as a calculator. When Calc is started from the Emacs command line
10096like this, Calc's normal ``quit'' commands actually quit Emacs itself.
10097
10098@kindex M-# o
10099@pindex calc-other-window
10100The @kbd{M-# o} command is like @kbd{M-# c} except that the Calc
10101window is not actually selected. If you are already in the Calc
10102window, @kbd{M-# o} switches you out of it. (The regular Emacs
10103@kbd{C-x o} command would also work for this, but it has a
10104tendency to drop you into the Calc Trail window instead, which
10105@kbd{M-# o} takes care not to do.)
10106
5d67986c
RS
10107@ignore
10108@mindex M-# q
10109@end ignore
d7b8e6c6
EZ
10110For one quick calculation, you can type @kbd{M-# q} (@code{quick-calc})
10111which prompts you for a formula (like @samp{2+3/4}). The result is
10112displayed at the bottom of the Emacs screen without ever creating
10113any special Calculator windows. @xref{Quick Calculator}.
10114
5d67986c
RS
10115@ignore
10116@mindex M-# k
10117@end ignore
d7b8e6c6
EZ
10118Finally, if you are using the X window system you may want to try
10119@kbd{M-# k} (@code{calc-keypad}) which runs Calc with a
10120``calculator keypad'' picture as well as a stack display. Click on
10121the keys with the mouse to operate the calculator. @xref{Keypad Mode}.
10122
10123@kindex q
10124@pindex calc-quit
10125@cindex Quitting the Calculator
10126@cindex Exiting the Calculator
07ce2eb3 10127The @kbd{q} key (@code{calc-quit}) exits Calc mode and closes the
d7b8e6c6
EZ
10128Calculator's window(s). It does not delete the Calculator buffers.
10129If you type @kbd{M-x calc} again, the Calculator will reappear with the
10130contents of the stack intact. Typing @kbd{M-# c} or @kbd{M-# M-#}
10131again from inside the Calculator buffer is equivalent to executing
10132@code{calc-quit}; you can think of @kbd{M-# M-#} as toggling the
a4231b04 10133Calculator on and off.
d7b8e6c6
EZ
10134
10135@kindex M-# x
10136The @kbd{M-# x} command also turns the Calculator off, no matter which
10137user interface (standard, Keypad, or Embedded) is currently active.
10138It also cancels @code{calc-edit} mode if used from there.
10139
5d67986c 10140@kindex d @key{SPC}
d7b8e6c6
EZ
10141@pindex calc-refresh
10142@cindex Refreshing a garbled display
10143@cindex Garbled displays, refreshing
5d67986c 10144The @kbd{d @key{SPC}} key sequence (@code{calc-refresh}) redraws the contents
d7b8e6c6
EZ
10145of the Calculator buffer from memory. Use this if the contents of the
10146buffer have been damaged somehow.
10147
5d67986c
RS
10148@ignore
10149@mindex o
10150@end ignore
d7b8e6c6
EZ
10151The @kbd{o} key (@code{calc-realign}) moves the cursor back to its
10152``home'' position at the bottom of the Calculator buffer.
10153
10154@kindex <
10155@kindex >
10156@pindex calc-scroll-left
10157@pindex calc-scroll-right
10158@cindex Horizontal scrolling
10159@cindex Scrolling
10160@cindex Wide text, scrolling
10161The @kbd{<} and @kbd{>} keys are bound to @code{calc-scroll-left} and
10162@code{calc-scroll-right}. These are just like the normal horizontal
10163scrolling commands except that they scroll one half-screen at a time by
10164default. (Calc formats its output to fit within the bounds of the
a4231b04 10165window whenever it can.)
d7b8e6c6
EZ
10166
10167@kindex @{
10168@kindex @}
10169@pindex calc-scroll-down
10170@pindex calc-scroll-up
10171@cindex Vertical scrolling
10172The @kbd{@{} and @kbd{@}} keys are bound to @code{calc-scroll-down}
10173and @code{calc-scroll-up}. They scroll up or down by one-half the
a4231b04 10174height of the Calc window.
d7b8e6c6
EZ
10175
10176@kindex M-# 0
10177@pindex calc-reset
10178The @kbd{M-# 0} command (@code{calc-reset}; that's @kbd{M-#} followed
d7347600
JB
10179by a zero) resets the Calculator to its initial state. This clears
10180the stack, resets all the modes to their initial values (the values
10181that were saved with @kbd{m m} (@code{calc-save-modes})), clears the
10182caches (@pxref{Caches}), and so on. (It does @emph{not} erase the
10183values of any variables.) With an argument of 0, Calc will be reset to
10184its default state; namely, the modes will be given their default values.
10185With a positive prefix argument, @kbd{M-# 0} preserves the contents of
10186the stack but resets everything else to its initial state; with a
10187negative prefix argument, @kbd{M-# 0} preserves the contents of the
10188stack but resets everything else to its default state.
d7b8e6c6
EZ
10189
10190@pindex calc-version
10191The @kbd{M-x calc-version} command displays the current version number
10192of Calc and the name of the person who installed it on your system.
10193(This information is also present in the @samp{*Calc Trail*} buffer,
10194and in the output of the @kbd{h h} command.)
10195
10196@node Help Commands, Stack Basics, Basic Commands, Introduction
10197@section Help Commands
10198
10199@noindent
10200@cindex Help commands
10201@kindex ?
10202@pindex calc-help
10203The @kbd{?} key (@code{calc-help}) displays a series of brief help messages.
10204Some keys (such as @kbd{b} and @kbd{d}) are prefix keys, like Emacs'
10205@key{ESC} and @kbd{C-x} prefixes. You can type
10206@kbd{?} after a prefix to see a list of commands beginning with that
10207prefix. (If the message includes @samp{[MORE]}, press @kbd{?} again
10208to see additional commands for that prefix.)
10209
10210@kindex h h
10211@pindex calc-full-help
10212The @kbd{h h} (@code{calc-full-help}) command displays all the @kbd{?}
10213responses at once. When printed, this makes a nice, compact (three pages)
10214summary of Calc keystrokes.
10215
10216In general, the @kbd{h} key prefix introduces various commands that
10217provide help within Calc. Many of the @kbd{h} key functions are
10218Calc-specific analogues to the @kbd{C-h} functions for Emacs help.
10219
10220@kindex h i
10221@kindex M-# i
10222@kindex i
10223@pindex calc-info
10224The @kbd{h i} (@code{calc-info}) command runs the Emacs Info system
10225to read this manual on-line. This is basically the same as typing
10226@kbd{C-h i} (the regular way to run the Info system), then, if Info
10227is not already in the Calc manual, selecting the beginning of the
10228manual. The @kbd{M-# i} command is another way to read the Calc
10229manual; it is different from @kbd{h i} in that it works any time,
10230not just inside Calc. The plain @kbd{i} key is also equivalent to
10231@kbd{h i}, though this key is obsolete and may be replaced with a
10232different command in a future version of Calc.
10233
10234@kindex h t
10235@kindex M-# t
10236@pindex calc-tutorial
10237The @kbd{h t} (@code{calc-tutorial}) command runs the Info system on
10238the Tutorial section of the Calc manual. It is like @kbd{h i},
10239except that it selects the starting node of the tutorial rather
10240than the beginning of the whole manual. (It actually selects the
10241node ``Interactive Tutorial'' which tells a few things about
10242using the Info system before going on to the actual tutorial.)
10243The @kbd{M-# t} key is equivalent to @kbd{h t} (but it works at
10244all times).
10245
10246@kindex h s
10247@kindex M-# s
10248@pindex calc-info-summary
10249The @kbd{h s} (@code{calc-info-summary}) command runs the Info system
10250on the Summary node of the Calc manual. @xref{Summary}. The @kbd{M-# s}
10251key is equivalent to @kbd{h s}.
10252
10253@kindex h k
10254@pindex calc-describe-key
10255The @kbd{h k} (@code{calc-describe-key}) command looks up a key
10256sequence in the Calc manual. For example, @kbd{h k H a S} looks
10257up the documentation on the @kbd{H a S} (@code{calc-solve-for})
10258command. This works by looking up the textual description of
10259the key(s) in the Key Index of the manual, then jumping to the
10260node indicated by the index.
10261
10262Most Calc commands do not have traditional Emacs documentation
10263strings, since the @kbd{h k} command is both more convenient and
10264more instructive. This means the regular Emacs @kbd{C-h k}
10265(@code{describe-key}) command will not be useful for Calc keystrokes.
10266
10267@kindex h c
10268@pindex calc-describe-key-briefly
10269The @kbd{h c} (@code{calc-describe-key-briefly}) command reads a
10270key sequence and displays a brief one-line description of it at
10271the bottom of the screen. It looks for the key sequence in the
10272Summary node of the Calc manual; if it doesn't find the sequence
10273there, it acts just like its regular Emacs counterpart @kbd{C-h c}
10274(@code{describe-key-briefly}). For example, @kbd{h c H a S}
10275gives the description:
10276
10277@smallexample
10278H a S runs calc-solve-for: a `H a S' v => fsolve(a,v) (?=notes)
10279@end smallexample
10280
10281@noindent
10282which means the command @kbd{H a S} or @kbd{H M-x calc-solve-for}
a4231b04 10283takes a value @expr{a} from the stack, prompts for a value @expr{v},
d7b8e6c6
EZ
10284then applies the algebraic function @code{fsolve} to these values.
10285The @samp{?=notes} message means you can now type @kbd{?} to see
10286additional notes from the summary that apply to this command.
10287
10288@kindex h f
10289@pindex calc-describe-function
10290The @kbd{h f} (@code{calc-describe-function}) command looks up an
b1848006 10291algebraic function or a command name in the Calc manual. Enter an
d7b8e6c6 10292algebraic function name to look up that function in the Function
b1848006
JB
10293Index or enter a command name beginning with @samp{calc-} to look it
10294up in the Command Index. This command will also look up operator
10295symbols that can appear in algebraic formulas, like @samp{%} and
10296@samp{=>}.
d7b8e6c6
EZ
10297
10298@kindex h v
10299@pindex calc-describe-variable
10300The @kbd{h v} (@code{calc-describe-variable}) command looks up a
b1848006 10301variable in the Calc manual. Enter a variable name like @code{pi} or
d7b8e6c6
EZ
10302@code{PlotRejects}.
10303
10304@kindex h b
10305@pindex describe-bindings
10306The @kbd{h b} (@code{calc-describe-bindings}) command is just like
10307@kbd{C-h b}, except that only local (Calc-related) key bindings are
10308listed.
10309
10310@kindex h n
10311The @kbd{h n} or @kbd{h C-n} (@code{calc-view-news}) command displays
10312the ``news'' or change history of Calc. This is kept in the file
10313@file{README}, which Calc looks for in the same directory as the Calc
10314source files.
10315
10316@kindex h C-c
10317@kindex h C-d
10318@kindex h C-w
10319The @kbd{h C-c}, @kbd{h C-d}, and @kbd{h C-w} keys display copying,
10320distribution, and warranty information about Calc. These work by
10321pulling up the appropriate parts of the ``Copying'' or ``Reporting
10322Bugs'' sections of the manual.
10323
10324@node Stack Basics, Numeric Entry, Help Commands, Introduction
10325@section Stack Basics
10326
10327@noindent
10328@cindex Stack basics
10329@c [fix-tut RPN Calculations and the Stack]
28665d46 10330Calc uses RPN notation. If you are not familiar with RPN, @pxref{RPN
d7b8e6c6
EZ
10331Tutorial}.
10332
10333To add the numbers 1 and 2 in Calc you would type the keys:
10334@kbd{1 @key{RET} 2 +}.
10335(@key{RET} corresponds to the @key{ENTER} key on most calculators.)
10336The first three keystrokes ``push'' the numbers 1 and 2 onto the stack. The
10337@kbd{+} key always ``pops'' the top two numbers from the stack, adds them,
10338and pushes the result (3) back onto the stack. This number is ready for
10339further calculations: @kbd{5 -} pushes 5 onto the stack, then pops the
8e04863e 103403 and 5, subtracts them, and pushes the result (@mathit{-2}).
d7b8e6c6
EZ
10341
10342Note that the ``top'' of the stack actually appears at the @emph{bottom}
10343of the buffer. A line containing a single @samp{.} character signifies
10344the end of the buffer; Calculator commands operate on the number(s)
10345directly above this line. The @kbd{d t} (@code{calc-truncate-stack})
10346command allows you to move the @samp{.} marker up and down in the stack;
10347@pxref{Truncating the Stack}.
10348
10349@kindex d l
10350@pindex calc-line-numbering
10351Stack elements are numbered consecutively, with number 1 being the top of
10352the stack. These line numbers are ordinarily displayed on the lefthand side
10353of the window. The @kbd{d l} (@code{calc-line-numbering}) command controls
10354whether these numbers appear. (Line numbers may be turned off since they
10355slow the Calculator down a bit and also clutter the display.)
10356
10357@kindex o
10358@pindex calc-realign
10359The unshifted letter @kbd{o} (@code{calc-realign}) command repositions
10360the cursor to its top-of-stack ``home'' position. It also undoes any
10361horizontal scrolling in the window. If you give it a numeric prefix
10362argument, it instead moves the cursor to the specified stack element.
10363
10364The @key{RET} (or equivalent @key{SPC}) key is only required to separate
10365two consecutive numbers.
10366(After all, if you typed @kbd{1 2} by themselves the Calculator
5d67986c 10367would enter the number 12.) If you press @key{RET} or @key{SPC} @emph{not}
d7b8e6c6 10368right after typing a number, the key duplicates the number on the top of
a4231b04 10369the stack. @kbd{@key{RET} *} is thus a handy way to square a number.
d7b8e6c6
EZ
10370
10371The @key{DEL} key pops and throws away the top number on the stack.
10372The @key{TAB} key swaps the top two objects on the stack.
10373@xref{Stack and Trail}, for descriptions of these and other stack-related
a4231b04 10374commands.
d7b8e6c6
EZ
10375
10376@node Numeric Entry, Algebraic Entry, Stack Basics, Introduction
10377@section Numeric Entry
10378
10379@noindent
10380@kindex 0-9
10381@kindex .
10382@kindex e
10383@cindex Numeric entry
10384@cindex Entering numbers
10385Pressing a digit or other numeric key begins numeric entry using the
10386minibuffer. The number is pushed on the stack when you press the @key{RET}
10387or @key{SPC} keys. If you press any other non-numeric key, the number is
10388pushed onto the stack and the appropriate operation is performed. If
10389you press a numeric key which is not valid, the key is ignored.
10390
10391@cindex Minus signs
10392@cindex Negative numbers, entering
10393@kindex _
10394There are three different concepts corresponding to the word ``minus,''
a4231b04
JB
10395typified by @expr{a-b} (subtraction), @expr{-x}
10396(change-sign), and @expr{-5} (negative number). Calc uses three
d7b8e6c6
EZ
10397different keys for these operations, respectively:
10398@kbd{-}, @kbd{n}, and @kbd{_} (the underscore). The @kbd{-} key subtracts
10399the two numbers on the top of the stack. The @kbd{n} key changes the sign
10400of the number on the top of the stack or the number currently being entered.
10401The @kbd{_} key begins entry of a negative number or changes the sign of
10402the number currently being entered. The following sequences all enter the
8e04863e 10403number @mathit{-5} onto the stack: @kbd{0 @key{RET} 5 -}, @kbd{5 n @key{RET}},
a4231b04 10404@kbd{5 @key{RET} n}, @kbd{_ 5 @key{RET}}, @kbd{5 _ @key{RET}}.
d7b8e6c6
EZ
10405
10406Some other keys are active during numeric entry, such as @kbd{#} for
10407non-decimal numbers, @kbd{:} for fractions, and @kbd{@@} for HMS forms.
10408These notations are described later in this manual with the corresponding
10409data types. @xref{Data Types}.
10410
5d67986c 10411During numeric entry, the only editing key available is @key{DEL}.
d7b8e6c6
EZ
10412
10413@node Algebraic Entry, Quick Calculator, Numeric Entry, Introduction
10414@section Algebraic Entry
10415
10416@noindent
10417@kindex '
10418@pindex calc-algebraic-entry
10419@cindex Algebraic notation
10420@cindex Formulas, entering
10421Calculations can also be entered in algebraic form. This is accomplished
10422by typing the apostrophe key, @kbd{'}, followed by the expression in
10423standard format: @kbd{@key{'} 2+3*4 @key{RET}} computes
8e04863e 10424@texline @math{2+(3\times4) = 14}
a4231b04
JB
10425@infoline @expr{2+(3*4) = 14}
10426and pushes that on the stack. If you wish you can
d7b8e6c6
EZ
10427ignore the RPN aspect of Calc altogether and simply enter algebraic
10428expressions in this way. You may want to use @key{DEL} every so often to
a4231b04 10429clear previous results off the stack.
d7b8e6c6
EZ
10430
10431You can press the apostrophe key during normal numeric entry to switch
07ce2eb3 10432the half-entered number into Algebraic entry mode. One reason to do this
d7b8e6c6
EZ
10433would be to use the full Emacs cursor motion and editing keys, which are
10434available during algebraic entry but not during numeric entry.
10435
10436In the same vein, during either numeric or algebraic entry you can
10437press @kbd{`} (backquote) to switch to @code{calc-edit} mode, where
10438you complete your half-finished entry in a separate buffer.
10439@xref{Editing Stack Entries}.
10440
10441@kindex m a
10442@pindex calc-algebraic-mode
07ce2eb3 10443@cindex Algebraic Mode
d7b8e6c6
EZ
10444If you prefer algebraic entry, you can use the command @kbd{m a}
10445(@code{calc-algebraic-mode}) to set Algebraic mode. In this mode,
10446digits and other keys that would normally start numeric entry instead
10447start full algebraic entry; as long as your formula begins with a digit
10448you can omit the apostrophe. Open parentheses and square brackets also
10449begin algebraic entry. You can still do RPN calculations in this mode,
10450but you will have to press @key{RET} to terminate every number:
10451@kbd{2 @key{RET} 3 @key{RET} * 4 @key{RET} +} would accomplish the same
a4231b04 10452thing as @kbd{2*3+4 @key{RET}}.
d7b8e6c6 10453
07ce2eb3 10454@cindex Incomplete Algebraic Mode
d7b8e6c6
EZ
10455If you give a numeric prefix argument like @kbd{C-u} to the @kbd{m a}
10456command, it enables Incomplete Algebraic mode; this is like regular
10457Algebraic mode except that it applies to the @kbd{(} and @kbd{[} keys
10458only. Numeric keys still begin a numeric entry in this mode.
10459
10460@kindex m t
10461@pindex calc-total-algebraic-mode
07ce2eb3 10462@cindex Total Algebraic Mode
d7b8e6c6
EZ
10463The @kbd{m t} (@code{calc-total-algebraic-mode}) gives you an even
10464stronger algebraic-entry mode, in which @emph{all} regular letter and
10465punctuation keys begin algebraic entry. Use this if you prefer typing
10466@w{@kbd{sqrt( )}} instead of @kbd{Q}, @w{@kbd{factor( )}} instead of
10467@kbd{a f}, and so on. To type regular Calc commands when you are in
07ce2eb3 10468Total Algebraic mode, hold down the @key{META} key. Thus @kbd{M-q}
d7b8e6c6 10469is the command to quit Calc, @kbd{M-p} sets the precision, and
07ce2eb3 10470@kbd{M-m t} (or @kbd{M-m M-t}, if you prefer) turns Total Algebraic
d7b8e6c6 10471mode back off again. Meta keys also terminate algebraic entry, so
5d67986c 10472that @kbd{2+3 M-S} is equivalent to @kbd{2+3 @key{RET} M-S}. The symbol
d7b8e6c6
EZ
10473@samp{Alg*} will appear in the mode line whenever you are in this mode.
10474
10475Pressing @kbd{'} (the apostrophe) a second time re-enters the previous
10476algebraic formula. You can then use the normal Emacs editing keys to
10477modify this formula to your liking before pressing @key{RET}.
10478
10479@kindex $
10480@cindex Formulas, referring to stack
10481Within a formula entered from the keyboard, the symbol @kbd{$}
10482represents the number on the top of the stack. If an entered formula
10483contains any @kbd{$} characters, the Calculator replaces the top of
10484stack with that formula rather than simply pushing the formula onto the
10485stack. Thus, @kbd{' 1+2 @key{RET}} pushes 3 on the stack, and @kbd{$*2
10486@key{RET}} replaces it with 6. Note that the @kbd{$} key always
10487initiates algebraic entry; the @kbd{'} is unnecessary if @kbd{$} is the
a4231b04 10488first character in the new formula.
d7b8e6c6
EZ
10489
10490Higher stack elements can be accessed from an entered formula with the
10491symbols @kbd{$$}, @kbd{$$$}, and so on. The number of stack elements
10492removed (to be replaced by the entered values) equals the number of dollar
10493signs in the longest such symbol in the formula. For example, @samp{$$+$$$}
10494adds the second and third stack elements, replacing the top three elements
10495with the answer. (All information about the top stack element is thus lost
a4231b04 10496since no single @samp{$} appears in this formula.)
d7b8e6c6
EZ
10497
10498A slightly different way to refer to stack elements is with a dollar
10499sign followed by a number: @samp{$1}, @samp{$2}, and so on are much
10500like @samp{$}, @samp{$$}, etc., except that stack entries referred
10501to numerically are not replaced by the algebraic entry. That is, while
10502@samp{$+1} replaces 5 on the stack with 6, @samp{$1+1} leaves the 5
10503on the stack and pushes an additional 6.
10504
10505If a sequence of formulas are entered separated by commas, each formula
10506is pushed onto the stack in turn. For example, @samp{1,2,3} pushes
10507those three numbers onto the stack (leaving the 3 at the top), and
10508@samp{$+1,$-1} replaces a 5 on the stack with 4 followed by 6. Also,
10509@samp{$,$$} exchanges the top two elements of the stack, just like the
10510@key{TAB} key.
10511
5d67986c 10512You can finish an algebraic entry with @kbd{M-=} or @kbd{M-@key{RET}} instead
d7b8e6c6
EZ
10513of @key{RET}. This uses @kbd{=} to evaluate the variables in each
10514formula that goes onto the stack. (Thus @kbd{' pi @key{RET}} pushes
5d67986c 10515the variable @samp{pi}, but @kbd{' pi M-@key{RET}} pushes 3.1415.)
d7b8e6c6 10516
5d67986c 10517If you finish your algebraic entry by pressing @key{LFD} (or @kbd{C-j})
d7b8e6c6
EZ
10518instead of @key{RET}, Calc disables the default simplifications
10519(as if by @kbd{m O}; @pxref{Simplification Modes}) while the entry
10520is being pushed on the stack. Thus @kbd{' 1+2 @key{RET}} pushes 3
a4231b04 10521on the stack, but @kbd{' 1+2 @key{LFD}} pushes the formula @expr{1+2};
d7b8e6c6
EZ
10522you might then press @kbd{=} when it is time to evaluate this formula.
10523
10524@node Quick Calculator, Prefix Arguments, Algebraic Entry, Introduction
10525@section ``Quick Calculator'' Mode
10526
10527@noindent
10528@kindex M-# q
10529@pindex quick-calc
10530@cindex Quick Calculator
10531There is another way to invoke the Calculator if all you need to do
10532is make one or two quick calculations. Type @kbd{M-# q} (or
10533@kbd{M-x quick-calc}), then type any formula as an algebraic entry.
10534The Calculator will compute the result and display it in the echo
10535area, without ever actually putting up a Calc window.
10536
10537You can use the @kbd{$} character in a Quick Calculator formula to
10538refer to the previous Quick Calculator result. Older results are
10539not retained; the Quick Calculator has no effect on the full
10540Calculator's stack or trail. If you compute a result and then
10541forget what it was, just run @code{M-# q} again and enter
10542@samp{$} as the formula.
10543
10544If this is the first time you have used the Calculator in this Emacs
10545session, the @kbd{M-# q} command will create the @code{*Calculator*}
10546buffer and perform all the usual initializations; it simply will
10547refrain from putting that buffer up in a new window. The Quick
10548Calculator refers to the @code{*Calculator*} buffer for all mode
10549settings. Thus, for example, to set the precision that the Quick
10550Calculator uses, simply run the full Calculator momentarily and use
10551the regular @kbd{p} command.
10552
10553If you use @code{M-# q} from inside the Calculator buffer, the
10554effect is the same as pressing the apostrophe key (algebraic entry).
10555
10556The result of a Quick calculation is placed in the Emacs ``kill ring''
10557as well as being displayed. A subsequent @kbd{C-y} command will
10558yank the result into the editing buffer. You can also use this
10559to yank the result into the next @kbd{M-# q} input line as a more
10560explicit alternative to @kbd{$} notation, or to yank the result
10561into the Calculator stack after typing @kbd{M-# c}.
10562
10563If you finish your formula by typing @key{LFD} (or @kbd{C-j}) instead
10564of @key{RET}, the result is inserted immediately into the current
10565buffer rather than going into the kill ring.
10566
10567Quick Calculator results are actually evaluated as if by the @kbd{=}
10568key (which replaces variable names by their stored values, if any).
10569If the formula you enter is an assignment to a variable using the
10570@samp{:=} operator, say, @samp{foo := 2 + 3} or @samp{foo := foo + 1},
10571then the result of the evaluation is stored in that Calc variable.
10572@xref{Store and Recall}.
10573
10574If the result is an integer and the current display radix is decimal,
10575the number will also be displayed in hex and octal formats. If the
10576integer is in the range from 1 to 126, it will also be displayed as
10577an ASCII character.
10578
10579For example, the quoted character @samp{"x"} produces the vector
10580result @samp{[120]} (because 120 is the ASCII code of the lower-case
10581`x'; @pxref{Strings}). Since this is a vector, not an integer, it
10582is displayed only according to the current mode settings. But
10583running Quick Calc again and entering @samp{120} will produce the
10584result @samp{120 (16#78, 8#170, x)} which shows the number in its
10585decimal, hexadecimal, octal, and ASCII forms.
10586
10587Please note that the Quick Calculator is not any faster at loading
10588or computing the answer than the full Calculator; the name ``quick''
10589merely refers to the fact that it's much less hassle to use for
10590small calculations.
10591
10592@node Prefix Arguments, Undo, Quick Calculator, Introduction
10593@section Numeric Prefix Arguments
10594
10595@noindent
10596Many Calculator commands use numeric prefix arguments. Some, such as
10597@kbd{d s} (@code{calc-sci-notation}), set a parameter to the value of
10598the prefix argument or use a default if you don't use a prefix.
10599Others (like @kbd{d f} (@code{calc-fix-notation})) require an argument
a4231b04 10600and prompt for a number if you don't give one as a prefix.
d7b8e6c6
EZ
10601
10602As a rule, stack-manipulation commands accept a numeric prefix argument
10603which is interpreted as an index into the stack. A positive argument
10604operates on the top @var{n} stack entries; a negative argument operates
10605on the @var{n}th stack entry in isolation; and a zero argument operates
10606on the entire stack.
10607
10608Most commands that perform computations (such as the arithmetic and
10609scientific functions) accept a numeric prefix argument that allows the
10610operation to be applied across many stack elements. For unary operations
10611(that is, functions of one argument like absolute value or complex
10612conjugate), a positive prefix argument applies that function to the top
10613@var{n} stack entries simultaneously, and a negative argument applies it
10614to the @var{n}th stack entry only. For binary operations (functions of
10615two arguments like addition, GCD, and vector concatenation), a positive
10616prefix argument ``reduces'' the function across the top @var{n}
10617stack elements (for example, @kbd{C-u 5 +} sums the top 5 stack entries;
10618@pxref{Reducing and Mapping}), and a negative argument maps the next-to-top
10619@var{n} stack elements with the top stack element as a second argument
10620(for example, @kbd{7 c-u -5 +} adds 7 to the top 5 stack elements).
10621This feature is not available for operations which use the numeric prefix
10622argument for some other purpose.
10623
10624Numeric prefixes are specified the same way as always in Emacs: Press
10625a sequence of @key{META}-digits, or press @key{ESC} followed by digits,
10626or press @kbd{C-u} followed by digits. Some commands treat plain
a4231b04 10627@kbd{C-u} (without any actual digits) specially.
d7b8e6c6
EZ
10628
10629@kindex ~
10630@pindex calc-num-prefix
10631You can type @kbd{~} (@code{calc-num-prefix}) to pop an integer from the
10632top of the stack and enter it as the numeric prefix for the next command.
10633For example, @kbd{C-u 16 p} sets the precision to 16 digits; an alternate
10634(silly) way to do this would be @kbd{2 @key{RET} 4 ^ ~ p}, i.e., compute 2
a4231b04 10635to the fourth power and set the precision to that value.
d7b8e6c6
EZ
10636
10637Conversely, if you have typed a numeric prefix argument the @kbd{~} key
10638pushes it onto the stack in the form of an integer.
10639
10640@node Undo, Error Messages, Prefix Arguments, Introduction
10641@section Undoing Mistakes
10642
10643@noindent
10644@kindex U
10645@kindex C-_
10646@pindex calc-undo
10647@cindex Mistakes, undoing
10648@cindex Undoing mistakes
10649@cindex Errors, undoing
10650The shift-@kbd{U} key (@code{calc-undo}) undoes the most recent operation.
10651If that operation added or dropped objects from the stack, those objects
10652are removed or restored. If it was a ``store'' operation, you are
10653queried whether or not to restore the variable to its original value.
10654The @kbd{U} key may be pressed any number of times to undo successively
10655farther back in time; with a numeric prefix argument it undoes a
10656specified number of operations. The undo history is cleared only by the
10657@kbd{q} (@code{calc-quit}) command. (Recall that @kbd{M-# c} is
10658synonymous with @code{calc-quit} while inside the Calculator; this
10659also clears the undo history.)
10660
10661Currently the mode-setting commands (like @code{calc-precision}) are not
10662undoable. You can undo past a point where you changed a mode, but you
10663will need to reset the mode yourself.
10664
10665@kindex D
10666@pindex calc-redo
10667@cindex Redoing after an Undo
10668The shift-@kbd{D} key (@code{calc-redo}) redoes an operation that was
10669mistakenly undone. Pressing @kbd{U} with a negative prefix argument is
10670equivalent to executing @code{calc-redo}. You can redo any number of
10671times, up to the number of recent consecutive undo commands. Redo
10672information is cleared whenever you give any command that adds new undo
10673information, i.e., if you undo, then enter a number on the stack or make
10674any other change, then it will be too late to redo.
10675
5d67986c 10676@kindex M-@key{RET}
d7b8e6c6
EZ
10677@pindex calc-last-args
10678@cindex Last-arguments feature
10679@cindex Arguments, restoring
10680The @kbd{M-@key{RET}} key (@code{calc-last-args}) is like undo in that
10681it restores the arguments of the most recent command onto the stack;
10682however, it does not remove the result of that command. Given a numeric
a4231b04 10683prefix argument, this command applies to the @expr{n}th most recent
d7b8e6c6
EZ
10684command which removed items from the stack; it pushes those items back
10685onto the stack.
10686
10687The @kbd{K} (@code{calc-keep-args}) command provides a related function
10688to @kbd{M-@key{RET}}. @xref{Stack and Trail}.
10689
10690It is also possible to recall previous results or inputs using the trail.
10691@xref{Trail Commands}.
10692
10693The standard Emacs @kbd{C-_} undo key is recognized as a synonym for @kbd{U}.
10694
10695@node Error Messages, Multiple Calculators, Undo, Introduction
10696@section Error Messages
10697
10698@noindent
10699@kindex w
10700@pindex calc-why
10701@cindex Errors, messages
10702@cindex Why did an error occur?
10703Many situations that would produce an error message in other calculators
10704simply create unsimplified formulas in the Emacs Calculator. For example,
a4231b04 10705@kbd{1 @key{RET} 0 /} pushes the formula @expr{1 / 0}; @w{@kbd{0 L}} pushes
d7b8e6c6
EZ
10706the formula @samp{ln(0)}. Floating-point overflow and underflow are also
10707reasons for this to happen.
10708
10709When a function call must be left in symbolic form, Calc usually
10710produces a message explaining why. Messages that are probably
10711surprising or indicative of user errors are displayed automatically.
10712Other messages are simply kept in Calc's memory and are displayed only
10713if you type @kbd{w} (@code{calc-why}). You can also press @kbd{w} if
10714the same computation results in several messages. (The first message
10715will end with @samp{[w=more]} in this case.)
10716
10717@kindex d w
10718@pindex calc-auto-why
10719The @kbd{d w} (@code{calc-auto-why}) command controls when error messages
10720are displayed automatically. (Calc effectively presses @kbd{w} for you
10721after your computation finishes.) By default, this occurs only for
10722``important'' messages. The other possible modes are to report
10723@emph{all} messages automatically, or to report none automatically (so
10724that you must always press @kbd{w} yourself to see the messages).
10725
10726@node Multiple Calculators, Troubleshooting Commands, Error Messages, Introduction
10727@section Multiple Calculators
10728
10729@noindent
10730@pindex another-calc
07ce2eb3 10731It is possible to have any number of Calc mode buffers at once.
d7b8e6c6
EZ
10732Usually this is done by executing @kbd{M-x another-calc}, which
10733is similar to @kbd{M-# c} except that if a @samp{*Calculator*}
10734buffer already exists, a new, independent one with a name of the
10735form @samp{*Calculator*<@var{n}>} is created. You can also use the
10736command @code{calc-mode} to put any buffer into Calculator mode, but
10737this would ordinarily never be done.
10738
10739The @kbd{q} (@code{calc-quit}) command does not destroy a Calculator buffer;
10740it only closes its window. Use @kbd{M-x kill-buffer} to destroy a
10741Calculator buffer.
10742
10743Each Calculator buffer keeps its own stack, undo list, and mode settings
10744such as precision, angular mode, and display formats. In Emacs terms,
10745variables such as @code{calc-stack} are buffer-local variables. The
10746global default values of these variables are used only when a new
10747Calculator buffer is created. The @code{calc-quit} command saves
10748the stack and mode settings of the buffer being quit as the new defaults.
10749
10750There is only one trail buffer, @samp{*Calc Trail*}, used by all
10751Calculator buffers.
10752
10753@node Troubleshooting Commands, , Multiple Calculators, Introduction
10754@section Troubleshooting Commands
10755
10756@noindent
10757This section describes commands you can use in case a computation
10758incorrectly fails or gives the wrong answer.
10759
10760@xref{Reporting Bugs}, if you find a problem that appears to be due
10761to a bug or deficiency in Calc.
10762
10763@menu
10764* Autoloading Problems::
10765* Recursion Depth::
10766* Caches::
10767* Debugging Calc::
10768@end menu
10769
10770@node Autoloading Problems, Recursion Depth, Troubleshooting Commands, Troubleshooting Commands
10771@subsection Autoloading Problems
10772
10773@noindent
10774The Calc program is split into many component files; components are
10775loaded automatically as you use various commands that require them.
10776Occasionally Calc may lose track of when a certain component is
10777necessary; typically this means you will type a command and it won't
10778work because some function you've never heard of was undefined.
10779
10780@kindex M-# L
10781@pindex calc-load-everything
10782If this happens, the easiest workaround is to type @kbd{M-# L}
10783(@code{calc-load-everything}) to force all the parts of Calc to be
10784loaded right away. This will cause Emacs to take up a lot more
10785memory than it would otherwise, but it's guaranteed to fix the problem.
10786
d7b8e6c6
EZ
10787@node Recursion Depth, Caches, Autoloading Problems, Troubleshooting Commands
10788@subsection Recursion Depth
10789
10790@noindent
10791@kindex M
10792@kindex I M
10793@pindex calc-more-recursion-depth
10794@pindex calc-less-recursion-depth
10795@cindex Recursion depth
10796@cindex ``Computation got stuck'' message
10797@cindex @code{max-lisp-eval-depth}
10798@cindex @code{max-specpdl-size}
10799Calc uses recursion in many of its calculations. Emacs Lisp keeps a
10800variable @code{max-lisp-eval-depth} which limits the amount of recursion
10801possible in an attempt to recover from program bugs. If a calculation
10802ever halts incorrectly with the message ``Computation got stuck or
10803ran too long,'' use the @kbd{M} command (@code{calc-more-recursion-depth})
10804to increase this limit. (Of course, this will not help if the
a4231b04 10805calculation really did get stuck due to some problem inside Calc.)
d7b8e6c6
EZ
10806
10807The limit is always increased (multiplied) by a factor of two. There
10808is also an @kbd{I M} (@code{calc-less-recursion-depth}) command which
10809decreases this limit by a factor of two, down to a minimum value of 200.
10810The default value is 1000.
10811
10812These commands also double or halve @code{max-specpdl-size}, another
10813internal Lisp recursion limit. The minimum value for this limit is 600.
10814
10815@node Caches, Debugging Calc, Recursion Depth, Troubleshooting Commands
10816@subsection Caches
10817
10818@noindent
10819@cindex Caches
10820@cindex Flushing caches
10821Calc saves certain values after they have been computed once. For
10822example, the @kbd{P} (@code{calc-pi}) command initially ``knows'' the
a4231b04
JB
10823constant @cpi{} to about 20 decimal places; if the current precision
10824is greater than this, it will recompute @cpi{} using a series
d7b8e6c6
EZ
10825approximation. This value will not need to be recomputed ever again
10826unless you raise the precision still further. Many operations such as
10827logarithms and sines make use of similarly cached values such as
a4231b04 10828@cpiover{4} and
8e04863e 10829@texline @math{\ln 2}.
a4231b04
JB
10830@infoline @expr{ln(2)}.
10831The visible effect of caching is that
d7b8e6c6
EZ
10832high-precision computations may seem to do extra work the first time.
10833Other things cached include powers of two (for the binary arithmetic
10834functions), matrix inverses and determinants, symbolic integrals, and
10835data points computed by the graphing commands.
10836
10837@pindex calc-flush-caches
10838If you suspect a Calculator cache has become corrupt, you can use the
10839@code{calc-flush-caches} command to reset all caches to the empty state.
10840(This should only be necessary in the event of bugs in the Calculator.)
10841The @kbd{M-# 0} (with the zero key) command also resets caches along
10842with all other aspects of the Calculator's state.
10843
10844@node Debugging Calc, , Caches, Troubleshooting Commands
10845@subsection Debugging Calc
10846
10847@noindent
10848A few commands exist to help in the debugging of Calc commands.
10849@xref{Programming}, to see the various ways that you can write
10850your own Calc commands.
10851
10852@kindex Z T
10853@pindex calc-timing
10854The @kbd{Z T} (@code{calc-timing}) command turns on and off a mode
10855in which the timing of slow commands is reported in the Trail.
10856Any Calc command that takes two seconds or longer writes a line
10857to the Trail showing how many seconds it took. This value is
10858accurate only to within one second.
10859
10860All steps of executing a command are included; in particular, time
10861taken to format the result for display in the stack and trail is
10862counted. Some prompts also count time taken waiting for them to
10863be answered, while others do not; this depends on the exact
10864implementation of the command. For best results, if you are timing
10865a sequence that includes prompts or multiple commands, define a
10866keyboard macro to run the whole sequence at once. Calc's @kbd{X}
10867command (@pxref{Keyboard Macros}) will then report the time taken
10868to execute the whole macro.
10869
10870Another advantage of the @kbd{X} command is that while it is
10871executing, the stack and trail are not updated from step to step.
10872So if you expect the output of your test sequence to leave a result
10873that may take a long time to format and you don't wish to count
10874this formatting time, end your sequence with a @key{DEL} keystroke
10875to clear the result from the stack. When you run the sequence with
10876@kbd{X}, Calc will never bother to format the large result.
10877
10878Another thing @kbd{Z T} does is to increase the Emacs variable
10879@code{gc-cons-threshold} to a much higher value (two million; the
10880usual default in Calc is 250,000) for the duration of each command.
10881This generally prevents garbage collection during the timing of
10882the command, though it may cause your Emacs process to grow
10883abnormally large. (Garbage collection time is a major unpredictable
10884factor in the timing of Emacs operations.)
10885
10886Another command that is useful when debugging your own Lisp
10887extensions to Calc is @kbd{M-x calc-pass-errors}, which disables
10888the error handler that changes the ``@code{max-lisp-eval-depth}
10889exceeded'' message to the much more friendly ``Computation got
10890stuck or ran too long.'' This handler interferes with the Emacs
10891Lisp debugger's @code{debug-on-error} mode. Errors are reported
10892in the handler itself rather than at the true location of the
10893error. After you have executed @code{calc-pass-errors}, Lisp
10894errors will be reported correctly but the user-friendly message
10895will be lost.
10896
10897@node Data Types, Stack and Trail, Introduction, Top
10898@chapter Data Types
10899
10900@noindent
10901This chapter discusses the various types of objects that can be placed
10902on the Calculator stack, how they are displayed, and how they are
10903entered. (@xref{Data Type Formats}, for information on how these data
a4231b04 10904types are represented as underlying Lisp objects.)
d7b8e6c6
EZ
10905
10906Integers, fractions, and floats are various ways of describing real
10907numbers. HMS forms also for many purposes act as real numbers. These
10908types can be combined to form complex numbers, modulo forms, error forms,
10909or interval forms. (But these last four types cannot be combined
10910arbitrarily:@: error forms may not contain modulo forms, for example.)
10911Finally, all these types of numbers may be combined into vectors,
10912matrices, or algebraic formulas.
10913
10914@menu
10915* Integers:: The most basic data type.
10916* Fractions:: This and above are called @dfn{rationals}.
10917* Floats:: This and above are called @dfn{reals}.
10918* Complex Numbers:: This and above are called @dfn{numbers}.
10919* Infinities::
10920* Vectors and Matrices::
10921* Strings::
10922* HMS Forms::
10923* Date Forms::
10924* Modulo Forms::
10925* Error Forms::
10926* Interval Forms::
10927* Incomplete Objects::
10928* Variables::
10929* Formulas::
10930@end menu
10931
10932@node Integers, Fractions, Data Types, Data Types
10933@section Integers
10934
10935@noindent
10936@cindex Integers
10937The Calculator stores integers to arbitrary precision. Addition,
10938subtraction, and multiplication of integers always yields an exact
10939integer result. (If the result of a division or exponentiation of
10940integers is not an integer, it is expressed in fractional or
07ce2eb3 10941floating-point form according to the current Fraction mode.
d7b8e6c6
EZ
10942@xref{Fraction Mode}.)
10943
10944A decimal integer is represented as an optional sign followed by a
10945sequence of digits. Grouping (@pxref{Grouping Digits}) can be used to
10946insert a comma at every third digit for display purposes, but you
a4231b04 10947must not type commas during the entry of numbers.
d7b8e6c6
EZ
10948
10949@kindex #
10950A non-decimal integer is represented as an optional sign, a radix
10951between 2 and 36, a @samp{#} symbol, and one or more digits. For radix 11
10952and above, the letters A through Z (upper- or lower-case) count as
10953digits and do not terminate numeric entry mode. @xref{Radix Modes}, for how
10954to set the default radix for display of integers. Numbers of any radix
10955may be entered at any time. If you press @kbd{#} at the beginning of a
a4231b04 10956number, the current display radix is used.
d7b8e6c6
EZ
10957
10958@node Fractions, Floats, Integers, Data Types
10959@section Fractions
10960
10961@noindent
10962@cindex Fractions
10963A @dfn{fraction} is a ratio of two integers. Fractions are traditionally
10964written ``2/3'' but Calc uses the notation @samp{2:3}. (The @kbd{/} key
10965performs RPN division; the following two sequences push the number
10966@samp{2:3} on the stack: @kbd{2 :@: 3 @key{RET}}, or @kbd{2 @key{RET} 3 /}
07ce2eb3 10967assuming Fraction mode has been enabled.)
d7b8e6c6 10968When the Calculator produces a fractional result it always reduces it to
a4231b04 10969simplest form, which may in fact be an integer.
d7b8e6c6
EZ
10970
10971Fractions may also be entered in a three-part form, where @samp{2:3:4}
10972represents two-and-three-quarters. @xref{Fraction Formats}, for fraction
a4231b04 10973display formats.
d7b8e6c6
EZ
10974
10975Non-decimal fractions are entered and displayed as
10976@samp{@var{radix}#@var{num}:@var{denom}} (or in the analogous three-part
a4231b04 10977form). The numerator and denominator always use the same radix.
d7b8e6c6
EZ
10978
10979@node Floats, Complex Numbers, Fractions, Data Types
10980@section Floats
10981
10982@noindent
10983@cindex Floating-point numbers
10984A floating-point number or @dfn{float} is a number stored in scientific
10985notation. The number of significant digits in the fractional part is
10986governed by the current floating precision (@pxref{Precision}). The
a4231b04 10987range of acceptable values is from
8e04863e 10988@texline @math{10^{-3999999}}
a4231b04
JB
10989@infoline @expr{10^-3999999}
10990(inclusive) to
8e04863e 10991@texline @math{10^{4000000}}
a4231b04
JB
10992@infoline @expr{10^4000000}
10993(exclusive), plus the corresponding negative values and zero.
d7b8e6c6
EZ
10994
10995Calculations that would exceed the allowable range of values (such
10996as @samp{exp(exp(20))}) are left in symbolic form by Calc. The
10997messages ``floating-point overflow'' or ``floating-point underflow''
10998indicate that during the calculation a number would have been produced
10999that was too large or too close to zero, respectively, to be represented
11000by Calc. This does not necessarily mean the final result would have
11001overflowed, just that an overflow occurred while computing the result.
11002(In fact, it could report an underflow even though the final result
11003would have overflowed!)
11004
11005If a rational number and a float are mixed in a calculation, the result
11006will in general be expressed as a float. Commands that require an integer
11007value (such as @kbd{k g} [@code{gcd}]) will also accept integer-valued
11008floats, i.e., floating-point numbers with nothing after the decimal point.
11009
11010Floats are identified by the presence of a decimal point and/or an
11011exponent. In general a float consists of an optional sign, digits
11012including an optional decimal point, and an optional exponent consisting
11013of an @samp{e}, an optional sign, and up to seven exponent digits.
11014For example, @samp{23.5e-2} is 23.5 times ten to the minus-second power,
11015or 0.235.
11016
11017Floating-point numbers are normally displayed in decimal notation with
11018all significant figures shown. Exceedingly large or small numbers are
11019displayed in scientific notation. Various other display options are
11020available. @xref{Float Formats}.
11021
11022@cindex Accuracy of calculations
11023Floating-point numbers are stored in decimal, not binary. The result
11024of each operation is rounded to the nearest value representable in the
11025number of significant digits specified by the current precision,
11026rounding away from zero in the case of a tie. Thus (in the default
11027display mode) what you see is exactly what you get. Some operations such
11028as square roots and transcendental functions are performed with several
11029digits of extra precision and then rounded down, in an effort to make the
11030final result accurate to the full requested precision. However,
11031accuracy is not rigorously guaranteed. If you suspect the validity of a
11032result, try doing the same calculation in a higher precision. The
11033Calculator's arithmetic is not intended to be IEEE-conformant in any
a4231b04 11034way.
d7b8e6c6
EZ
11035
11036While floats are always @emph{stored} in decimal, they can be entered
11037and displayed in any radix just like integers and fractions. The
11038notation @samp{@var{radix}#@var{ddd}.@var{ddd}} is a floating-point
11039number whose digits are in the specified radix. Note that the @samp{.}
11040is more aptly referred to as a ``radix point'' than as a decimal
11041point in this case. The number @samp{8#123.4567} is defined as
11042@samp{8#1234567 * 8^-4}. If the radix is 14 or less, you can use
11043@samp{e} notation to write a non-decimal number in scientific notation.
11044The exponent is written in decimal, and is considered to be a power
11045of the radix: @samp{8#1234567e-4}. If the radix is 15 or above, the
11046letter @samp{e} is a digit, so scientific notation must be written
11047out, e.g., @samp{16#123.4567*16^2}. The first two exercises of the
11048Modes Tutorial explore some of the properties of non-decimal floats.
11049
11050@node Complex Numbers, Infinities, Floats, Data Types
11051@section Complex Numbers
11052
11053@noindent
11054@cindex Complex numbers
11055There are two supported formats for complex numbers: rectangular and
11056polar. The default format is rectangular, displayed in the form
11057@samp{(@var{real},@var{imag})} where @var{real} is the real part and
11058@var{imag} is the imaginary part, each of which may be any real number.
11059Rectangular complex numbers can also be displayed in @samp{@var{a}+@var{b}i}
a4231b04
JB
11060notation; @pxref{Complex Formats}.
11061
11062Polar complex numbers are displayed in the form
bd712b70
JB
11063@texline `@tfn{(}@var{r}@tfn{;}@math{\theta}@tfn{)}'
11064@infoline `@tfn{(}@var{r}@tfn{;}@var{theta}@tfn{)}'
a4231b04 11065where @var{r} is the nonnegative magnitude and
8e04863e 11066@texline @math{\theta}
a4231b04
JB
11067@infoline @var{theta}
11068is the argument or phase angle. The range of
8e04863e 11069@texline @math{\theta}
a4231b04
JB
11070@infoline @var{theta}
11071depends on the current angular mode (@pxref{Angular Modes}); it is
8e04863e 11072generally between @mathit{-180} and @mathit{+180} degrees or the equivalent range
a4231b04 11073in radians.
d7b8e6c6
EZ
11074
11075Complex numbers are entered in stages using incomplete objects.
11076@xref{Incomplete Objects}.
11077
11078Operations on rectangular complex numbers yield rectangular complex
11079results, and similarly for polar complex numbers. Where the two types
11080are mixed, or where new complex numbers arise (as for the square root of
07ce2eb3 11081a negative real), the current @dfn{Polar mode} is used to determine the
d7b8e6c6
EZ
11082type. @xref{Polar Mode}.
11083
11084A complex result in which the imaginary part is zero (or the phase angle
a4231b04 11085is 0 or 180 degrees or @cpi{} radians) is automatically converted to a real
d7b8e6c6
EZ
11086number.
11087
11088@node Infinities, Vectors and Matrices, Complex Numbers, Data Types
11089@section Infinities
11090
11091@noindent
11092@cindex Infinity
11093@cindex @code{inf} variable
11094@cindex @code{uinf} variable
11095@cindex @code{nan} variable
11096@vindex inf
11097@vindex uinf
11098@vindex nan
11099The word @code{inf} represents the mathematical concept of @dfn{infinity}.
11100Calc actually has three slightly different infinity-like values:
11101@code{inf}, @code{uinf}, and @code{nan}. These are just regular
11102variable names (@pxref{Variables}); you should avoid using these
11103names for your own variables because Calc gives them special
11104treatment. Infinities, like all variable names, are normally
11105entered using algebraic entry.
11106
11107Mathematically speaking, it is not rigorously correct to treat
11108``infinity'' as if it were a number, but mathematicians often do
11109so informally. When they say that @samp{1 / inf = 0}, what they
a4231b04 11110really mean is that @expr{1 / x}, as @expr{x} becomes larger and
d7b8e6c6 11111larger, becomes arbitrarily close to zero. So you can imagine
a4231b04 11112that if @expr{x} got ``all the way to infinity,'' then @expr{1 / x}
d7b8e6c6 11113would go all the way to zero. Similarly, when they say that
a4231b04 11114@samp{exp(inf) = inf}, they mean that
8e04863e 11115@texline @math{e^x}
a4231b04
JB
11116@infoline @expr{exp(x)}
11117grows without bound as @expr{x} grows. The symbol @samp{-inf} likewise
11118stands for an infinitely negative real value; for example, we say that
d7b8e6c6
EZ
11119@samp{exp(-inf) = 0}. You can have an infinity pointing in any
11120direction on the complex plane: @samp{sqrt(-inf) = i inf}.
11121
a4231b04
JB
11122The same concept of limits can be used to define @expr{1 / 0}. We
11123really want the value that @expr{1 / x} approaches as @expr{x}
11124approaches zero. But if all we have is @expr{1 / 0}, we can't
11125tell which direction @expr{x} was coming from. If @expr{x} was
d7b8e6c6 11126positive and decreasing toward zero, then we should say that
a4231b04
JB
11127@samp{1 / 0 = inf}. But if @expr{x} was negative and increasing
11128toward zero, the answer is @samp{1 / 0 = -inf}. In fact, @expr{x}
d7b8e6c6
EZ
11129could be an imaginary number, giving the answer @samp{i inf} or
11130@samp{-i inf}. Calc uses the special symbol @samp{uinf} to mean
11131@dfn{undirected infinity}, i.e., a value which is infinitely
11132large but with an unknown sign (or direction on the complex plane).
11133
11134Calc actually has three modes that say how infinities are handled.
11135Normally, infinities never arise from calculations that didn't
a4231b04 11136already have them. Thus, @expr{1 / 0} is treated simply as an
d7b8e6c6
EZ
11137error and left unevaluated. The @kbd{m i} (@code{calc-infinite-mode})
11138command (@pxref{Infinite Mode}) enables a mode in which
a4231b04 11139@expr{1 / 0} evaluates to @code{uinf} instead. There is also
d7b8e6c6
EZ
11140an alternative type of infinite mode which says to treat zeros
11141as if they were positive, so that @samp{1 / 0 = inf}. While this
11142is less mathematically correct, it may be the answer you want in
11143some cases.
11144
11145Since all infinities are ``as large'' as all others, Calc simplifies,
11146e.g., @samp{5 inf} to @samp{inf}. Another example is
11147@samp{5 - inf = -inf}, where the @samp{-inf} is so large that
11148adding a finite number like five to it does not affect it.
11149Note that @samp{a - inf} also results in @samp{-inf}; Calc assumes
11150that variables like @code{a} always stand for finite quantities.
11151Just to show that infinities really are all the same size,
11152note that @samp{sqrt(inf) = inf^2 = exp(inf) = inf} in Calc's
11153notation.
11154
11155It's not so easy to define certain formulas like @samp{0 * inf} and
11156@samp{inf / inf}. Depending on where these zeros and infinities
11157came from, the answer could be literally anything. The latter
a4231b04
JB
11158formula could be the limit of @expr{x / x} (giving a result of one),
11159or @expr{2 x / x} (giving two), or @expr{x^2 / x} (giving @code{inf}),
11160or @expr{x / x^2} (giving zero). Calc uses the symbol @code{nan}
d7b8e6c6
EZ
11161to represent such an @dfn{indeterminate} value. (The name ``nan''
11162comes from analogy with the ``NAN'' concept of IEEE standard
11163arithmetic; it stands for ``Not A Number.'' This is somewhat of a
11164misnomer, since @code{nan} @emph{does} stand for some number or
11165infinity, it's just that @emph{which} number it stands for
11166cannot be determined.) In Calc's notation, @samp{0 * inf = nan}
11167and @samp{inf / inf = nan}. A few other common indeterminate
11168expressions are @samp{inf - inf} and @samp{inf ^ 0}. Also,
07ce2eb3 11169@samp{0 / 0 = nan} if you have turned on Infinite mode
d7b8e6c6
EZ
11170(as described above).
11171
11172Infinities are especially useful as parts of @dfn{intervals}.
11173@xref{Interval Forms}.
11174
11175@node Vectors and Matrices, Strings, Infinities, Data Types
11176@section Vectors and Matrices
11177
11178@noindent
11179@cindex Vectors
11180@cindex Plain vectors
11181@cindex Matrices
11182The @dfn{vector} data type is flexible and general. A vector is simply a
11183list of zero or more data objects. When these objects are numbers, the
11184whole is a vector in the mathematical sense. When these objects are
11185themselves vectors of equal (nonzero) length, the whole is a @dfn{matrix}.
11186A vector which is not a matrix is referred to here as a @dfn{plain vector}.
11187
11188A vector is displayed as a list of values separated by commas and enclosed
11189in square brackets: @samp{[1, 2, 3]}. Thus the following is a 2 row by
111903 column matrix: @samp{[[1, 2, 3], [4, 5, 6]]}. Vectors, like complex
11191numbers, are entered as incomplete objects. @xref{Incomplete Objects}.
11192During algebraic entry, vectors are entered all at once in the usual
11193brackets-and-commas form. Matrices may be entered algebraically as nested
11194vectors, or using the shortcut notation @w{@samp{[1, 2, 3; 4, 5, 6]}},
11195with rows separated by semicolons. The commas may usually be omitted
11196when entering vectors: @samp{[1 2 3]}. Curly braces may be used in
11197place of brackets: @samp{@{1, 2, 3@}}, but the commas are required in
11198this case.
11199
11200Traditional vector and matrix arithmetic is also supported;
11201@pxref{Basic Arithmetic} and @pxref{Matrix Functions}.
11202Many other operations are applied to vectors element-wise. For example,
11203the complex conjugate of a vector is a vector of the complex conjugates
a4231b04 11204of its elements.
d7b8e6c6 11205
5d67986c
RS
11206@ignore
11207@starindex
11208@end ignore
d7b8e6c6
EZ
11209@tindex vec
11210Algebraic functions for building vectors include @samp{vec(a, b, c)}
a4231b04 11211to build @samp{[a, b, c]}, @samp{cvec(a, n, m)} to build an
8e04863e 11212@texline @math{n\times m}
a4231b04 11213@infoline @var{n}x@var{m}
d7b8e6c6
EZ
11214matrix of @samp{a}s, and @samp{index(n)} to build a vector of integers
11215from 1 to @samp{n}.
11216
11217@node Strings, HMS Forms, Vectors and Matrices, Data Types
11218@section Strings
11219
11220@noindent
11221@kindex "
11222@cindex Strings
11223@cindex Character strings
11224Character strings are not a special data type in the Calculator.
11225Rather, a string is represented simply as a vector all of whose
11226elements are integers in the range 0 to 255 (ASCII codes). You can
11227enter a string at any time by pressing the @kbd{"} key. Quotation
11228marks and backslashes are written @samp{\"} and @samp{\\}, respectively,
11229inside strings. Other notations introduced by backslashes are:
11230
d7b8e6c6 11231@example
5d67986c 11232@group
d7b8e6c6
EZ
11233\a 7 \^@@ 0
11234\b 8 \^a-z 1-26
11235\e 27 \^[ 27
11236\f 12 \^\\ 28
11237\n 10 \^] 29
11238\r 13 \^^ 30
11239\t 9 \^_ 31
11240 \^? 127
d7b8e6c6 11241@end group
5d67986c 11242@end example
d7b8e6c6
EZ
11243
11244@noindent
11245Finally, a backslash followed by three octal digits produces any
11246character from its ASCII code.
11247
11248@kindex d "
11249@pindex calc-display-strings
11250Strings are normally displayed in vector-of-integers form. The
11251@w{@kbd{d "}} (@code{calc-display-strings}) command toggles a mode in
11252which any vectors of small integers are displayed as quoted strings
11253instead.
11254
11255The backslash notations shown above are also used for displaying
11256strings. Characters 128 and above are not translated by Calc; unless
11257you have an Emacs modified for 8-bit fonts, these will show up in
11258backslash-octal-digits notation. For characters below 32, and
11259for character 127, Calc uses the backslash-letter combination if
11260there is one, or otherwise uses a @samp{\^} sequence.
11261
11262The only Calc feature that uses strings is @dfn{compositions};
11263@pxref{Compositions}. Strings also provide a convenient
11264way to do conversions between ASCII characters and integers.
11265
5d67986c
RS
11266@ignore
11267@starindex
11268@end ignore
d7b8e6c6
EZ
11269@tindex string
11270There is a @code{string} function which provides a different display
11271format for strings. Basically, @samp{string(@var{s})}, where @var{s}
11272is a vector of integers in the proper range, is displayed as the
11273corresponding string of characters with no surrounding quotation
11274marks or other modifications. Thus @samp{string("ABC")} (or
11275@samp{string([65 66 67])}) will look like @samp{ABC} on the stack.
11276This happens regardless of whether @w{@kbd{d "}} has been used. The
11277only way to turn it off is to use @kbd{d U} (unformatted language
11278mode) which will display @samp{string("ABC")} instead.
11279
11280Control characters are displayed somewhat differently by @code{string}.
11281Characters below 32, and character 127, are shown using @samp{^} notation
11282(same as shown above, but without the backslash). The quote and
11283backslash characters are left alone, as are characters 128 and above.
11284
5d67986c
RS
11285@ignore
11286@starindex
11287@end ignore
d7b8e6c6
EZ
11288@tindex bstring
11289The @code{bstring} function is just like @code{string} except that
11290the resulting string is breakable across multiple lines if it doesn't
11291fit all on one line. Potential break points occur at every space
11292character in the string.
11293
11294@node HMS Forms, Date Forms, Strings, Data Types
11295@section HMS Forms
11296
11297@noindent
11298@cindex Hours-minutes-seconds forms
11299@cindex Degrees-minutes-seconds forms
11300@dfn{HMS} stands for Hours-Minutes-Seconds; when used as an angular
11301argument, the interpretation is Degrees-Minutes-Seconds. All functions
11302that operate on angles accept HMS forms. These are interpreted as
11303degrees regardless of the current angular mode. It is also possible to
11304use HMS as the angular mode so that calculated angles are expressed in
11305degrees, minutes, and seconds.
11306
11307@kindex @@
5d67986c
RS
11308@ignore
11309@mindex @null
11310@end ignore
d7b8e6c6 11311@kindex ' (HMS forms)
5d67986c
RS
11312@ignore
11313@mindex @null
11314@end ignore
d7b8e6c6 11315@kindex " (HMS forms)
5d67986c
RS
11316@ignore
11317@mindex @null
11318@end ignore
d7b8e6c6 11319@kindex h (HMS forms)
5d67986c
RS
11320@ignore
11321@mindex @null
11322@end ignore
d7b8e6c6 11323@kindex o (HMS forms)
5d67986c
RS
11324@ignore
11325@mindex @null
11326@end ignore
d7b8e6c6 11327@kindex m (HMS forms)
5d67986c
RS
11328@ignore
11329@mindex @null
11330@end ignore
d7b8e6c6
EZ
11331@kindex s (HMS forms)
11332The default format for HMS values is
11333@samp{@var{hours}@@ @var{mins}' @var{secs}"}. During entry, the letters
11334@samp{h} (for ``hours'') or
11335@samp{o} (approximating the ``degrees'' symbol) are accepted as well as
11336@samp{@@}, @samp{m} is accepted in place of @samp{'}, and @samp{s} is
11337accepted in place of @samp{"}.
11338The @var{hours} value is an integer (or integer-valued float).
11339The @var{mins} value is an integer or integer-valued float between 0 and 59.
11340The @var{secs} value is a real number between 0 (inclusive) and 60
11341(exclusive). A positive HMS form is interpreted as @var{hours} +
11342@var{mins}/60 + @var{secs}/3600. A negative HMS form is interpreted
8e04863e 11343as @mathit{- @var{hours}} @mathit{-} @var{mins}/60 @mathit{-} @var{secs}/3600.
a4231b04 11344Display format for HMS forms is quite flexible. @xref{HMS Formats}.
d7b8e6c6
EZ
11345
11346HMS forms can be added and subtracted. When they are added to numbers,
11347the numbers are interpreted according to the current angular mode. HMS
11348forms can also be multiplied and divided by real numbers. Dividing
11349two HMS forms produces a real-valued ratio of the two angles.
11350
11351@pindex calc-time
11352@cindex Time of day
11353Just for kicks, @kbd{M-x calc-time} pushes the current time of day on
11354the stack as an HMS form.
11355
11356@node Date Forms, Modulo Forms, HMS Forms, Data Types
11357@section Date Forms
11358
11359@noindent
11360@cindex Date forms
11361A @dfn{date form} represents a date and possibly an associated time.
11362Simple date arithmetic is supported: Adding a number to a date
11363produces a new date shifted by that many days; adding an HMS form to
11364a date shifts it by that many hours. Subtracting two date forms
11365computes the number of days between them (represented as a simple
11366number). Many other operations, such as multiplying two date forms,
11367are nonsensical and are not allowed by Calc.
11368
11369Date forms are entered and displayed enclosed in @samp{< >} brackets.
11370The default format is, e.g., @samp{<Wed Jan 9, 1991>} for dates,
11371or @samp{<3:32:20pm Wed Jan 9, 1991>} for dates with times.
11372Input is flexible; date forms can be entered in any of the usual
11373notations for dates and times. @xref{Date Formats}.
11374
11375Date forms are stored internally as numbers, specifically the number
11376of days since midnight on the morning of January 1 of the year 1 AD.
11377If the internal number is an integer, the form represents a date only;
11378if the internal number is a fraction or float, the form represents
11379a date and time. For example, @samp{<6:00am Wed Jan 9, 1991>}
11380is represented by the number 726842.25. The standard precision of
1138112 decimal digits is enough to ensure that a (reasonable) date and
11382time can be stored without roundoff error.
11383
11384If the current precision is greater than 12, date forms will keep
11385additional digits in the seconds position. For example, if the
11386precision is 15, the seconds will keep three digits after the
11387decimal point. Decreasing the precision below 12 may cause the
11388time part of a date form to become inaccurate. This can also happen
11389if astronomically high years are used, though this will not be an
28665d46 11390issue in everyday (or even everymillennium) use. Note that date
d7b8e6c6
EZ
11391forms without times are stored as exact integers, so roundoff is
11392never an issue for them.
11393
11394You can use the @kbd{v p} (@code{calc-pack}) and @kbd{v u}
11395(@code{calc-unpack}) commands to get at the numerical representation
11396of a date form. @xref{Packing and Unpacking}.
11397
11398Date forms can go arbitrarily far into the future or past. Negative
11399year numbers represent years BC. Calc uses a combination of the
11400Gregorian and Julian calendars, following the history of Great
11401Britain and the British colonies. This is the same calendar that
11402is used by the @code{cal} program in most Unix implementations.
11403
11404@cindex Julian calendar
11405@cindex Gregorian calendar
11406Some historical background: The Julian calendar was created by
11407Julius Caesar in the year 46 BC as an attempt to fix the gradual
11408drift caused by the lack of leap years in the calendar used
11409until that time. The Julian calendar introduced an extra day in
11410all years divisible by four. After some initial confusion, the
11411calendar was adopted around the year we call 8 AD. Some centuries
11412later it became apparent that the Julian year of 365.25 days was
11413itself not quite right. In 1582 Pope Gregory XIII introduced the
11414Gregorian calendar, which added the new rule that years divisible
11415by 100, but not by 400, were not to be considered leap years
11416despite being divisible by four. Many countries delayed adoption
11417of the Gregorian calendar because of religious differences;
11418in Britain it was put off until the year 1752, by which time
11419the Julian calendar had fallen eleven days behind the true
11420seasons. So the switch to the Gregorian calendar in early
11421September 1752 introduced a discontinuity: The day after
11422Sep 2, 1752 is Sep 14, 1752. Calc follows this convention.
11423To take another example, Russia waited until 1918 before
11424adopting the new calendar, and thus needed to remove thirteen
11425days (between Feb 1, 1918 and Feb 14, 1918). This means that
11426Calc's reckoning will be inconsistent with Russian history between
114271752 and 1918, and similarly for various other countries.
11428
11429Today's timekeepers introduce an occasional ``leap second'' as
11430well, but Calc does not take these minor effects into account.
11431(If it did, it would have to report a non-integer number of days
11432between, say, @samp{<12:00am Mon Jan 1, 1900>} and
11433@samp{<12:00am Sat Jan 1, 2000>}.)
11434
11435Calc uses the Julian calendar for all dates before the year 1752,
11436including dates BC when the Julian calendar technically had not
8e04863e 11437yet been invented. Thus the claim that day number @mathit{-10000} is
d7b8e6c6
EZ
11438called ``August 16, 28 BC'' should be taken with a grain of salt.
11439
11440Please note that there is no ``year 0''; the day before
11441@samp{<Sat Jan 1, +1>} is @samp{<Fri Dec 31, -1>}. These are
8e04863e 11442days 0 and @mathit{-1} respectively in Calc's internal numbering scheme.
d7b8e6c6
EZ
11443
11444@cindex Julian day counting
11445Another day counting system in common use is, confusingly, also
11446called ``Julian.'' It was invented in 1583 by Joseph Justus
11447Scaliger, who named it in honor of his father Julius Caesar
11448Scaliger. For obscure reasons he chose to start his day
11449numbering on Jan 1, 4713 BC at noon, which in Calc's scheme
8e04863e 11450is @mathit{-1721423.5} (recall that Calc starts at midnight instead
d7b8e6c6
EZ
11451of noon). Thus to convert a Calc date code obtained by
11452unpacking a date form into a Julian day number, simply add
114531721423.5. The Julian code for @samp{6:00am Jan 9, 1991}
11454is 2448265.75. The built-in @kbd{t J} command performs
11455this conversion for you.
11456
11457@cindex Unix time format
11458The Unix operating system measures time as an integer number of
11459seconds since midnight, Jan 1, 1970. To convert a Calc date
11460value into a Unix time stamp, first subtract 719164 (the code
11461for @samp{<Jan 1, 1970>}), then multiply by 86400 (the number of
11462seconds in a day) and press @kbd{R} to round to the nearest
11463integer. If you have a date form, you can simply subtract the
11464day @samp{<Jan 1, 1970>} instead of unpacking and subtracting
11465719164. Likewise, divide by 86400 and add @samp{<Jan 1, 1970>}
11466to convert from Unix time to a Calc date form. (Note that
11467Unix normally maintains the time in the GMT time zone; you may
11468need to subtract five hours to get New York time, or eight hours
11469for California time. The same is usually true of Julian day
11470counts.) The built-in @kbd{t U} command performs these
11471conversions.
11472
11473@node Modulo Forms, Error Forms, Date Forms, Data Types
11474@section Modulo Forms
11475
11476@noindent
11477@cindex Modulo forms
11478A @dfn{modulo form} is a real number which is taken modulo (i.e., within
5d67986c 11479an integer multiple of) some value @var{M}. Arithmetic modulo @var{M}
d7b8e6c6 11480often arises in number theory. Modulo forms are written
bd712b70 11481`@var{a} @tfn{mod} @var{M}',
5d67986c 11482where @var{a} and @var{M} are real numbers or HMS forms, and
8e04863e 11483@texline @math{0 \le a < M}.
a4231b04
JB
11484@infoline @expr{0 <= a < @var{M}}.
11485In many applications @expr{a} and @expr{M} will be
11486integers but this is not required.
d7b8e6c6 11487
029b2a44
JB
11488@ignore
11489@mindex M
11490@end ignore
11491@kindex M (modulo forms)
11492@ignore
11493@mindex mod
11494@end ignore
11495@tindex mod (operator)
11496To create a modulo form during numeric entry, press the shift-@kbd{M}
11497key to enter the word @samp{mod}. As a special convenience, pressing
11498shift-@kbd{M} a second time automatically enters the value of @expr{M}
11499that was most recently used before. During algebraic entry, either
11500type @samp{mod} by hand or press @kbd{M-m} (that's @kbd{@key{META}-m}).
11501Once again, pressing this a second time enters the current modulo.
11502
d7b8e6c6
EZ
11503Modulo forms are not to be confused with the modulo operator @samp{%}.
11504The expression @samp{27 % 10} means to compute 27 modulo 10 to produce
11505the result 7. Further computations treat this 7 as just a regular integer.
11506The expression @samp{27 mod 10} produces the result @samp{7 mod 10};
11507further computations with this value are again reduced modulo 10 so that
11508the result always lies in the desired range.
11509
a4231b04 11510When two modulo forms with identical @expr{M}'s are added or multiplied,
d7b8e6c6 11511the Calculator simply adds or multiplies the values, then reduces modulo
a4231b04 11512@expr{M}. If one argument is a modulo form and the other a plain number,
d7b8e6c6
EZ
11513the plain number is treated like a compatible modulo form. It is also
11514possible to raise modulo forms to powers; the result is the value raised
a4231b04 11515to the power, then reduced modulo @expr{M}. (When all values involved
d7b8e6c6
EZ
11516are integers, this calculation is done much more efficiently than
11517actually computing the power and then reducing.)
11518
11519@cindex Modulo division
bd712b70 11520Two modulo forms `@var{a} @tfn{mod} @var{M}' and `@var{b} @tfn{mod} @var{M}'
a4231b04 11521can be divided if @expr{a}, @expr{b}, and @expr{M} are all
d7b8e6c6 11522integers. The result is the modulo form which, when multiplied by
bd712b70 11523`@var{b} @tfn{mod} @var{M}', produces `@var{a} @tfn{mod} @var{M}'. If
d7b8e6c6 11524there is no solution to this equation (which can happen only when
a4231b04 11525@expr{M} is non-prime), or if any of the arguments are non-integers, the
d7b8e6c6
EZ
11526division is left in symbolic form. Other operations, such as square
11527roots, are not yet supported for modulo forms. (Note that, although
bd712b70 11528@w{`@tfn{(}@var{a} @tfn{mod} @var{M}@tfn{)^.5}'} will compute a ``modulo square root''
a4231b04 11529in the sense of reducing
8e04863e 11530@texline @math{\sqrt a}
a4231b04
JB
11531@infoline @expr{sqrt(a)}
11532modulo @expr{M}, this is not a useful definition from the
11533number-theoretical point of view.)
d7b8e6c6 11534
d7b8e6c6
EZ
11535It is possible to mix HMS forms and modulo forms. For example, an
11536HMS form modulo 24 could be used to manipulate clock times; an HMS
a4231b04 11537form modulo 360 would be suitable for angles. Making the modulo @expr{M}
d7b8e6c6
EZ
11538also be an HMS form eliminates troubles that would arise if the angular
11539mode were inadvertently set to Radians, in which case
11540@w{@samp{2@@ 0' 0" mod 24}} would be interpreted as two degrees modulo
1154124 radians!
11542
11543Modulo forms cannot have variables or formulas for components. If you
11544enter the formula @samp{(x + 2) mod 5}, Calc propagates the modulus
11545to each of the coefficients: @samp{(1 mod 5) x + (2 mod 5)}.
11546
029b2a44
JB
11547You can use @kbd{v p} and @kbd{%} to modify modulo forms.
11548@xref{Packing and Unpacking}. @xref{Basic Arithmetic}.
11549
5d67986c
RS
11550@ignore
11551@starindex
11552@end ignore
d7b8e6c6
EZ
11553@tindex makemod
11554The algebraic function @samp{makemod(a, m)} builds the modulo form
11555@w{@samp{a mod m}}.
11556
11557@node Error Forms, Interval Forms, Modulo Forms, Data Types
11558@section Error Forms
11559
11560@noindent
11561@cindex Error forms
11562@cindex Standard deviations
11563An @dfn{error form} is a number with an associated standard
11564deviation, as in @samp{2.3 +/- 0.12}. The notation
bd712b70
JB
11565@texline `@var{x} @tfn{+/-} @math{\sigma}'
11566@infoline `@var{x} @tfn{+/-} sigma'
a4231b04
JB
11567stands for an uncertain value which follows
11568a normal or Gaussian distribution of mean @expr{x} and standard
11569deviation or ``error''
8e04863e 11570@texline @math{\sigma}.
a4231b04
JB
11571@infoline @expr{sigma}.
11572Both the mean and the error can be either numbers or
d7b8e6c6
EZ
11573formulas. Generally these are real numbers but the mean may also be
11574complex. If the error is negative or complex, it is changed to its
11575absolute value. An error form with zero error is converted to a
a4231b04 11576regular number by the Calculator.
d7b8e6c6
EZ
11577
11578All arithmetic and transcendental functions accept error forms as input.
11579Operations on the mean-value part work just like operations on regular
a4231b04 11580numbers. The error part for any function @expr{f(x)} (such as
8e04863e 11581@texline @math{\sin x}
a4231b04
JB
11582@infoline @expr{sin(x)})
11583is defined by the error of @expr{x} times the derivative of @expr{f}
11584evaluated at the mean value of @expr{x}. For a two-argument function
11585@expr{f(x,y)} (such as addition) the error is the square root of the sum
11586of the squares of the errors due to @expr{x} and @expr{y}.
d7b8e6c6
EZ
11587@tex
11588$$ \eqalign{
11589 f(x \hbox{\code{ +/- }} \sigma)
11590 &= f(x) \hbox{\code{ +/- }} \sigma \left| {df(x) \over dx} \right| \cr
11591 f(x \hbox{\code{ +/- }} \sigma_x, y \hbox{\code{ +/- }} \sigma_y)
11592 &= f(x,y) \hbox{\code{ +/- }}
11593 \sqrt{\left(\sigma_x \left| {\partial f(x,y) \over \partial x}
11594 \right| \right)^2
11595 +\left(\sigma_y \left| {\partial f(x,y) \over \partial y}
11596 \right| \right)^2 } \cr
11597} $$
11598@end tex
11599Note that this
a4231b04 11600definition assumes the errors in @expr{x} and @expr{y} are uncorrelated.
d7b8e6c6
EZ
11601A side effect of this definition is that @samp{(2 +/- 1) * (2 +/- 1)}
11602is not the same as @samp{(2 +/- 1)^2}; the former represents the product
11603of two independent values which happen to have the same probability
11604distributions, and the latter is the product of one random value with itself.
11605The former will produce an answer with less error, since on the average
a4231b04 11606the two independent errors can be expected to cancel out.
d7b8e6c6
EZ
11607
11608Consult a good text on error analysis for a discussion of the proper use
11609of standard deviations. Actual errors often are neither Gaussian-distributed
11610nor uncorrelated, and the above formulas are valid only when errors
11611are small. As an example, the error arising from
bd712b70
JB
11612@texline `@tfn{sin(}@var{x} @tfn{+/-} @math{\sigma}@tfn{)}'
11613@infoline `@tfn{sin(}@var{x} @tfn{+/-} @var{sigma}@tfn{)}'
a4231b04 11614is
bd712b70
JB
11615@texline `@math{\sigma} @tfn{abs(cos(}@var{x}@tfn{))}'.
11616@infoline `@var{sigma} @tfn{abs(cos(}@var{x}@tfn{))}'.
a4231b04 11617When @expr{x} is close to zero,
8e04863e 11618@texline @math{\cos x}
a4231b04
JB
11619@infoline @expr{cos(x)}
11620is close to one so the error in the sine is close to
8e04863e 11621@texline @math{\sigma};
a4231b04
JB
11622@infoline @expr{sigma};
11623this makes sense, since
8e04863e 11624@texline @math{\sin x}
a4231b04
JB
11625@infoline @expr{sin(x)}
11626is approximately @expr{x} near zero, so a given error in @expr{x} will
11627produce about the same error in the sine. Likewise, near 90 degrees
8e04863e 11628@texline @math{\cos x}
a4231b04
JB
11629@infoline @expr{cos(x)}
11630is nearly zero and so the computed error is
11631small: The sine curve is nearly flat in that region, so an error in @expr{x}
11632has relatively little effect on the value of
8e04863e 11633@texline @math{\sin x}.
a4231b04
JB
11634@infoline @expr{sin(x)}.
11635However, consider @samp{sin(90 +/- 1000)}. The cosine of 90 is zero, so
11636Calc will report zero error! We get an obviously wrong result because
11637we have violated the small-error approximation underlying the error
11638analysis. If the error in @expr{x} had been small, the error in
8e04863e 11639@texline @math{\sin x}
a4231b04
JB
11640@infoline @expr{sin(x)}
11641would indeed have been negligible.
d7b8e6c6 11642
5d67986c
RS
11643@ignore
11644@mindex p
11645@end ignore
d7b8e6c6
EZ
11646@kindex p (error forms)
11647@tindex +/-
11648To enter an error form during regular numeric entry, use the @kbd{p}
11649(``plus-or-minus'') key to type the @samp{+/-} symbol. (If you try actually
11650typing @samp{+/-} the @kbd{+} key will be interpreted as the Calculator's
11651@kbd{+} command!) Within an algebraic formula, you can press @kbd{M-p} to
11652type the @samp{+/-} symbol, or type it out by hand.
11653
11654Error forms and complex numbers can be mixed; the formulas shown above
11655are used for complex numbers, too; note that if the error part evaluates
11656to a complex number its absolute value (or the square root of the sum of
11657the squares of the absolute values of the two error contributions) is
11658used. Mathematically, this corresponds to a radially symmetric Gaussian
11659distribution of numbers on the complex plane. However, note that Calc
11660considers an error form with real components to represent a real number,
11661not a complex distribution around a real mean.
11662
11663Error forms may also be composed of HMS forms. For best results, both
11664the mean and the error should be HMS forms if either one is.
11665
5d67986c
RS
11666@ignore
11667@starindex
11668@end ignore
d7b8e6c6
EZ
11669@tindex sdev
11670The algebraic function @samp{sdev(a, b)} builds the error form @samp{a +/- b}.
11671
11672@node Interval Forms, Incomplete Objects, Error Forms, Data Types
11673@section Interval Forms
11674
11675@noindent
11676@cindex Interval forms
11677An @dfn{interval} is a subset of consecutive real numbers. For example,
11678the interval @samp{[2 ..@: 4]} represents all the numbers from 2 to 4,
11679inclusive. If you multiply it by the interval @samp{[0.5 ..@: 2]} you
11680obtain @samp{[1 ..@: 8]}. This calculation represents the fact that if
11681you multiply some number in the range @samp{[2 ..@: 4]} by some other
11682number in the range @samp{[0.5 ..@: 2]}, your result will lie in the range
11683from 1 to 8. Interval arithmetic is used to get a worst-case estimate
11684of the possible range of values a computation will produce, given the
11685set of possible values of the input.
11686
11687@ifinfo
11688Calc supports several varieties of intervals, including @dfn{closed}
11689intervals of the type shown above, @dfn{open} intervals such as
11690@samp{(2 ..@: 4)}, which represents the range of numbers from 2 to 4
11691@emph{exclusive}, and @dfn{semi-open} intervals in which one end
11692uses a round parenthesis and the other a square bracket. In mathematical
11693terms,
a4231b04
JB
11694@samp{[2 ..@: 4]} means @expr{2 <= x <= 4}, whereas
11695@samp{[2 ..@: 4)} represents @expr{2 <= x < 4},
11696@samp{(2 ..@: 4]} represents @expr{2 < x <= 4}, and
11697@samp{(2 ..@: 4)} represents @expr{2 < x < 4}.
d7b8e6c6
EZ
11698@end ifinfo
11699@tex
11700Calc supports several varieties of intervals, including \dfn{closed}
11701intervals of the type shown above, \dfn{open} intervals such as
11702\samp{(2 ..\: 4)}, which represents the range of numbers from 2 to 4
11703\emph{exclusive}, and \dfn{semi-open} intervals in which one end
11704uses a round parenthesis and the other a square bracket. In mathematical
11705terms,
11706$$ \eqalign{
11707 [2 \hbox{\cite{..}} 4] &\quad\hbox{means}\quad 2 \le x \le 4 \cr
11708 [2 \hbox{\cite{..}} 4) &\quad\hbox{means}\quad 2 \le x < 4 \cr
11709 (2 \hbox{\cite{..}} 4] &\quad\hbox{means}\quad 2 < x \le 4 \cr
11710 (2 \hbox{\cite{..}} 4) &\quad\hbox{means}\quad 2 < x < 4 \cr
11711} $$
11712@end tex
11713
11714The lower and upper limits of an interval must be either real numbers
11715(or HMS or date forms), or symbolic expressions which are assumed to be
11716real-valued, or @samp{-inf} and @samp{inf}. In general the lower limit
11717must be less than the upper limit. A closed interval containing only
11718one value, @samp{[3 ..@: 3]}, is converted to a plain number (3)
11719automatically. An interval containing no values at all (such as
11720@samp{[3 ..@: 2]} or @samp{[2 ..@: 2)}) can be represented but is not
11721guaranteed to behave well when used in arithmetic. Note that the
11722interval @samp{[3 .. inf)} represents all real numbers greater than
11723or equal to 3, and @samp{(-inf .. inf)} represents all real numbers.
11724In fact, @samp{[-inf .. inf]} represents all real numbers including
11725the real infinities.
11726
11727Intervals are entered in the notation shown here, either as algebraic
11728formulas, or using incomplete forms. (@xref{Incomplete Objects}.)
11729In algebraic formulas, multiple periods in a row are collected from
11730left to right, so that @samp{1...1e2} is interpreted as @samp{1.0 ..@: 1e2}
11731rather than @samp{1 ..@: 0.1e2}. Add spaces or zeros if you want to
11732get the other interpretation. If you omit the lower or upper limit,
11733a default of @samp{-inf} or @samp{inf} (respectively) is furnished.
11734
07ce2eb3 11735Infinite mode also affects operations on intervals
d7b8e6c6
EZ
11736(@pxref{Infinities}). Calc will always introduce an open infinity,
11737as in @samp{1 / (0 .. 2] = [0.5 .. inf)}. But closed infinities,
07ce2eb3 11738@w{@samp{1 / [0 .. 2] = [0.5 .. inf]}}, arise only in Infinite mode;
d7b8e6c6
EZ
11739otherwise they are left unevaluated. Note that the ``direction'' of
11740a zero is not an issue in this case since the zero is always assumed
11741to be continuous with the rest of the interval. For intervals that
11742contain zero inside them Calc is forced to give the result,
11743@samp{1 / (-2 .. 2) = [-inf .. inf]}.
11744
11745While it may seem that intervals and error forms are similar, they are
11746based on entirely different concepts of inexact quantities. An error
a4231b04 11747form
bd712b70
JB
11748@texline `@var{x} @tfn{+/-} @math{\sigma}'
11749@infoline `@var{x} @tfn{+/-} @var{sigma}'
a4231b04
JB
11750means a variable is random, and its value could
11751be anything but is ``probably'' within one
8e04863e 11752@texline @math{\sigma}
a4231b04
JB
11753@infoline @var{sigma}
11754of the mean value @expr{x}. An interval
bd712b70 11755`@tfn{[}@var{a} @tfn{..@:} @var{b}@tfn{]}' means a
a4231b04
JB
11756variable's value is unknown, but guaranteed to lie in the specified
11757range. Error forms are statistical or ``average case'' approximations;
11758interval arithmetic tends to produce ``worst case'' bounds on an
11759answer.
d7b8e6c6
EZ
11760
11761Intervals may not contain complex numbers, but they may contain
11762HMS forms or date forms.
11763
11764@xref{Set Operations}, for commands that interpret interval forms
11765as subsets of the set of real numbers.
11766
5d67986c
RS
11767@ignore
11768@starindex
11769@end ignore
d7b8e6c6
EZ
11770@tindex intv
11771The algebraic function @samp{intv(n, a, b)} builds an interval form
11772from @samp{a} to @samp{b}; @samp{n} is an integer code which must
11773be 0 for @samp{(..)}, 1 for @samp{(..]}, 2 for @samp{[..)}, or
117743 for @samp{[..]}.
11775
11776Please note that in fully rigorous interval arithmetic, care would be
11777taken to make sure that the computation of the lower bound rounds toward
11778minus infinity, while upper bound computations round toward plus
11779infinity. Calc's arithmetic always uses a round-to-nearest mode,
11780which means that roundoff errors could creep into an interval
11781calculation to produce intervals slightly smaller than they ought to
11782be. For example, entering @samp{[1..2]} and pressing @kbd{Q 2 ^}
11783should yield the interval @samp{[1..2]} again, but in fact it yields the
11784(slightly too small) interval @samp{[1..1.9999999]} due to roundoff
11785error.
11786
11787@node Incomplete Objects, Variables, Interval Forms, Data Types
11788@section Incomplete Objects
11789
11790@noindent
5d67986c
RS
11791@ignore
11792@mindex [ ]
11793@end ignore
d7b8e6c6 11794@kindex [
5d67986c
RS
11795@ignore
11796@mindex ( )
11797@end ignore
d7b8e6c6
EZ
11798@kindex (
11799@kindex ,
5d67986c
RS
11800@ignore
11801@mindex @null
11802@end ignore
d7b8e6c6 11803@kindex ]
5d67986c
RS
11804@ignore
11805@mindex @null
11806@end ignore
d7b8e6c6
EZ
11807@kindex )
11808@cindex Incomplete vectors
11809@cindex Incomplete complex numbers
11810@cindex Incomplete interval forms
11811When @kbd{(} or @kbd{[} is typed to begin entering a complex number or
11812vector, respectively, the effect is to push an @dfn{incomplete} complex
11813number or vector onto the stack. The @kbd{,} key adds the value(s) at
11814the top of the stack onto the current incomplete object. The @kbd{)}
11815and @kbd{]} keys ``close'' the incomplete object after adding any values
11816on the top of the stack in front of the incomplete object.
11817
11818As a result, the sequence of keystrokes @kbd{[ 2 , 3 @key{RET} 2 * , 9 ]}
11819pushes the vector @samp{[2, 6, 9]} onto the stack. Likewise, @kbd{( 1 , 2 Q )}
11820pushes the complex number @samp{(1, 1.414)} (approximately).
11821
11822If several values lie on the stack in front of the incomplete object,
11823all are collected and appended to the object. Thus the @kbd{,} key
11824is redundant: @kbd{[ 2 @key{RET} 3 @key{RET} 2 * 9 ]}. Some people
a4231b04 11825prefer the equivalent @key{SPC} key to @key{RET}.
d7b8e6c6
EZ
11826
11827As a special case, typing @kbd{,} immediately after @kbd{(}, @kbd{[}, or
11828@kbd{,} adds a zero or duplicates the preceding value in the list being
11829formed. Typing @key{DEL} during incomplete entry removes the last item
11830from the list.
11831
11832@kindex ;
11833The @kbd{;} key is used in the same way as @kbd{,} to create polar complex
11834numbers: @kbd{( 1 ; 2 )}. When entering a vector, @kbd{;} is useful for
11835creating a matrix. In particular, @kbd{[ [ 1 , 2 ; 3 , 4 ; 5 , 6 ] ]} is
11836equivalent to @kbd{[ [ 1 , 2 ] , [ 3 , 4 ] , [ 5 , 6 ] ]}.
11837
11838@kindex ..
11839@pindex calc-dots
11840Incomplete entry is also used to enter intervals. For example,
11841@kbd{[ 2 ..@: 4 )} enters a semi-open interval. Note that when you type
11842the first period, it will be interpreted as a decimal point, but when
11843you type a second period immediately afterward, it is re-interpreted as
11844part of the interval symbol. Typing @kbd{..} corresponds to executing
11845the @code{calc-dots} command.
11846
11847If you find incomplete entry distracting, you may wish to enter vectors
11848and complex numbers as algebraic formulas by pressing the apostrophe key.
11849
11850@node Variables, Formulas, Incomplete Objects, Data Types
11851@section Variables
11852
11853@noindent
11854@cindex Variables, in formulas
11855A @dfn{variable} is somewhere between a storage register on a conventional
11856calculator, and a variable in a programming language. (In fact, a Calc
11857variable is really just an Emacs Lisp variable that contains a Calc number
11858or formula.) A variable's name is normally composed of letters and digits.
11859Calc also allows apostrophes and @code{#} signs in variable names.
4f38ed98
JB
11860(The Calc variable @code{foo} corresponds to the Emacs Lisp variable
11861@code{var-foo}, but unless you access the variable from within Emacs
a2db4c6b
JB
11862Lisp, you don't need to worry about it. Variable names in algebraic
11863formulas implicitly have @samp{var-} prefixed to their names. The
11864@samp{#} character in variable names used in algebraic formulas
11865corresponds to a dash @samp{-} in the Lisp variable name. If the name
11866contains any dashes, the prefix @samp{var-} is @emph{not} automatically
11867added. Thus the two formulas @samp{foo + 1} and @samp{var#foo + 1} both
11868refer to the same variable.)
d7b8e6c6
EZ
11869
11870In a command that takes a variable name, you can either type the full
11871name of a variable, or type a single digit to use one of the special
4f38ed98
JB
11872convenience variables @code{q0} through @code{q9}. For example,
11873@kbd{3 s s 2} stores the number 3 in variable @code{q2}, and
d7b8e6c6 11874@w{@kbd{3 s s foo @key{RET}}} stores that number in variable
4f38ed98 11875@code{foo}.
d7b8e6c6
EZ
11876
11877To push a variable itself (as opposed to the variable's value) on the
11878stack, enter its name as an algebraic expression using the apostrophe
4f38ed98
JB
11879(@key{'}) key.
11880
d7b8e6c6
EZ
11881@kindex =
11882@pindex calc-evaluate
11883@cindex Evaluation of variables in a formula
11884@cindex Variables, evaluation
11885@cindex Formulas, evaluation
11886The @kbd{=} (@code{calc-evaluate}) key ``evaluates'' a formula by
11887replacing all variables in the formula which have been given values by a
11888@code{calc-store} or @code{calc-let} command by their stored values.
11889Other variables are left alone. Thus a variable that has not been
11890stored acts like an abstract variable in algebra; a variable that has
11891been stored acts more like a register in a traditional calculator.
11892With a positive numeric prefix argument, @kbd{=} evaluates the top
11893@var{n} stack entries; with a negative argument, @kbd{=} evaluates
11894the @var{n}th stack entry.
11895
11896@cindex @code{e} variable
11897@cindex @code{pi} variable
11898@cindex @code{i} variable
11899@cindex @code{phi} variable
11900@cindex @code{gamma} variable
11901@vindex e
11902@vindex pi
11903@vindex i
11904@vindex phi
11905@vindex gamma
11906A few variables are called @dfn{special constants}. Their names are
11907@samp{e}, @samp{pi}, @samp{i}, @samp{phi}, and @samp{gamma}.
11908(@xref{Scientific Functions}.) When they are evaluated with @kbd{=},
11909their values are calculated if necessary according to the current precision
11910or complex polar mode. If you wish to use these symbols for other purposes,
a4231b04 11911simply undefine or redefine them using @code{calc-store}.
d7b8e6c6
EZ
11912
11913The variables @samp{inf}, @samp{uinf}, and @samp{nan} stand for
11914infinite or indeterminate values. It's best not to use them as
11915regular variables, since Calc uses special algebraic rules when
11916it manipulates them. Calc displays a warning message if you store
11917a value into any of these special variables.
11918
11919@xref{Store and Recall}, for a discussion of commands dealing with variables.
11920
11921@node Formulas, , Variables, Data Types
11922@section Formulas
11923
11924@noindent
11925@cindex Formulas
11926@cindex Expressions
11927@cindex Operators in formulas
11928@cindex Precedence of operators
11929When you press the apostrophe key you may enter any expression or formula
11930in algebraic form. (Calc uses the terms ``expression'' and ``formula''
11931interchangeably.) An expression is built up of numbers, variable names,
11932and function calls, combined with various arithmetic operators.
11933Parentheses may
11934be used to indicate grouping. Spaces are ignored within formulas, except
11935that spaces are not permitted within variable names or numbers.
11936Arithmetic operators, in order from highest to lowest precedence, and
11937with their equivalent function names, are:
11938
11939@samp{_} [@code{subscr}] (subscripts);
11940
11941postfix @samp{%} [@code{percent}] (as in @samp{25% = 0.25});
11942
11943prefix @samp{+} and @samp{-} [@code{neg}] (as in @samp{-x})
11944and prefix @samp{!} [@code{lnot}] (logical ``not,'' as in @samp{!x});
11945
11946@samp{+/-} [@code{sdev}] (the standard deviation symbol) and
11947@samp{mod} [@code{makemod}] (the symbol for modulo forms);
11948
11949postfix @samp{!} [@code{fact}] (factorial, as in @samp{n!})
11950and postfix @samp{!!} [@code{dfact}] (double factorial);
11951
11952@samp{^} [@code{pow}] (raised-to-the-power-of);
11953
11954@samp{*} [@code{mul}];
11955
11956@samp{/} [@code{div}], @samp{%} [@code{mod}] (modulo), and
11957@samp{\} [@code{idiv}] (integer division);
11958
11959infix @samp{+} [@code{add}] and @samp{-} [@code{sub}] (as in @samp{x-y});
11960
11961@samp{|} [@code{vconcat}] (vector concatenation);
11962
11963relations @samp{=} [@code{eq}], @samp{!=} [@code{neq}], @samp{<} [@code{lt}],
11964@samp{>} [@code{gt}], @samp{<=} [@code{leq}], and @samp{>=} [@code{geq}];
11965
11966@samp{&&} [@code{land}] (logical ``and'');
11967
11968@samp{||} [@code{lor}] (logical ``or'');
11969
11970the C-style ``if'' operator @samp{a?b:c} [@code{if}];
11971
11972@samp{!!!} [@code{pnot}] (rewrite pattern ``not'');
11973
11974@samp{&&&} [@code{pand}] (rewrite pattern ``and'');
11975
11976@samp{|||} [@code{por}] (rewrite pattern ``or'');
11977
11978@samp{:=} [@code{assign}] (for assignments and rewrite rules);
11979
11980@samp{::} [@code{condition}] (rewrite pattern condition);
11981
11982@samp{=>} [@code{evalto}].
11983
11984Note that, unlike in usual computer notation, multiplication binds more
a4231b04 11985strongly than division: @samp{a*b/c*d} is equivalent to
8e04863e 11986@texline @math{a b \over c d}.
a4231b04 11987@infoline @expr{(a*b)/(c*d)}.
d7b8e6c6
EZ
11988
11989@cindex Multiplication, implicit
11990@cindex Implicit multiplication
11991The multiplication sign @samp{*} may be omitted in many cases. In particular,
11992if the righthand side is a number, variable name, or parenthesized
11993expression, the @samp{*} may be omitted. Implicit multiplication has the
11994same precedence as the explicit @samp{*} operator. The one exception to
11995the rule is that a variable name followed by a parenthesized expression,
11996as in @samp{f(x)},
11997is interpreted as a function call, not an implicit @samp{*}. In many
11998cases you must use a space if you omit the @samp{*}: @samp{2a} is the
11999same as @samp{2*a}, and @samp{a b} is the same as @samp{a*b}, but @samp{ab}
12000is a variable called @code{ab}, @emph{not} the product of @samp{a} and
a4231b04 12001@samp{b}! Also note that @samp{f (x)} is still a function call.
d7b8e6c6
EZ
12002
12003@cindex Implicit comma in vectors
12004The rules are slightly different for vectors written with square brackets.
12005In vectors, the space character is interpreted (like the comma) as a
12006separator of elements of the vector. Thus @w{@samp{[ 2a b+c d ]}} is
12007equivalent to @samp{[2*a, b+c, d]}, whereas @samp{2a b+c d} is equivalent
12008to @samp{2*a*b + c*d}.
12009Note that spaces around the brackets, and around explicit commas, are
12010ignored. To force spaces to be interpreted as multiplication you can
12011enclose a formula in parentheses as in @samp{[(a b) 2(c d)]}, which is
12012interpreted as @samp{[a*b, 2*c*d]}. An implicit comma is also inserted
a4231b04 12013between @samp{][}, as in the matrix @samp{[[1 2][3 4]]}.
d7b8e6c6
EZ
12014
12015Vectors that contain commas (not embedded within nested parentheses or
12016brackets) do not treat spaces specially: @samp{[a b, 2 c d]} is a vector
12017of two elements. Also, if it would be an error to treat spaces as
12018separators, but not otherwise, then Calc will ignore spaces:
12019@w{@samp{[a - b]}} is a vector of one element, but @w{@samp{[a -b]}} is
12020a vector of two elements. Finally, vectors entered with curly braces
12021instead of square brackets do not give spaces any special treatment.
12022When Calc displays a vector that does not contain any commas, it will
12023insert parentheses if necessary to make the meaning clear:
12024@w{@samp{[(a b)]}}.
12025
12026The expression @samp{5%-2} is ambiguous; is this five-percent minus two,
12027or five modulo minus-two? Calc always interprets the leftmost symbol as
12028an infix operator preferentially (modulo, in this case), so you would
12029need to write @samp{(5%)-2} to get the former interpretation.
12030
12031@cindex Function call notation
a2db4c6b
JB
12032A function call is, e.g., @samp{sin(1+x)}. (The Calc algebraic function
12033@code{foo} corresponds to the Emacs Lisp function @code{calcFunc-foo},
12034but unless you access the function from within Emacs Lisp, you don't
12035need to worry about it.) Most mathematical Calculator commands like
d7b8e6c6
EZ
12036@code{calc-sin} have function equivalents like @code{sin}.
12037If no Lisp function is defined for a function called by a formula, the
12038call is left as it is during algebraic manipulation: @samp{f(x+y)} is
12039left alone. Beware that many innocent-looking short names like @code{in}
12040and @code{re} have predefined meanings which could surprise you; however,
12041single letters or single letters followed by digits are always safe to
a4231b04 12042use for your own function names. @xref{Function Index}.
d7b8e6c6
EZ
12043
12044In the documentation for particular commands, the notation @kbd{H S}
12045(@code{calc-sinh}) [@code{sinh}] means that the key sequence @kbd{H S}, the
12046command @kbd{M-x calc-sinh}, and the algebraic function @code{sinh(x)} all
a4231b04 12047represent the same operation.
d7b8e6c6
EZ
12048
12049Commands that interpret (``parse'') text as algebraic formulas include
12050algebraic entry (@kbd{'}), editing commands like @kbd{`} which parse
12051the contents of the editing buffer when you finish, the @kbd{M-# g}
12052and @w{@kbd{M-# r}} commands, the @kbd{C-y} command, the X window system
07ce2eb3 12053``paste'' mouse operation, and Embedded mode. All of these operations
d7b8e6c6
EZ
12054use the same rules for parsing formulas; in particular, language modes
12055(@pxref{Language Modes}) affect them all in the same way.
12056
12057When you read a large amount of text into the Calculator (say a vector
12058which represents a big set of rewrite rules; @pxref{Rewrite Rules}),
12059you may wish to include comments in the text. Calc's formula parser
12060ignores the symbol @samp{%%} and anything following it on a line:
12061
12062@example
12063[ a + b, %% the sum of "a" and "b"
12064 c + d,
12065 %% last line is coming up:
12066 e + f ]
12067@end example
12068
12069@noindent
12070This is parsed exactly the same as @samp{[ a + b, c + d, e + f ]}.
12071
12072@xref{Syntax Tables}, for a way to create your own operators and other
12073input notations. @xref{Compositions}, for a way to create new display
12074formats.
12075
12076@xref{Algebra}, for commands for manipulating formulas symbolically.
12077
12078@node Stack and Trail, Mode Settings, Data Types, Top
12079@chapter Stack and Trail Commands
12080
12081@noindent
12082This chapter describes the Calc commands for manipulating objects on the
12083stack and in the trail buffer. (These commands operate on objects of any
12084type, such as numbers, vectors, formulas, and incomplete objects.)
12085
12086@menu
12087* Stack Manipulation::
12088* Editing Stack Entries::
12089* Trail Commands::
12090* Keep Arguments::
12091@end menu
12092
12093@node Stack Manipulation, Editing Stack Entries, Stack and Trail, Stack and Trail
12094@section Stack Manipulation Commands
12095
12096@noindent
5d67986c
RS
12097@kindex @key{RET}
12098@kindex @key{SPC}
d7b8e6c6
EZ
12099@pindex calc-enter
12100@cindex Duplicating stack entries
12101To duplicate the top object on the stack, press @key{RET} or @key{SPC}
12102(two equivalent keys for the @code{calc-enter} command).
12103Given a positive numeric prefix argument, these commands duplicate
12104several elements at the top of the stack.
12105Given a negative argument,
12106these commands duplicate the specified element of the stack.
12107Given an argument of zero, they duplicate the entire stack.
12108For example, with @samp{10 20 30} on the stack,
12109@key{RET} creates @samp{10 20 30 30},
12110@kbd{C-u 2 @key{RET}} creates @samp{10 20 30 20 30},
12111@kbd{C-u - 2 @key{RET}} creates @samp{10 20 30 20}, and
a4231b04 12112@kbd{C-u 0 @key{RET}} creates @samp{10 20 30 10 20 30}.
d7b8e6c6 12113
5d67986c 12114@kindex @key{LFD}
d7b8e6c6
EZ
12115@pindex calc-over
12116The @key{LFD} (@code{calc-over}) command (on a key marked Line-Feed if you
12117have it, else on @kbd{C-j}) is like @code{calc-enter}
12118except that the sign of the numeric prefix argument is interpreted
12119oppositely. Also, with no prefix argument the default argument is 2.
12120Thus with @samp{10 20 30} on the stack, @key{LFD} and @kbd{C-u 2 @key{LFD}}
12121are both equivalent to @kbd{C-u - 2 @key{RET}}, producing
a4231b04 12122@samp{10 20 30 20}.
d7b8e6c6 12123
5d67986c 12124@kindex @key{DEL}
d7b8e6c6
EZ
12125@kindex C-d
12126@pindex calc-pop
12127@cindex Removing stack entries
12128@cindex Deleting stack entries
12129To remove the top element from the stack, press @key{DEL} (@code{calc-pop}).
12130The @kbd{C-d} key is a synonym for @key{DEL}.
12131(If the top element is an incomplete object with at least one element, the
12132last element is removed from it.) Given a positive numeric prefix argument,
12133several elements are removed. Given a negative argument, the specified
12134element of the stack is deleted. Given an argument of zero, the entire
12135stack is emptied.
12136For example, with @samp{10 20 30} on the stack,
12137@key{DEL} leaves @samp{10 20},
12138@kbd{C-u 2 @key{DEL}} leaves @samp{10},
12139@kbd{C-u - 2 @key{DEL}} leaves @samp{10 30}, and
a4231b04 12140@kbd{C-u 0 @key{DEL}} leaves an empty stack.
d7b8e6c6 12141
5d67986c 12142@kindex M-@key{DEL}
d7b8e6c6 12143@pindex calc-pop-above
0d48e8aa 12144The @kbd{M-@key{DEL}} (@code{calc-pop-above}) command is to @key{DEL} what
d7b8e6c6
EZ
12145@key{LFD} is to @key{RET}: It interprets the sign of the numeric
12146prefix argument in the opposite way, and the default argument is 2.
0d48e8aa 12147Thus @kbd{M-@key{DEL}} by itself removes the second-from-top stack element,
5d67986c 12148leaving the first, third, fourth, and so on; @kbd{M-3 M-@key{DEL}} deletes
d7b8e6c6
EZ
12149the third stack element.
12150
5d67986c 12151@kindex @key{TAB}
d7b8e6c6
EZ
12152@pindex calc-roll-down
12153To exchange the top two elements of the stack, press @key{TAB}
12154(@code{calc-roll-down}). Given a positive numeric prefix argument, the
12155specified number of elements at the top of the stack are rotated downward.
12156Given a negative argument, the entire stack is rotated downward the specified
12157number of times. Given an argument of zero, the entire stack is reversed
12158top-for-bottom.
12159For example, with @samp{10 20 30 40 50} on the stack,
12160@key{TAB} creates @samp{10 20 30 50 40},
12161@kbd{C-u 3 @key{TAB}} creates @samp{10 20 50 30 40},
12162@kbd{C-u - 2 @key{TAB}} creates @samp{40 50 10 20 30}, and
a4231b04 12163@kbd{C-u 0 @key{TAB}} creates @samp{50 40 30 20 10}.
d7b8e6c6 12164
5d67986c 12165@kindex M-@key{TAB}
d7b8e6c6 12166@pindex calc-roll-up
5d67986c 12167The command @kbd{M-@key{TAB}} (@code{calc-roll-up}) is analogous to @key{TAB}
d7b8e6c6
EZ
12168except that it rotates upward instead of downward. Also, the default
12169with no prefix argument is to rotate the top 3 elements.
12170For example, with @samp{10 20 30 40 50} on the stack,
5d67986c
RS
12171@kbd{M-@key{TAB}} creates @samp{10 20 40 50 30},
12172@kbd{C-u 4 M-@key{TAB}} creates @samp{10 30 40 50 20},
12173@kbd{C-u - 2 M-@key{TAB}} creates @samp{30 40 50 10 20}, and
a4231b04 12174@kbd{C-u 0 M-@key{TAB}} creates @samp{50 40 30 20 10}.
d7b8e6c6 12175
5d67986c 12176A good way to view the operation of @key{TAB} and @kbd{M-@key{TAB}} is in
d7b8e6c6 12177terms of moving a particular element to a new position in the stack.
5d67986c
RS
12178With a positive argument @var{n}, @key{TAB} moves the top stack
12179element down to level @var{n}, making room for it by pulling all the
12180intervening stack elements toward the top. @kbd{M-@key{TAB}} moves the
12181element at level @var{n} up to the top. (Compare with @key{LFD},
12182which copies instead of moving the element in level @var{n}.)
12183
8e04863e 12184With a negative argument @mathit{-@var{n}}, @key{TAB} rotates the stack
5d67986c 12185to move the object in level @var{n} to the deepest place in the
8e04863e
JB
12186stack, and the object in level @mathit{@var{n}+1} to the top. @kbd{M-@key{TAB}}
12187rotates the deepest stack element to be in level @mathit{n}, also
12188putting the top stack element in level @mathit{@var{n}+1}.
d7b8e6c6
EZ
12189
12190@xref{Selecting Subformulas}, for a way to apply these commands to
12191any portion of a vector or formula on the stack.
12192
12193@node Editing Stack Entries, Trail Commands, Stack Manipulation, Stack and Trail
12194@section Editing Stack Entries
12195
12196@noindent
12197@kindex `
12198@pindex calc-edit
12199@pindex calc-edit-finish
12200@cindex Editing the stack with Emacs
12201The backquote, @kbd{`} (@code{calc-edit}) command creates a temporary
12202buffer (@samp{*Calc Edit*}) for editing the top-of-stack value using
12203regular Emacs commands. With a numeric prefix argument, it edits the
12204specified number of stack entries at once. (An argument of zero edits
12205the entire stack; a negative argument edits one specific stack entry.)
12206
33108698 12207When you are done editing, press @kbd{C-c C-c} to finish and return
d7b8e6c6
EZ
12208to Calc. The @key{RET} and @key{LFD} keys also work to finish most
12209sorts of editing, though in some cases Calc leaves @key{RET} with its
12210usual meaning (``insert a newline'') if it's a situation where you
33108698 12211might want to insert new lines into the editing buffer.
d7b8e6c6
EZ
12212
12213When you finish editing, the Calculator parses the lines of text in
12214the @samp{*Calc Edit*} buffer as numbers or formulas, replaces the
12215original stack elements in the original buffer with these new values,
12216then kills the @samp{*Calc Edit*} buffer. The original Calculator buffer
12217continues to exist during editing, but for best results you should be
12218careful not to change it until you have finished the edit. You can
33108698 12219also cancel the edit by killing the buffer with @kbd{C-x k}.
d7b8e6c6
EZ
12220
12221The formula is normally reevaluated as it is put onto the stack.
12222For example, editing @samp{a + 2} to @samp{3 + 2} and pressing
33108698 12223@kbd{C-c C-c} will push 5 on the stack. If you use @key{LFD} to
d7b8e6c6
EZ
12224finish, Calc will put the result on the stack without evaluating it.
12225
33108698 12226If you give a prefix argument to @kbd{C-c C-c},
d7b8e6c6
EZ
12227Calc will not kill the @samp{*Calc Edit*} buffer. You can switch
12228back to that buffer and continue editing if you wish. However, you
12229should understand that if you initiated the edit with @kbd{`}, the
33108698 12230@kbd{C-c C-c} operation will be programmed to replace the top of the
d7b8e6c6
EZ
12231stack with the new edited value, and it will do this even if you have
12232rearranged the stack in the meanwhile. This is not so much of a problem
12233with other editing commands, though, such as @kbd{s e}
12234(@code{calc-edit-variable}; @pxref{Operations on Variables}).
12235
12236If the @code{calc-edit} command involves more than one stack entry,
12237each line of the @samp{*Calc Edit*} buffer is interpreted as a
12238separate formula. Otherwise, the entire buffer is interpreted as
12239one formula, with line breaks ignored. (You can use @kbd{C-o} or
12240@kbd{C-q C-j} to insert a newline in the buffer without pressing @key{RET}.)
12241
12242The @kbd{`} key also works during numeric or algebraic entry. The
12243text entered so far is moved to the @code{*Calc Edit*} buffer for
12244more extensive editing than is convenient in the minibuffer.
12245
12246@node Trail Commands, Keep Arguments, Editing Stack Entries, Stack and Trail
12247@section Trail Commands
12248
12249@noindent
12250@cindex Trail buffer
12251The commands for manipulating the Calc Trail buffer are two-key sequences
12252beginning with the @kbd{t} prefix.
12253
12254@kindex t d
12255@pindex calc-trail-display
12256The @kbd{t d} (@code{calc-trail-display}) command turns display of the
12257trail on and off. Normally the trail display is toggled on if it was off,
12258off if it was on. With a numeric prefix of zero, this command always
12259turns the trail off; with a prefix of one, it always turns the trail on.
12260The other trail-manipulation commands described here automatically turn
12261the trail on. Note that when the trail is off values are still recorded
12262there; they are simply not displayed. To set Emacs to turn the trail
12263off by default, type @kbd{t d} and then save the mode settings with
12264@kbd{m m} (@code{calc-save-modes}).
12265
12266@kindex t i
12267@pindex calc-trail-in
12268@kindex t o
12269@pindex calc-trail-out
12270The @kbd{t i} (@code{calc-trail-in}) and @kbd{t o}
12271(@code{calc-trail-out}) commands switch the cursor into and out of the
12272Calc Trail window. In practice they are rarely used, since the commands
12273shown below are a more convenient way to move around in the
12274trail, and they work ``by remote control'' when the cursor is still
a4231b04 12275in the Calculator window.
d7b8e6c6
EZ
12276
12277@cindex Trail pointer
12278There is a @dfn{trail pointer} which selects some entry of the trail at
12279any given time. The trail pointer looks like a @samp{>} symbol right
12280before the selected number. The following commands operate on the
12281trail pointer in various ways.
12282
12283@kindex t y
12284@pindex calc-trail-yank
12285@cindex Retrieving previous results
12286The @kbd{t y} (@code{calc-trail-yank}) command reads the selected value in
12287the trail and pushes it onto the Calculator stack. It allows you to
12288re-use any previously computed value without retyping. With a numeric
12289prefix argument @var{n}, it yanks the value @var{n} lines above the current
12290trail pointer.
12291
12292@kindex t <
12293@pindex calc-trail-scroll-left
12294@kindex t >
12295@pindex calc-trail-scroll-right
12296The @kbd{t <} (@code{calc-trail-scroll-left}) and @kbd{t >}
12297(@code{calc-trail-scroll-right}) commands horizontally scroll the trail
a4231b04 12298window left or right by one half of its width.
d7b8e6c6
EZ
12299
12300@kindex t n
12301@pindex calc-trail-next
12302@kindex t p
12303@pindex calc-trail-previous
12304@kindex t f
12305@pindex calc-trail-forward
12306@kindex t b
12307@pindex calc-trail-backward
12308The @kbd{t n} (@code{calc-trail-next}) and @kbd{t p}
12309(@code{calc-trail-previous)} commands move the trail pointer down or up
12310one line. The @kbd{t f} (@code{calc-trail-forward}) and @kbd{t b}
12311(@code{calc-trail-backward}) commands move the trail pointer down or up
12312one screenful at a time. All of these commands accept numeric prefix
a4231b04 12313arguments to move several lines or screenfuls at a time.
d7b8e6c6
EZ
12314
12315@kindex t [
12316@pindex calc-trail-first
12317@kindex t ]
12318@pindex calc-trail-last
12319@kindex t h
12320@pindex calc-trail-here
12321The @kbd{t [} (@code{calc-trail-first}) and @kbd{t ]}
12322(@code{calc-trail-last}) commands move the trail pointer to the first or
12323last line of the trail. The @kbd{t h} (@code{calc-trail-here}) command
12324moves the trail pointer to the cursor position; unlike the other trail
a4231b04 12325commands, @kbd{t h} works only when Calc Trail is the selected window.
d7b8e6c6
EZ
12326
12327@kindex t s
12328@pindex calc-trail-isearch-forward
12329@kindex t r
12330@pindex calc-trail-isearch-backward
12331@ifinfo
12332The @kbd{t s} (@code{calc-trail-isearch-forward}) and @kbd{t r}
12333(@code{calc-trail-isearch-backward}) commands perform an incremental
12334search forward or backward through the trail. You can press @key{RET}
12335to terminate the search; the trail pointer moves to the current line.
12336If you cancel the search with @kbd{C-g}, the trail pointer stays where
a4231b04 12337it was when the search began.
d7b8e6c6
EZ
12338@end ifinfo
12339@tex
12340The @kbd{t s} (@code{calc-trail-isearch-forward}) and @kbd{t r}
12341(@code{calc-trail-isearch-backward}) com\-mands perform an incremental
12342search forward or backward through the trail. You can press @key{RET}
12343to terminate the search; the trail pointer moves to the current line.
12344If you cancel the search with @kbd{C-g}, the trail pointer stays where
12345it was when the search began.
12346@end tex
12347
12348@kindex t m
12349@pindex calc-trail-marker
12350The @kbd{t m} (@code{calc-trail-marker}) command allows you to enter a
12351line of text of your own choosing into the trail. The text is inserted
12352after the line containing the trail pointer; this usually means it is
12353added to the end of the trail. Trail markers are useful mainly as the
12354targets for later incremental searches in the trail.
12355
12356@kindex t k
12357@pindex calc-trail-kill
12358The @kbd{t k} (@code{calc-trail-kill}) command removes the selected line
12359from the trail. The line is saved in the Emacs kill ring suitable for
12360yanking into another buffer, but it is not easy to yank the text back
12361into the trail buffer. With a numeric prefix argument, this command
12362kills the @var{n} lines below or above the selected one.
12363
12364The @kbd{t .} (@code{calc-full-trail-vectors}) command is described
12365elsewhere; @pxref{Vector and Matrix Formats}.
12366
12367@node Keep Arguments, , Trail Commands, Stack and Trail
12368@section Keep Arguments
12369
12370@noindent
12371@kindex K
12372@pindex calc-keep-args
12373The @kbd{K} (@code{calc-keep-args}) command acts like a prefix for
12374the following command. It prevents that command from removing its
12375arguments from the stack. For example, after @kbd{2 @key{RET} 3 +},
12376the stack contains the sole number 5, but after @kbd{2 @key{RET} 3 K +},
12377the stack contains the arguments and the result: @samp{2 3 5}.
12378
11e81923
JB
12379With the exception of keyboard macros, this works for all commands that
12380take arguments off the stack. (To avoid potentially unpleasant behavior,
8423891c
JB
12381a @kbd{K} prefix before a keyboard macro will be ignored. A @kbd{K}
12382prefix called @emph{within} the keyboard macro will still take effect.)
12383As another example, @kbd{K a s} simplifies a formula, pushing the
12384simplified version of the formula onto the stack after the original
12385formula (rather than replacing the original formula). Note that you
12386could get the same effect by typing @kbd{@key{RET} a s}, copying the
12387formula and then simplifying the copy. One difference is that for a very
12388large formula the time taken to format the intermediate copy in
12389@kbd{@key{RET} a s} could be noticeable; @kbd{K a s} would avoid this
12390extra work.
d7b8e6c6
EZ
12391
12392Even stack manipulation commands are affected. @key{TAB} works by
12393popping two values and pushing them back in the opposite order,
12394so @kbd{2 @key{RET} 3 K @key{TAB}} produces @samp{2 3 3 2}.
12395
12396A few Calc commands provide other ways of doing the same thing.
12397For example, @kbd{' sin($)} replaces the number on the stack with
12398its sine using algebraic entry; to push the sine and keep the
12399original argument you could use either @kbd{' sin($1)} or
12400@kbd{K ' sin($)}. @xref{Algebraic Entry}. Also, the @kbd{s s}
12401command is effectively the same as @kbd{K s t}. @xref{Storing Variables}.
12402
d7b8e6c6
EZ
12403If you execute a command and then decide you really wanted to keep
12404the argument, you can press @kbd{M-@key{RET}} (@code{calc-last-args}).
12405This command pushes the last arguments that were popped by any command
12406onto the stack. Note that the order of things on the stack will be
12407different than with @kbd{K}: @kbd{2 @key{RET} 3 + M-@key{RET}} leaves
12408@samp{5 2 3} on the stack instead of @samp{2 3 5}. @xref{Undo}.
12409
12410@node Mode Settings, Arithmetic, Stack and Trail, Top
12411@chapter Mode Settings
12412
12413@noindent
12414This chapter describes commands that set modes in the Calculator.
12415They do not affect the contents of the stack, although they may change
12416the @emph{appearance} or @emph{interpretation} of the stack's contents.
12417
12418@menu
12419* General Mode Commands::
12420* Precision::
12421* Inverse and Hyperbolic::
12422* Calculation Modes::
12423* Simplification Modes::
12424* Declarations::
12425* Display Modes::
12426* Language Modes::
12427* Modes Variable::
12428* Calc Mode Line::
12429@end menu
12430
12431@node General Mode Commands, Precision, Mode Settings, Mode Settings
12432@section General Mode Commands
12433
12434@noindent
12435@kindex m m
12436@pindex calc-save-modes
12437@cindex Continuous memory
12438@cindex Saving mode settings
12439@cindex Permanent mode settings
3b846359
JB
12440@cindex Calc init file, mode settings
12441You can save all of the current mode settings in your Calc init file
12442(the file given by the variable @code{calc-settings-file}, typically
12443@file{~/.calc.el}) with the @kbd{m m} (@code{calc-save-modes}) command.
12444This will cause Emacs to reestablish these modes each time it starts up.
12445The modes saved in the file include everything controlled by the @kbd{m}
12446and @kbd{d} prefix keys, the current precision and binary word size,
12447whether or not the trail is displayed, the current height of the Calc
12448window, and more. The current interface (used when you type @kbd{M-#
12449M-#}) is also saved. If there were already saved mode settings in the
12450file, they are replaced. Otherwise, the new mode information is
12451appended to the end of the file.
d7b8e6c6
EZ
12452
12453@kindex m R
12454@pindex calc-mode-record-mode
12455The @kbd{m R} (@code{calc-mode-record-mode}) command tells Calc to
35626cba
JB
12456record all the mode settings (as if by pressing @kbd{m m}) every
12457time a mode setting changes. If the modes are saved this way, then this
12458``automatic mode recording'' mode is also saved.
12459Type @kbd{m R} again to disable this method of recording the mode
12460settings. To turn it off permanently, the @kbd{m m} command will also be
12461necessary. (If Embedded mode is enabled, other options for recording
12462the modes are available; @pxref{Mode Settings in Embedded Mode}.)
d7b8e6c6
EZ
12463
12464@kindex m F
12465@pindex calc-settings-file-name
12466The @kbd{m F} (@code{calc-settings-file-name}) command allows you to
16085693
JB
12467choose a different file than the current value of @code{calc-settings-file}
12468for @kbd{m m}, @kbd{Z P}, and similar commands to save permanent information.
d7b8e6c6
EZ
12469You are prompted for a file name. All Calc modes are then reset to
12470their default values, then settings from the file you named are loaded
12471if this file exists, and this file becomes the one that Calc will
12472use in the future for commands like @kbd{m m}. The default settings
16085693 12473file name is @file{~/.calc.el}. You can see the current file name by
d7b8e6c6 12474giving a blank response to the @kbd{m F} prompt. See also the
b154df16 12475discussion of the @code{calc-settings-file} variable; @pxref{Customizable Variables}.
d7b8e6c6 12476
16085693
JB
12477If the file name you give is your user init file (typically
12478@file{~/.emacs}), @kbd{m F} will not automatically load the new file. This
12479is because your user init file may contain other things you don't want
12480to reread. You can give
d7b8e6c6 12481a numeric prefix argument of 1 to @kbd{m F} to force it to read the
16085693 12482file no matter what. Conversely, an argument of @mathit{-1} tells
8e04863e 12483@kbd{m F} @emph{not} to read the new file. An argument of 2 or @mathit{-2}
d7b8e6c6
EZ
12484tells @kbd{m F} not to reset the modes to their defaults beforehand,
12485which is useful if you intend your new file to have a variant of the
12486modes present in the file you were using before.
12487
12488@kindex m x
12489@pindex calc-always-load-extensions
12490The @kbd{m x} (@code{calc-always-load-extensions}) command enables a mode
12491in which the first use of Calc loads the entire program, including all
12492extensions modules. Otherwise, the extensions modules will not be loaded
12493until the various advanced Calc features are used. Since this mode only
12494has effect when Calc is first loaded, @kbd{m x} is usually followed by
12495@kbd{m m} to make the mode-setting permanent. To load all of Calc just
12496once, rather than always in the future, you can press @kbd{M-# L}.
12497
12498@kindex m S
12499@pindex calc-shift-prefix
12500The @kbd{m S} (@code{calc-shift-prefix}) command enables a mode in which
12501all of Calc's letter prefix keys may be typed shifted as well as unshifted.
12502If you are typing, say, @kbd{a S} (@code{calc-solve-for}) quite often
12503you might find it easier to turn this mode on so that you can type
12504@kbd{A S} instead. When this mode is enabled, the commands that used to
12505be on those single shifted letters (e.g., @kbd{A} (@code{calc-abs})) can
12506now be invoked by pressing the shifted letter twice: @kbd{A A}. Note
12507that the @kbd{v} prefix key always works both shifted and unshifted, and
12508the @kbd{z} and @kbd{Z} prefix keys are always distinct. Also, the @kbd{h}
12509prefix is not affected by this mode. Press @kbd{m S} again to disable
12510shifted-prefix mode.
12511
12512@node Precision, Inverse and Hyperbolic, General Mode Commands, Mode Settings
12513@section Precision
12514
12515@noindent
12516@kindex p
12517@pindex calc-precision
12518@cindex Precision of calculations
12519The @kbd{p} (@code{calc-precision}) command controls the precision to
12520which floating-point calculations are carried. The precision must be
12521at least 3 digits and may be arbitrarily high, within the limits of
12522memory and time. This affects only floats: Integer and rational
12523calculations are always carried out with as many digits as necessary.
12524
12525The @kbd{p} key prompts for the current precision. If you wish you
12526can instead give the precision as a numeric prefix argument.
12527
12528Many internal calculations are carried to one or two digits higher
12529precision than normal. Results are rounded down afterward to the
12530current precision. Unless a special display mode has been selected,
12531floats are always displayed with their full stored precision, i.e.,
12532what you see is what you get. Reducing the current precision does not
12533round values already on the stack, but those values will be rounded
12534down before being used in any calculation. The @kbd{c 0} through
12535@kbd{c 9} commands (@pxref{Conversions}) can be used to round an
a4231b04 12536existing value to a new precision.
d7b8e6c6
EZ
12537
12538@cindex Accuracy of calculations
12539It is important to distinguish the concepts of @dfn{precision} and
12540@dfn{accuracy}. In the normal usage of these words, the number
12541123.4567 has a precision of 7 digits but an accuracy of 4 digits.
12542The precision is the total number of digits not counting leading
12543or trailing zeros (regardless of the position of the decimal point).
12544The accuracy is simply the number of digits after the decimal point
12545(again not counting trailing zeros). In Calc you control the precision,
12546not the accuracy of computations. If you were to set the accuracy
12547instead, then calculations like @samp{exp(100)} would generate many
12548more digits than you would typically need, while @samp{exp(-100)} would
12549probably round to zero! In Calc, both these computations give you
12550exactly 12 (or the requested number of) significant digits.
12551
12552The only Calc features that deal with accuracy instead of precision
12553are fixed-point display mode for floats (@kbd{d f}; @pxref{Float Formats}),
12554and the rounding functions like @code{floor} and @code{round}
12555(@pxref{Integer Truncation}). Also, @kbd{c 0} through @kbd{c 9}
12556deal with both precision and accuracy depending on the magnitudes
12557of the numbers involved.
12558
12559If you need to work with a particular fixed accuracy (say, dollars and
12560cents with two digits after the decimal point), one solution is to work
12561with integers and an ``implied'' decimal point. For example, $8.99
5d67986c 12562divided by 6 would be entered @kbd{899 @key{RET} 6 /}, yielding 149.833
d7b8e6c6
EZ
12563(actually $1.49833 with our implied decimal point); pressing @kbd{R}
12564would round this to 150 cents, i.e., $1.50.
12565
12566@xref{Floats}, for still more on floating-point precision and related
12567issues.
12568
12569@node Inverse and Hyperbolic, Calculation Modes, Precision, Mode Settings
12570@section Inverse and Hyperbolic Flags
12571
12572@noindent
12573@kindex I
12574@pindex calc-inverse
12575There is no single-key equivalent to the @code{calc-arcsin} function.
12576Instead, you must first press @kbd{I} (@code{calc-inverse}) to set
12577the @dfn{Inverse Flag}, then press @kbd{S} (@code{calc-sin}).
12578The @kbd{I} key actually toggles the Inverse Flag. When this flag
a4231b04 12579is set, the word @samp{Inv} appears in the mode line.
d7b8e6c6
EZ
12580
12581@kindex H
12582@pindex calc-hyperbolic
12583Likewise, the @kbd{H} key (@code{calc-hyperbolic}) sets or clears the
12584Hyperbolic Flag, which transforms @code{calc-sin} into @code{calc-sinh}.
12585If both of these flags are set at once, the effect will be
12586@code{calc-arcsinh}. (The Hyperbolic flag is also used by some
12587non-trigonometric commands; for example @kbd{H L} computes a base-10,
8e04863e 12588instead of base-@mathit{e}, logarithm.)
d7b8e6c6
EZ
12589
12590Command names like @code{calc-arcsin} are provided for completeness, and
12591may be executed with @kbd{x} or @kbd{M-x}. Their effect is simply to
12592toggle the Inverse and/or Hyperbolic flags and then execute the
12593corresponding base command (@code{calc-sin} in this case).
12594
12595The Inverse and Hyperbolic flags apply only to the next Calculator
12596command, after which they are automatically cleared. (They are also
12597cleared if the next keystroke is not a Calc command.) Digits you
12598type after @kbd{I} or @kbd{H} (or @kbd{K}) are treated as prefix
12599arguments for the next command, not as numeric entries. The same
12600is true of @kbd{C-u}, but not of the minus sign (@kbd{K -} means to
12601subtract and keep arguments).
12602
12603The third Calc prefix flag, @kbd{K} (keep-arguments), is discussed
12604elsewhere. @xref{Keep Arguments}.
12605
12606@node Calculation Modes, Simplification Modes, Inverse and Hyperbolic, Mode Settings
12607@section Calculation Modes
12608
12609@noindent
12610The commands in this section are two-key sequences beginning with
12611the @kbd{m} prefix. (That's the letter @kbd{m}, not the @key{META} key.)
12612The @samp{m a} (@code{calc-algebraic-mode}) command is described elsewhere
12613(@pxref{Algebraic Entry}).
12614
12615@menu
12616* Angular Modes::
12617* Polar Mode::
12618* Fraction Mode::
12619* Infinite Mode::
12620* Symbolic Mode::
12621* Matrix Mode::
12622* Automatic Recomputation::
12623* Working Message::
12624@end menu
12625
12626@node Angular Modes, Polar Mode, Calculation Modes, Calculation Modes
12627@subsection Angular Modes
12628
12629@noindent
12630@cindex Angular mode
12631The Calculator supports three notations for angles: radians, degrees,
12632and degrees-minutes-seconds. When a number is presented to a function
12633like @code{sin} that requires an angle, the current angular mode is
12634used to interpret the number as either radians or degrees. If an HMS
12635form is presented to @code{sin}, it is always interpreted as
12636degrees-minutes-seconds.
12637
12638Functions that compute angles produce a number in radians, a number in
12639degrees, or an HMS form depending on the current angular mode. If the
12640result is a complex number and the current mode is HMS, the number is
12641instead expressed in degrees. (Complex-number calculations would
07ce2eb3 12642normally be done in Radians mode, though. Complex numbers are converted
d7b8e6c6 12643to degrees by calculating the complex result in radians and then
a4231b04 12644multiplying by 180 over @cpi{}.)
d7b8e6c6
EZ
12645
12646@kindex m r
12647@pindex calc-radians-mode
12648@kindex m d
12649@pindex calc-degrees-mode
12650@kindex m h
12651@pindex calc-hms-mode
12652The @kbd{m r} (@code{calc-radians-mode}), @kbd{m d} (@code{calc-degrees-mode}),
12653and @kbd{m h} (@code{calc-hms-mode}) commands control the angular mode.
12654The current angular mode is displayed on the Emacs mode line.
07ce2eb3 12655The default angular mode is Degrees.
d7b8e6c6
EZ
12656
12657@node Polar Mode, Fraction Mode, Angular Modes, Calculation Modes
12658@subsection Polar Mode
12659
12660@noindent
12661@cindex Polar mode
12662The Calculator normally ``prefers'' rectangular complex numbers in the
12663sense that rectangular form is used when the proper form can not be
12664decided from the input. This might happen by multiplying a rectangular
12665number by a polar one, by taking the square root of a negative real
12666number, or by entering @kbd{( 2 @key{SPC} 3 )}.
12667
12668@kindex m p
12669@pindex calc-polar-mode
12670The @kbd{m p} (@code{calc-polar-mode}) command toggles complex-number
07ce2eb3 12671preference between rectangular and polar forms. In Polar mode, all
d7b8e6c6
EZ
12672of the above example situations would produce polar complex numbers.
12673
12674@node Fraction Mode, Infinite Mode, Polar Mode, Calculation Modes
12675@subsection Fraction Mode
12676
12677@noindent
12678@cindex Fraction mode
12679@cindex Division of integers
12680Division of two integers normally yields a floating-point number if the
12681result cannot be expressed as an integer. In some cases you would
12682rather get an exact fractional answer. One way to accomplish this is
029b2a44
JB
12683to use the @kbd{:} (@code{calc-fdiv}) [@code{fdiv}] command, which
12684divides the two integers on the top of the stack to produce a fraction:
12685@kbd{6 @key{RET} 4 :} produces @expr{3:2} even though
12686@kbd{6 @key{RET} 4 /} produces @expr{1.5}.
d7b8e6c6
EZ
12687
12688@kindex m f
12689@pindex calc-frac-mode
12690To set the Calculator to produce fractional results for normal integer
12691divisions, use the @kbd{m f} (@code{calc-frac-mode}) command.
a4231b04 12692For example, @expr{8/4} produces @expr{2} in either mode,
07ce2eb3
JB
12693but @expr{6/4} produces @expr{3:2} in Fraction mode, @expr{1.5} in
12694Float mode.
d7b8e6c6
EZ
12695
12696At any time you can use @kbd{c f} (@code{calc-float}) to convert a
12697fraction to a float, or @kbd{c F} (@code{calc-fraction}) to convert a
12698float to a fraction. @xref{Conversions}.
12699
12700@node Infinite Mode, Symbolic Mode, Fraction Mode, Calculation Modes
12701@subsection Infinite Mode
12702
12703@noindent
12704@cindex Infinite mode
a4231b04 12705The Calculator normally treats results like @expr{1 / 0} as errors;
d7b8e6c6
EZ
12706formulas like this are left in unsimplified form. But Calc can be
12707put into a mode where such calculations instead produce ``infinite''
12708results.
12709
12710@kindex m i
12711@pindex calc-infinite-mode
12712The @kbd{m i} (@code{calc-infinite-mode}) command turns this mode
12713on and off. When the mode is off, infinities do not arise except
12714in calculations that already had infinities as inputs. (One exception
12715is that infinite open intervals like @samp{[0 .. inf)} can be
12716generated; however, intervals closed at infinity (@samp{[0 .. inf]})
07ce2eb3 12717will not be generated when Infinite mode is off.)
d7b8e6c6 12718
07ce2eb3 12719With Infinite mode turned on, @samp{1 / 0} will generate @code{uinf},
d7b8e6c6 12720an undirected infinity. @xref{Infinities}, for a discussion of the
a4231b04 12721difference between @code{inf} and @code{uinf}. Also, @expr{0 / 0}
d7b8e6c6
EZ
12722evaluates to @code{nan}, the ``indeterminate'' symbol. Various other
12723functions can also return infinities in this mode; for example,
12724@samp{ln(0) = -inf}, and @samp{gamma(-7) = uinf}. Once again,
07ce2eb3 12725note that @samp{exp(inf) = inf} regardless of Infinite mode because
d7b8e6c6
EZ
12726this calculation has infinity as an input.
12727
07ce2eb3 12728@cindex Positive Infinite mode
d7b8e6c6 12729The @kbd{m i} command with a numeric prefix argument of zero,
07ce2eb3 12730i.e., @kbd{C-u 0 m i}, turns on a Positive Infinite mode in
177c0ea7 12731which zero is treated as positive instead of being directionless.
d7b8e6c6
EZ
12732Thus, @samp{1 / 0 = inf} and @samp{-1 / 0 = -inf} in this mode.
12733Note that zero never actually has a sign in Calc; there are no
8e04863e 12734separate representations for @mathit{+0} and @mathit{-0}. Positive
07ce2eb3 12735Infinite mode merely changes the interpretation given to the
d7b8e6c6
EZ
12736single symbol, @samp{0}. One consequence of this is that, while
12737you might expect @samp{1 / -0 = -inf}, actually @samp{1 / -0}
12738is equivalent to @samp{1 / 0}, which is equal to positive @code{inf}.
12739
12740@node Symbolic Mode, Matrix Mode, Infinite Mode, Calculation Modes
12741@subsection Symbolic Mode
12742
12743@noindent
12744@cindex Symbolic mode
12745@cindex Inexact results
12746Calculations are normally performed numerically wherever possible.
12747For example, the @code{calc-sqrt} command, or @code{sqrt} function in an
12748algebraic expression, produces a numeric answer if the argument is a
12749number or a symbolic expression if the argument is an expression:
12750@kbd{2 Q} pushes 1.4142 but @kbd{@key{'} x+1 @key{RET} Q} pushes @samp{sqrt(x+1)}.
12751
12752@kindex m s
12753@pindex calc-symbolic-mode
07ce2eb3 12754In @dfn{Symbolic mode}, controlled by the @kbd{m s} (@code{calc-symbolic-mode})
d7b8e6c6
EZ
12755command, functions which would produce inexact, irrational results are
12756left in symbolic form. Thus @kbd{16 Q} pushes 4, but @kbd{2 Q} pushes
12757@samp{sqrt(2)}.
12758
12759@kindex N
12760@pindex calc-eval-num
12761The shift-@kbd{N} (@code{calc-eval-num}) command evaluates numerically
12762the expression at the top of the stack, by temporarily disabling
12763@code{calc-symbolic-mode} and executing @kbd{=} (@code{calc-evaluate}).
12764Given a numeric prefix argument, it also
12765sets the floating-point precision to the specified value for the duration
a4231b04 12766of the command.
d7b8e6c6
EZ
12767
12768To evaluate a formula numerically without expanding the variables it
12769contains, you can use the key sequence @kbd{m s a v m s} (this uses
12770@code{calc-alg-evaluate}, which resimplifies but doesn't evaluate
12771variables.)
12772
12773@node Matrix Mode, Automatic Recomputation, Symbolic Mode, Calculation Modes
12774@subsection Matrix and Scalar Modes
12775
12776@noindent
12777@cindex Matrix mode
12778@cindex Scalar mode
12779Calc sometimes makes assumptions during algebraic manipulation that
12780are awkward or incorrect when vectors and matrices are involved.
07ce2eb3 12781Calc has two modes, @dfn{Matrix mode} and @dfn{Scalar mode}, which
d7b8e6c6
EZ
12782modify its behavior around vectors in useful ways.
12783
12784@kindex m v
12785@pindex calc-matrix-mode
07ce2eb3 12786Press @kbd{m v} (@code{calc-matrix-mode}) once to enter Matrix mode.
d7b8e6c6
EZ
12787In this mode, all objects are assumed to be matrices unless provably
12788otherwise. One major effect is that Calc will no longer consider
12789multiplication to be commutative. (Recall that in matrix arithmetic,
12790@samp{A*B} is not the same as @samp{B*A}.) This assumption affects
12791rewrite rules and algebraic simplification. Another effect of this
12792mode is that calculations that would normally produce constants like
a4231b04 127930 and 1 (e.g., @expr{a - a} and @expr{a / a}, respectively) will now
d7b8e6c6
EZ
12794produce function calls that represent ``generic'' zero or identity
12795matrices: @samp{idn(0)}, @samp{idn(1)}. The @code{idn} function
12796@samp{idn(@var{a},@var{n})} returns @var{a} times an @var{n}x@var{n}
12797identity matrix; if @var{n} is omitted, it doesn't know what
12798dimension to use and so the @code{idn} call remains in symbolic
12799form. However, if this generic identity matrix is later combined
12800with a matrix whose size is known, it will be converted into
12801a true identity matrix of the appropriate size. On the other hand,
12802if it is combined with a scalar (as in @samp{idn(1) + 2}), Calc
12803will assume it really was a scalar after all and produce, e.g., 3.
12804
07ce2eb3 12805Press @kbd{m v} a second time to get Scalar mode. Here, objects are
d7b8e6c6
EZ
12806assumed @emph{not} to be vectors or matrices unless provably so.
12807For example, normally adding a variable to a vector, as in
12808@samp{[x, y, z] + a}, will leave the sum in symbolic form because
12809as far as Calc knows, @samp{a} could represent either a number or
07ce2eb3 12810another 3-vector. In Scalar mode, @samp{a} is assumed to be a
d7b8e6c6
EZ
12811non-vector, and the addition is evaluated to @samp{[x+a, y+a, z+a]}.
12812
12813Press @kbd{m v} a third time to return to the normal mode of operation.
12814
12815If you press @kbd{m v} with a numeric prefix argument @var{n}, you
07ce2eb3 12816get a special ``dimensioned'' Matrix mode in which matrices of
d7b8e6c6
EZ
12817unknown size are assumed to be @var{n}x@var{n} square matrices.
12818Then, the function call @samp{idn(1)} will expand into an actual
12819matrix rather than representing a ``generic'' matrix.
12820
12821@cindex Declaring scalar variables
12822Of course these modes are approximations to the true state of
12823affairs, which is probably that some quantities will be matrices
12824and others will be scalars. One solution is to ``declare''
12825certain variables or functions to be scalar-valued.
12826@xref{Declarations}, to see how to make declarations in Calc.
12827
12828There is nothing stopping you from declaring a variable to be
12829scalar and then storing a matrix in it; however, if you do, the
12830results you get from Calc may not be valid. Suppose you let Calc
12831get the result @samp{[x+a, y+a, z+a]} shown above, and then stored
12832@samp{[1, 2, 3]} in @samp{a}. The result would not be the same as
12833for @samp{[x, y, z] + [1, 2, 3]}, but that's because you have broken
12834your earlier promise to Calc that @samp{a} would be scalar.
12835
12836Another way to mix scalars and matrices is to use selections
07ce2eb3
JB
12837(@pxref{Selecting Subformulas}). Use Matrix mode when operating on
12838your formula normally; then, to apply Scalar mode to a certain part
d7b8e6c6 12839of the formula without affecting the rest just select that part,
07ce2eb3
JB
12840change into Scalar mode and press @kbd{=} to resimplify the part
12841under this mode, then change back to Matrix mode before deselecting.
d7b8e6c6
EZ
12842
12843@node Automatic Recomputation, Working Message, Matrix Mode, Calculation Modes
12844@subsection Automatic Recomputation
12845
12846@noindent
12847The @dfn{evaluates-to} operator, @samp{=>}, has the special
12848property that any @samp{=>} formulas on the stack are recomputed
12849whenever variable values or mode settings that might affect them
12850are changed. @xref{Evaluates-To Operator}.
12851
12852@kindex m C
12853@pindex calc-auto-recompute
12854The @kbd{m C} (@code{calc-auto-recompute}) command turns this
12855automatic recomputation on and off. If you turn it off, Calc will
12856not update @samp{=>} operators on the stack (nor those in the
07ce2eb3 12857attached Embedded mode buffer, if there is one). They will not
d7b8e6c6
EZ
12858be updated unless you explicitly do so by pressing @kbd{=} or until
12859you press @kbd{m C} to turn recomputation back on. (While automatic
12860recomputation is off, you can think of @kbd{m C m C} as a command
12861to update all @samp{=>} operators while leaving recomputation off.)
12862
12863To update @samp{=>} operators in an Embedded buffer while
12864automatic recomputation is off, use @w{@kbd{M-# u}}.
12865@xref{Embedded Mode}.
12866
12867@node Working Message, , Automatic Recomputation, Calculation Modes
12868@subsection Working Messages
12869
12870@noindent
12871@cindex Performance
12872@cindex Working messages
12873Since the Calculator is written entirely in Emacs Lisp, which is not
12874designed for heavy numerical work, many operations are quite slow.
12875The Calculator normally displays the message @samp{Working...} in the
12876echo area during any command that may be slow. In addition, iterative
12877operations such as square roots and trigonometric functions display the
12878intermediate result at each step. Both of these types of messages can
12879be disabled if you find them distracting.
12880
12881@kindex m w
12882@pindex calc-working
12883Type @kbd{m w} (@code{calc-working}) with a numeric prefix of 0 to
12884disable all ``working'' messages. Use a numeric prefix of 1 to enable
12885only the plain @samp{Working...} message. Use a numeric prefix of 2 to
12886see intermediate results as well. With no numeric prefix this displays
a4231b04 12887the current mode.
d7b8e6c6
EZ
12888
12889While it may seem that the ``working'' messages will slow Calc down
12890considerably, experiments have shown that their impact is actually
12891quite small. But if your terminal is slow you may find that it helps
12892to turn the messages off.
12893
12894@node Simplification Modes, Declarations, Calculation Modes, Mode Settings
12895@section Simplification Modes
12896
12897@noindent
12898The current @dfn{simplification mode} controls how numbers and formulas
12899are ``normalized'' when being taken from or pushed onto the stack.
12900Some normalizations are unavoidable, such as rounding floating-point
12901results to the current precision, and reducing fractions to simplest
a4231b04 12902form. Others, such as simplifying a formula like @expr{a+a} (or @expr{2+3}),
d7b8e6c6
EZ
12903are done by default but can be turned off when necessary.
12904
a4231b04 12905When you press a key like @kbd{+} when @expr{2} and @expr{3} are on the
d7b8e6c6 12906stack, Calc pops these numbers, normalizes them, creates the formula
a4231b04
JB
12907@expr{2+3}, normalizes it, and pushes the result. Of course the standard
12908rules for normalizing @expr{2+3} will produce the result @expr{5}.
d7b8e6c6
EZ
12909
12910Simplification mode commands consist of the lower-case @kbd{m} prefix key
12911followed by a shifted letter.
12912
12913@kindex m O
12914@pindex calc-no-simplify-mode
12915The @kbd{m O} (@code{calc-no-simplify-mode}) command turns off all optional
a4231b04 12916simplifications. These would leave a formula like @expr{2+3} alone. In
d7b8e6c6
EZ
12917fact, nothing except simple numbers are ever affected by normalization
12918in this mode.
12919
12920@kindex m N
12921@pindex calc-num-simplify-mode
12922The @kbd{m N} (@code{calc-num-simplify-mode}) command turns off simplification
12923of any formulas except those for which all arguments are constants. For
a4231b04
JB
12924example, @expr{1+2} is simplified to @expr{3}, and @expr{a+(2-2)} is
12925simplified to @expr{a+0} but no further, since one argument of the sum
12926is not a constant. Unfortunately, @expr{(a+2)-2} is @emph{not} simplified
d7b8e6c6 12927because the top-level @samp{-} operator's arguments are not both
a4231b04 12928constant numbers (one of them is the formula @expr{a+2}).
d7b8e6c6
EZ
12929A constant is a number or other numeric object (such as a constant
12930error form or modulo form), or a vector all of whose
a4231b04 12931elements are constant.
d7b8e6c6
EZ
12932
12933@kindex m D
12934@pindex calc-default-simplify-mode
12935The @kbd{m D} (@code{calc-default-simplify-mode}) command restores the
12936default simplifications for all formulas. This includes many easy and
a4231b04
JB
12937fast algebraic simplifications such as @expr{a+0} to @expr{a}, and
12938@expr{a + 2 a} to @expr{3 a}, as well as evaluating functions like
bd712b70 12939@expr{@tfn{deriv}(x^2, x)} to @expr{2 x}.
d7b8e6c6
EZ
12940
12941@kindex m B
12942@pindex calc-bin-simplify-mode
12943The @kbd{m B} (@code{calc-bin-simplify-mode}) mode applies the default
12944simplifications to a result and then, if the result is an integer,
12945uses the @kbd{b c} (@code{calc-clip}) command to clip the integer according
12946to the current binary word size. @xref{Binary Functions}. Real numbers
12947are rounded to the nearest integer and then clipped; other kinds of
12948results (after the default simplifications) are left alone.
12949
12950@kindex m A
12951@pindex calc-alg-simplify-mode
12952The @kbd{m A} (@code{calc-alg-simplify-mode}) mode does algebraic
12953simplification; it applies all the default simplifications, and also
12954the more powerful (and slower) simplifications made by @kbd{a s}
12955(@code{calc-simplify}). @xref{Algebraic Simplifications}.
12956
12957@kindex m E
12958@pindex calc-ext-simplify-mode
12959The @kbd{m E} (@code{calc-ext-simplify-mode}) mode does ``extended''
12960algebraic simplification, as by the @kbd{a e} (@code{calc-simplify-extended})
12961command. @xref{Unsafe Simplifications}.
12962
12963@kindex m U
12964@pindex calc-units-simplify-mode
12965The @kbd{m U} (@code{calc-units-simplify-mode}) mode does units
12966simplification; it applies the command @kbd{u s}
12967(@code{calc-simplify-units}), which in turn
12968is a superset of @kbd{a s}. In this mode, variable names which
12969are identifiable as unit names (like @samp{mm} for ``millimeters'')
a4231b04 12970are simplified with their unit definitions in mind.
d7b8e6c6
EZ
12971
12972A common technique is to set the simplification mode down to the lowest
12973amount of simplification you will allow to be applied automatically, then
12974use manual commands like @kbd{a s} and @kbd{c c} (@code{calc-clean}) to
12975perform higher types of simplifications on demand. @xref{Algebraic
07ce2eb3 12976Definitions}, for another sample use of No-Simplification mode.
d7b8e6c6
EZ
12977
12978@node Declarations, Display Modes, Simplification Modes, Mode Settings
12979@section Declarations
12980
12981@noindent
12982A @dfn{declaration} is a statement you make that promises you will
12983use a certain variable or function in a restricted way. This may
12984give Calc the freedom to do things that it couldn't do if it had to
12985take the fully general situation into account.
12986
12987@menu
12988* Declaration Basics::
12989* Kinds of Declarations::
12990* Functions for Declarations::
12991@end menu
12992
12993@node Declaration Basics, Kinds of Declarations, Declarations, Declarations
12994@subsection Declaration Basics
12995
12996@noindent
12997@kindex s d
12998@pindex calc-declare-variable
12999The @kbd{s d} (@code{calc-declare-variable}) command is the easiest
13000way to make a declaration for a variable. This command prompts for
13001the variable name, then prompts for the declaration. The default
13002at the declaration prompt is the previous declaration, if any.
13003You can edit this declaration, or press @kbd{C-k} to erase it and
13004type a new declaration. (Or, erase it and press @key{RET} to clear
13005the declaration, effectively ``undeclaring'' the variable.)
13006
13007A declaration is in general a vector of @dfn{type symbols} and
13008@dfn{range} values. If there is only one type symbol or range value,
13009you can write it directly rather than enclosing it in a vector.
5d67986c
RS
13010For example, @kbd{s d foo @key{RET} real @key{RET}} declares @code{foo} to
13011be a real number, and @kbd{s d bar @key{RET} [int, const, [1..6]] @key{RET}}
d7b8e6c6
EZ
13012declares @code{bar} to be a constant integer between 1 and 6.
13013(Actually, you can omit the outermost brackets and Calc will
5d67986c 13014provide them for you: @kbd{s d bar @key{RET} int, const, [1..6] @key{RET}}.)
d7b8e6c6
EZ
13015
13016@cindex @code{Decls} variable
13017@vindex Decls
13018Declarations in Calc are kept in a special variable called @code{Decls}.
13019This variable encodes the set of all outstanding declarations in
13020the form of a matrix. Each row has two elements: A variable or
13021vector of variables declared by that row, and the declaration
13022specifier as described above. You can use the @kbd{s D} command to
13023edit this variable if you wish to see all the declarations at once.
13024@xref{Operations on Variables}, for a description of this command
13025and the @kbd{s p} command that allows you to save your declarations
13026permanently if you wish.
13027
13028Items being declared can also be function calls. The arguments in
13029the call are ignored; the effect is to say that this function returns
13030values of the declared type for any valid arguments. The @kbd{s d}
13031command declares only variables, so if you wish to make a function
13032declaration you will have to edit the @code{Decls} matrix yourself.
13033
13034For example, the declaration matrix
13035
d7b8e6c6 13036@smallexample
5d67986c 13037@group
d7b8e6c6
EZ
13038[ [ foo, real ]
13039 [ [j, k, n], int ]
13040 [ f(1,2,3), [0 .. inf) ] ]
d7b8e6c6 13041@end group
5d67986c 13042@end smallexample
d7b8e6c6
EZ
13043
13044@noindent
13045declares that @code{foo} represents a real number, @code{j}, @code{k}
13046and @code{n} represent integers, and the function @code{f} always
13047returns a real number in the interval shown.
13048
13049@vindex All
13050If there is a declaration for the variable @code{All}, then that
13051declaration applies to all variables that are not otherwise declared.
13052It does not apply to function names. For example, using the row
13053@samp{[All, real]} says that all your variables are real unless they
13054are explicitly declared without @code{real} in some other row.
13055The @kbd{s d} command declares @code{All} if you give a blank
13056response to the variable-name prompt.
13057
13058@node Kinds of Declarations, Functions for Declarations, Declaration Basics, Declarations
13059@subsection Kinds of Declarations
13060
13061@noindent
13062The type-specifier part of a declaration (that is, the second prompt
13063in the @kbd{s d} command) can be a type symbol, an interval, or a
13064vector consisting of zero or more type symbols followed by zero or
13065more intervals or numbers that represent the set of possible values
13066for the variable.
13067
d7b8e6c6 13068@smallexample
5d67986c 13069@group
d7b8e6c6
EZ
13070[ [ a, [1, 2, 3, 4, 5] ]
13071 [ b, [1 .. 5] ]
13072 [ c, [int, 1 .. 5] ] ]
d7b8e6c6 13073@end group
5d67986c 13074@end smallexample
d7b8e6c6
EZ
13075
13076Here @code{a} is declared to contain one of the five integers shown;
13077@code{b} is any number in the interval from 1 to 5 (any real number
13078since we haven't specified), and @code{c} is any integer in that
13079interval. Thus the declarations for @code{a} and @code{c} are
13080nearly equivalent (see below).
13081
13082The type-specifier can be the empty vector @samp{[]} to say that
13083nothing is known about a given variable's value. This is the same
13084as not declaring the variable at all except that it overrides any
13085@code{All} declaration which would otherwise apply.
13086
13087The initial value of @code{Decls} is the empty vector @samp{[]}.
13088If @code{Decls} has no stored value or if the value stored in it
13089is not valid, it is ignored and there are no declarations as far
13090as Calc is concerned. (The @kbd{s d} command will replace such a
13091malformed value with a fresh empty matrix, @samp{[]}, before recording
13092the new declaration.) Unrecognized type symbols are ignored.
13093
13094The following type symbols describe what sorts of numbers will be
13095stored in a variable:
13096
13097@table @code
13098@item int
13099Integers.
13100@item numint
13101Numerical integers. (Integers or integer-valued floats.)
13102@item frac
13103Fractions. (Rational numbers which are not integers.)
13104@item rat
13105Rational numbers. (Either integers or fractions.)
13106@item float
13107Floating-point numbers.
13108@item real
13109Real numbers. (Integers, fractions, or floats. Actually,
13110intervals and error forms with real components also count as
13111reals here.)
13112@item pos
13113Positive real numbers. (Strictly greater than zero.)
13114@item nonneg
13115Nonnegative real numbers. (Greater than or equal to zero.)
13116@item number
13117Numbers. (Real or complex.)
13118@end table
13119
13120Calc uses this information to determine when certain simplifications
13121of formulas are safe. For example, @samp{(x^y)^z} cannot be
13122simplified to @samp{x^(y z)} in general; for example,
8e04863e 13123@samp{((-3)^2)^1:2} is 3, but @samp{(-3)^(2*1:2) = (-3)^1} is @mathit{-3}.
d7b8e6c6
EZ
13124However, this simplification @emph{is} safe if @code{z} is known
13125to be an integer, or if @code{x} is known to be a nonnegative
13126real number. If you have given declarations that allow Calc to
13127deduce either of these facts, Calc will perform this simplification
13128of the formula.
13129
13130Calc can apply a certain amount of logic when using declarations.
13131For example, @samp{(x^y)^(2n+1)} will be simplified if @code{n}
13132has been declared @code{int}; Calc knows that an integer times an
13133integer, plus an integer, must always be an integer. (In fact,
13134Calc would simplify @samp{(-x)^(2n+1)} to @samp{-(x^(2n+1))} since
13135it is able to determine that @samp{2n+1} must be an odd integer.)
13136
13137Similarly, @samp{(abs(x)^y)^z} will be simplified to @samp{abs(x)^(y z)}
13138because Calc knows that the @code{abs} function always returns a
13139nonnegative real. If you had a @code{myabs} function that also had
13140this property, you could get Calc to recognize it by adding the row
13141@samp{[myabs(), nonneg]} to the @code{Decls} matrix.
13142
13143One instance of this simplification is @samp{sqrt(x^2)} (since the
13144@code{sqrt} function is effectively a one-half power). Normally
13145Calc leaves this formula alone. After the command
5d67986c
RS
13146@kbd{s d x @key{RET} real @key{RET}}, however, it can simplify the formula to
13147@samp{abs(x)}. And after @kbd{s d x @key{RET} nonneg @key{RET}}, Calc can
d7b8e6c6
EZ
13148simplify this formula all the way to @samp{x}.
13149
13150If there are any intervals or real numbers in the type specifier,
13151they comprise the set of possible values that the variable or
13152function being declared can have. In particular, the type symbol
13153@code{real} is effectively the same as the range @samp{[-inf .. inf]}
13154(note that infinity is included in the range of possible values);
13155@code{pos} is the same as @samp{(0 .. inf]}, and @code{nonneg} is
13156the same as @samp{[0 .. inf]}. Saying @samp{[real, [-5 .. 5]]} is
13157redundant because the fact that the variable is real can be
13158deduced just from the interval, but @samp{[int, [-5 .. 5]]} and
13159@samp{[rat, [-5 .. 5]]} are useful combinations.
13160
13161Note that the vector of intervals or numbers is in the same format
13162used by Calc's set-manipulation commands. @xref{Set Operations}.
13163
13164The type specifier @samp{[1, 2, 3]} is equivalent to
13165@samp{[numint, 1, 2, 3]}, @emph{not} to @samp{[int, 1, 2, 3]}.
13166In other words, the range of possible values means only that
13167the variable's value must be numerically equal to a number in
13168that range, but not that it must be equal in type as well.
13169Calc's set operations act the same way; @samp{in(2, [1., 2., 3.])}
13170and @samp{in(1.5, [1:2, 3:2, 5:2])} both report ``true.''
13171
13172If you use a conflicting combination of type specifiers, the
13173results are unpredictable. An example is @samp{[pos, [0 .. 5]]},
13174where the interval does not lie in the range described by the
13175type symbol.
13176
13177``Real'' declarations mostly affect simplifications involving powers
13178like the one described above. Another case where they are used
13179is in the @kbd{a P} command which returns a list of all roots of a
13180polynomial; if the variable has been declared real, only the real
13181roots (if any) will be included in the list.
13182
13183``Integer'' declarations are used for simplifications which are valid
13184only when certain values are integers (such as @samp{(x^y)^z}
13185shown above).
13186
13187Another command that makes use of declarations is @kbd{a s}, when
13188simplifying equations and inequalities. It will cancel @code{x}
13189from both sides of @samp{a x = b x} only if it is sure @code{x}
13190is non-zero, say, because it has a @code{pos} declaration.
13191To declare specifically that @code{x} is real and non-zero,
13192use @samp{[[-inf .. 0), (0 .. inf]]}. (There is no way in the
13193current notation to say that @code{x} is nonzero but not necessarily
13194real.) The @kbd{a e} command does ``unsafe'' simplifications,
13195including cancelling @samp{x} from the equation when @samp{x} is
13196not known to be nonzero.
13197
13198Another set of type symbols distinguish between scalars and vectors.
13199
13200@table @code
13201@item scalar
13202The value is not a vector.
13203@item vector
13204The value is a vector.
13205@item matrix
13206The value is a matrix (a rectangular vector of vectors).
13207@end table
13208
13209These type symbols can be combined with the other type symbols
13210described above; @samp{[int, matrix]} describes an object which
13211is a matrix of integers.
13212
13213Scalar/vector declarations are used to determine whether certain
13214algebraic operations are safe. For example, @samp{[a, b, c] + x}
13215is normally not simplified to @samp{[a + x, b + x, c + x]}, but
13216it will be if @code{x} has been declared @code{scalar}. On the
13217other hand, multiplication is usually assumed to be commutative,
13218but the terms in @samp{x y} will never be exchanged if both @code{x}
13219and @code{y} are known to be vectors or matrices. (Calc currently
13220never distinguishes between @code{vector} and @code{matrix}
13221declarations.)
13222
07ce2eb3
JB
13223@xref{Matrix Mode}, for a discussion of Matrix mode and
13224Scalar mode, which are similar to declaring @samp{[All, matrix]}
d7b8e6c6
EZ
13225or @samp{[All, scalar]} but much more convenient.
13226
13227One more type symbol that is recognized is used with the @kbd{H a d}
13228command for taking total derivatives of a formula. @xref{Calculus}.
13229
13230@table @code
13231@item const
13232The value is a constant with respect to other variables.
13233@end table
13234
13235Calc does not check the declarations for a variable when you store
8e04863e 13236a value in it. However, storing @mathit{-3.5} in a variable that has
d7b8e6c6 13237been declared @code{pos}, @code{int}, or @code{matrix} may have
a4231b04
JB
13238unexpected effects; Calc may evaluate @samp{sqrt(x^2)} to @expr{3.5}
13239if it substitutes the value first, or to @expr{-3.5} if @code{x}
d7b8e6c6
EZ
13240was declared @code{pos} and the formula @samp{sqrt(x^2)} is
13241simplified to @samp{x} before the value is substituted. Before
13242using a variable for a new purpose, it is best to use @kbd{s d}
13243or @kbd{s D} to check to make sure you don't still have an old
13244declaration for the variable that will conflict with its new meaning.
13245
13246@node Functions for Declarations, , Kinds of Declarations, Declarations
13247@subsection Functions for Declarations
13248
13249@noindent
13250Calc has a set of functions for accessing the current declarations
13251in a convenient manner. These functions return 1 if the argument
13252can be shown to have the specified property, or 0 if the argument
13253can be shown @emph{not} to have that property; otherwise they are
13254left unevaluated. These functions are suitable for use with rewrite
13255rules (@pxref{Conditional Rewrite Rules}) or programming constructs
13256(@pxref{Conditionals in Macros}). They can be entered only using
13257algebraic notation. @xref{Logical Operations}, for functions
13258that perform other tests not related to declarations.
13259
13260For example, @samp{dint(17)} returns 1 because 17 is an integer, as
13261do @samp{dint(n)} and @samp{dint(2 n - 3)} if @code{n} has been declared
13262@code{int}, but @samp{dint(2.5)} and @samp{dint(n + 0.5)} return 0.
13263Calc consults knowledge of its own built-in functions as well as your
13264own declarations: @samp{dint(floor(x))} returns 1.
13265
5d67986c
RS
13266@ignore
13267@starindex
13268@end ignore
d7b8e6c6 13269@tindex dint
5d67986c
RS
13270@ignore
13271@starindex
13272@end ignore
d7b8e6c6 13273@tindex dnumint
5d67986c
RS
13274@ignore
13275@starindex
13276@end ignore
d7b8e6c6
EZ
13277@tindex dnatnum
13278The @code{dint} function checks if its argument is an integer.
13279The @code{dnatnum} function checks if its argument is a natural
13280number, i.e., a nonnegative integer. The @code{dnumint} function
13281checks if its argument is numerically an integer, i.e., either an
13282integer or an integer-valued float. Note that these and the other
13283data type functions also accept vectors or matrices composed of
13284suitable elements, and that real infinities @samp{inf} and @samp{-inf}
13285are considered to be integers for the purposes of these functions.
13286
5d67986c
RS
13287@ignore
13288@starindex
13289@end ignore
d7b8e6c6
EZ
13290@tindex drat
13291The @code{drat} function checks if its argument is rational, i.e.,
13292an integer or fraction. Infinities count as rational, but intervals
13293and error forms do not.
13294
5d67986c
RS
13295@ignore
13296@starindex
13297@end ignore
d7b8e6c6
EZ
13298@tindex dreal
13299The @code{dreal} function checks if its argument is real. This
13300includes integers, fractions, floats, real error forms, and intervals.
13301
5d67986c
RS
13302@ignore
13303@starindex
13304@end ignore
d7b8e6c6
EZ
13305@tindex dimag
13306The @code{dimag} function checks if its argument is imaginary,
a4231b04 13307i.e., is mathematically equal to a real number times @expr{i}.
d7b8e6c6 13308
5d67986c
RS
13309@ignore
13310@starindex
13311@end ignore
d7b8e6c6 13312@tindex dpos
5d67986c
RS
13313@ignore
13314@starindex
13315@end ignore
d7b8e6c6 13316@tindex dneg
5d67986c
RS
13317@ignore
13318@starindex
13319@end ignore
d7b8e6c6
EZ
13320@tindex dnonneg
13321The @code{dpos} function checks for positive (but nonzero) reals.
13322The @code{dneg} function checks for negative reals. The @code{dnonneg}
13323function checks for nonnegative reals, i.e., reals greater than or
13324equal to zero. Note that the @kbd{a s} command can simplify an
a4231b04 13325expression like @expr{x > 0} to 1 or 0 using @code{dpos}, and that
d7b8e6c6
EZ
13326@kbd{a s} is effectively applied to all conditions in rewrite rules,
13327so the actual functions @code{dpos}, @code{dneg}, and @code{dnonneg}
13328are rarely necessary.
13329
5d67986c
RS
13330@ignore
13331@starindex
13332@end ignore
d7b8e6c6
EZ
13333@tindex dnonzero
13334The @code{dnonzero} function checks that its argument is nonzero.
13335This includes all nonzero real or complex numbers, all intervals that
13336do not include zero, all nonzero modulo forms, vectors all of whose
13337elements are nonzero, and variables or formulas whose values can be
13338deduced to be nonzero. It does not include error forms, since they
13339represent values which could be anything including zero. (This is
13340also the set of objects considered ``true'' in conditional contexts.)
13341
5d67986c
RS
13342@ignore
13343@starindex
13344@end ignore
d7b8e6c6 13345@tindex deven
5d67986c
RS
13346@ignore
13347@starindex
13348@end ignore
d7b8e6c6
EZ
13349@tindex dodd
13350The @code{deven} function returns 1 if its argument is known to be
13351an even integer (or integer-valued float); it returns 0 if its argument
13352is known not to be even (because it is known to be odd or a non-integer).
13353The @kbd{a s} command uses this to simplify a test of the form
13354@samp{x % 2 = 0}. There is also an analogous @code{dodd} function.
13355
5d67986c
RS
13356@ignore
13357@starindex
13358@end ignore
d7b8e6c6
EZ
13359@tindex drange
13360The @code{drange} function returns a set (an interval or a vector
13361of intervals and/or numbers; @pxref{Set Operations}) that describes
13362the set of possible values of its argument. If the argument is
13363a variable or a function with a declaration, the range is copied
13364from the declaration. Otherwise, the possible signs of the
13365expression are determined using a method similar to @code{dpos},
13366etc., and a suitable set like @samp{[0 .. inf]} is returned. If
13367the expression is not provably real, the @code{drange} function
13368remains unevaluated.
13369
5d67986c
RS
13370@ignore
13371@starindex
13372@end ignore
d7b8e6c6
EZ
13373@tindex dscalar
13374The @code{dscalar} function returns 1 if its argument is provably
13375scalar, or 0 if its argument is provably non-scalar. It is left
07ce2eb3
JB
13376unevaluated if this cannot be determined. (If Matrix mode or Scalar
13377mode is in effect, this function returns 1 or 0, respectively,
d7b8e6c6
EZ
13378if it has no other information.) When Calc interprets a condition
13379(say, in a rewrite rule) it considers an unevaluated formula to be
13380``false.'' Thus, @samp{dscalar(a)} is ``true'' only if @code{a} is
13381provably scalar, and @samp{!dscalar(a)} is ``true'' only if @code{a}
13382is provably non-scalar; both are ``false'' if there is insufficient
13383information to tell.
13384
13385@node Display Modes, Language Modes, Declarations, Mode Settings
13386@section Display Modes
13387
13388@noindent
13389The commands in this section are two-key sequences beginning with the
13390@kbd{d} prefix. The @kbd{d l} (@code{calc-line-numbering}) and @kbd{d b}
13391(@code{calc-line-breaking}) commands are described elsewhere;
13392@pxref{Stack Basics} and @pxref{Normal Language Modes}, respectively.
13393Display formats for vectors and matrices are also covered elsewhere;
a4231b04 13394@pxref{Vector and Matrix Formats}.
d7b8e6c6
EZ
13395
13396One thing all display modes have in common is their treatment of the
13397@kbd{H} prefix. This prefix causes any mode command that would normally
13398refresh the stack to leave the stack display alone. The word ``Dirty''
13399will appear in the mode line when Calc thinks the stack display may not
13400reflect the latest mode settings.
13401
5d67986c 13402@kindex d @key{RET}
d7b8e6c6 13403@pindex calc-refresh-top
5d67986c 13404The @kbd{d @key{RET}} (@code{calc-refresh-top}) command reformats the
d7b8e6c6
EZ
13405top stack entry according to all the current modes. Positive prefix
13406arguments reformat the top @var{n} entries; negative prefix arguments
13407reformat the specified entry, and a prefix of zero is equivalent to
5d67986c
RS
13408@kbd{d @key{SPC}} (@code{calc-refresh}), which reformats the entire stack.
13409For example, @kbd{H d s M-2 d @key{RET}} changes to scientific notation
d7b8e6c6
EZ
13410but reformats only the top two stack entries in the new mode.
13411
13412The @kbd{I} prefix has another effect on the display modes. The mode
13413is set only temporarily; the top stack entry is reformatted according
13414to that mode, then the original mode setting is restored. In other
5d67986c 13415words, @kbd{I d s} is equivalent to @kbd{H d s d @key{RET} H d (@var{old mode})}.
d7b8e6c6
EZ
13416
13417@menu
13418* Radix Modes::
13419* Grouping Digits::
13420* Float Formats::
13421* Complex Formats::
13422* Fraction Formats::
13423* HMS Formats::
13424* Date Formats::
13425* Truncating the Stack::
13426* Justification::
13427* Labels::
13428@end menu
13429
13430@node Radix Modes, Grouping Digits, Display Modes, Display Modes
13431@subsection Radix Modes
13432
13433@noindent
13434@cindex Radix display
13435@cindex Non-decimal numbers
13436@cindex Decimal and non-decimal numbers
13437Calc normally displays numbers in decimal (@dfn{base-10} or @dfn{radix-10})
13438notation. Calc can actually display in any radix from two (binary) to 36.
13439When the radix is above 10, the letters @code{A} to @code{Z} are used as
13440digits. When entering such a number, letter keys are interpreted as
13441potential digits rather than terminating numeric entry mode.
13442
13443@kindex d 2
13444@kindex d 8
13445@kindex d 6
13446@kindex d 0
13447@cindex Hexadecimal integers
13448@cindex Octal integers
13449The key sequences @kbd{d 2}, @kbd{d 8}, @kbd{d 6}, and @kbd{d 0} select
13450binary, octal, hexadecimal, and decimal as the current display radix,
13451respectively. Numbers can always be entered in any radix, though the
13452current radix is used as a default if you press @kbd{#} without any initial
13453digits. A number entered without a @kbd{#} is @emph{always} interpreted
a4231b04 13454as decimal.
d7b8e6c6
EZ
13455
13456@kindex d r
13457@pindex calc-radix
13458To set the radix generally, use @kbd{d r} (@code{calc-radix}) and enter
13459an integer from 2 to 36. You can specify the radix as a numeric prefix
13460argument; otherwise you will be prompted for it.
13461
13462@kindex d z
13463@pindex calc-leading-zeros
13464@cindex Leading zeros
13465Integers normally are displayed with however many digits are necessary to
13466represent the integer and no more. The @kbd{d z} (@code{calc-leading-zeros})
13467command causes integers to be padded out with leading zeros according to the
13468current binary word size. (@xref{Binary Functions}, for a discussion of
a4231b04
JB
13469word size.) If the absolute value of the word size is @expr{w}, all integers
13470are displayed with at least enough digits to represent
8e04863e 13471@texline @math{2^w-1}
a4231b04
JB
13472@infoline @expr{(2^w)-1}
13473in the current radix. (Larger integers will still be displayed in their
13474entirety.)
d7b8e6c6
EZ
13475
13476@node Grouping Digits, Float Formats, Radix Modes, Display Modes
13477@subsection Grouping Digits
13478
13479@noindent
13480@kindex d g
13481@pindex calc-group-digits
13482@cindex Grouping digits
13483@cindex Digit grouping
13484Long numbers can be hard to read if they have too many digits. For
13485example, the factorial of 30 is 33 digits long! Press @kbd{d g}
07ce2eb3 13486(@code{calc-group-digits}) to enable @dfn{Grouping} mode, in which digits
d7b8e6c6
EZ
13487are displayed in clumps of 3 or 4 (depending on the current radix)
13488separated by commas.
13489
13490The @kbd{d g} command toggles grouping on and off.
029b2a44 13491With a numeric prefix of 0, this command displays the current state of
d7b8e6c6 13492the grouping flag; with an argument of minus one it disables grouping;
a4231b04 13493with a positive argument @expr{N} it enables grouping on every @expr{N}
d7b8e6c6 13494digits. For floating-point numbers, grouping normally occurs only
a4231b04
JB
13495before the decimal point. A negative prefix argument @expr{-N} enables
13496grouping every @expr{N} digits both before and after the decimal point.
d7b8e6c6
EZ
13497
13498@kindex d ,
13499@pindex calc-group-char
13500The @kbd{d ,} (@code{calc-group-char}) command allows you to choose any
13501character as the grouping separator. The default is the comma character.
13502If you find it difficult to read vectors of large integers grouped with
13503commas, you may wish to use spaces or some other character instead.
13504This command takes the next character you type, whatever it is, and
13505uses it as the digit separator. As a special case, @kbd{d , \} selects
13506@samp{\,} (@TeX{}'s thin-space symbol) as the digit separator.
13507
13508Please note that grouped numbers will not generally be parsed correctly
13509if re-read in textual form, say by the use of @kbd{M-# y} and @kbd{M-# g}.
13510(@xref{Kill and Yank}, for details on these commands.) One exception is
13511the @samp{\,} separator, which doesn't interfere with parsing because it
13512is ignored by @TeX{} language mode.
13513
13514@node Float Formats, Complex Formats, Grouping Digits, Display Modes
13515@subsection Float Formats
13516
13517@noindent
13518Floating-point quantities are normally displayed in standard decimal
13519form, with scientific notation used if the exponent is especially high
13520or low. All significant digits are normally displayed. The commands
13521in this section allow you to choose among several alternative display
13522formats for floats.
13523
13524@kindex d n
13525@pindex calc-normal-notation
13526The @kbd{d n} (@code{calc-normal-notation}) command selects the normal
13527display format. All significant figures in a number are displayed.
13528With a positive numeric prefix, numbers are rounded if necessary to
13529that number of significant digits. With a negative numerix prefix,
13530the specified number of significant digits less than the current
13531precision is used. (Thus @kbd{C-u -2 d n} displays 10 digits if the
13532current precision is 12.)
13533
13534@kindex d f
13535@pindex calc-fix-notation
13536The @kbd{d f} (@code{calc-fix-notation}) command selects fixed-point
13537notation. The numeric argument is the number of digits after the
13538decimal point, zero or more. This format will relax into scientific
13539notation if a nonzero number would otherwise have been rounded all the
13540way to zero. Specifying a negative number of digits is the same as
13541for a positive number, except that small nonzero numbers will be rounded
13542to zero rather than switching to scientific notation.
13543
13544@kindex d s
13545@pindex calc-sci-notation
13546@cindex Scientific notation, display of
13547The @kbd{d s} (@code{calc-sci-notation}) command selects scientific
13548notation. A positive argument sets the number of significant figures
13549displayed, of which one will be before and the rest after the decimal
13550point. A negative argument works the same as for @kbd{d n} format.
13551The default is to display all significant digits.
13552
13553@kindex d e
13554@pindex calc-eng-notation
13555@cindex Engineering notation, display of
13556The @kbd{d e} (@code{calc-eng-notation}) command selects engineering
13557notation. This is similar to scientific notation except that the
13558exponent is rounded down to a multiple of three, with from one to three
13559digits before the decimal point. An optional numeric prefix sets the
13560number of significant digits to display, as for @kbd{d s}.
13561
13562It is important to distinguish between the current @emph{precision} and
13563the current @emph{display format}. After the commands @kbd{C-u 10 p}
13564and @kbd{C-u 6 d n} the Calculator computes all results to ten
13565significant figures but displays only six. (In fact, intermediate
13566calculations are often carried to one or two more significant figures,
13567but values placed on the stack will be rounded down to ten figures.)
13568Numbers are never actually rounded to the display precision for storage,
13569except by commands like @kbd{C-k} and @kbd{M-# y} which operate on the
13570actual displayed text in the Calculator buffer.
13571
13572@kindex d .
13573@pindex calc-point-char
13574The @kbd{d .} (@code{calc-point-char}) command selects the character used
13575as a decimal point. Normally this is a period; users in some countries
13576may wish to change this to a comma. Note that this is only a display
13577style; on entry, periods must always be used to denote floating-point
13578numbers, and commas to separate elements in a list.
13579
13580@node Complex Formats, Fraction Formats, Float Formats, Display Modes
13581@subsection Complex Formats
13582
13583@noindent
13584@kindex d c
13585@pindex calc-complex-notation
13586There are three supported notations for complex numbers in rectangular
13587form. The default is as a pair of real numbers enclosed in parentheses
13588and separated by a comma: @samp{(a,b)}. The @kbd{d c}
a4231b04 13589(@code{calc-complex-notation}) command selects this style.
d7b8e6c6
EZ
13590
13591@kindex d i
13592@pindex calc-i-notation
13593@kindex d j
13594@pindex calc-j-notation
13595The other notations are @kbd{d i} (@code{calc-i-notation}), in which
13596numbers are displayed in @samp{a+bi} form, and @kbd{d j}
13597(@code{calc-j-notation}) which displays the form @samp{a+bj} preferred
a4231b04 13598in some disciplines.
d7b8e6c6
EZ
13599
13600@cindex @code{i} variable
13601@vindex i
13602Complex numbers are normally entered in @samp{(a,b)} format.
13603If you enter @samp{2+3i} as an algebraic formula, it will be stored as
13604the formula @samp{2 + 3 * i}. However, if you use @kbd{=} to evaluate
13605this formula and you have not changed the variable @samp{i}, the @samp{i}
13606will be interpreted as @samp{(0,1)} and the formula will be simplified
13607to @samp{(2,3)}. Other commands (like @code{calc-sin}) will @emph{not}
13608interpret the formula @samp{2 + 3 * i} as a complex number.
a4231b04 13609@xref{Variables}, under ``special constants.''
d7b8e6c6
EZ
13610
13611@node Fraction Formats, HMS Formats, Complex Formats, Display Modes
13612@subsection Fraction Formats
13613
13614@noindent
13615@kindex d o
13616@pindex calc-over-notation
13617Display of fractional numbers is controlled by the @kbd{d o}
13618(@code{calc-over-notation}) command. By default, a number like
13619eight thirds is displayed in the form @samp{8:3}. The @kbd{d o} command
13620prompts for a one- or two-character format. If you give one character,
13621that character is used as the fraction separator. Common separators are
13622@samp{:} and @samp{/}. (During input of numbers, the @kbd{:} key must be
13623used regardless of the display format; in particular, the @kbd{/} is used
13624for RPN-style division, @emph{not} for entering fractions.)
13625
13626If you give two characters, fractions use ``integer-plus-fractional-part''
13627notation. For example, the format @samp{+/} would display eight thirds
13628as @samp{2+2/3}. If two colons are present in a number being entered,
13629the number is interpreted in this form (so that the entries @kbd{2:2:3}
13630and @kbd{8:3} are equivalent).
13631
13632It is also possible to follow the one- or two-character format with
13633a number. For example: @samp{:10} or @samp{+/3}. In this case,
13634Calc adjusts all fractions that are displayed to have the specified
13635denominator, if possible. Otherwise it adjusts the denominator to
13636be a multiple of the specified value. For example, in @samp{:6} mode
a4231b04
JB
13637the fraction @expr{1:6} will be unaffected, but @expr{2:3} will be
13638displayed as @expr{4:6}, @expr{1:2} will be displayed as @expr{3:6},
13639and @expr{1:8} will be displayed as @expr{3:24}. Integers are also
13640affected by this mode: 3 is displayed as @expr{18:6}. Note that the
d7b8e6c6 13641format @samp{:1} writes fractions the same as @samp{:}, but it writes
a4231b04 13642integers as @expr{n:1}.
d7b8e6c6
EZ
13643
13644The fraction format does not affect the way fractions or integers are
13645stored, only the way they appear on the screen. The fraction format
13646never affects floats.
13647
13648@node HMS Formats, Date Formats, Fraction Formats, Display Modes
13649@subsection HMS Formats
13650
13651@noindent
13652@kindex d h
13653@pindex calc-hms-notation
13654The @kbd{d h} (@code{calc-hms-notation}) command controls the display of
13655HMS (hours-minutes-seconds) forms. It prompts for a string which
13656consists basically of an ``hours'' marker, optional punctuation, a
13657``minutes'' marker, more optional punctuation, and a ``seconds'' marker.
13658Punctuation is zero or more spaces, commas, or semicolons. The hours
13659marker is one or more non-punctuation characters. The minutes and
13660seconds markers must be single non-punctuation characters.
13661
13662The default HMS format is @samp{@@ ' "}, producing HMS values of the form
13663@samp{23@@ 30' 15.75"}. The format @samp{deg, ms} would display this same
13664value as @samp{23deg, 30m15.75s}. During numeric entry, the @kbd{h} or @kbd{o}
13665keys are recognized as synonyms for @kbd{@@} regardless of display format.
13666The @kbd{m} and @kbd{s} keys are recognized as synonyms for @kbd{'} and
13667@kbd{"}, respectively, but only if an @kbd{@@} (or @kbd{h} or @kbd{o}) has
13668already been typed; otherwise, they have their usual meanings
13669(@kbd{m-} prefix and @kbd{s-} prefix). Thus, @kbd{5 "}, @kbd{0 @@ 5 "}, and
13670@kbd{0 h 5 s} are some of the ways to enter the quantity ``five seconds.''
13671The @kbd{'} key is recognized as ``minutes'' only if @kbd{@@} (or @kbd{h} or
13672@kbd{o}) has already been pressed; otherwise it means to switch to algebraic
13673entry.
13674
13675@node Date Formats, Truncating the Stack, HMS Formats, Display Modes
13676@subsection Date Formats
13677
13678@noindent
13679@kindex d d
13680@pindex calc-date-notation
13681The @kbd{d d} (@code{calc-date-notation}) command controls the display
13682of date forms (@pxref{Date Forms}). It prompts for a string which
13683contains letters that represent the various parts of a date and time.
13684To show which parts should be omitted when the form represents a pure
13685date with no time, parts of the string can be enclosed in @samp{< >}
13686marks. If you don't include @samp{< >} markers in the format, Calc
13687guesses at which parts, if any, should be omitted when formatting
13688pure dates.
13689
13690The default format is: @samp{<H:mm:SSpp >Www Mmm D, YYYY}.
13691An example string in this format is @samp{3:32pm Wed Jan 9, 1991}.
13692If you enter a blank format string, this default format is
13693reestablished.
13694
13695Calc uses @samp{< >} notation for nameless functions as well as for
13696dates. @xref{Specifying Operators}. To avoid confusion with nameless
13697functions, your date formats should avoid using the @samp{#} character.
13698
13699@menu
13700* Date Formatting Codes::
13701* Free-Form Dates::
13702* Standard Date Formats::
13703@end menu
13704
13705@node Date Formatting Codes, Free-Form Dates, Date Formats, Date Formats
13706@subsubsection Date Formatting Codes
13707
13708@noindent
13709When displaying a date, the current date format is used. All
13710characters except for letters and @samp{<} and @samp{>} are
13711copied literally when dates are formatted. The portion between
13712@samp{< >} markers is omitted for pure dates, or included for
13713date/time forms. Letters are interpreted according to the table
13714below.
13715
13716When dates are read in during algebraic entry, Calc first tries to
13717match the input string to the current format either with or without
13718the time part. The punctuation characters (including spaces) must
13719match exactly; letter fields must correspond to suitable text in
13720the input. If this doesn't work, Calc checks if the input is a
13721simple number; if so, the number is interpreted as a number of days
13722since Jan 1, 1 AD. Otherwise, Calc tries a much more relaxed and
13723flexible algorithm which is described in the next section.
13724
13725Weekday names are ignored during reading.
13726
13727Two-digit year numbers are interpreted as lying in the range
13728from 1941 to 2039. Years outside that range are always
13729entered and displayed in full. Year numbers with a leading
13730@samp{+} sign are always interpreted exactly, allowing the
13731entry and display of the years 1 through 99 AD.
13732
13733Here is a complete list of the formatting codes for dates:
13734
13735@table @asis
13736@item Y
13737Year: ``91'' for 1991, ``7'' for 2007, ``+23'' for 23 AD.
13738@item YY
13739Year: ``91'' for 1991, ``07'' for 2007, ``+23'' for 23 AD.
13740@item BY
13741Year: ``91'' for 1991, `` 7'' for 2007, ``+23'' for 23 AD.
13742@item YYY
13743Year: ``1991'' for 1991, ``23'' for 23 AD.
13744@item YYYY
13745Year: ``1991'' for 1991, ``+23'' for 23 AD.
13746@item aa
13747Year: ``ad'' or blank.
13748@item AA
13749Year: ``AD'' or blank.
13750@item aaa
13751Year: ``ad '' or blank. (Note trailing space.)
13752@item AAA
13753Year: ``AD '' or blank.
13754@item aaaa
13755Year: ``a.d.'' or blank.
13756@item AAAA
13757Year: ``A.D.'' or blank.
13758@item bb
13759Year: ``bc'' or blank.
13760@item BB
13761Year: ``BC'' or blank.
13762@item bbb
13763Year: `` bc'' or blank. (Note leading space.)
13764@item BBB
13765Year: `` BC'' or blank.
13766@item bbbb
13767Year: ``b.c.'' or blank.
13768@item BBBB
13769Year: ``B.C.'' or blank.
13770@item M
13771Month: ``8'' for August.
13772@item MM
13773Month: ``08'' for August.
13774@item BM
13775Month: `` 8'' for August.
13776@item MMM
13777Month: ``AUG'' for August.
13778@item Mmm
13779Month: ``Aug'' for August.
13780@item mmm
13781Month: ``aug'' for August.
13782@item MMMM
13783Month: ``AUGUST'' for August.
13784@item Mmmm
13785Month: ``August'' for August.
13786@item D
13787Day: ``7'' for 7th day of month.
13788@item DD
13789Day: ``07'' for 7th day of month.
13790@item BD
13791Day: `` 7'' for 7th day of month.
13792@item W
13793Weekday: ``0'' for Sunday, ``6'' for Saturday.
13794@item WWW
13795Weekday: ``SUN'' for Sunday.
13796@item Www
13797Weekday: ``Sun'' for Sunday.
13798@item www
13799Weekday: ``sun'' for Sunday.
13800@item WWWW
13801Weekday: ``SUNDAY'' for Sunday.
13802@item Wwww
13803Weekday: ``Sunday'' for Sunday.
13804@item d
13805Day of year: ``34'' for Feb. 3.
13806@item ddd
13807Day of year: ``034'' for Feb. 3.
13808@item bdd
13809Day of year: `` 34'' for Feb. 3.
13810@item h
13811Hour: ``5'' for 5 AM; ``17'' for 5 PM.
13812@item hh
13813Hour: ``05'' for 5 AM; ``17'' for 5 PM.
13814@item bh
13815Hour: `` 5'' for 5 AM; ``17'' for 5 PM.
13816@item H
13817Hour: ``5'' for 5 AM and 5 PM.
13818@item HH
13819Hour: ``05'' for 5 AM and 5 PM.
13820@item BH
13821Hour: `` 5'' for 5 AM and 5 PM.
13822@item p
13823AM/PM: ``a'' or ``p''.
13824@item P
13825AM/PM: ``A'' or ``P''.
13826@item pp
13827AM/PM: ``am'' or ``pm''.
13828@item PP
13829AM/PM: ``AM'' or ``PM''.
13830@item pppp
13831AM/PM: ``a.m.'' or ``p.m.''.
13832@item PPPP
13833AM/PM: ``A.M.'' or ``P.M.''.
13834@item m
13835Minutes: ``7'' for 7.
13836@item mm
13837Minutes: ``07'' for 7.
13838@item bm
13839Minutes: `` 7'' for 7.
13840@item s
13841Seconds: ``7'' for 7; ``7.23'' for 7.23.
13842@item ss
13843Seconds: ``07'' for 7; ``07.23'' for 7.23.
13844@item bs
13845Seconds: `` 7'' for 7; `` 7.23'' for 7.23.
13846@item SS
13847Optional seconds: ``07'' for 7; blank for 0.
13848@item BS
13849Optional seconds: `` 7'' for 7; blank for 0.
13850@item N
13851Numeric date/time: ``726842.25'' for 6:00am Wed Jan 9, 1991.
13852@item n
13853Numeric date: ``726842'' for any time on Wed Jan 9, 1991.
13854@item J
13855Julian date/time: ``2448265.75'' for 6:00am Wed Jan 9, 1991.
13856@item j
13857Julian date: ``2448266'' for any time on Wed Jan 9, 1991.
13858@item U
13859Unix time: ``663400800'' for 6:00am Wed Jan 9, 1991.
13860@item X
13861Brackets suppression. An ``X'' at the front of the format
13862causes the surrounding @w{@samp{< >}} delimiters to be omitted
13863when formatting dates. Note that the brackets are still
13864required for algebraic entry.
13865@end table
13866
13867If ``SS'' or ``BS'' (optional seconds) is preceded by a colon, the
13868colon is also omitted if the seconds part is zero.
13869
13870If ``bb,'' ``bbb'' or ``bbbb'' or their upper-case equivalents
13871appear in the format, then negative year numbers are displayed
13872without a minus sign. Note that ``aa'' and ``bb'' are mutually
13873exclusive. Some typical usages would be @samp{YYYY AABB};
13874@samp{AAAYYYYBBB}; @samp{YYYYBBB}.
13875
13876The formats ``YY,'' ``YYYY,'' ``MM,'' ``DD,'' ``ddd,'' ``hh,'' ``HH,''
13877``mm,'' ``ss,'' and ``SS'' actually match any number of digits during
13878reading unless several of these codes are strung together with no
13879punctuation in between, in which case the input must have exactly as
13880many digits as there are letters in the format.
13881
13882The ``j,'' ``J,'' and ``U'' formats do not make any time zone
13883adjustment. They effectively use @samp{julian(x,0)} and
13884@samp{unixtime(x,0)} to make the conversion; @pxref{Date Arithmetic}.
13885
13886@node Free-Form Dates, Standard Date Formats, Date Formatting Codes, Date Formats
13887@subsubsection Free-Form Dates
13888
13889@noindent
13890When reading a date form during algebraic entry, Calc falls back
13891on the algorithm described here if the input does not exactly
13892match the current date format. This algorithm generally
13893``does the right thing'' and you don't have to worry about it,
13894but it is described here in full detail for the curious.
13895
13896Calc does not distinguish between upper- and lower-case letters
13897while interpreting dates.
13898
13899First, the time portion, if present, is located somewhere in the
13900text and then removed. The remaining text is then interpreted as
13901the date.
13902
13903A time is of the form @samp{hh:mm:ss}, possibly with the seconds
13904part omitted and possibly with an AM/PM indicator added to indicate
1390512-hour time. If the AM/PM is present, the minutes may also be
13906omitted. The AM/PM part may be any of the words @samp{am},
13907@samp{pm}, @samp{noon}, or @samp{midnight}; each of these may be
13908abbreviated to one letter, and the alternate forms @samp{a.m.},
13909@samp{p.m.}, and @samp{mid} are also understood. Obviously
13910@samp{noon} and @samp{midnight} are allowed only on 12:00:00.
13911The words @samp{noon}, @samp{mid}, and @samp{midnight} are also
13912recognized with no number attached.
13913
13914If there is no AM/PM indicator, the time is interpreted in 24-hour
13915format.
13916
13917To read the date portion, all words and numbers are isolated
13918from the string; other characters are ignored. All words must
13919be either month names or day-of-week names (the latter of which
13920are ignored). Names can be written in full or as three-letter
13921abbreviations.
13922
13923Large numbers, or numbers with @samp{+} or @samp{-} signs,
13924are interpreted as years. If one of the other numbers is
13925greater than 12, then that must be the day and the remaining
13926number in the input is therefore the month. Otherwise, Calc
13927assumes the month, day and year are in the same order that they
13928appear in the current date format. If the year is omitted, the
13929current year is taken from the system clock.
13930
13931If there are too many or too few numbers, or any unrecognizable
13932words, then the input is rejected.
13933
13934If there are any large numbers (of five digits or more) other than
13935the year, they are ignored on the assumption that they are something
13936like Julian dates that were included along with the traditional
13937date components when the date was formatted.
13938
13939One of the words @samp{ad}, @samp{a.d.}, @samp{bc}, or @samp{b.c.}
13940may optionally be used; the latter two are equivalent to a
13941minus sign on the year value.
13942
13943If you always enter a four-digit year, and use a name instead
13944of a number for the month, there is no danger of ambiguity.
13945
13946@node Standard Date Formats, , Free-Form Dates, Date Formats
13947@subsubsection Standard Date Formats
13948
13949@noindent
13950There are actually ten standard date formats, numbered 0 through 9.
13951Entering a blank line at the @kbd{d d} command's prompt gives
13952you format number 1, Calc's usual format. You can enter any digit
13953to select the other formats.
13954
13955To create your own standard date formats, give a numeric prefix
13956argument from 0 to 9 to the @w{@kbd{d d}} command. The format you
13957enter will be recorded as the new standard format of that
13958number, as well as becoming the new current date format.
13959You can save your formats permanently with the @w{@kbd{m m}}
13960command (@pxref{Mode Settings}).
13961
13962@table @asis
13963@item 0
13964@samp{N} (Numerical format)
13965@item 1
13966@samp{<H:mm:SSpp >Www Mmm D, YYYY} (American format)
13967@item 2
13968@samp{D Mmm YYYY<, h:mm:SS>} (European format)
13969@item 3
13970@samp{Www Mmm BD< hh:mm:ss> YYYY} (Unix written date format)
13971@item 4
13972@samp{M/D/Y< H:mm:SSpp>} (American slashed format)
13973@item 5
13974@samp{D.M.Y< h:mm:SS>} (European dotted format)
13975@item 6
13976@samp{M-D-Y< H:mm:SSpp>} (American dashed format)
13977@item 7
13978@samp{D-M-Y< h:mm:SS>} (European dashed format)
13979@item 8
13980@samp{j<, h:mm:ss>} (Julian day plus time)
13981@item 9
13982@samp{YYddd< hh:mm:ss>} (Year-day format)
13983@end table
13984
13985@node Truncating the Stack, Justification, Date Formats, Display Modes
13986@subsection Truncating the Stack
13987
13988@noindent
13989@kindex d t
13990@pindex calc-truncate-stack
13991@cindex Truncating the stack
13992@cindex Narrowing the stack
13993The @kbd{d t} (@code{calc-truncate-stack}) command moves the @samp{.}@:
13994line that marks the top-of-stack up or down in the Calculator buffer.
13995The number right above that line is considered to the be at the top of
13996the stack. Any numbers below that line are ``hidden'' from all stack
029b2a44
JB
13997operations (although still visible to the user). This is similar to the
13998Emacs ``narrowing'' feature, except that the values below the @samp{.}
13999are @emph{visible}, just temporarily frozen. This feature allows you to
14000keep several independent calculations running at once in different parts
14001of the stack, or to apply a certain command to an element buried deep in
14002the stack.
d7b8e6c6
EZ
14003
14004Pressing @kbd{d t} by itself moves the @samp{.} to the line the cursor
14005is on. Thus, this line and all those below it become hidden. To un-hide
14006these lines, move down to the end of the buffer and press @w{@kbd{d t}}.
a4231b04
JB
14007With a positive numeric prefix argument @expr{n}, @kbd{d t} hides the
14008bottom @expr{n} values in the buffer. With a negative argument, it hides
14009all but the top @expr{n} values. With an argument of zero, it hides zero
14010values, i.e., moves the @samp{.} all the way down to the bottom.
d7b8e6c6
EZ
14011
14012@kindex d [
14013@pindex calc-truncate-up
14014@kindex d ]
14015@pindex calc-truncate-down
14016The @kbd{d [} (@code{calc-truncate-up}) and @kbd{d ]}
14017(@code{calc-truncate-down}) commands move the @samp{.} up or down one
a4231b04 14018line at a time (or several lines with a prefix argument).
d7b8e6c6
EZ
14019
14020@node Justification, Labels, Truncating the Stack, Display Modes
14021@subsection Justification
14022
14023@noindent
14024@kindex d <
14025@pindex calc-left-justify
14026@kindex d =
14027@pindex calc-center-justify
14028@kindex d >
14029@pindex calc-right-justify
14030Values on the stack are normally left-justified in the window. You can
14031control this arrangement by typing @kbd{d <} (@code{calc-left-justify}),
14032@kbd{d >} (@code{calc-right-justify}), or @kbd{d =}
07ce2eb3 14033(@code{calc-center-justify}). For example, in Right-Justification mode,
d7b8e6c6 14034stack entries are displayed flush-right against the right edge of the
a4231b04 14035window.
d7b8e6c6
EZ
14036
14037If you change the width of the Calculator window you may have to type
5d67986c 14038@kbd{d @key{SPC}} (@code{calc-refresh}) to re-align right-justified or centered
d7b8e6c6
EZ
14039text.
14040
14041Right-justification is especially useful together with fixed-point
14042notation (see @code{d f}; @code{calc-fix-notation}). With these modes
14043together, the decimal points on numbers will always line up.
14044
14045With a numeric prefix argument, the justification commands give you
14046a little extra control over the display. The argument specifies the
14047horizontal ``origin'' of a display line. It is also possible to
14048specify a maximum line width using the @kbd{d b} command (@pxref{Normal
14049Language Modes}). For reference, the precise rules for formatting and
14050breaking lines are given below. Notice that the interaction between
14051origin and line width is slightly different in each justification
14052mode.
14053
07ce2eb3 14054In Left-Justified mode, the line is indented by a number of spaces
d7b8e6c6
EZ
14055given by the origin (default zero). If the result is longer than the
14056maximum line width, if given, or too wide to fit in the Calc window
14057otherwise, then it is broken into lines which will fit; each broken
14058line is indented to the origin.
14059
07ce2eb3 14060In Right-Justified mode, lines are shifted right so that the rightmost
d7b8e6c6
EZ
14061character is just before the origin, or just before the current
14062window width if no origin was specified. If the line is too long
14063for this, then it is broken; the current line width is used, if
14064specified, or else the origin is used as a width if that is
14065specified, or else the line is broken to fit in the window.
14066
07ce2eb3 14067In Centering mode, the origin is the column number of the center of
d7b8e6c6
EZ
14068each stack entry. If a line width is specified, lines will not be
14069allowed to go past that width; Calc will either indent less or
14070break the lines if necessary. If no origin is specified, half the
14071line width or Calc window width is used.
14072
14073Note that, in each case, if line numbering is enabled the display
14074is indented an additional four spaces to make room for the line
14075number. The width of the line number is taken into account when
14076positioning according to the current Calc window width, but not
14077when positioning by explicit origins and widths. In the latter
14078case, the display is formatted as specified, and then uniformly
14079shifted over four spaces to fit the line numbers.
14080
14081@node Labels, , Justification, Display Modes
14082@subsection Labels
14083
14084@noindent
14085@kindex d @{
14086@pindex calc-left-label
14087The @kbd{d @{} (@code{calc-left-label}) command prompts for a string,
14088then displays that string to the left of every stack entry. If the
14089entries are left-justified (@pxref{Justification}), then they will
14090appear immediately after the label (unless you specified an origin
14091greater than the length of the label). If the entries are centered
14092or right-justified, the label appears on the far left and does not
14093affect the horizontal position of the stack entry.
14094
14095Give a blank string (with @kbd{d @{ @key{RET}}) to turn the label off.
14096
14097@kindex d @}
14098@pindex calc-right-label
14099The @kbd{d @}} (@code{calc-right-label}) command similarly adds a
14100label on the righthand side. It does not affect positioning of
14101the stack entries unless they are right-justified. Also, if both
07ce2eb3 14102a line width and an origin are given in Right-Justified mode, the
d7b8e6c6
EZ
14103stack entry is justified to the origin and the righthand label is
14104justified to the line width.
14105
14106One application of labels would be to add equation numbers to
14107formulas you are manipulating in Calc and then copying into a
07ce2eb3 14108document (possibly using Embedded mode). The equations would
d7b8e6c6
EZ
14109typically be centered, and the equation numbers would be on the
14110left or right as you prefer.
14111
14112@node Language Modes, Modes Variable, Display Modes, Mode Settings
14113@section Language Modes
14114
14115@noindent
14116The commands in this section change Calc to use a different notation for
14117entry and display of formulas, corresponding to the conventions of some
053bc283 14118other common language such as Pascal or La@TeX{}. Objects displayed on the
d7b8e6c6
EZ
14119stack or yanked from the Calculator to an editing buffer will be formatted
14120in the current language; objects entered in algebraic entry or yanked from
14121another buffer will be interpreted according to the current language.
14122
14123The current language has no effect on things written to or read from the
14124trail buffer, nor does it affect numeric entry. Only algebraic entry is
14125affected. You can make even algebraic entry ignore the current language
14126and use the standard notation by giving a numeric prefix, e.g., @kbd{C-u '}.
14127
14128For example, suppose the formula @samp{2*a[1] + atan(a[2])} occurs in a C
14129program; elsewhere in the program you need the derivatives of this formula
14130with respect to @samp{a[1]} and @samp{a[2]}. First, type @kbd{d C}
14131to switch to C notation. Now use @code{C-u M-# g} to grab the formula
14132into the Calculator, @kbd{a d a[1] @key{RET}} to differentiate with respect
14133to the first variable, and @kbd{M-# y} to yank the formula for the derivative
14134back into your C program. Press @kbd{U} to undo the differentiation and
14135repeat with @kbd{a d a[2] @key{RET}} for the other derivative.
14136
14137Without being switched into C mode first, Calc would have misinterpreted
14138the brackets in @samp{a[1]} and @samp{a[2]}, would not have known that
14139@code{atan} was equivalent to Calc's built-in @code{arctan} function,
14140and would have written the formula back with notations (like implicit
2cbd16b9 14141multiplication) which would not have been valid for a C program.
d7b8e6c6 14142
053bc283 14143As another example, suppose you are maintaining a C program and a La@TeX{}
d7b8e6c6 14144document, each of which needs a copy of the same formula. You can grab the
053bc283
JB
14145formula from the program in C mode, switch to La@TeX{} mode, and yank the
14146formula into the document in La@TeX{} math-mode format.
d7b8e6c6
EZ
14147
14148Language modes are selected by typing the letter @kbd{d} followed by a
14149shifted letter key.
14150
14151@menu
14152* Normal Language Modes::
14153* C FORTRAN Pascal::
8ed713c6 14154* TeX and LaTeX Language Modes::
d7b8e6c6
EZ
14155* Eqn Language Mode::
14156* Mathematica Language Mode::
14157* Maple Language Mode::
14158* Compositions::
14159* Syntax Tables::
14160@end menu
14161
14162@node Normal Language Modes, C FORTRAN Pascal, Language Modes, Language Modes
14163@subsection Normal Language Modes
14164
14165@noindent
14166@kindex d N
14167@pindex calc-normal-language
14168The @kbd{d N} (@code{calc-normal-language}) command selects the usual
14169notation for Calc formulas, as described in the rest of this manual.
14170Matrices are displayed in a multi-line tabular format, but all other
14171objects are written in linear form, as they would be typed from the
14172keyboard.
14173
14174@kindex d O
14175@pindex calc-flat-language
14176@cindex Matrix display
14177The @kbd{d O} (@code{calc-flat-language}) command selects a language
14178identical with the normal one, except that matrices are written in
14179one-line form along with everything else. In some applications this
14180form may be more suitable for yanking data into other buffers.
14181
14182@kindex d b
14183@pindex calc-line-breaking
14184@cindex Line breaking
14185@cindex Breaking up long lines
14186Even in one-line mode, long formulas or vectors will still be split
14187across multiple lines if they exceed the width of the Calculator window.
14188The @kbd{d b} (@code{calc-line-breaking}) command turns this line-breaking
14189feature on and off. (It works independently of the current language.)
14190If you give a numeric prefix argument of five or greater to the @kbd{d b}
14191command, that argument will specify the line width used when breaking
14192long lines.
14193
14194@kindex d B
14195@pindex calc-big-language
14196The @kbd{d B} (@code{calc-big-language}) command selects a language
14197which uses textual approximations to various mathematical notations,
14198such as powers, quotients, and square roots:
14199
14200@example
14201 ____________
14202 | a + 1 2
14203 | ----- + c
14204\| b
14205@end example
14206
14207@noindent
14208in place of @samp{sqrt((a+1)/b + c^2)}.
14209
07ce2eb3 14210Subscripts like @samp{a_i} are displayed as actual subscripts in Big
d7b8e6c6
EZ
14211mode. Double subscripts, @samp{a_i_j} (@samp{subscr(subscr(a, i), j)})
14212are displayed as @samp{a} with subscripts separated by commas:
14213@samp{i, j}. They must still be entered in the usual underscore
14214notation.
14215
14216One slight ambiguity of Big notation is that
14217
14218@example
14219 3
14220- -
14221 4
14222@end example
14223
14224@noindent
a4231b04 14225can represent either the negative rational number @expr{-3:4}, or the
d7b8e6c6
EZ
14226actual expression @samp{-(3/4)}; but the latter formula would normally
14227never be displayed because it would immediately be evaluated to
a4231b04 14228@expr{-3:4} or @expr{-0.75}, so this ambiguity is not a problem in
d7b8e6c6
EZ
14229typical use.
14230
14231Non-decimal numbers are displayed with subscripts. Thus there is no
14232way to tell the difference between @samp{16#C2} and @samp{C2_16},
14233though generally you will know which interpretation is correct.
14234Logarithms @samp{log(x,b)} and @samp{log10(x)} also use subscripts
14235in Big mode.
14236
14237In Big mode, stack entries often take up several lines. To aid
14238readability, stack entries are separated by a blank line in this mode.
14239You may find it useful to expand the Calc window's height using
14240@kbd{C-x ^} (@code{enlarge-window}) or to make the Calc window the only
14241one on the screen with @kbd{C-x 1} (@code{delete-other-windows}).
14242
14243Long lines are currently not rearranged to fit the window width in
14244Big mode, so you may need to use the @kbd{<} and @kbd{>} keys
14245to scroll across a wide formula. For really big formulas, you may
14246even need to use @kbd{@{} and @kbd{@}} to scroll up and down.
14247
14248@kindex d U
14249@pindex calc-unformatted-language
14250The @kbd{d U} (@code{calc-unformatted-language}) command altogether disables
14251the use of operator notation in formulas. In this mode, the formula
14252shown above would be displayed:
14253
14254@example
14255sqrt(add(div(add(a, 1), b), pow(c, 2)))
14256@end example
14257
14258These four modes differ only in display format, not in the format
14259expected for algebraic entry. The standard Calc operators work in
14260all four modes, and unformatted notation works in any language mode
14261(except that Mathematica mode expects square brackets instead of
14262parentheses).
14263
8ed713c6 14264@node C FORTRAN Pascal, TeX and LaTeX Language Modes, Normal Language Modes, Language Modes
d7b8e6c6
EZ
14265@subsection C, FORTRAN, and Pascal Modes
14266
14267@noindent
14268@kindex d C
14269@pindex calc-c-language
14270@cindex C language
14271The @kbd{d C} (@code{calc-c-language}) command selects the conventions
14272of the C language for display and entry of formulas. This differs from
14273the normal language mode in a variety of (mostly minor) ways. In
14274particular, C language operators and operator precedences are used in
14275place of Calc's usual ones. For example, @samp{a^b} means @samp{xor(a,b)}
14276in C mode; a value raised to a power is written as a function call,
14277@samp{pow(a,b)}.
14278
14279In C mode, vectors and matrices use curly braces instead of brackets.
14280Octal and hexadecimal values are written with leading @samp{0} or @samp{0x}
14281rather than using the @samp{#} symbol. Array subscripting is
14282translated into @code{subscr} calls, so that @samp{a[i]} in C
07ce2eb3 14283mode is the same as @samp{a_i} in Normal mode. Assignments
d7b8e6c6
EZ
14284turn into the @code{assign} function, which Calc normally displays
14285using the @samp{:=} symbol.
14286
4f38ed98 14287The variables @code{pi} and @code{e} would be displayed @samp{pi}
07ce2eb3 14288and @samp{e} in Normal mode, but in C mode they are displayed as
d7b8e6c6
EZ
14289@samp{M_PI} and @samp{M_E}, corresponding to the names of constants
14290typically provided in the @file{<math.h>} header. Functions whose
14291names are different in C are translated automatically for entry and
14292display purposes. For example, entering @samp{asin(x)} will push the
14293formula @samp{arcsin(x)} onto the stack; this formula will be displayed
14294as @samp{asin(x)} as long as C mode is in effect.
14295
14296@kindex d P
14297@pindex calc-pascal-language
14298@cindex Pascal language
14299The @kbd{d P} (@code{calc-pascal-language}) command selects Pascal
14300conventions. Like C mode, Pascal mode interprets array brackets and uses
14301a different table of operators. Hexadecimal numbers are entered and
14302displayed with a preceding dollar sign. (Thus the regular meaning of
14303@kbd{$2} during algebraic entry does not work in Pascal mode, though
14304@kbd{$} (and @kbd{$$}, etc.) not followed by digits works the same as
14305always.) No special provisions are made for other non-decimal numbers,
14306vectors, and so on, since there is no universally accepted standard way
14307of handling these in Pascal.
14308
14309@kindex d F
14310@pindex calc-fortran-language
14311@cindex FORTRAN language
14312The @kbd{d F} (@code{calc-fortran-language}) command selects FORTRAN
14313conventions. Various function names are transformed into FORTRAN
14314equivalents. Vectors are written as @samp{/1, 2, 3/}, and may be
14315entered this way or using square brackets. Since FORTRAN uses round
14316parentheses for both function calls and array subscripts, Calc displays
14317both in the same way; @samp{a(i)} is interpreted as a function call
14318upon reading, and subscripts must be entered as @samp{subscr(a, i)}.
14319Also, if the variable @code{a} has been declared to have type
14320@code{vector} or @code{matrix} then @samp{a(i)} will be parsed as a
14321subscript. (@xref{Declarations}.) Usually it doesn't matter, though;
14322if you enter the subscript expression @samp{a(i)} and Calc interprets
14323it as a function call, you'll never know the difference unless you
14324switch to another language mode or replace @code{a} with an actual
14325vector (or unless @code{a} happens to be the name of a built-in
14326function!).
14327
14328Underscores are allowed in variable and function names in all of these
14329language modes. The underscore here is equivalent to the @samp{#} in
07ce2eb3 14330Normal mode, or to hyphens in the underlying Emacs Lisp variable names.
d7b8e6c6
EZ
14331
14332FORTRAN and Pascal modes normally do not adjust the case of letters in
14333formulas. Most built-in Calc names use lower-case letters. If you use a
14334positive numeric prefix argument with @kbd{d P} or @kbd{d F}, these
14335modes will use upper-case letters exclusively for display, and will
14336convert to lower-case on input. With a negative prefix, these modes
14337convert to lower-case for display and input.
14338
8ed713c6 14339@node TeX and LaTeX Language Modes, Eqn Language Mode, C FORTRAN Pascal, Language Modes
053bc283 14340@subsection @TeX{} and La@TeX{} Language Modes
d7b8e6c6
EZ
14341
14342@noindent
14343@kindex d T
14344@pindex calc-tex-language
14345@cindex TeX language
8ed713c6
JB
14346@kindex d L
14347@pindex calc-latex-language
14348@cindex LaTeX language
d7b8e6c6 14349The @kbd{d T} (@code{calc-tex-language}) command selects the conventions
8ed713c6
JB
14350of ``math mode'' in Donald Knuth's @TeX{} typesetting language,
14351and the @kbd{d L} (@code{calc-latex-language}) command selects the
053bc283
JB
14352conventions of ``math mode'' in La@TeX{}, a typesetting language that
14353uses @TeX{} as its formatting engine. Calc's La@TeX{} language mode can
14354read any formula that the @TeX{} language mode can, although La@TeX{}
8ed713c6
JB
14355mode may display it differently.
14356
14357Formulas are entered and displayed in the appropriate notation;
14358@texline @math{\sin(a/b)}
14359@infoline @expr{sin(a/b)}
14360will appear as @samp{\sin\left( a \over b \right)} in @TeX{} mode and
053bc283 14361@samp{\sin\left(\frac@{a@}@{b@}\right)} in La@TeX{} mode.
8ed713c6 14362Math formulas are often enclosed by @samp{$ $} signs in @TeX{} and
053bc283 14363La@TeX{}; these should be omitted when interfacing with Calc. To Calc,
8ed713c6
JB
14364the @samp{$} sign has the same meaning it always does in algebraic
14365formulas (a reference to an existing entry on the stack).
d7b8e6c6
EZ
14366
14367Complex numbers are displayed as in @samp{3 + 4i}. Fractions and
8ed713c6 14368quotients are written using @code{\over} in @TeX{} mode (as in
053bc283 14369@code{@{a \over b@}}) and @code{\frac} in La@TeX{} mode (as in
8ed713c6
JB
14370@code{\frac@{a@}@{b@}}); binomial coefficients are written with
14371@code{\choose} in @TeX{} mode (as in @code{@{a \choose b@}}) and
053bc283 14372@code{\binom} in La@TeX{} mode (as in @code{\binom@{a@}@{b@}}).
8ed713c6
JB
14373Interval forms are written with @code{\ldots}, and error forms are
14374written with @code{\pm}. Absolute values are written as in
14375@samp{|x + 1|}, and the floor and ceiling functions are written with
14376@code{\lfloor}, @code{\rfloor}, etc. The words @code{\left} and
053bc283 14377@code{\right} are ignored when reading formulas in @TeX{} and La@TeX{}
8ed713c6
JB
14378modes. Both @code{inf} and @code{uinf} are written as @code{\infty};
14379when read, @code{\infty} always translates to @code{inf}.
d7b8e6c6
EZ
14380
14381Function calls are written the usual way, with the function name followed
8ed713c6 14382by the arguments in parentheses. However, functions for which @TeX{}
053bc283 14383and La@TeX{} have special names (like @code{\sin}) will use curly braces
8ed713c6
JB
14384instead of parentheses for very simple arguments. During input, curly
14385braces and parentheses work equally well for grouping, but when the
14386document is formatted the curly braces will be invisible. Thus the
14387printed result is
8e04863e 14388@texline @math{\sin{2 x}}
a4231b04
JB
14389@infoline @expr{sin 2x}
14390but
8e04863e 14391@texline @math{\sin(2 + x)}.
a4231b04 14392@infoline @expr{sin(2 + x)}.
d7b8e6c6 14393
053bc283 14394Function and variable names not treated specially by @TeX{} and La@TeX{}
8ed713c6
JB
14395are simply written out as-is, which will cause them to come out in
14396italic letters in the printed document. If you invoke @kbd{d T} or
14397@kbd{d L} with a positive numeric prefix argument, names of more than
14398one character will instead be enclosed in a protective commands that
14399will prevent them from being typeset in the math italics; they will be
14400written @samp{\hbox@{@var{name}@}} in @TeX{} mode and
053bc283 14401@samp{\text@{@var{name}@}} in La@TeX{} mode. The
8ed713c6
JB
14402@samp{\hbox@{ @}} and @samp{\text@{ @}} notations are ignored during
14403reading. If you use a negative prefix argument, such function names are
14404written @samp{\@var{name}}, and function names that begin with @code{\} during
14405reading have the @code{\} removed. (Note that in this mode, long
14406variable names are still written with @code{\hbox} or @code{\text}.
14407However, you can always make an actual variable name like @code{\bar} in
14408any @TeX{} mode.)
d7b8e6c6
EZ
14409
14410During reading, text of the form @samp{\matrix@{ ...@: @}} is replaced
14411by @samp{[ ...@: ]}. The same also applies to @code{\pmatrix} and
053bc283 14412@code{\bmatrix}. In La@TeX{} mode this also applies to
8ed713c6
JB
14413@samp{\begin@{matrix@} ... \end@{matrix@}},
14414@samp{\begin@{bmatrix@} ... \end@{bmatrix@}},
14415@samp{\begin@{pmatrix@} ... \end@{pmatrix@}}, as well as
14416@samp{\begin@{smallmatrix@} ... \end@{smallmatrix@}}.
14417The symbol @samp{&} is interpreted as a comma,
d7b8e6c6
EZ
14418and the symbols @samp{\cr} and @samp{\\} are interpreted as semicolons.
14419During output, matrices are displayed in @samp{\matrix@{ a & b \\ c & d@}}
8ed713c6
JB
14420format in @TeX{} mode and in
14421@samp{\begin@{pmatrix@} a & b \\ c & d \end@{pmatrix@}} format in
053bc283 14422La@TeX{} mode; you may need to edit this afterwards to change to your
8ed713c6
JB
14423preferred matrix form. If you invoke @kbd{d T} or @kbd{d L} with an
14424argument of 2 or -2, then matrices will be displayed in two-dimensional
14425form, such as
14426
14427@example
14428\begin@{pmatrix@}
14429a & b \\
14430c & d
14431\end@{pmatrix@}
14432@end example
14433
14434@noindent
14435This may be convenient for isolated matrices, but could lead to
14436expressions being displayed like
14437
14438@example
14439\begin@{pmatrix@} \times x
14440a & b \\
14441c & d
14442\end@{pmatrix@}
14443@end example
14444
14445@noindent
053bc283 14446While this wouldn't bother Calc, it is incorrect La@TeX{}.
8ed713c6 14447(Similarly for @TeX{}.)
d7b8e6c6
EZ
14448
14449Accents like @code{\tilde} and @code{\bar} translate into function
14450calls internally (@samp{tilde(x)}, @samp{bar(x)}). The @code{\underline}
14451sequence is treated as an accent. The @code{\vec} accent corresponds
14452to the function name @code{Vec}, because @code{vec} is the name of
14453a built-in Calc function. The following table shows the accents
053bc283 14454in Calc, @TeX{}, La@TeX{} and @dfn{eqn} (described in the next section):
d7b8e6c6
EZ
14455
14456@iftex
14457@begingroup
14458@let@calcindexershow=@calcindexernoshow @c Suppress marginal notes
14459@let@calcindexersh=@calcindexernoshow
14460@end iftex
5d67986c
RS
14461@ignore
14462@starindex
14463@end ignore
d7b8e6c6 14464@tindex acute
5d67986c
RS
14465@ignore
14466@starindex
14467@end ignore
8ed713c6
JB
14468@tindex Acute
14469@ignore
14470@starindex
14471@end ignore
d7b8e6c6 14472@tindex bar
5d67986c
RS
14473@ignore
14474@starindex
14475@end ignore
8ed713c6
JB
14476@tindex Bar
14477@ignore
14478@starindex
14479@end ignore
d7b8e6c6 14480@tindex breve
5d67986c
RS
14481@ignore
14482@starindex
14483@end ignore
8ed713c6
JB
14484@tindex Breve
14485@ignore
14486@starindex
14487@end ignore
d7b8e6c6 14488@tindex check
5d67986c
RS
14489@ignore
14490@starindex
14491@end ignore
8ed713c6
JB
14492@tindex Check
14493@ignore
14494@starindex
14495@end ignore
14496@tindex dddot
14497@ignore
14498@starindex
14499@end ignore
14500@tindex ddddot
14501@ignore
14502@starindex
14503@end ignore
d7b8e6c6 14504@tindex dot
5d67986c
RS
14505@ignore
14506@starindex
14507@end ignore
8ed713c6
JB
14508@tindex Dot
14509@ignore
14510@starindex
14511@end ignore
d7b8e6c6 14512@tindex dotdot
5d67986c
RS
14513@ignore
14514@starindex
14515@end ignore
8ed713c6
JB
14516@tindex DotDot
14517@ignore
14518@starindex
14519@end ignore
d7b8e6c6 14520@tindex dyad
5d67986c
RS
14521@ignore
14522@starindex
14523@end ignore
d7b8e6c6 14524@tindex grave
5d67986c
RS
14525@ignore
14526@starindex
14527@end ignore
8ed713c6
JB
14528@tindex Grave
14529@ignore
14530@starindex
14531@end ignore
d7b8e6c6 14532@tindex hat
5d67986c
RS
14533@ignore
14534@starindex
14535@end ignore
8ed713c6
JB
14536@tindex Hat
14537@ignore
14538@starindex
14539@end ignore
d7b8e6c6 14540@tindex Prime
5d67986c
RS
14541@ignore
14542@starindex
14543@end ignore
d7b8e6c6 14544@tindex tilde
5d67986c
RS
14545@ignore
14546@starindex
14547@end ignore
8ed713c6
JB
14548@tindex Tilde
14549@ignore
14550@starindex
14551@end ignore
d7b8e6c6 14552@tindex under
5d67986c
RS
14553@ignore
14554@starindex
14555@end ignore
d7b8e6c6 14556@tindex Vec
8ed713c6
JB
14557@ignore
14558@starindex
14559@end ignore
14560@tindex VEC
d7b8e6c6
EZ
14561@iftex
14562@endgroup
14563@end iftex
14564@example
8ed713c6
JB
14565Calc TeX LaTeX eqn
14566---- --- ----- ---
14567acute \acute \acute
14568Acute \Acute
14569bar \bar \bar bar
14570Bar \Bar
14571breve \breve \breve
14572Breve \Breve
14573check \check \check
14574Check \Check
14575dddot \dddot
14576ddddot \ddddot
14577dot \dot \dot dot
14578Dot \Dot
14579dotdot \ddot \ddot dotdot
14580DotDot \Ddot
14581dyad dyad
14582grave \grave \grave
14583Grave \Grave
14584hat \hat \hat hat
14585Hat \Hat
14586Prime prime
14587tilde \tilde \tilde tilde
14588Tilde \Tilde
14589under \underline \underline under
14590Vec \vec \vec vec
14591VEC \Vec
d7b8e6c6
EZ
14592@end example
14593
14594The @samp{=>} (evaluates-to) operator appears as a @code{\to} symbol:
14595@samp{@{@var{a} \to @var{b}@}}. @TeX{} defines @code{\to} as an
14596alias for @code{\rightarrow}. However, if the @samp{=>} is the
14597top-level expression being formatted, a slightly different notation
14598is used: @samp{\evalto @var{a} \to @var{b}}. The @code{\evalto}
14599word is ignored by Calc's input routines, and is undefined in @TeX{}.
14600You will typically want to include one of the following definitions
14601at the top of a @TeX{} file that uses @code{\evalto}:
14602
14603@example
14604\def\evalto@{@}
14605\def\evalto#1\to@{@}
14606@end example
14607
14608The first definition formats evaluates-to operators in the usual
14609way. The second causes only the @var{b} part to appear in the
14610printed document; the @var{a} part and the arrow are hidden.
14611Another definition you may wish to use is @samp{\let\to=\Rightarrow}
14612which causes @code{\to} to appear more like Calc's @samp{=>} symbol.
14613@xref{Evaluates-To Operator}, for a discussion of @code{evalto}.
14614
14615The complete set of @TeX{} control sequences that are ignored during
14616reading is:
14617
14618@example
14619\hbox \mbox \text \left \right
14620\, \> \: \; \! \quad \qquad \hfil \hfill
14621\displaystyle \textstyle \dsize \tsize
14622\scriptstyle \scriptscriptstyle \ssize \ssize
14623\rm \bf \it \sl \roman \bold \italic \slanted
14624\cal \mit \Cal \Bbb \frak \goth
14625\evalto
14626@end example
14627
8ed713c6 14628Note that, because these symbols are ignored, reading a @TeX{} or
053bc283 14629La@TeX{} formula into Calc and writing it back out may lose spacing and
8ed713c6 14630font information.
d7b8e6c6
EZ
14631
14632Also, the ``discretionary multiplication sign'' @samp{\*} is read
14633the same as @samp{*}.
14634
14635@ifinfo
14636The @TeX{} version of this manual includes some printed examples at the
14637end of this section.
14638@end ifinfo
14639@iftex
14640Here are some examples of how various Calc formulas are formatted in @TeX{}:
14641
d7b8e6c6 14642@example
5d67986c 14643@group
d7b8e6c6
EZ
14644sin(a^2 / b_i)
14645\sin\left( {a^2 \over b_i} \right)
5d67986c 14646@end group
d7b8e6c6
EZ
14647@end example
14648@tex
d7b8e6c6
EZ
14649$$ \sin\left( a^2 \over b_i \right) $$
14650@end tex
14651@sp 1
d7b8e6c6 14652
d7b8e6c6 14653@example
5d67986c 14654@group
d7b8e6c6
EZ
14655[(3, 4), 3:4, 3 +/- 4, [3 .. inf)]
14656[3 + 4i, @{3 \over 4@}, 3 \pm 4, [3 \ldots \infty)]
5d67986c 14657@end group
d7b8e6c6
EZ
14658@end example
14659@tex
14660\turnoffactive
14661$$ [3 + 4i, {3 \over 4}, 3 \pm 4, [ 3 \ldots \infty)] $$
14662@end tex
14663@sp 1
d7b8e6c6 14664
d7b8e6c6 14665@example
5d67986c 14666@group
d7b8e6c6
EZ
14667[abs(a), abs(a / b), floor(a), ceil(a / b)]
14668[|a|, \left| a \over b \right|,
14669 \lfloor a \rfloor, \left\lceil a \over b \right\rceil]
5d67986c 14670@end group
d7b8e6c6
EZ
14671@end example
14672@tex
14673$$ [|a|, \left| a \over b \right|,
14674 \lfloor a \rfloor, \left\lceil a \over b \right\rceil] $$
14675@end tex
14676@sp 1
d7b8e6c6 14677
d7b8e6c6 14678@example
5d67986c 14679@group
d7b8e6c6
EZ
14680[sin(a), sin(2 a), sin(2 + a), sin(a / b)]
14681[\sin@{a@}, \sin@{2 a@}, \sin(2 + a),
14682 \sin\left( @{a \over b@} \right)]
5d67986c 14683@end group
d7b8e6c6
EZ
14684@end example
14685@tex
a4231b04 14686\turnoffactive
d7b8e6c6
EZ
14687$$ [\sin{a}, \sin{2 a}, \sin(2 + a), \sin\left( {a \over b} \right)] $$
14688@end tex
14689@sp 2
d7b8e6c6 14690
d7b8e6c6
EZ
14691First with plain @kbd{d T}, then with @kbd{C-u d T}, then finally with
14692@kbd{C-u - d T} (using the example definition
14693@samp{\def\foo#1@{\tilde F(#1)@}}:
14694
14695@example
5d67986c 14696@group
d7b8e6c6
EZ
14697[f(a), foo(bar), sin(pi)]
14698[f(a), foo(bar), \sin{\pi}]
14699[f(a), \hbox@{foo@}(\hbox@{bar@}), \sin@{\pi@}]
14700[f(a), \foo@{\hbox@{bar@}@}, \sin@{\pi@}]
5d67986c 14701@end group
d7b8e6c6
EZ
14702@end example
14703@tex
d7b8e6c6
EZ
14704$$ [f(a), foo(bar), \sin{\pi}] $$
14705$$ [f(a), \hbox{foo}(\hbox{bar}), \sin{\pi}] $$
14706$$ [f(a), \tilde F(\hbox{bar}), \sin{\pi}] $$
14707@end tex
14708@sp 2
d7b8e6c6 14709
d7b8e6c6
EZ
14710First with @samp{\def\evalto@{@}}, then with @samp{\def\evalto#1\to@{@}}:
14711
14712@example
5d67986c 14713@group
d7b8e6c6
EZ
147142 + 3 => 5
14715\evalto 2 + 3 \to 5
5d67986c 14716@end group
d7b8e6c6
EZ
14717@end example
14718@tex
14719\turnoffactive
14720$$ 2 + 3 \to 5 $$
14721$$ 5 $$
14722@end tex
14723@sp 2
d7b8e6c6 14724
d7b8e6c6
EZ
14725First with standard @code{\to}, then with @samp{\let\to\Rightarrow}:
14726
14727@example
5d67986c 14728@group
d7b8e6c6
EZ
14729[2 + 3 => 5, a / 2 => (b + c) / 2]
14730[@{2 + 3 \to 5@}, @{@{a \over 2@} \to @{b + c \over 2@}@}]
5d67986c 14731@end group
d7b8e6c6
EZ
14732@end example
14733@tex
14734\turnoffactive
14735$$ [{2 + 3 \to 5}, {{a \over 2} \to {b + c \over 2}}] $$
14736{\let\to\Rightarrow
14737$$ [{2 + 3 \to 5}, {{a \over 2} \to {b + c \over 2}}] $$}
14738@end tex
14739@sp 2
d7b8e6c6 14740
d7b8e6c6
EZ
14741Matrices normally, then changing @code{\matrix} to @code{\pmatrix}:
14742
14743@example
5d67986c 14744@group
d7b8e6c6
EZ
14745[ [ a / b, 0 ], [ 0, 2^(x + 1) ] ]
14746\matrix@{ @{a \over b@} & 0 \\ 0 & 2^@{(x + 1)@} @}
14747\pmatrix@{ @{a \over b@} & 0 \\ 0 & 2^@{(x + 1)@} @}
5d67986c 14748@end group
d7b8e6c6
EZ
14749@end example
14750@tex
14751\turnoffactive
14752$$ \matrix{ {a \over b} & 0 \cr 0 & 2^{(x + 1)} } $$
14753$$ \pmatrix{ {a \over b} & 0 \cr 0 & 2^{(x + 1)} } $$
14754@end tex
14755@sp 2
d7b8e6c6
EZ
14756@end iftex
14757
8ed713c6 14758@node Eqn Language Mode, Mathematica Language Mode, TeX and LaTeX Language Modes, Language Modes
d7b8e6c6
EZ
14759@subsection Eqn Language Mode
14760
14761@noindent
14762@kindex d E
14763@pindex calc-eqn-language
14764@dfn{Eqn} is another popular formatter for math formulas. It is
14765designed for use with the TROFF text formatter, and comes standard
14766with many versions of Unix. The @kbd{d E} (@code{calc-eqn-language})
14767command selects @dfn{eqn} notation.
14768
14769The @dfn{eqn} language's main idiosyncrasy is that whitespace plays
14770a significant part in the parsing of the language. For example,
14771@samp{sqrt x+1 + y} treats @samp{x+1} as the argument of the
14772@code{sqrt} operator. @dfn{Eqn} also understands more conventional
14773grouping using curly braces: @samp{sqrt@{x+1@} + y}. Braces are
14774required only when the argument contains spaces.
14775
14776In Calc's @dfn{eqn} mode, however, curly braces are required to
14777delimit arguments of operators like @code{sqrt}. The first of the
14778above examples would treat only the @samp{x} as the argument of
14779@code{sqrt}, and in fact @samp{sin x+1} would be interpreted as
14780@samp{sin * x + 1}, because @code{sin} is not a special operator
14781in the @dfn{eqn} language. If you always surround the argument
14782with curly braces, Calc will never misunderstand.
14783
14784Calc also understands parentheses as grouping characters. Another
14785peculiarity of @dfn{eqn}'s syntax makes it advisable to separate
14786words with spaces from any surrounding characters that aren't curly
14787braces, so Calc writes @samp{sin ( x + y )} in @dfn{eqn} mode.
14788(The spaces around @code{sin} are important to make @dfn{eqn}
14789recognize that @code{sin} should be typeset in a roman font, and
14790the spaces around @code{x} and @code{y} are a good idea just in
14791case the @dfn{eqn} document has defined special meanings for these
14792names, too.)
14793
14794Powers and subscripts are written with the @code{sub} and @code{sup}
14795operators, respectively. Note that the caret symbol @samp{^} is
14796treated the same as a space in @dfn{eqn} mode, as is the @samp{~}
14797symbol (these are used to introduce spaces of various widths into
14798the typeset output of @dfn{eqn}).
14799
053bc283 14800As in La@TeX{} mode, Calc's formatter omits parentheses around the
d7b8e6c6
EZ
14801arguments of functions like @code{ln} and @code{sin} if they are
14802``simple-looking''; in this case Calc surrounds the argument with
14803braces, separated by a @samp{~} from the function name: @samp{sin~@{x@}}.
14804
14805Font change codes (like @samp{roman @var{x}}) and positioning codes
14806(like @samp{~} and @samp{down @var{n} @var{x}}) are ignored by the
14807@dfn{eqn} reader. Also ignored are the words @code{left}, @code{right},
14808@code{mark}, and @code{lineup}. Quotation marks in @dfn{eqn} mode input
14809are treated the same as curly braces: @samp{sqrt "1+x"} is equivalent to
14810@samp{sqrt @{1+x@}}; this is only an approximation to the true meaning
14811of quotes in @dfn{eqn}, but it is good enough for most uses.
14812
14813Accent codes (@samp{@var{x} dot}) are handled by treating them as
8ed713c6
JB
14814function calls (@samp{dot(@var{x})}) internally.
14815@xref{TeX and LaTeX Language Modes}, for a table of these accent
14816functions. The @code{prime} accent is treated specially if it occurs on
14817a variable or function name: @samp{f prime prime @w{( x prime )}} is
14818stored internally as @samp{f'@w{'}(x')}. For example, taking the
14819derivative of @samp{f(2 x)} with @kbd{a d x} will produce @samp{2 f'(2
14820x)}, which @dfn{eqn} mode will display as @samp{2 f prime ( 2 x )}.
d7b8e6c6
EZ
14821
14822Assignments are written with the @samp{<-} (left-arrow) symbol,
14823and @code{evalto} operators are written with @samp{->} or
8ed713c6 14824@samp{evalto ... ->} (@pxref{TeX and LaTeX Language Modes}, for a discussion
d7b8e6c6
EZ
14825of this). The regular Calc symbols @samp{:=} and @samp{=>} are also
14826recognized for these operators during reading.
14827
14828Vectors in @dfn{eqn} mode use regular Calc square brackets, but
14829matrices are formatted as @samp{matrix @{ ccol @{ a above b @} ... @}}.
14830The words @code{lcol} and @code{rcol} are recognized as synonyms
14831for @code{ccol} during input, and are generated instead of @code{ccol}
14832if the matrix justification mode so specifies.
14833
14834@node Mathematica Language Mode, Maple Language Mode, Eqn Language Mode, Language Modes
14835@subsection Mathematica Language Mode
14836
14837@noindent
14838@kindex d M
14839@pindex calc-mathematica-language
14840@cindex Mathematica language
14841The @kbd{d M} (@code{calc-mathematica-language}) command selects the
87101b33 14842conventions of Mathematica. Notable differences in Mathematica mode
d7b8e6c6
EZ
14843are that the names of built-in functions are capitalized, and function
14844calls use square brackets instead of parentheses. Thus the Calc
14845formula @samp{sin(2 x)} is entered and displayed @w{@samp{Sin[2 x]}} in
14846Mathematica mode.
14847
14848Vectors and matrices use curly braces in Mathematica. Complex numbers
14849are written @samp{3 + 4 I}. The standard special constants in Calc are
14850written @code{Pi}, @code{E}, @code{I}, @code{GoldenRatio}, @code{EulerGamma},
14851@code{Infinity}, @code{ComplexInfinity}, and @code{Indeterminate} in
14852Mathematica mode.
14853Non-decimal numbers are written, e.g., @samp{16^^7fff}. Floating-point
14854numbers in scientific notation are written @samp{1.23*10.^3}.
a4231b04 14855Subscripts use double square brackets: @samp{a[[i]]}.
d7b8e6c6
EZ
14856
14857@node Maple Language Mode, Compositions, Mathematica Language Mode, Language Modes
14858@subsection Maple Language Mode
14859
14860@noindent
14861@kindex d W
14862@pindex calc-maple-language
14863@cindex Maple language
14864The @kbd{d W} (@code{calc-maple-language}) command selects the
87101b33 14865conventions of Maple.
d7b8e6c6
EZ
14866
14867Maple's language is much like C. Underscores are allowed in symbol
14868names; square brackets are used for subscripts; explicit @samp{*}s for
14869multiplications are required. Use either @samp{^} or @samp{**} to
14870denote powers.
14871
14872Maple uses square brackets for lists and curly braces for sets. Calc
14873interprets both notations as vectors, and displays vectors with square
14874brackets. This means Maple sets will be converted to lists when they
14875pass through Calc. As a special case, matrices are written as calls
14876to the function @code{matrix}, given a list of lists as the argument,
14877and can be read in this form or with all-capitals @code{MATRIX}.
14878
14879The Maple interval notation @samp{2 .. 3} has no surrounding brackets;
14880Calc reads @samp{2 .. 3} as the closed interval @samp{[2 .. 3]}, and
14881writes any kind of interval as @samp{2 .. 3}. This means you cannot
14882see the difference between an open and a closed interval while in
14883Maple display mode.
14884
14885Maple writes complex numbers as @samp{3 + 4*I}. Its special constants
14886are @code{Pi}, @code{E}, @code{I}, and @code{infinity} (all three of
14887@code{inf}, @code{uinf}, and @code{nan} display as @code{infinity}).
14888Floating-point numbers are written @samp{1.23*10.^3}.
14889
14890Among things not currently handled by Calc's Maple mode are the
14891various quote symbols, procedures and functional operators, and
14892inert (@samp{&}) operators.
14893
14894@node Compositions, Syntax Tables, Maple Language Mode, Language Modes
14895@subsection Compositions
14896
14897@noindent
14898@cindex Compositions
14899There are several @dfn{composition functions} which allow you to get
14900displays in a variety of formats similar to those in Big language
14901mode. Most of these functions do not evaluate to anything; they are
14902placeholders which are left in symbolic form by Calc's evaluator but
14903are recognized by Calc's display formatting routines.
14904
14905Two of these, @code{string} and @code{bstring}, are described elsewhere.
14906@xref{Strings}. For example, @samp{string("ABC")} is displayed as
14907@samp{ABC}. When viewed on the stack it will be indistinguishable from
14908the variable @code{ABC}, but internally it will be stored as
14909@samp{string([65, 66, 67])} and can still be manipulated this way; for
14910example, the selection and vector commands @kbd{j 1 v v j u} would
14911select the vector portion of this object and reverse the elements, then
14912deselect to reveal a string whose characters had been reversed.
14913
14914The composition functions do the same thing in all language modes
14915(although their components will of course be formatted in the current
14916language mode). The one exception is Unformatted mode (@kbd{d U}),
14917which does not give the composition functions any special treatment.
14918The functions are discussed here because of their relationship to
14919the language modes.
14920
14921@menu
14922* Composition Basics::
14923* Horizontal Compositions::
14924* Vertical Compositions::
14925* Other Compositions::
14926* Information about Compositions::
14927* User-Defined Compositions::
14928@end menu
14929
14930@node Composition Basics, Horizontal Compositions, Compositions, Compositions
14931@subsubsection Composition Basics
14932
14933@noindent
14934Compositions are generally formed by stacking formulas together
14935horizontally or vertically in various ways. Those formulas are
14936themselves compositions. @TeX{} users will find this analogous
14937to @TeX{}'s ``boxes.'' Each multi-line composition has a
14938@dfn{baseline}; horizontal compositions use the baselines to
14939decide how formulas should be positioned relative to one another.
14940For example, in the Big mode formula
14941
d7b8e6c6 14942@example
5d67986c 14943@group
d7b8e6c6
EZ
14944 2
14945 a + b
1494617 + ------
14947 c
d7b8e6c6 14948@end group
5d67986c 14949@end example
d7b8e6c6
EZ
14950
14951@noindent
14952the second term of the sum is four lines tall and has line three as
14953its baseline. Thus when the term is combined with 17, line three
14954is placed on the same level as the baseline of 17.
14955
14956@tex
14957\bigskip
14958@end tex
14959
14960Another important composition concept is @dfn{precedence}. This is
14961an integer that represents the binding strength of various operators.
14962For example, @samp{*} has higher precedence (195) than @samp{+} (180),
14963which means that @samp{(a * b) + c} will be formatted without the
14964parentheses, but @samp{a * (b + c)} will keep the parentheses.
14965
14966The operator table used by normal and Big language modes has the
14967following precedences:
14968
14969@example
14970_ 1200 @r{(subscripts)}
14971% 1100 @r{(as in n}%@r{)}
14972- 1000 @r{(as in }-@r{n)}
14973! 1000 @r{(as in }!@r{n)}
14974mod 400
14975+/- 300
14976!! 210 @r{(as in n}!!@r{)}
14977! 210 @r{(as in n}!@r{)}
14978^ 200
14979* 195 @r{(or implicit multiplication)}
14980/ % \ 190
14981+ - 180 @r{(as in a}+@r{b)}
14982| 170
14983< = 160 @r{(and other relations)}
14984&& 110
14985|| 100
14986? : 90
14987!!! 85
14988&&& 80
14989||| 75
14990:= 50
14991:: 45
14992=> 40
14993@end example
14994
a4231b04
JB
14995The general rule is that if an operator with precedence @expr{n}
14996occurs as an argument to an operator with precedence @expr{m}, then
14997the argument is enclosed in parentheses if @expr{n < m}. Top-level
d7b8e6c6
EZ
14998expressions and expressions which are function arguments, vector
14999components, etc., are formatted with precedence zero (so that they
15000normally never get additional parentheses).
15001
15002For binary left-associative operators like @samp{+}, the righthand
15003argument is actually formatted with one-higher precedence than shown
15004in the table. This makes sure @samp{(a + b) + c} omits the parentheses,
15005but the unnatural form @samp{a + (b + c)} keeps its parentheses.
15006Right-associative operators like @samp{^} format the lefthand argument
15007with one-higher precedence.
15008
5d67986c
RS
15009@ignore
15010@starindex
15011@end ignore
d7b8e6c6
EZ
15012@tindex cprec
15013The @code{cprec} function formats an expression with an arbitrary
15014precedence. For example, @samp{cprec(abc, 185)} will combine into
15015sums and products as follows: @samp{7 + abc}, @samp{7 (abc)} (because
15016this @code{cprec} form has higher precedence than addition, but lower
15017precedence than multiplication).
15018
15019@tex
15020\bigskip
15021@end tex
15022
15023A final composition issue is @dfn{line breaking}. Calc uses two
15024different strategies for ``flat'' and ``non-flat'' compositions.
15025A non-flat composition is anything that appears on multiple lines
15026(not counting line breaking). Examples would be matrices and Big
15027mode powers and quotients. Non-flat compositions are displayed
15028exactly as specified. If they come out wider than the current
15029window, you must use horizontal scrolling (@kbd{<} and @kbd{>}) to
15030view them.
15031
15032Flat compositions, on the other hand, will be broken across several
15033lines if they are too wide to fit the window. Certain points in a
15034composition are noted internally as @dfn{break points}. Calc's
15035general strategy is to fill each line as much as possible, then to
15036move down to the next line starting at the first break point that
15037didn't fit. However, the line breaker understands the hierarchical
15038structure of formulas. It will not break an ``inner'' formula if
15039it can use an earlier break point from an ``outer'' formula instead.
15040For example, a vector of sums might be formatted as:
15041
d7b8e6c6 15042@example
5d67986c 15043@group
d7b8e6c6
EZ
15044[ a + b + c, d + e + f,
15045 g + h + i, j + k + l, m ]
d7b8e6c6 15046@end group
5d67986c 15047@end example
d7b8e6c6
EZ
15048
15049@noindent
15050If the @samp{m} can fit, then so, it seems, could the @samp{g}.
15051But Calc prefers to break at the comma since the comma is part
15052of a ``more outer'' formula. Calc would break at a plus sign
15053only if it had to, say, if the very first sum in the vector had
15054itself been too large to fit.
15055
15056Of the composition functions described below, only @code{choriz}
15057generates break points. The @code{bstring} function (@pxref{Strings})
15058also generates breakable items: A break point is added after every
15059space (or group of spaces) except for spaces at the very beginning or
15060end of the string.
15061
15062Composition functions themselves count as levels in the formula
15063hierarchy, so a @code{choriz} that is a component of a larger
15064@code{choriz} will be less likely to be broken. As a special case,
15065if a @code{bstring} occurs as a component of a @code{choriz} or
15066@code{choriz}-like object (such as a vector or a list of arguments
15067in a function call), then the break points in that @code{bstring}
15068will be on the same level as the break points of the surrounding
15069object.
15070
15071@node Horizontal Compositions, Vertical Compositions, Composition Basics, Compositions
15072@subsubsection Horizontal Compositions
15073
15074@noindent
5d67986c
RS
15075@ignore
15076@starindex
15077@end ignore
d7b8e6c6
EZ
15078@tindex choriz
15079The @code{choriz} function takes a vector of objects and composes
15080them horizontally. For example, @samp{choriz([17, a b/c, d])} formats
07ce2eb3 15081as @w{@samp{17a b / cd}} in Normal language mode, or as
d7b8e6c6 15082
d7b8e6c6 15083@example
5d67986c 15084@group
d7b8e6c6
EZ
15085 a b
1508617---d
15087 c
d7b8e6c6 15088@end group
5d67986c 15089@end example
d7b8e6c6
EZ
15090
15091@noindent
15092in Big language mode. This is actually one case of the general
15093function @samp{choriz(@var{vec}, @var{sep}, @var{prec})}, where
15094either or both of @var{sep} and @var{prec} may be omitted.
15095@var{Prec} gives the @dfn{precedence} to use when formatting
15096each of the components of @var{vec}. The default precedence is
15097the precedence from the surrounding environment.
15098
15099@var{Sep} is a string (i.e., a vector of character codes as might
15100be entered with @code{" "} notation) which should separate components
15101of the composition. Also, if @var{sep} is given, the line breaker
15102will allow lines to be broken after each occurrence of @var{sep}.
15103If @var{sep} is omitted, the composition will not be breakable
15104(unless any of its component compositions are breakable).
15105
15106For example, @samp{2 choriz([a, b c, d = e], " + ", 180)} is
15107formatted as @samp{2 a + b c + (d = e)}. To get the @code{choriz}
15108to have precedence 180 ``outwards'' as well as ``inwards,''
15109enclose it in a @code{cprec} form: @samp{2 cprec(choriz(...), 180)}
15110formats as @samp{2 (a + b c + (d = e))}.
15111
15112The baseline of a horizontal composition is the same as the
15113baselines of the component compositions, which are all aligned.
15114
15115@node Vertical Compositions, Other Compositions, Horizontal Compositions, Compositions
15116@subsubsection Vertical Compositions
15117
15118@noindent
5d67986c
RS
15119@ignore
15120@starindex
15121@end ignore
d7b8e6c6
EZ
15122@tindex cvert
15123The @code{cvert} function makes a vertical composition. Each
15124component of the vector is centered in a column. The baseline of
15125the result is by default the top line of the resulting composition.
15126For example, @samp{f(cvert([a, bb, ccc]), cvert([a^2 + 1, b^2]))}
15127formats in Big mode as
15128
d7b8e6c6 15129@example
5d67986c 15130@group
d7b8e6c6
EZ
15131f( a , 2 )
15132 bb a + 1
15133 ccc 2
15134 b
d7b8e6c6 15135@end group
5d67986c 15136@end example
d7b8e6c6 15137
5d67986c
RS
15138@ignore
15139@starindex
15140@end ignore
d7b8e6c6
EZ
15141@tindex cbase
15142There are several special composition functions that work only as
15143components of a vertical composition. The @code{cbase} function
15144controls the baseline of the vertical composition; the baseline
15145will be the same as the baseline of whatever component is enclosed
15146in @code{cbase}. Thus @samp{f(cvert([a, cbase(bb), ccc]),
15147cvert([a^2 + 1, cbase(b^2)]))} displays as
15148
d7b8e6c6 15149@example
5d67986c 15150@group
d7b8e6c6
EZ
15151 2
15152 a + 1
15153 a 2
15154f(bb , b )
15155 ccc
d7b8e6c6 15156@end group
5d67986c 15157@end example
d7b8e6c6 15158
5d67986c
RS
15159@ignore
15160@starindex
15161@end ignore
d7b8e6c6 15162@tindex ctbase
5d67986c
RS
15163@ignore
15164@starindex
15165@end ignore
d7b8e6c6
EZ
15166@tindex cbbase
15167There are also @code{ctbase} and @code{cbbase} functions which
15168make the baseline of the vertical composition equal to the top
15169or bottom line (rather than the baseline) of that component.
15170Thus @samp{cvert([cbase(a / b)]) + cvert([ctbase(a / b)]) +
15171cvert([cbbase(a / b)])} gives
15172
d7b8e6c6 15173@example
5d67986c 15174@group
d7b8e6c6
EZ
15175 a
15176a -
15177- + a + b
15178b -
15179 b
d7b8e6c6 15180@end group
5d67986c 15181@end example
d7b8e6c6
EZ
15182
15183There should be only one @code{cbase}, @code{ctbase}, or @code{cbbase}
15184function in a given vertical composition. These functions can also
15185be written with no arguments: @samp{ctbase()} is a zero-height object
15186which means the baseline is the top line of the following item, and
15187@samp{cbbase()} means the baseline is the bottom line of the preceding
15188item.
15189
5d67986c
RS
15190@ignore
15191@starindex
15192@end ignore
d7b8e6c6
EZ
15193@tindex crule
15194The @code{crule} function builds a ``rule,'' or horizontal line,
15195across a vertical composition. By itself @samp{crule()} uses @samp{-}
15196characters to build the rule. You can specify any other character,
15197e.g., @samp{crule("=")}. The argument must be a character code or
15198vector of exactly one character code. It is repeated to match the
15199width of the widest item in the stack. For example, a quotient
15200with a thick line is @samp{cvert([a + 1, cbase(crule("=")), b^2])}:
15201
d7b8e6c6 15202@example
5d67986c 15203@group
d7b8e6c6
EZ
15204a + 1
15205=====
15206 2
15207 b
d7b8e6c6 15208@end group
5d67986c 15209@end example
d7b8e6c6 15210
5d67986c
RS
15211@ignore
15212@starindex
15213@end ignore
d7b8e6c6 15214@tindex clvert
5d67986c
RS
15215@ignore
15216@starindex
15217@end ignore
d7b8e6c6
EZ
15218@tindex crvert
15219Finally, the functions @code{clvert} and @code{crvert} act exactly
15220like @code{cvert} except that the items are left- or right-justified
15221in the stack. Thus @samp{clvert([a, bb, ccc]) + crvert([a, bb, ccc])}
15222gives:
15223
d7b8e6c6 15224@example
5d67986c 15225@group
d7b8e6c6
EZ
15226a + a
15227bb bb
15228ccc ccc
d7b8e6c6 15229@end group
5d67986c 15230@end example
d7b8e6c6
EZ
15231
15232Like @code{choriz}, the vertical compositions accept a second argument
15233which gives the precedence to use when formatting the components.
15234Vertical compositions do not support separator strings.
15235
15236@node Other Compositions, Information about Compositions, Vertical Compositions, Compositions
15237@subsubsection Other Compositions
15238
15239@noindent
5d67986c
RS
15240@ignore
15241@starindex
15242@end ignore
d7b8e6c6
EZ
15243@tindex csup
15244The @code{csup} function builds a superscripted expression. For
15245example, @samp{csup(a, b)} looks the same as @samp{a^b} does in Big
15246language mode. This is essentially a horizontal composition of
15247@samp{a} and @samp{b}, where @samp{b} is shifted up so that its
15248bottom line is one above the baseline.
15249
5d67986c
RS
15250@ignore
15251@starindex
15252@end ignore
d7b8e6c6
EZ
15253@tindex csub
15254Likewise, the @code{csub} function builds a subscripted expression.
15255This shifts @samp{b} down so that its top line is one below the
15256bottom line of @samp{a} (note that this is not quite analogous to
15257@code{csup}). Other arrangements can be obtained by using
15258@code{choriz} and @code{cvert} directly.
15259
5d67986c
RS
15260@ignore
15261@starindex
15262@end ignore
d7b8e6c6
EZ
15263@tindex cflat
15264The @code{cflat} function formats its argument in ``flat'' mode,
15265as obtained by @samp{d O}, if the current language mode is normal
15266or Big. It has no effect in other language modes. For example,
15267@samp{a^(b/c)} is formatted by Big mode like @samp{csup(a, cflat(b/c))}
15268to improve its readability.
15269
5d67986c
RS
15270@ignore
15271@starindex
15272@end ignore
d7b8e6c6
EZ
15273@tindex cspace
15274The @code{cspace} function creates horizontal space. For example,
15275@samp{cspace(4)} is effectively the same as @samp{string(" ")}.
15276A second string (i.e., vector of characters) argument is repeated
15277instead of the space character. For example, @samp{cspace(4, "ab")}
15278looks like @samp{abababab}. If the second argument is not a string,
15279it is formatted in the normal way and then several copies of that
15280are composed together: @samp{cspace(4, a^2)} yields
15281
d7b8e6c6 15282@example
5d67986c 15283@group
d7b8e6c6
EZ
15284 2 2 2 2
15285a a a a
d7b8e6c6 15286@end group
5d67986c 15287@end example
d7b8e6c6
EZ
15288
15289@noindent
15290If the number argument is zero, this is a zero-width object.
15291
5d67986c
RS
15292@ignore
15293@starindex
15294@end ignore
d7b8e6c6
EZ
15295@tindex cvspace
15296The @code{cvspace} function creates vertical space, or a vertical
15297stack of copies of a certain string or formatted object. The
15298baseline is the center line of the resulting stack. A numerical
15299argument of zero will produce an object which contributes zero
15300height if used in a vertical composition.
15301
5d67986c
RS
15302@ignore
15303@starindex
15304@end ignore
d7b8e6c6 15305@tindex ctspace
5d67986c
RS
15306@ignore
15307@starindex
15308@end ignore
d7b8e6c6
EZ
15309@tindex cbspace
15310There are also @code{ctspace} and @code{cbspace} functions which
15311create vertical space with the baseline the same as the baseline
15312of the top or bottom copy, respectively, of the second argument.
15313Thus @samp{cvspace(2, a/b) + ctspace(2, a/b) + cbspace(2, a/b)}
15314displays as:
15315
d7b8e6c6 15316@example
5d67986c 15317@group
d7b8e6c6
EZ
15318 a
15319 -
15320a b
15321- a a
15322b + - + -
15323a b b
15324- a
15325b -
15326 b
d7b8e6c6 15327@end group
5d67986c 15328@end example
d7b8e6c6
EZ
15329
15330@node Information about Compositions, User-Defined Compositions, Other Compositions, Compositions
15331@subsubsection Information about Compositions
15332
15333@noindent
15334The functions in this section are actual functions; they compose their
15335arguments according to the current language and other display modes,
15336then return a certain measurement of the composition as an integer.
15337
5d67986c
RS
15338@ignore
15339@starindex
15340@end ignore
d7b8e6c6
EZ
15341@tindex cwidth
15342The @code{cwidth} function measures the width, in characters, of a
15343composition. For example, @samp{cwidth(a + b)} is 5, and
07ce2eb3 15344@samp{cwidth(a / b)} is 5 in Normal mode, 1 in Big mode, and 11 in
d7b8e6c6
EZ
15345@TeX{} mode (for @samp{@{a \over b@}}). The argument may involve
15346the composition functions described in this section.
15347
5d67986c
RS
15348@ignore
15349@starindex
15350@end ignore
d7b8e6c6
EZ
15351@tindex cheight
15352The @code{cheight} function measures the height of a composition.
15353This is the total number of lines in the argument's printed form.
15354
5d67986c
RS
15355@ignore
15356@starindex
15357@end ignore
d7b8e6c6 15358@tindex cascent
5d67986c
RS
15359@ignore
15360@starindex
15361@end ignore
d7b8e6c6
EZ
15362@tindex cdescent
15363The functions @code{cascent} and @code{cdescent} measure the amount
15364of the height that is above (and including) the baseline, or below
15365the baseline, respectively. Thus @samp{cascent(@var{x}) + cdescent(@var{x})}
15366always equals @samp{cheight(@var{x})}. For a one-line formula like
15367@samp{a + b}, @code{cascent} returns 1 and @code{cdescent} returns 0.
15368For @samp{a / b} in Big mode, @code{cascent} returns 2 and @code{cdescent}
15369returns 1. The only formula for which @code{cascent} will return zero
15370is @samp{cvspace(0)} or equivalents.
15371
15372@node User-Defined Compositions, , Information about Compositions, Compositions
15373@subsubsection User-Defined Compositions
15374
15375@noindent
15376@kindex Z C
15377@pindex calc-user-define-composition
15378The @kbd{Z C} (@code{calc-user-define-composition}) command lets you
15379define the display format for any algebraic function. You provide a
15380formula containing a certain number of argument variables on the stack.
15381Any time Calc formats a call to the specified function in the current
15382language mode and with that number of arguments, Calc effectively
15383replaces the function call with that formula with the arguments
15384replaced.
15385
15386Calc builds the default argument list by sorting all the variable names
15387that appear in the formula into alphabetical order. You can edit this
15388argument list before pressing @key{RET} if you wish. Any variables in
15389the formula that do not appear in the argument list will be displayed
15390literally; any arguments that do not appear in the formula will not
15391affect the display at all.
15392
15393You can define formats for built-in functions, for functions you have
15394defined with @kbd{Z F} (@pxref{Algebraic Definitions}), or for functions
15395which have no definitions but are being used as purely syntactic objects.
15396You can define different formats for each language mode, and for each
15397number of arguments, using a succession of @kbd{Z C} commands. When
15398Calc formats a function call, it first searches for a format defined
15399for the current language mode (and number of arguments); if there is
15400none, it uses the format defined for the Normal language mode. If
15401neither format exists, Calc uses its built-in standard format for that
15402function (usually just @samp{@var{func}(@var{args})}).
15403
15404If you execute @kbd{Z C} with the number 0 on the stack instead of a
15405formula, any defined formats for the function in the current language
15406mode will be removed. The function will revert to its standard format.
15407
15408For example, the default format for the binomial coefficient function
15409@samp{choose(n, m)} in the Big language mode is
15410
d7b8e6c6 15411@example
5d67986c 15412@group
d7b8e6c6
EZ
15413 n
15414( )
15415 m
d7b8e6c6 15416@end group
5d67986c 15417@end example
d7b8e6c6
EZ
15418
15419@noindent
15420You might prefer the notation,
15421
d7b8e6c6 15422@example
5d67986c 15423@group
d7b8e6c6
EZ
15424 C
15425n m
d7b8e6c6 15426@end group
5d67986c 15427@end example
d7b8e6c6
EZ
15428
15429@noindent
15430To define this notation, first make sure you are in Big mode,
15431then put the formula
15432
15433@smallexample
15434choriz([cvert([cvspace(1), n]), C, cvert([cvspace(1), m])])
15435@end smallexample
15436
15437@noindent
15438on the stack and type @kbd{Z C}. Answer the first prompt with
15439@code{choose}. The second prompt will be the default argument list
15440of @samp{(C m n)}. Edit this list to be @samp{(n m)} and press
15441@key{RET}. Now, try it out: For example, turn simplification
15442off with @kbd{m O} and enter @samp{choose(a,b) + choose(7,3)}
15443as an algebraic entry.
15444
d7b8e6c6 15445@example
5d67986c 15446@group
177c0ea7 15447 C + C
d7b8e6c6 15448a b 7 3
d7b8e6c6 15449@end group
5d67986c 15450@end example
d7b8e6c6
EZ
15451
15452As another example, let's define the usual notation for Stirling
15453numbers of the first kind, @samp{stir1(n, m)}. This is just like
15454the regular format for binomial coefficients but with square brackets
15455instead of parentheses.
15456
15457@smallexample
15458choriz([string("["), cvert([n, cbase(cvspace(1)), m]), string("]")])
15459@end smallexample
15460
15461Now type @kbd{Z C stir1 @key{RET}}, edit the argument list to
15462@samp{(n m)}, and type @key{RET}.
15463
15464The formula provided to @kbd{Z C} usually will involve composition
15465functions, but it doesn't have to. Putting the formula @samp{a + b + c}
15466onto the stack and typing @kbd{Z C foo @key{RET} @key{RET}} would define
15467the function @samp{foo(x,y,z)} to display like @samp{x + y + z}.
15468This ``sum'' will act exactly like a real sum for all formatting
15469purposes (it will be parenthesized the same, and so on). However
15470it will be computationally unrelated to a sum. For example, the
15471formula @samp{2 * foo(1, 2, 3)} will display as @samp{2 (1 + 2 + 3)}.
15472Operator precedences have caused the ``sum'' to be written in
15473parentheses, but the arguments have not actually been summed.
15474(Generally a display format like this would be undesirable, since
15475it can easily be confused with a real sum.)
15476
15477The special function @code{eval} can be used inside a @kbd{Z C}
15478composition formula to cause all or part of the formula to be
15479evaluated at display time. For example, if the formula is
15480@samp{a + eval(b + c)}, then @samp{foo(1, 2, 3)} will be displayed
15481as @samp{1 + 5}. Evaluation will use the default simplifications,
15482regardless of the current simplification mode. There are also
15483@code{evalsimp} and @code{evalextsimp} which simplify as if by
15484@kbd{a s} and @kbd{a e} (respectively). Note that these ``functions''
15485operate only in the context of composition formulas (and also in
15486rewrite rules, where they serve a similar purpose; @pxref{Rewrite
15487Rules}). On the stack, a call to @code{eval} will be left in
15488symbolic form.
15489
15490It is not a good idea to use @code{eval} except as a last resort.
15491It can cause the display of formulas to be extremely slow. For
15492example, while @samp{eval(a + b)} might seem quite fast and simple,
15493there are several situations where it could be slow. For example,
15494@samp{a} and/or @samp{b} could be polar complex numbers, in which
15495case doing the sum requires trigonometry. Or, @samp{a} could be
15496the factorial @samp{fact(100)} which is unevaluated because you
15497have typed @kbd{m O}; @code{eval} will evaluate it anyway to
15498produce a large, unwieldy integer.
15499
15500You can save your display formats permanently using the @kbd{Z P}
15501command (@pxref{Creating User Keys}).
15502
15503@node Syntax Tables, , Compositions, Language Modes
15504@subsection Syntax Tables
15505
15506@noindent
15507@cindex Syntax tables
15508@cindex Parsing formulas, customized
15509Syntax tables do for input what compositions do for output: They
15510allow you to teach custom notations to Calc's formula parser.
15511Calc keeps a separate syntax table for each language mode.
15512
15513(Note that the Calc ``syntax tables'' discussed here are completely
15514unrelated to the syntax tables described in the Emacs manual.)
15515
15516@kindex Z S
15517@pindex calc-edit-user-syntax
15518The @kbd{Z S} (@code{calc-edit-user-syntax}) command edits the
15519syntax table for the current language mode. If you want your
07ce2eb3 15520syntax to work in any language, define it in the Normal language
33108698
JB
15521mode. Type @kbd{C-c C-c} to finish editing the syntax table, or
15522@kbd{C-x k} to cancel the edit. The @kbd{m m} command saves all
d7b8e6c6
EZ
15523the syntax tables along with the other mode settings;
15524@pxref{General Mode Commands}.
15525
15526@menu
15527* Syntax Table Basics::
15528* Precedence in Syntax Tables::
15529* Advanced Syntax Patterns::
15530* Conditional Syntax Rules::
15531@end menu
15532
15533@node Syntax Table Basics, Precedence in Syntax Tables, Syntax Tables, Syntax Tables
15534@subsubsection Syntax Table Basics
15535
15536@noindent
15537@dfn{Parsing} is the process of converting a raw string of characters,
15538such as you would type in during algebraic entry, into a Calc formula.
15539Calc's parser works in two stages. First, the input is broken down
15540into @dfn{tokens}, such as words, numbers, and punctuation symbols
15541like @samp{+}, @samp{:=}, and @samp{+/-}. Space between tokens is
15542ignored (except when it serves to separate adjacent words). Next,
15543the parser matches this string of tokens against various built-in
15544syntactic patterns, such as ``an expression followed by @samp{+}
15545followed by another expression'' or ``a name followed by @samp{(},
15546zero or more expressions separated by commas, and @samp{)}.''
15547
15548A @dfn{syntax table} is a list of user-defined @dfn{syntax rules},
15549which allow you to specify new patterns to define your own
15550favorite input notations. Calc's parser always checks the syntax
07ce2eb3 15551table for the current language mode, then the table for the Normal
d7b8e6c6
EZ
15552language mode, before it uses its built-in rules to parse an
15553algebraic formula you have entered. Each syntax rule should go on
15554its own line; it consists of a @dfn{pattern}, a @samp{:=} symbol,
15555and a Calc formula with an optional @dfn{condition}. (Syntax rules
15556resemble algebraic rewrite rules, but the notation for patterns is
15557completely different.)
15558
15559A syntax pattern is a list of tokens, separated by spaces.
15560Except for a few special symbols, tokens in syntax patterns are
15561matched literally, from left to right. For example, the rule,
15562
15563@example
15564foo ( ) := 2+3
15565@end example
15566
15567@noindent
15568would cause Calc to parse the formula @samp{4+foo()*5} as if it
15569were @samp{4+(2+3)*5}. Notice that the parentheses were written
15570as two separate tokens in the rule. As a result, the rule works
15571for both @samp{foo()} and @w{@samp{foo ( )}}. If we had written
15572the rule as @samp{foo () := 2+3}, then Calc would treat @samp{()}
15573as a single, indivisible token, so that @w{@samp{foo( )}} would
15574not be recognized by the rule. (It would be parsed as a regular
15575zero-argument function call instead.) In fact, this rule would
15576also make trouble for the rest of Calc's parser: An unrelated
15577formula like @samp{bar()} would now be tokenized into @samp{bar ()}
15578instead of @samp{bar ( )}, so that the standard parser for function
15579calls would no longer recognize it!
15580
15581While it is possible to make a token with a mixture of letters
15582and punctuation symbols, this is not recommended. It is better to
15583break it into several tokens, as we did with @samp{foo()} above.
15584
15585The symbol @samp{#} in a syntax pattern matches any Calc expression.
15586On the righthand side, the things that matched the @samp{#}s can
15587be referred to as @samp{#1}, @samp{#2}, and so on (where @samp{#1}
15588matches the leftmost @samp{#} in the pattern). For example, these
15589rules match a user-defined function, prefix operator, infix operator,
15590and postfix operator, respectively:
15591
15592@example
15593foo ( # ) := myfunc(#1)
15594foo # := myprefix(#1)
15595# foo # := myinfix(#1,#2)
15596# foo := mypostfix(#1)
15597@end example
15598
15599Thus @samp{foo(3)} will parse as @samp{myfunc(3)}, and @samp{2+3 foo}
15600will parse as @samp{mypostfix(2+3)}.
15601
15602It is important to write the first two rules in the order shown,
15603because Calc tries rules in order from first to last. If the
15604pattern @samp{foo #} came first, it would match anything that could
15605match the @samp{foo ( # )} rule, since an expression in parentheses
15606is itself a valid expression. Thus the @w{@samp{foo ( # )}} rule would
15607never get to match anything. Likewise, the last two rules must be
15608written in the order shown or else @samp{3 foo 4} will be parsed as
15609@samp{mypostfix(3) * 4}. (Of course, the best way to avoid these
15610ambiguities is not to use the same symbol in more than one way at
15611the same time! In case you're not convinced, try the following
15612exercise: How will the above rules parse the input @samp{foo(3,4)},
15613if at all? Work it out for yourself, then try it in Calc and see.)
15614
15615Calc is quite flexible about what sorts of patterns are allowed.
15616The only rule is that every pattern must begin with a literal
15617token (like @samp{foo} in the first two patterns above), or with
15618a @samp{#} followed by a literal token (as in the last two
15619patterns). After that, any mixture is allowed, although putting
15620two @samp{#}s in a row will not be very useful since two
15621expressions with nothing between them will be parsed as one
15622expression that uses implicit multiplication.
15623
15624As a more practical example, Maple uses the notation
15625@samp{sum(a(i), i=1..10)} for sums, which Calc's Maple mode doesn't
15626recognize at present. To handle this syntax, we simply add the
15627rule,
15628
15629@example
15630sum ( # , # = # .. # ) := sum(#1,#2,#3,#4)
15631@end example
15632
15633@noindent
15634to the Maple mode syntax table. As another example, C mode can't
15635read assignment operators like @samp{++} and @samp{*=}. We can
15636define these operators quite easily:
15637
15638@example
15639# *= # := muleq(#1,#2)
15640# ++ := postinc(#1)
15641++ # := preinc(#1)
15642@end example
15643
15644@noindent
15645To complete the job, we would use corresponding composition functions
15646and @kbd{Z C} to cause these functions to display in their respective
15647Maple and C notations. (Note that the C example ignores issues of
15648operator precedence, which are discussed in the next section.)
15649
15650You can enclose any token in quotes to prevent its usual
15651interpretation in syntax patterns:
15652
15653@example
15654# ":=" # := becomes(#1,#2)
15655@end example
15656
15657Quotes also allow you to include spaces in a token, although once
15658again it is generally better to use two tokens than one token with
15659an embedded space. To include an actual quotation mark in a quoted
15660token, precede it with a backslash. (This also works to include
15661backslashes in tokens.)
15662
15663@example
15664# "bad token" # "/\"\\" # := silly(#1,#2,#3)
15665@end example
15666
15667@noindent
15668This will parse @samp{3 bad token 4 /"\ 5} to @samp{silly(3,4,5)}.
15669
15670The token @kbd{#} has a predefined meaning in Calc's formula parser;
2cbd16b9 15671it is not valid to use @samp{"#"} in a syntax rule. However, longer
d7b8e6c6
EZ
15672tokens that include the @samp{#} character are allowed. Also, while
15673@samp{"$"} and @samp{"\""} are allowed as tokens, their presence in
15674the syntax table will prevent those characters from working in their
15675usual ways (referring to stack entries and quoting strings,
15676respectively).
15677
15678Finally, the notation @samp{%%} anywhere in a syntax table causes
15679the rest of the line to be ignored as a comment.
15680
15681@node Precedence in Syntax Tables, Advanced Syntax Patterns, Syntax Table Basics, Syntax Tables
15682@subsubsection Precedence
15683
15684@noindent
15685Different operators are generally assigned different @dfn{precedences}.
15686By default, an operator defined by a rule like
15687
15688@example
15689# foo # := foo(#1,#2)
15690@end example
15691
15692@noindent
15693will have an extremely low precedence, so that @samp{2*3+4 foo 5 == 6}
15694will be parsed as @samp{(2*3+4) foo (5 == 6)}. To change the
15695precedence of an operator, use the notation @samp{#/@var{p}} in
15696place of @samp{#}, where @var{p} is an integer precedence level.
15697For example, 185 lies between the precedences for @samp{+} and
15698@samp{*}, so if we change this rule to
15699
15700@example
15701#/185 foo #/186 := foo(#1,#2)
15702@end example
15703
15704@noindent
15705then @samp{2+3 foo 4*5} will be parsed as @samp{2+(3 foo (4*5))}.
15706Also, because we've given the righthand expression slightly higher
15707precedence, our new operator will be left-associative:
15708@samp{1 foo 2 foo 3} will be parsed as @samp{(1 foo 2) foo 3}.
15709By raising the precedence of the lefthand expression instead, we
15710can create a right-associative operator.
15711
15712@xref{Composition Basics}, for a table of precedences of the
15713standard Calc operators. For the precedences of operators in other
15714language modes, look in the Calc source file @file{calc-lang.el}.
15715
15716@node Advanced Syntax Patterns, Conditional Syntax Rules, Precedence in Syntax Tables, Syntax Tables
15717@subsubsection Advanced Syntax Patterns
15718
15719@noindent
15720To match a function with a variable number of arguments, you could
15721write
15722
15723@example
15724foo ( # ) := myfunc(#1)
15725foo ( # , # ) := myfunc(#1,#2)
15726foo ( # , # , # ) := myfunc(#1,#2,#3)
15727@end example
15728
15729@noindent
15730but this isn't very elegant. To match variable numbers of items,
15731Calc uses some notations inspired regular expressions and the
15732``extended BNF'' style used by some language designers.
15733
15734@example
15735foo ( @{ # @}*, ) := apply(myfunc,#1)
15736@end example
15737
15738The token @samp{@{} introduces a repeated or optional portion.
15739One of the three tokens @samp{@}*}, @samp{@}+}, or @samp{@}?}
15740ends the portion. These will match zero or more, one or more,
15741or zero or one copies of the enclosed pattern, respectively.
15742In addition, @samp{@}*} and @samp{@}+} can be followed by a
15743separator token (with no space in between, as shown above).
15744Thus @samp{@{ # @}*,} matches nothing, or one expression, or
15745several expressions separated by commas.
15746
15747A complete @samp{@{ ... @}} item matches as a vector of the
15748items that matched inside it. For example, the above rule will
15749match @samp{foo(1,2,3)} to get @samp{apply(myfunc,[1,2,3])}.
15750The Calc @code{apply} function takes a function name and a vector
15751of arguments and builds a call to the function with those
15752arguments, so the net result is the formula @samp{myfunc(1,2,3)}.
15753
15754If the body of a @samp{@{ ... @}} contains several @samp{#}s
15755(or nested @samp{@{ ... @}} constructs), then the items will be
15756strung together into the resulting vector. If the body
15757does not contain anything but literal tokens, the result will
15758always be an empty vector.
15759
15760@example
15761foo ( @{ # , # @}+, ) := bar(#1)
15762foo ( @{ @{ # @}*, @}*; ) := matrix(#1)
15763@end example
15764
15765@noindent
5d67986c
RS
15766will parse @samp{foo(1, 2, 3, 4)} as @samp{bar([1, 2, 3, 4])}, and
15767@samp{foo(1, 2; 3, 4)} as @samp{matrix([[1, 2], [3, 4]])}. Also, after
d7b8e6c6 15768some thought it's easy to see how this pair of rules will parse
5d67986c 15769@samp{foo(1, 2, 3)} as @samp{matrix([[1, 2, 3]])}, since the first
d7b8e6c6
EZ
15770rule will only match an even number of arguments. The rule
15771
15772@example
15773foo ( # @{ , # , # @}? ) := bar(#1,#2)
15774@end example
15775
15776@noindent
15777will parse @samp{foo(2,3,4)} as @samp{bar(2,[3,4])}, and
15778@samp{foo(2)} as @samp{bar(2,[])}.
15779
15780The notation @samp{@{ ... @}?.} (note the trailing period) works
15781just the same as regular @samp{@{ ... @}?}, except that it does not
15782count as an argument; the following two rules are equivalent:
15783
15784@example
15785foo ( # , @{ also @}? # ) := bar(#1,#3)
15786foo ( # , @{ also @}?. # ) := bar(#1,#2)
15787@end example
15788
15789@noindent
15790Note that in the first case the optional text counts as @samp{#2},
15791which will always be an empty vector, but in the second case no
15792empty vector is produced.
15793
15794Another variant is @samp{@{ ... @}?$}, which means the body is
15795optional only at the end of the input formula. All built-in syntax
15796rules in Calc use this for closing delimiters, so that during
5d67986c 15797algebraic entry you can type @kbd{[sqrt(2), sqrt(3 @key{RET}}, omitting
d7b8e6c6
EZ
15798the closing parenthesis and bracket. Calc does this automatically
15799for trailing @samp{)}, @samp{]}, and @samp{>} tokens in syntax
15800rules, but you can use @samp{@{ ... @}?$} explicitly to get
15801this effect with any token (such as @samp{"@}"} or @samp{end}).
15802Like @samp{@{ ... @}?.}, this notation does not count as an
15803argument. Conversely, you can use quotes, as in @samp{")"}, to
15804prevent a closing-delimiter token from being automatically treated
15805as optional.
15806
15807Calc's parser does not have full backtracking, which means some
15808patterns will not work as you might expect:
15809
15810@example
15811foo ( @{ # , @}? # , # ) := bar(#1,#2,#3)
15812@end example
15813
15814@noindent
15815Here we are trying to make the first argument optional, so that
15816@samp{foo(2,3)} parses as @samp{bar([],2,3)}. Unfortunately, Calc
15817first tries to match @samp{2,} against the optional part of the
15818pattern, finds a match, and so goes ahead to match the rest of the
15819pattern. Later on it will fail to match the second comma, but it
15820doesn't know how to go back and try the other alternative at that
15821point. One way to get around this would be to use two rules:
15822
15823@example
15824foo ( # , # , # ) := bar([#1],#2,#3)
15825foo ( # , # ) := bar([],#1,#2)
15826@end example
15827
15828More precisely, when Calc wants to match an optional or repeated
15829part of a pattern, it scans forward attempting to match that part.
15830If it reaches the end of the optional part without failing, it
15831``finalizes'' its choice and proceeds. If it fails, though, it
15832backs up and tries the other alternative. Thus Calc has ``partial''
15833backtracking. A fully backtracking parser would go on to make sure
15834the rest of the pattern matched before finalizing the choice.
15835
15836@node Conditional Syntax Rules, , Advanced Syntax Patterns, Syntax Tables
15837@subsubsection Conditional Syntax Rules
15838
15839@noindent
15840It is possible to attach a @dfn{condition} to a syntax rule. For
15841example, the rules
15842
15843@example
15844foo ( # ) := ifoo(#1) :: integer(#1)
15845foo ( # ) := gfoo(#1)
15846@end example
15847
15848@noindent
15849will parse @samp{foo(3)} as @samp{ifoo(3)}, but will parse
15850@samp{foo(3.5)} and @samp{foo(x)} as calls to @code{gfoo}. Any
15851number of conditions may be attached; all must be true for the
15852rule to succeed. A condition is ``true'' if it evaluates to a
15853nonzero number. @xref{Logical Operations}, for a list of Calc
15854functions like @code{integer} that perform logical tests.
15855
15856The exact sequence of events is as follows: When Calc tries a
15857rule, it first matches the pattern as usual. It then substitutes
15858@samp{#1}, @samp{#2}, etc., in the conditions, if any. Next, the
15859conditions are simplified and evaluated in order from left to right,
15860as if by the @w{@kbd{a s}} algebra command (@pxref{Simplifying Formulas}).
15861Each result is true if it is a nonzero number, or an expression
15862that can be proven to be nonzero (@pxref{Declarations}). If the
15863results of all conditions are true, the expression (such as
15864@samp{ifoo(#1)}) has its @samp{#}s substituted, and that is the
15865result of the parse. If the result of any condition is false, Calc
15866goes on to try the next rule in the syntax table.
15867
15868Syntax rules also support @code{let} conditions, which operate in
15869exactly the same way as they do in algebraic rewrite rules.
15870@xref{Other Features of Rewrite Rules}, for details. A @code{let}
15871condition is always true, but as a side effect it defines a
15872variable which can be used in later conditions, and also in the
15873expression after the @samp{:=} sign:
15874
15875@example
15876foo ( # ) := hifoo(x) :: let(x := #1 + 0.5) :: dnumint(x)
15877@end example
15878
15879@noindent
15880The @code{dnumint} function tests if a value is numerically an
15881integer, i.e., either a true integer or an integer-valued float.
15882This rule will parse @code{foo} with a half-integer argument,
15883like @samp{foo(3.5)}, to a call like @samp{hifoo(4.)}.
15884
15885The lefthand side of a syntax rule @code{let} must be a simple
15886variable, not the arbitrary pattern that is allowed in rewrite
15887rules.
15888
15889The @code{matches} function is also treated specially in syntax
15890rule conditions (again, in the same way as in rewrite rules).
15891@xref{Matching Commands}. If the matching pattern contains
15892meta-variables, then those meta-variables may be used in later
15893conditions and in the result expression. The arguments to
15894@code{matches} are not evaluated in this situation.
15895
15896@example
15897sum ( # , # ) := sum(#1,a,b,c) :: matches(#2, a=[b..c])
15898@end example
15899
15900@noindent
15901This is another way to implement the Maple mode @code{sum} notation.
15902In this approach, we allow @samp{#2} to equal the whole expression
15903@samp{i=1..10}. Then, we use @code{matches} to break it apart into
15904its components. If the expression turns out not to match the pattern,
15905the syntax rule will fail. Note that @kbd{Z S} always uses Calc's
07ce2eb3 15906Normal language mode for editing expressions in syntax rules, so we
d7b8e6c6
EZ
15907must use regular Calc notation for the interval @samp{[b..c]} that
15908will correspond to the Maple mode interval @samp{1..10}.
15909
15910@node Modes Variable, Calc Mode Line, Language Modes, Mode Settings
15911@section The @code{Modes} Variable
15912
15913@noindent
15914@kindex m g
15915@pindex calc-get-modes
15916The @kbd{m g} (@code{calc-get-modes}) command pushes onto the stack
15917a vector of numbers that describes the various mode settings that
15918are in effect. With a numeric prefix argument, it pushes only the
15919@var{n}th mode, i.e., the @var{n}th element of this vector. Keyboard
15920macros can use the @kbd{m g} command to modify their behavior based
15921on the current mode settings.
15922
15923@cindex @code{Modes} variable
15924@vindex Modes
15925The modes vector is also available in the special variable
5d67986c 15926@code{Modes}. In other words, @kbd{m g} is like @kbd{s r Modes @key{RET}}.
d7b8e6c6
EZ
15927It will not work to store into this variable; in fact, if you do,
15928@code{Modes} will cease to track the current modes. (The @kbd{m g}
15929command will continue to work, however.)
15930
15931In general, each number in this vector is suitable as a numeric
15932prefix argument to the associated mode-setting command. (Recall
15933that the @kbd{~} key takes a number from the stack and gives it as
15934a numeric prefix to the next command.)
15935
15936The elements of the modes vector are as follows:
15937
15938@enumerate
15939@item
15940Current precision. Default is 12; associated command is @kbd{p}.
15941
15942@item
15943Binary word size. Default is 32; associated command is @kbd{b w}.
15944
15945@item
15946Stack size (not counting the value about to be pushed by @kbd{m g}).
15947This is zero if @kbd{m g} is executed with an empty stack.
15948
15949@item
15950Number radix. Default is 10; command is @kbd{d r}.
15951
15952@item
15953Floating-point format. This is the number of digits, plus the
15954constant 0 for normal notation, 10000 for scientific notation,
1595520000 for engineering notation, or 30000 for fixed-point notation.
15956These codes are acceptable as prefix arguments to the @kbd{d n}
15957command, but note that this may lose information: For example,
15958@kbd{d s} and @kbd{C-u 12 d s} have similar (but not quite
15959identical) effects if the current precision is 12, but they both
15960produce a code of 10012, which will be treated by @kbd{d n} as
15961@kbd{C-u 12 d s}. If the precision then changes, the float format
15962will still be frozen at 12 significant figures.
15963
15964@item
15965Angular mode. Default is 1 (degrees). Other values are 2 (radians)
15966and 3 (HMS). The @kbd{m d} command accepts these prefixes.
15967
15968@item
15969Symbolic mode. Value is 0 or 1; default is 0. Command is @kbd{m s}.
15970
177c0ea7 15971@item
d7b8e6c6
EZ
15972Fraction mode. Value is 0 or 1; default is 0. Command is @kbd{m f}.
15973
15974@item
15975Polar mode. Value is 0 (rectangular) or 1 (polar); default is 0.
15976Command is @kbd{m p}.
15977
15978@item
07ce2eb3
JB
15979Matrix/Scalar mode. Default value is @mathit{-1}. Value is 0 for Scalar
15980mode, @mathit{-2} for Matrix mode, or @var{N} for
8e04863e 15981@texline @math{N\times N}
a4231b04 15982@infoline @var{N}x@var{N}
07ce2eb3 15983Matrix mode. Command is @kbd{m v}.
d7b8e6c6
EZ
15984
15985@item
8e04863e 15986Simplification mode. Default is 1. Value is @mathit{-1} for off (@kbd{m O}),
d7b8e6c6
EZ
159870 for @kbd{m N}, 2 for @kbd{m B}, 3 for @kbd{m A}, 4 for @kbd{m E},
15988or 5 for @w{@kbd{m U}}. The @kbd{m D} command accepts these prefixes.
15989
15990@item
8e04863e 15991Infinite mode. Default is @mathit{-1} (off). Value is 1 if the mode is on,
d7b8e6c6
EZ
15992or 0 if the mode is on with positive zeros. Command is @kbd{m i}.
15993@end enumerate
15994
5d67986c 15995For example, the sequence @kbd{M-1 m g @key{RET} 2 + ~ p} increases the
d7b8e6c6
EZ
15996precision by two, leaving a copy of the old precision on the stack.
15997Later, @kbd{~ p} will restore the original precision using that
15998stack value. (This sequence might be especially useful inside a
15999keyboard macro.)
16000
5d67986c 16001As another example, @kbd{M-3 m g 1 - ~ @key{DEL}} deletes all but the
d7b8e6c6
EZ
16002oldest (bottommost) stack entry.
16003
16004Yet another example: The HP-48 ``round'' command rounds a number
16005to the current displayed precision. You could roughly emulate this
16006in Calc with the sequence @kbd{M-5 m g 10000 % ~ c c}. (This
16007would not work for fixed-point mode, but it wouldn't be hard to
16008do a full emulation with the help of the @kbd{Z [} and @kbd{Z ]}
16009programming commands. @xref{Conditionals in Macros}.)
16010
16011@node Calc Mode Line, , Modes Variable, Mode Settings
16012@section The Calc Mode Line
16013
16014@noindent
16015@cindex Mode line indicators
16016This section is a summary of all symbols that can appear on the
16017Calc mode line, the highlighted bar that appears under the Calc
07ce2eb3 16018stack window (or under an editing window in Embedded mode).
d7b8e6c6
EZ
16019
16020The basic mode line format is:
16021
16022@example
16023--%%-Calc: 12 Deg @var{other modes} (Calculator)
16024@end example
16025
16026The @samp{%%} is the Emacs symbol for ``read-only''; it shows that
16027regular Emacs commands are not allowed to edit the stack buffer
16028as if it were text.
16029
07ce2eb3 16030The word @samp{Calc:} changes to @samp{CalcEmbed:} if Embedded mode
d7b8e6c6
EZ
16031is enabled. The words after this describe the various Calc modes
16032that are in effect.
16033
16034The first mode is always the current precision, an integer.
16035The second mode is always the angular mode, either @code{Deg},
16036@code{Rad}, or @code{Hms}.
16037
16038Here is a complete list of the remaining symbols that can appear
16039on the mode line:
16040
16041@table @code
16042@item Alg
16043Algebraic mode (@kbd{m a}; @pxref{Algebraic Entry}).
16044
16045@item Alg[(
16046Incomplete algebraic mode (@kbd{C-u m a}).
16047
16048@item Alg*
16049Total algebraic mode (@kbd{m t}).
16050
16051@item Symb
16052Symbolic mode (@kbd{m s}; @pxref{Symbolic Mode}).
16053
16054@item Matrix
16055Matrix mode (@kbd{m v}; @pxref{Matrix Mode}).
16056
16057@item Matrix@var{n}
07ce2eb3 16058Dimensioned Matrix mode (@kbd{C-u @var{n} m v}).
d7b8e6c6
EZ
16059
16060@item Scalar
16061Scalar mode (@kbd{m v}; @pxref{Matrix Mode}).
16062
16063@item Polar
16064Polar complex mode (@kbd{m p}; @pxref{Polar Mode}).
16065
16066@item Frac
16067Fraction mode (@kbd{m f}; @pxref{Fraction Mode}).
16068
16069@item Inf
16070Infinite mode (@kbd{m i}; @pxref{Infinite Mode}).
16071
16072@item +Inf
07ce2eb3 16073Positive Infinite mode (@kbd{C-u 0 m i}).
d7b8e6c6
EZ
16074
16075@item NoSimp
16076Default simplifications off (@kbd{m O}; @pxref{Simplification Modes}).
16077
16078@item NumSimp
16079Default simplifications for numeric arguments only (@kbd{m N}).
16080
16081@item BinSimp@var{w}
16082Binary-integer simplification mode; word size @var{w} (@kbd{m B}, @kbd{b w}).
16083
16084@item AlgSimp
16085Algebraic simplification mode (@kbd{m A}).
16086
16087@item ExtSimp
16088Extended algebraic simplification mode (@kbd{m E}).
16089
16090@item UnitSimp
16091Units simplification mode (@kbd{m U}).
16092
16093@item Bin
16094Current radix is 2 (@kbd{d 2}; @pxref{Radix Modes}).
16095
16096@item Oct
16097Current radix is 8 (@kbd{d 8}).
16098
16099@item Hex
16100Current radix is 16 (@kbd{d 6}).
16101
16102@item Radix@var{n}
16103Current radix is @var{n} (@kbd{d r}).
16104
16105@item Zero
16106Leading zeros (@kbd{d z}; @pxref{Radix Modes}).
16107
16108@item Big
16109Big language mode (@kbd{d B}; @pxref{Normal Language Modes}).
16110
16111@item Flat
16112One-line normal language mode (@kbd{d O}).
16113
16114@item Unform
16115Unformatted language mode (@kbd{d U}).
16116
16117@item C
16118C language mode (@kbd{d C}; @pxref{C FORTRAN Pascal}).
16119
16120@item Pascal
16121Pascal language mode (@kbd{d P}).
16122
16123@item Fortran
16124FORTRAN language mode (@kbd{d F}).
16125
16126@item TeX
8ed713c6
JB
16127@TeX{} language mode (@kbd{d T}; @pxref{TeX and LaTeX Language Modes}).
16128
16129@item LaTeX
053bc283 16130La@TeX{} language mode (@kbd{d L}; @pxref{TeX and LaTeX Language Modes}).
d7b8e6c6
EZ
16131
16132@item Eqn
16133@dfn{Eqn} language mode (@kbd{d E}; @pxref{Eqn Language Mode}).
16134
16135@item Math
16136Mathematica language mode (@kbd{d M}; @pxref{Mathematica Language Mode}).
16137
16138@item Maple
16139Maple language mode (@kbd{d W}; @pxref{Maple Language Mode}).
16140
16141@item Norm@var{n}
16142Normal float mode with @var{n} digits (@kbd{d n}; @pxref{Float Formats}).
16143
16144@item Fix@var{n}
16145Fixed point mode with @var{n} digits after the point (@kbd{d f}).
16146
16147@item Sci
16148Scientific notation mode (@kbd{d s}).
16149
16150@item Sci@var{n}
16151Scientific notation with @var{n} digits (@kbd{d s}).
16152
16153@item Eng
16154Engineering notation mode (@kbd{d e}).
16155
16156@item Eng@var{n}
16157Engineering notation with @var{n} digits (@kbd{d e}).
16158
16159@item Left@var{n}
16160Left-justified display indented by @var{n} (@kbd{d <}; @pxref{Justification}).
16161
16162@item Right
16163Right-justified display (@kbd{d >}).
16164
16165@item Right@var{n}
16166Right-justified display with width @var{n} (@kbd{d >}).
16167
16168@item Center
16169Centered display (@kbd{d =}).
16170
16171@item Center@var{n}
16172Centered display with center column @var{n} (@kbd{d =}).
16173
16174@item Wid@var{n}
16175Line breaking with width @var{n} (@kbd{d b}; @pxref{Normal Language Modes}).
16176
16177@item Wide
16178No line breaking (@kbd{d b}).
16179
16180@item Break
16181Selections show deep structure (@kbd{j b}; @pxref{Making Selections}).
16182
16183@item Save
3b846359 16184Record modes in @file{~/.calc.el} (@kbd{m R}; @pxref{General Mode Commands}).
d7b8e6c6
EZ
16185
16186@item Local
16187Record modes in Embedded buffer (@kbd{m R}).
16188
16189@item LocEdit
16190Record modes as editing-only in Embedded buffer (@kbd{m R}).
16191
16192@item LocPerm
16193Record modes as permanent-only in Embedded buffer (@kbd{m R}).
16194
16195@item Global
16196Record modes as global in Embedded buffer (@kbd{m R}).
16197
16198@item Manual
16199Automatic recomputation turned off (@kbd{m C}; @pxref{Automatic
16200Recomputation}).
16201
16202@item Graph
16203GNUPLOT process is alive in background (@pxref{Graphics}).
16204
16205@item Sel
16206Top-of-stack has a selection (Embedded only; @pxref{Making Selections}).
16207
16208@item Dirty
16209The stack display may not be up-to-date (@pxref{Display Modes}).
16210
16211@item Inv
16212``Inverse'' prefix was pressed (@kbd{I}; @pxref{Inverse and Hyperbolic}).
16213
16214@item Hyp
16215``Hyperbolic'' prefix was pressed (@kbd{H}).
16216
16217@item Keep
16218``Keep-arguments'' prefix was pressed (@kbd{K}).
16219
16220@item Narrow
16221Stack is truncated (@kbd{d t}; @pxref{Truncating the Stack}).
16222@end table
16223
16224In addition, the symbols @code{Active} and @code{~Active} can appear
16225as minor modes on an Embedded buffer's mode line. @xref{Embedded Mode}.
16226
16227@node Arithmetic, Scientific Functions, Mode Settings, Top
16228@chapter Arithmetic Functions
16229
16230@noindent
16231This chapter describes the Calc commands for doing simple calculations
16232on numbers, such as addition, absolute value, and square roots. These
16233commands work by removing the top one or two values from the stack,
16234performing the desired operation, and pushing the result back onto the
16235stack. If the operation cannot be performed, the result pushed is a
16236formula instead of a number, such as @samp{2/0} (because division by zero
ce7c7522 16237is invalid) or @samp{sqrt(x)} (because the argument @samp{x} is a formula).
d7b8e6c6
EZ
16238
16239Most of the commands described here can be invoked by a single keystroke.
16240Some of the more obscure ones are two-letter sequences beginning with
16241the @kbd{f} (``functions'') prefix key.
16242
16243@xref{Prefix Arguments}, for a discussion of the effect of numeric
16244prefix arguments on commands in this chapter which do not otherwise
16245interpret a prefix argument.
16246
16247@menu
16248* Basic Arithmetic::
16249* Integer Truncation::
16250* Complex Number Functions::
16251* Conversions::
16252* Date Arithmetic::
16253* Financial Functions::
16254* Binary Functions::
16255@end menu
16256
16257@node Basic Arithmetic, Integer Truncation, Arithmetic, Arithmetic
16258@section Basic Arithmetic
16259
16260@noindent
16261@kindex +
16262@pindex calc-plus
5d67986c
RS
16263@ignore
16264@mindex @null
16265@end ignore
d7b8e6c6
EZ
16266@tindex +
16267The @kbd{+} (@code{calc-plus}) command adds two numbers. The numbers may
16268be any of the standard Calc data types. The resulting sum is pushed back
16269onto the stack.
16270
16271If both arguments of @kbd{+} are vectors or matrices (of matching dimensions),
16272the result is a vector or matrix sum. If one argument is a vector and the
16273other a scalar (i.e., a non-vector), the scalar is added to each of the
16274elements of the vector to form a new vector. If the scalar is not a
16275number, the operation is left in symbolic form: Suppose you added @samp{x}
16276to the vector @samp{[1,2]}. You may want the result @samp{[1+x,2+x]}, or
16277you may plan to substitute a 2-vector for @samp{x} in the future. Since
16278the Calculator can't tell which interpretation you want, it makes the
16279safest assumption. @xref{Reducing and Mapping}, for a way to add @samp{x}
16280to every element of a vector.
16281
16282If either argument of @kbd{+} is a complex number, the result will in general
16283be complex. If one argument is in rectangular form and the other polar,
07ce2eb3
JB
16284the current Polar mode determines the form of the result. If Symbolic
16285mode is enabled, the sum may be left as a formula if the necessary
d7b8e6c6
EZ
16286conversions for polar addition are non-trivial.
16287
16288If both arguments of @kbd{+} are HMS forms, the forms are added according to
16289the usual conventions of hours-minutes-seconds notation. If one argument
16290is an HMS form and the other is a number, that number is converted from
07ce2eb3 16291degrees or radians (depending on the current Angular mode) to HMS format
d7b8e6c6
EZ
16292and then the two HMS forms are added.
16293
16294If one argument of @kbd{+} is a date form, the other can be either a
16295real number, which advances the date by a certain number of days, or
16296an HMS form, which advances the date by a certain amount of time.
16297Subtracting two date forms yields the number of days between them.
16298Adding two date forms is meaningless, but Calc interprets it as the
16299subtraction of one date form and the negative of the other. (The
16300negative of a date form can be understood by remembering that dates
16301are stored as the number of days before or after Jan 1, 1 AD.)
16302
16303If both arguments of @kbd{+} are error forms, the result is an error form
16304with an appropriately computed standard deviation. If one argument is an
16305error form and the other is a number, the number is taken to have zero error.
16306Error forms may have symbolic formulas as their mean and/or error parts;
16307adding these will produce a symbolic error form result. However, adding an
16308error form to a plain symbolic formula (as in @samp{(a +/- b) + c}) will not
16309work, for the same reasons just mentioned for vectors. Instead you must
16310write @samp{(a +/- b) + (c +/- 0)}.
16311
a4231b04 16312If both arguments of @kbd{+} are modulo forms with equal values of @expr{M},
d7b8e6c6 16313or if one argument is a modulo form and the other a plain number, the
a4231b04 16314result is a modulo form which represents the sum, modulo @expr{M}, of
d7b8e6c6
EZ
16315the two values.
16316
16317If both arguments of @kbd{+} are intervals, the result is an interval
16318which describes all possible sums of the possible input values. If
16319one argument is a plain number, it is treated as the interval
16320@w{@samp{[x ..@: x]}}.
16321
16322If one argument of @kbd{+} is an infinity and the other is not, the
16323result is that same infinity. If both arguments are infinite and in
16324the same direction, the result is the same infinity, but if they are
16325infinite in different directions the result is @code{nan}.
16326
16327@kindex -
16328@pindex calc-minus
5d67986c
RS
16329@ignore
16330@mindex @null
16331@end ignore
d7b8e6c6
EZ
16332@tindex -
16333The @kbd{-} (@code{calc-minus}) command subtracts two values. The top
16334number on the stack is subtracted from the one behind it, so that the
8e04863e 16335computation @kbd{5 @key{RET} 2 -} produces 3, not @mathit{-3}. All options
d7b8e6c6
EZ
16336available for @kbd{+} are available for @kbd{-} as well.
16337
16338@kindex *
16339@pindex calc-times
5d67986c
RS
16340@ignore
16341@mindex @null
16342@end ignore
d7b8e6c6
EZ
16343@tindex *
16344The @kbd{*} (@code{calc-times}) command multiplies two numbers. If one
16345argument is a vector and the other a scalar, the scalar is multiplied by
16346the elements of the vector to produce a new vector. If both arguments
16347are vectors, the interpretation depends on the dimensions of the
16348vectors: If both arguments are matrices, a matrix multiplication is
16349done. If one argument is a matrix and the other a plain vector, the
16350vector is interpreted as a row vector or column vector, whichever is
16351dimensionally correct. If both arguments are plain vectors, the result
16352is a single scalar number which is the dot product of the two vectors.
16353
16354If one argument of @kbd{*} is an HMS form and the other a number, the
16355HMS form is multiplied by that amount. It is an error to multiply two
16356HMS forms together, or to attempt any multiplication involving date
16357forms. Error forms, modulo forms, and intervals can be multiplied;
16358see the comments for addition of those forms. When two error forms
16359or intervals are multiplied they are considered to be statistically
16360independent; thus, @samp{[-2 ..@: 3] * [-2 ..@: 3]} is @samp{[-6 ..@: 9]},
16361whereas @w{@samp{[-2 ..@: 3] ^ 2}} is @samp{[0 ..@: 9]}.
16362
16363@kindex /
16364@pindex calc-divide
5d67986c
RS
16365@ignore
16366@mindex @null
16367@end ignore
d7b8e6c6
EZ
16368@tindex /
16369The @kbd{/} (@code{calc-divide}) command divides two numbers. When
a4231b04
JB
16370dividing a scalar @expr{B} by a square matrix @expr{A}, the computation
16371performed is @expr{B} times the inverse of @expr{A}. This also occurs
16372if @expr{B} is itself a vector or matrix, in which case the effect is
16373to solve the set of linear equations represented by @expr{B}. If @expr{B}
16374is a matrix with the same number of rows as @expr{A}, or a plain vector
d7b8e6c6 16375(which is interpreted here as a column vector), then the equation
a4231b04
JB
16376@expr{A X = B} is solved for the vector or matrix @expr{X}. Otherwise,
16377if @expr{B} is a non-square matrix with the same number of @emph{columns}
16378as @expr{A}, the equation @expr{X A = B} is solved. If you wish a vector
16379@expr{B} to be interpreted as a row vector to be solved as @expr{X A = B},
d7b8e6c6 16380make it into a one-row matrix with @kbd{C-u 1 v p} first. To force a
a4231b04
JB
16381left-handed solution with a square matrix @expr{B}, transpose @expr{A} and
16382@expr{B} before dividing, then transpose the result.
d7b8e6c6
EZ
16383
16384HMS forms can be divided by real numbers or by other HMS forms. Error
16385forms can be divided in any combination of ways. Modulo forms where both
16386values and the modulo are integers can be divided to get an integer modulo
16387form result. Intervals can be divided; dividing by an interval that
16388encompasses zero or has zero as a limit will result in an infinite
16389interval.
16390
16391@kindex ^
16392@pindex calc-power
5d67986c
RS
16393@ignore
16394@mindex @null
16395@end ignore
d7b8e6c6
EZ
16396@tindex ^
16397The @kbd{^} (@code{calc-power}) command raises a number to a power. If
16398the power is an integer, an exact result is computed using repeated
16399multiplications. For non-integer powers, Calc uses Newton's method or
16400logarithms and exponentials. Square matrices can be raised to integer
16401powers. If either argument is an error (or interval or modulo) form,
16402the result is also an error (or interval or modulo) form.
16403
16404@kindex I ^
16405@tindex nroot
16406If you press the @kbd{I} (inverse) key first, the @kbd{I ^} command
5d67986c
RS
16407computes an Nth root: @kbd{125 @key{RET} 3 I ^} computes the number 5.
16408(This is entirely equivalent to @kbd{125 @key{RET} 1:3 ^}.)
d7b8e6c6
EZ
16409
16410@kindex \
16411@pindex calc-idiv
16412@tindex idiv
5d67986c
RS
16413@ignore
16414@mindex @null
16415@end ignore
d7b8e6c6
EZ
16416@tindex \
16417The @kbd{\} (@code{calc-idiv}) command divides two numbers on the stack
16418to produce an integer result. It is equivalent to dividing with
16419@key{/}, then rounding down with @kbd{F} (@code{calc-floor}), only a bit
16420more convenient and efficient. Also, since it is an all-integer
16421operation when the arguments are integers, it avoids problems that
16422@kbd{/ F} would have with floating-point roundoff.
16423
16424@kindex %
16425@pindex calc-mod
5d67986c
RS
16426@ignore
16427@mindex @null
16428@end ignore
d7b8e6c6
EZ
16429@tindex %
16430The @kbd{%} (@code{calc-mod}) command performs a ``modulo'' (or ``remainder'')
16431operation. Mathematically, @samp{a%b = a - (a\b)*b}, and is defined
a4231b04
JB
16432for all real numbers @expr{a} and @expr{b} (except @expr{b=0}). For
16433positive @expr{b}, the result will always be between 0 (inclusive) and
16434@expr{b} (exclusive). Modulo does not work for HMS forms and error forms.
16435If @expr{a} is a modulo form, its modulo is changed to @expr{b}, which
d7b8e6c6
EZ
16436must be positive real number.
16437
16438@kindex :
16439@pindex calc-fdiv
16440@tindex fdiv
029b2a44 16441The @kbd{:} (@code{calc-fdiv}) [@code{fdiv}] command
d7b8e6c6 16442divides the two integers on the top of the stack to produce a fractional
07ce2eb3 16443result. This is a convenient shorthand for enabling Fraction mode (with
d7b8e6c6
EZ
16444@kbd{m f}) temporarily and using @samp{/}. Note that during numeric entry
16445the @kbd{:} key is interpreted as a fraction separator, so to divide 8 by 6
16446you would have to type @kbd{8 @key{RET} 6 @key{RET} :}. (Of course, in
16447this case, it would be much easier simply to enter the fraction directly
16448as @kbd{8:6 @key{RET}}!)
16449
16450@kindex n
16451@pindex calc-change-sign
16452The @kbd{n} (@code{calc-change-sign}) command negates the number on the top
16453of the stack. It works on numbers, vectors and matrices, HMS forms, date
16454forms, error forms, intervals, and modulo forms.
16455
16456@kindex A
16457@pindex calc-abs
16458@tindex abs
16459The @kbd{A} (@code{calc-abs}) [@code{abs}] command computes the absolute
16460value of a number. The result of @code{abs} is always a nonnegative
16461real number: With a complex argument, it computes the complex magnitude.
16462With a vector or matrix argument, it computes the Frobenius norm, i.e.,
16463the square root of the sum of the squares of the absolute values of the
16464elements. The absolute value of an error form is defined by replacing
16465the mean part with its absolute value and leaving the error part the same.
16466The absolute value of a modulo form is undefined. The absolute value of
16467an interval is defined in the obvious way.
16468
16469@kindex f A
16470@pindex calc-abssqr
16471@tindex abssqr
16472The @kbd{f A} (@code{calc-abssqr}) [@code{abssqr}] command computes the
16473absolute value squared of a number, vector or matrix, or error form.
16474
16475@kindex f s
16476@pindex calc-sign
16477@tindex sign
16478The @kbd{f s} (@code{calc-sign}) [@code{sign}] command returns 1 if its
8e04863e 16479argument is positive, @mathit{-1} if its argument is negative, or 0 if its
d7b8e6c6
EZ
16480argument is zero. In algebraic form, you can also write @samp{sign(a,x)}
16481which evaluates to @samp{x * sign(a)}, i.e., either @samp{x}, @samp{-x}, or
16482zero depending on the sign of @samp{a}.
16483
16484@kindex &
16485@pindex calc-inv
16486@tindex inv
16487@cindex Reciprocal
16488The @kbd{&} (@code{calc-inv}) [@code{inv}] command computes the
a4231b04 16489reciprocal of a number, i.e., @expr{1 / x}. Operating on a square
d7b8e6c6
EZ
16490matrix, it computes the inverse of that matrix.
16491
16492@kindex Q
16493@pindex calc-sqrt
16494@tindex sqrt
16495The @kbd{Q} (@code{calc-sqrt}) [@code{sqrt}] command computes the square
16496root of a number. For a negative real argument, the result will be a
07ce2eb3 16497complex number whose form is determined by the current Polar mode.
d7b8e6c6
EZ
16498
16499@kindex f h
16500@pindex calc-hypot
16501@tindex hypot
16502The @kbd{f h} (@code{calc-hypot}) [@code{hypot}] command computes the square
16503root of the sum of the squares of two numbers. That is, @samp{hypot(a,b)}
a4231b04
JB
16504is the length of the hypotenuse of a right triangle with sides @expr{a}
16505and @expr{b}. If the arguments are complex numbers, their squared
d7b8e6c6
EZ
16506magnitudes are used.
16507
16508@kindex f Q
16509@pindex calc-isqrt
16510@tindex isqrt
16511The @kbd{f Q} (@code{calc-isqrt}) [@code{isqrt}] command computes the
16512integer square root of an integer. This is the true square root of the
16513number, rounded down to an integer. For example, @samp{isqrt(10)}
16514produces 3. Note that, like @kbd{\} [@code{idiv}], this uses exact
16515integer arithmetic throughout to avoid roundoff problems. If the input
16516is a floating-point number or other non-integer value, this is exactly
16517the same as @samp{floor(sqrt(x))}.
16518
16519@kindex f n
16520@kindex f x
16521@pindex calc-min
16522@tindex min
16523@pindex calc-max
16524@tindex max
16525The @kbd{f n} (@code{calc-min}) [@code{min}] and @kbd{f x} (@code{calc-max})
16526[@code{max}] commands take the minimum or maximum of two real numbers,
16527respectively. These commands also work on HMS forms, date forms,
16528intervals, and infinities. (In algebraic expressions, these functions
16529take any number of arguments and return the maximum or minimum among
a4231b04 16530all the arguments.)
d7b8e6c6
EZ
16531
16532@kindex f M
16533@kindex f X
16534@pindex calc-mant-part
16535@tindex mant
16536@pindex calc-xpon-part
16537@tindex xpon
16538The @kbd{f M} (@code{calc-mant-part}) [@code{mant}] function extracts
a4231b04 16539the ``mantissa'' part @expr{m} of its floating-point argument; @kbd{f X}
d7b8e6c6 16540(@code{calc-xpon-part}) [@code{xpon}] extracts the ``exponent'' part
a4231b04 16541@expr{e}. The original number is equal to
8e04863e 16542@texline @math{m \times 10^e},
a4231b04
JB
16543@infoline @expr{m * 10^e},
16544where @expr{m} is in the interval @samp{[1.0 ..@: 10.0)} except that
16545@expr{m=e=0} if the original number is zero. For integers
d7b8e6c6
EZ
16546and fractions, @code{mant} returns the number unchanged and @code{xpon}
16547returns zero. The @kbd{v u} (@code{calc-unpack}) command can also be
16548used to ``unpack'' a floating-point number; this produces an integer
16549mantissa and exponent, with the constraint that the mantissa is not
a4231b04 16550a multiple of ten (again except for the @expr{m=e=0} case).
d7b8e6c6
EZ
16551
16552@kindex f S
16553@pindex calc-scale-float
16554@tindex scf
16555The @kbd{f S} (@code{calc-scale-float}) [@code{scf}] function scales a number
16556by a given power of ten. Thus, @samp{scf(mant(x), xpon(x)) = x} for any
16557real @samp{x}. The second argument must be an integer, but the first
16558may actually be any numeric value. For example, @samp{scf(5,-2) = 0.05}
07ce2eb3 16559or @samp{1:20} depending on the current Fraction mode.
d7b8e6c6
EZ
16560
16561@kindex f [
16562@kindex f ]
16563@pindex calc-decrement
16564@pindex calc-increment
16565@tindex decr
16566@tindex incr
16567The @kbd{f [} (@code{calc-decrement}) [@code{decr}] and @kbd{f ]}
16568(@code{calc-increment}) [@code{incr}] functions decrease or increase
16569a number by one unit. For integers, the effect is obvious. For
16570floating-point numbers, the change is by one unit in the last place.
16571For example, incrementing @samp{12.3456} when the current precision
16572is 6 digits yields @samp{12.3457}. If the current precision had been
165738 digits, the result would have been @samp{12.345601}. Incrementing
a4231b04 16574@samp{0.0} produces
8e04863e 16575@texline @math{10^{-p}},
a4231b04
JB
16576@infoline @expr{10^-p},
16577where @expr{p} is the current
d7b8e6c6 16578precision. These operations are defined only on integers and floats.
a4231b04 16579With numeric prefix arguments, they change the number by @expr{n} units.
d7b8e6c6
EZ
16580
16581Note that incrementing followed by decrementing, or vice-versa, will
16582almost but not quite always cancel out. Suppose the precision is
165836 digits and the number @samp{9.99999} is on the stack. Incrementing
16584will produce @samp{10.0000}; decrementing will produce @samp{9.9999}.
16585One digit has been dropped. This is an unavoidable consequence of the
16586way floating-point numbers work.
16587
16588Incrementing a date/time form adjusts it by a certain number of seconds.
16589Incrementing a pure date form adjusts it by a certain number of days.
16590
16591@node Integer Truncation, Complex Number Functions, Basic Arithmetic, Arithmetic
16592@section Integer Truncation
16593
16594@noindent
16595There are four commands for truncating a real number to an integer,
16596differing mainly in their treatment of negative numbers. All of these
16597commands have the property that if the argument is an integer, the result
16598is the same integer. An integer-valued floating-point argument is converted
16599to integer form.
16600
16601If you press @kbd{H} (@code{calc-hyperbolic}) first, the result will be
16602expressed as an integer-valued floating-point number.
16603
16604@cindex Integer part of a number
16605@kindex F
16606@pindex calc-floor
16607@tindex floor
16608@tindex ffloor
5d67986c
RS
16609@ignore
16610@mindex @null
16611@end ignore
d7b8e6c6
EZ
16612@kindex H F
16613The @kbd{F} (@code{calc-floor}) [@code{floor} or @code{ffloor}] command
16614truncates a real number to the next lower integer, i.e., toward minus
16615infinity. Thus @kbd{3.6 F} produces 3, but @kbd{_3.6 F} produces
8e04863e 16616@mathit{-4}.
d7b8e6c6
EZ
16617
16618@kindex I F
16619@pindex calc-ceiling
16620@tindex ceil
16621@tindex fceil
5d67986c
RS
16622@ignore
16623@mindex @null
16624@end ignore
d7b8e6c6
EZ
16625@kindex H I F
16626The @kbd{I F} (@code{calc-ceiling}) [@code{ceil} or @code{fceil}]
16627command truncates toward positive infinity. Thus @kbd{3.6 I F} produces
8e04863e 166284, and @kbd{_3.6 I F} produces @mathit{-3}.
d7b8e6c6
EZ
16629
16630@kindex R
16631@pindex calc-round
16632@tindex round
16633@tindex fround
5d67986c
RS
16634@ignore
16635@mindex @null
16636@end ignore
d7b8e6c6
EZ
16637@kindex H R
16638The @kbd{R} (@code{calc-round}) [@code{round} or @code{fround}] command
16639rounds to the nearest integer. When the fractional part is .5 exactly,
16640this command rounds away from zero. (All other rounding in the
16641Calculator uses this convention as well.) Thus @kbd{3.5 R} produces 4
8e04863e 16642but @kbd{3.4 R} produces 3; @kbd{_3.5 R} produces @mathit{-4}.
d7b8e6c6
EZ
16643
16644@kindex I R
16645@pindex calc-trunc
16646@tindex trunc
16647@tindex ftrunc
5d67986c
RS
16648@ignore
16649@mindex @null
16650@end ignore
d7b8e6c6
EZ
16651@kindex H I R
16652The @kbd{I R} (@code{calc-trunc}) [@code{trunc} or @code{ftrunc}]
16653command truncates toward zero. In other words, it ``chops off''
16654everything after the decimal point. Thus @kbd{3.6 I R} produces 3 and
8e04863e 16655@kbd{_3.6 I R} produces @mathit{-3}.
d7b8e6c6
EZ
16656
16657These functions may not be applied meaningfully to error forms, but they
16658do work for intervals. As a convenience, applying @code{floor} to a
16659modulo form floors the value part of the form. Applied to a vector,
16660these functions operate on all elements of the vector one by one.
16661Applied to a date form, they operate on the internal numerical
16662representation of dates, converting a date/time form into a pure date.
16663
5d67986c
RS
16664@ignore
16665@starindex
16666@end ignore
d7b8e6c6 16667@tindex rounde
5d67986c
RS
16668@ignore
16669@starindex
16670@end ignore
d7b8e6c6 16671@tindex roundu
5d67986c
RS
16672@ignore
16673@starindex
16674@end ignore
d7b8e6c6 16675@tindex frounde
5d67986c
RS
16676@ignore
16677@starindex
16678@end ignore
d7b8e6c6
EZ
16679@tindex froundu
16680There are two more rounding functions which can only be entered in
16681algebraic notation. The @code{roundu} function is like @code{round}
16682except that it rounds up, toward plus infinity, when the fractional
16683part is .5. This distinction matters only for negative arguments.
16684Also, @code{rounde} rounds to an even number in the case of a tie,
16685rounding up or down as necessary. For example, @samp{rounde(3.5)} and
16686@samp{rounde(4.5)} both return 4, but @samp{rounde(5.5)} returns 6.
16687The advantage of round-to-even is that the net error due to rounding
16688after a long calculation tends to cancel out to zero. An important
16689subtle point here is that the number being fed to @code{rounde} will
16690already have been rounded to the current precision before @code{rounde}
16691begins. For example, @samp{rounde(2.500001)} with a current precision
16692of 6 will incorrectly, or at least surprisingly, yield 2 because the
a4231b04 16693argument will first have been rounded down to @expr{2.5} (which
d7b8e6c6
EZ
16694@code{rounde} sees as an exact tie between 2 and 3).
16695
16696Each of these functions, when written in algebraic formulas, allows
16697a second argument which specifies the number of digits after the
16698decimal point to keep. For example, @samp{round(123.4567, 2)} will
16699produce the answer 123.46, and @samp{round(123.4567, -1)} will
16700produce 120 (i.e., the cutoff is one digit to the @emph{left} of
16701the decimal point). A second argument of zero is equivalent to
16702no second argument at all.
16703
16704@cindex Fractional part of a number
16705To compute the fractional part of a number (i.e., the amount which, when
bd712b70 16706added to `@tfn{floor(}@var{n}@tfn{)}', will produce @var{n}) just take @var{n}
a4231b04 16707modulo 1 using the @code{%} command.
d7b8e6c6
EZ
16708
16709Note also the @kbd{\} (integer quotient), @kbd{f I} (integer logarithm),
16710and @kbd{f Q} (integer square root) commands, which are analogous to
16711@kbd{/}, @kbd{B}, and @kbd{Q}, respectively, except that they take integer
16712arguments and return the result rounded down to an integer.
16713
16714@node Complex Number Functions, Conversions, Integer Truncation, Arithmetic
16715@section Complex Number Functions
16716
16717@noindent
16718@kindex J
16719@pindex calc-conj
16720@tindex conj
16721The @kbd{J} (@code{calc-conj}) [@code{conj}] command computes the
a4231b04
JB
16722complex conjugate of a number. For complex number @expr{a+bi}, the
16723complex conjugate is @expr{a-bi}. If the argument is a real number,
d7b8e6c6
EZ
16724this command leaves it the same. If the argument is a vector or matrix,
16725this command replaces each element by its complex conjugate.
16726
16727@kindex G
16728@pindex calc-argument
16729@tindex arg
16730The @kbd{G} (@code{calc-argument}) [@code{arg}] command computes the
16731``argument'' or polar angle of a complex number. For a number in polar
16732notation, this is simply the second component of the pair
bd712b70
JB
16733@texline `@tfn{(}@var{r}@tfn{;}@math{\theta}@tfn{)}'.
16734@infoline `@tfn{(}@var{r}@tfn{;}@var{theta}@tfn{)}'.
d7b8e6c6 16735The result is expressed according to the current angular mode and will
8e04863e 16736be in the range @mathit{-180} degrees (exclusive) to @mathit{+180} degrees
a4231b04 16737(inclusive), or the equivalent range in radians.
d7b8e6c6
EZ
16738
16739@pindex calc-imaginary
16740The @code{calc-imaginary} command multiplies the number on the
a4231b04 16741top of the stack by the imaginary number @expr{i = (0,1)}. This
d7b8e6c6 16742command is not normally bound to a key in Calc, but it is available
07ce2eb3 16743on the @key{IMAG} button in Keypad mode.
d7b8e6c6
EZ
16744
16745@kindex f r
16746@pindex calc-re
16747@tindex re
16748The @kbd{f r} (@code{calc-re}) [@code{re}] command replaces a complex number
16749by its real part. This command has no effect on real numbers. (As an
16750added convenience, @code{re} applied to a modulo form extracts
a4231b04 16751the value part.)
d7b8e6c6
EZ
16752
16753@kindex f i
16754@pindex calc-im
16755@tindex im
16756The @kbd{f i} (@code{calc-im}) [@code{im}] command replaces a complex number
16757by its imaginary part; real numbers are converted to zero. With a vector
a4231b04 16758or matrix argument, these functions operate element-wise.
d7b8e6c6 16759
5d67986c
RS
16760@ignore
16761@mindex v p
16762@end ignore
d7b8e6c6
EZ
16763@kindex v p (complex)
16764@pindex calc-pack
16765The @kbd{v p} (@code{calc-pack}) command can pack the top two numbers on
269b7745 16766the stack into a composite object such as a complex number. With
8e04863e
JB
16767a prefix argument of @mathit{-1}, it produces a rectangular complex number;
16768with an argument of @mathit{-2}, it produces a polar complex number.
d7b8e6c6
EZ
16769(Also, @pxref{Building Vectors}.)
16770
5d67986c
RS
16771@ignore
16772@mindex v u
16773@end ignore
d7b8e6c6
EZ
16774@kindex v u (complex)
16775@pindex calc-unpack
16776The @kbd{v u} (@code{calc-unpack}) command takes the complex number
16777(or other composite object) on the top of the stack and unpacks it
16778into its separate components.
16779
16780@node Conversions, Date Arithmetic, Complex Number Functions, Arithmetic
16781@section Conversions
16782
16783@noindent
16784The commands described in this section convert numbers from one form
16785to another; they are two-key sequences beginning with the letter @kbd{c}.
16786
16787@kindex c f
16788@pindex calc-float
16789@tindex pfloat
16790The @kbd{c f} (@code{calc-float}) [@code{pfloat}] command converts the
16791number on the top of the stack to floating-point form. For example,
a4231b04
JB
16792@expr{23} is converted to @expr{23.0}, @expr{3:2} is converted to
16793@expr{1.5}, and @expr{2.3} is left the same. If the value is a composite
d7b8e6c6
EZ
16794object such as a complex number or vector, each of the components is
16795converted to floating-point. If the value is a formula, all numbers
16796in the formula are converted to floating-point. Note that depending
16797on the current floating-point precision, conversion to floating-point
a4231b04 16798format may lose information.
d7b8e6c6
EZ
16799
16800As a special exception, integers which appear as powers or subscripts
16801are not floated by @kbd{c f}. If you really want to float a power,
16802you can use a @kbd{j s} command to select the power followed by @kbd{c f}.
16803Because @kbd{c f} cannot examine the formula outside of the selection,
16804it does not notice that the thing being floated is a power.
16805@xref{Selecting Subformulas}.
16806
16807The normal @kbd{c f} command is ``pervasive'' in the sense that it
16808applies to all numbers throughout the formula. The @code{pfloat}
16809algebraic function never stays around in a formula; @samp{pfloat(a + 1)}
16810changes to @samp{a + 1.0} as soon as it is evaluated.
16811
16812@kindex H c f
16813@tindex float
16814With the Hyperbolic flag, @kbd{H c f} [@code{float}] operates
16815only on the number or vector of numbers at the top level of its
16816argument. Thus, @samp{float(1)} is 1.0, but @samp{float(a + 1)}
16817is left unevaluated because its argument is not a number.
16818
16819You should use @kbd{H c f} if you wish to guarantee that the final
16820value, once all the variables have been assigned, is a float; you
16821would use @kbd{c f} if you wish to do the conversion on the numbers
16822that appear right now.
16823
16824@kindex c F
16825@pindex calc-fraction
16826@tindex pfrac
16827The @kbd{c F} (@code{calc-fraction}) [@code{pfrac}] command converts a
16828floating-point number into a fractional approximation. By default, it
16829produces a fraction whose decimal representation is the same as the
16830input number, to within the current precision. You can also give a
16831numeric prefix argument to specify a tolerance, either directly, or,
16832if the prefix argument is zero, by using the number on top of the stack
16833as the tolerance. If the tolerance is a positive integer, the fraction
16834is correct to within that many significant figures. If the tolerance is
16835a non-positive integer, it specifies how many digits fewer than the current
16836precision to use. If the tolerance is a floating-point number, the
16837fraction is correct to within that absolute amount.
16838
16839@kindex H c F
16840@tindex frac
16841The @code{pfrac} function is pervasive, like @code{pfloat}.
16842There is also a non-pervasive version, @kbd{H c F} [@code{frac}],
16843which is analogous to @kbd{H c f} discussed above.
16844
16845@kindex c d
16846@pindex calc-to-degrees
16847@tindex deg
16848The @kbd{c d} (@code{calc-to-degrees}) [@code{deg}] command converts a
16849number into degrees form. The value on the top of the stack may be an
16850HMS form (interpreted as degrees-minutes-seconds), or a real number which
a4231b04 16851will be interpreted in radians regardless of the current angular mode.
d7b8e6c6
EZ
16852
16853@kindex c r
16854@pindex calc-to-radians
16855@tindex rad
16856The @kbd{c r} (@code{calc-to-radians}) [@code{rad}] command converts an
16857HMS form or angle in degrees into an angle in radians.
16858
16859@kindex c h
16860@pindex calc-to-hms
16861@tindex hms
16862The @kbd{c h} (@code{calc-to-hms}) [@code{hms}] command converts a real
16863number, interpreted according to the current angular mode, to an HMS
16864form describing the same angle. In algebraic notation, the @code{hms}
16865function also accepts three arguments: @samp{hms(@var{h}, @var{m}, @var{s})}.
16866(The three-argument version is independent of the current angular mode.)
16867
16868@pindex calc-from-hms
16869The @code{calc-from-hms} command converts the HMS form on the top of the
16870stack into a real number according to the current angular mode.
16871
16872@kindex c p
16873@kindex I c p
16874@pindex calc-polar
16875@tindex polar
16876@tindex rect
16877The @kbd{c p} (@code{calc-polar}) command converts the complex number on
16878the top of the stack from polar to rectangular form, or from rectangular
16879to polar form, whichever is appropriate. Real numbers are left the same.
16880This command is equivalent to the @code{rect} or @code{polar}
16881functions in algebraic formulas, depending on the direction of
16882conversion. (It uses @code{polar}, except that if the argument is
16883already a polar complex number, it uses @code{rect} instead. The
a4231b04 16884@kbd{I c p} command always uses @code{rect}.)
d7b8e6c6
EZ
16885
16886@kindex c c
16887@pindex calc-clean
16888@tindex pclean
16889The @kbd{c c} (@code{calc-clean}) [@code{pclean}] command ``cleans'' the
16890number on the top of the stack. Floating point numbers are re-rounded
16891according to the current precision. Polar numbers whose angular
8e04863e 16892components have strayed from the @mathit{-180} to @mathit{+180} degree range
d7b8e6c6
EZ
16893are normalized. (Note that results will be undesirable if the current
16894angular mode is different from the one under which the number was
16895produced!) Integers and fractions are generally unaffected by this
16896operation. Vectors and formulas are cleaned by cleaning each component
a4231b04 16897number (i.e., pervasively).
d7b8e6c6
EZ
16898
16899If the simplification mode is set below the default level, it is raised
16900to the default level for the purposes of this command. Thus, @kbd{c c}
16901applies the default simplifications even if their automatic application
16902is disabled. @xref{Simplification Modes}.
16903
16904@cindex Roundoff errors, correcting
16905A numeric prefix argument to @kbd{c c} sets the floating-point precision
16906to that value for the duration of the command. A positive prefix (of at
16907least 3) sets the precision to the specified value; a negative or zero
16908prefix decreases the precision by the specified amount.
16909
16910@kindex c 0-9
16911@pindex calc-clean-num
16912The keystroke sequences @kbd{c 0} through @kbd{c 9} are equivalent
16913to @kbd{c c} with the corresponding negative prefix argument. If roundoff
16914errors have changed 2.0 into 1.999999, typing @kbd{c 1} to clip off one
16915decimal place often conveniently does the trick.
16916
16917The @kbd{c c} command with a numeric prefix argument, and the @kbd{c 0}
16918through @kbd{c 9} commands, also ``clip'' very small floating-point
16919numbers to zero. If the exponent is less than or equal to the negative
16920of the specified precision, the number is changed to 0.0. For example,
16921if the current precision is 12, then @kbd{c 2} changes the vector
16922@samp{[1e-8, 1e-9, 1e-10, 1e-11]} to @samp{[1e-8, 1e-9, 0, 0]}.
16923Numbers this small generally arise from roundoff noise.
16924
16925If the numbers you are using really are legitimately this small,
16926you should avoid using the @kbd{c 0} through @kbd{c 9} commands.
16927(The plain @kbd{c c} command rounds to the current precision but
16928does not clip small numbers.)
16929
16930One more property of @kbd{c 0} through @kbd{c 9}, and of @kbd{c c} with
16931a prefix argument, is that integer-valued floats are converted to
16932plain integers, so that @kbd{c 1} on @samp{[1., 1.5, 2., 2.5, 3.]}
16933produces @samp{[1, 1.5, 2, 2.5, 3]}. This is not done for huge
16934numbers (@samp{1e100} is technically an integer-valued float, but
16935you wouldn't want it automatically converted to a 100-digit integer).
16936
16937@kindex H c 0-9
16938@kindex H c c
16939@tindex clean
16940With the Hyperbolic flag, @kbd{H c c} and @kbd{H c 0} through @kbd{H c 9}
16941operate non-pervasively [@code{clean}].
16942
16943@node Date Arithmetic, Financial Functions, Conversions, Arithmetic
16944@section Date Arithmetic
16945
16946@noindent
16947@cindex Date arithmetic, additional functions
16948The commands described in this section perform various conversions
16949and calculations involving date forms (@pxref{Date Forms}). They
16950use the @kbd{t} (for time/date) prefix key followed by shifted
16951letters.
16952
16953The simplest date arithmetic is done using the regular @kbd{+} and @kbd{-}
16954commands. In particular, adding a number to a date form advances the
16955date form by a certain number of days; adding an HMS form to a date
16956form advances the date by a certain amount of time; and subtracting two
16957date forms produces a difference measured in days. The commands
16958described here provide additional, more specialized operations on dates.
16959
16960Many of these commands accept a numeric prefix argument; if you give
16961plain @kbd{C-u} as the prefix, these commands will instead take the
16962additional argument from the top of the stack.
16963
16964@menu
16965* Date Conversions::
16966* Date Functions::
16967* Time Zones::
16968* Business Days::
16969@end menu
16970
16971@node Date Conversions, Date Functions, Date Arithmetic, Date Arithmetic
16972@subsection Date Conversions
16973
16974@noindent
16975@kindex t D
16976@pindex calc-date
16977@tindex date
16978The @kbd{t D} (@code{calc-date}) [@code{date}] command converts a
16979date form into a number, measured in days since Jan 1, 1 AD. The
16980result will be an integer if @var{date} is a pure date form, or a
16981fraction or float if @var{date} is a date/time form. Or, if its
16982argument is a number, it converts this number into a date form.
16983
16984With a numeric prefix argument, @kbd{t D} takes that many objects
16985(up to six) from the top of the stack and interprets them in one
16986of the following ways:
16987
16988The @samp{date(@var{year}, @var{month}, @var{day})} function
16989builds a pure date form out of the specified year, month, and
16990day, which must all be integers. @var{Year} is a year number,
16991such as 1991 (@emph{not} the same as 91!). @var{Month} must be
16992an integer in the range 1 to 12; @var{day} must be in the range
169931 to 31. If the specified month has fewer than 31 days and
16994@var{day} is too large, the equivalent day in the following
16995month will be used.
16996
16997The @samp{date(@var{month}, @var{day})} function builds a
16998pure date form using the current year, as determined by the
16999real-time clock.
17000
17001The @samp{date(@var{year}, @var{month}, @var{day}, @var{hms})}
17002function builds a date/time form using an @var{hms} form.
17003
17004The @samp{date(@var{year}, @var{month}, @var{day}, @var{hour},
17005@var{minute}, @var{second})} function builds a date/time form.
17006@var{hour} should be an integer in the range 0 to 23;
17007@var{minute} should be an integer in the range 0 to 59;
17008@var{second} should be any real number in the range @samp{[0 .. 60)}.
17009The last two arguments default to zero if omitted.
17010
17011@kindex t J
17012@pindex calc-julian
17013@tindex julian
17014@cindex Julian day counts, conversions
17015The @kbd{t J} (@code{calc-julian}) [@code{julian}] command converts
17016a date form into a Julian day count, which is the number of days
17017since noon on Jan 1, 4713 BC. A pure date is converted to an integer
17018Julian count representing noon of that day. A date/time form is
17019converted to an exact floating-point Julian count, adjusted to
17020interpret the date form in the current time zone but the Julian
17021day count in Greenwich Mean Time. A numeric prefix argument allows
17022you to specify the time zone; @pxref{Time Zones}. Use a prefix of
17023zero to suppress the time zone adjustment. Note that pure date forms
17024are never time-zone adjusted.
17025
17026This command can also do the opposite conversion, from a Julian day
17027count (either an integer day, or a floating-point day and time in
17028the GMT zone), into a pure date form or a date/time form in the
17029current or specified time zone.
17030
17031@kindex t U
17032@pindex calc-unix-time
17033@tindex unixtime
17034@cindex Unix time format, conversions
17035The @kbd{t U} (@code{calc-unix-time}) [@code{unixtime}] command
17036converts a date form into a Unix time value, which is the number of
17037seconds since midnight on Jan 1, 1970, or vice-versa. The numeric result
17038will be an integer if the current precision is 12 or less; for higher
5d67986c 17039precisions, the result may be a float with (@var{precision}@minus{}12)
d7b8e6c6
EZ
17040digits after the decimal. Just as for @kbd{t J}, the numeric time
17041is interpreted in the GMT time zone and the date form is interpreted
17042in the current or specified zone. Some systems use Unix-like
17043numbering but with the local time zone; give a prefix of zero to
17044suppress the adjustment if so.
17045
17046@kindex t C
17047@pindex calc-convert-time-zones
17048@tindex tzconv
17049@cindex Time Zones, converting between
17050The @kbd{t C} (@code{calc-convert-time-zones}) [@code{tzconv}]
17051command converts a date form from one time zone to another. You
17052are prompted for each time zone name in turn; you can answer with
17053any suitable Calc time zone expression (@pxref{Time Zones}).
17054If you answer either prompt with a blank line, the local time
17055zone is used for that prompt. You can also answer the first
17056prompt with @kbd{$} to take the two time zone names from the
17057stack (and the date to be converted from the third stack level).
17058
17059@node Date Functions, Business Days, Date Conversions, Date Arithmetic
17060@subsection Date Functions
17061
17062@noindent
17063@kindex t N
17064@pindex calc-now
17065@tindex now
17066The @kbd{t N} (@code{calc-now}) [@code{now}] command pushes the
17067current date and time on the stack as a date form. The time is
17068reported in terms of the specified time zone; with no numeric prefix
17069argument, @kbd{t N} reports for the current time zone.
17070
17071@kindex t P
17072@pindex calc-date-part
17073The @kbd{t P} (@code{calc-date-part}) command extracts one part
17074of a date form. The prefix argument specifies the part; with no
17075argument, this command prompts for a part code from 1 to 9.
17076The various part codes are described in the following paragraphs.
17077
17078@tindex year
17079The @kbd{M-1 t P} [@code{year}] function extracts the year number
17080from a date form as an integer, e.g., 1991. This and the
17081following functions will also accept a real number for an
17082argument, which is interpreted as a standard Calc day number.
17083Note that this function will never return zero, since the year
170841 BC immediately precedes the year 1 AD.
17085
17086@tindex month
17087The @kbd{M-2 t P} [@code{month}] function extracts the month number
17088from a date form as an integer in the range 1 to 12.
17089
17090@tindex day
17091The @kbd{M-3 t P} [@code{day}] function extracts the day number
17092from a date form as an integer in the range 1 to 31.
17093
17094@tindex hour
17095The @kbd{M-4 t P} [@code{hour}] function extracts the hour from
17096a date form as an integer in the range 0 (midnight) to 23. Note
17097that 24-hour time is always used. This returns zero for a pure
17098date form. This function (and the following two) also accept
17099HMS forms as input.
17100
17101@tindex minute
17102The @kbd{M-5 t P} [@code{minute}] function extracts the minute
17103from a date form as an integer in the range 0 to 59.
17104
17105@tindex second
17106The @kbd{M-6 t P} [@code{second}] function extracts the second
17107from a date form. If the current precision is 12 or less,
17108the result is an integer in the range 0 to 59. For higher
17109precisions, the result may instead be a floating-point number.
17110
17111@tindex weekday
17112The @kbd{M-7 t P} [@code{weekday}] function extracts the weekday
17113number from a date form as an integer in the range 0 (Sunday)
17114to 6 (Saturday).
17115
17116@tindex yearday
17117The @kbd{M-8 t P} [@code{yearday}] function extracts the day-of-year
17118number from a date form as an integer in the range 1 (January 1)
17119to 366 (December 31 of a leap year).
17120
17121@tindex time
17122The @kbd{M-9 t P} [@code{time}] function extracts the time portion
17123of a date form as an HMS form. This returns @samp{0@@ 0' 0"}
17124for a pure date form.
17125
17126@kindex t M
17127@pindex calc-new-month
17128@tindex newmonth
17129The @kbd{t M} (@code{calc-new-month}) [@code{newmonth}] command
17130computes a new date form that represents the first day of the month
17131specified by the input date. The result is always a pure date
17132form; only the year and month numbers of the input are retained.
17133With a numeric prefix argument @var{n} in the range from 1 to 31,
17134@kbd{t M} computes the @var{n}th day of the month. (If @var{n}
17135is greater than the actual number of days in the month, or if
17136@var{n} is zero, the last day of the month is used.)
17137
17138@kindex t Y
17139@pindex calc-new-year
17140@tindex newyear
17141The @kbd{t Y} (@code{calc-new-year}) [@code{newyear}] command
17142computes a new pure date form that represents the first day of
17143the year specified by the input. The month, day, and time
17144of the input date form are lost. With a numeric prefix argument
17145@var{n} in the range from 1 to 366, @kbd{t Y} computes the
17146@var{n}th day of the year (366 is treated as 365 in non-leap
17147years). A prefix argument of 0 computes the last day of the
8e04863e
JB
17148year (December 31). A negative prefix argument from @mathit{-1} to
17149@mathit{-12} computes the first day of the @var{n}th month of the year.
d7b8e6c6
EZ
17150
17151@kindex t W
17152@pindex calc-new-week
17153@tindex newweek
17154The @kbd{t W} (@code{calc-new-week}) [@code{newweek}] command
17155computes a new pure date form that represents the Sunday on or before
17156the input date. With a numeric prefix argument, it can be made to
17157use any day of the week as the starting day; the argument must be in
17158the range from 0 (Sunday) to 6 (Saturday). This function always
17159subtracts between 0 and 6 days from the input date.
17160
17161Here's an example use of @code{newweek}: Find the date of the next
17162Wednesday after a given date. Using @kbd{M-3 t W} or @samp{newweek(d, 3)}
17163will give you the @emph{preceding} Wednesday, so @samp{newweek(d+7, 3)}
17164will give you the following Wednesday. A further look at the definition
17165of @code{newweek} shows that if the input date is itself a Wednesday,
17166this formula will return the Wednesday one week in the future. An
17167exercise for the reader is to modify this formula to yield the same day
17168if the input is already a Wednesday. Another interesting exercise is
17169to preserve the time-of-day portion of the input (@code{newweek} resets
17170the time to midnight; hint:@: how can @code{newweek} be defined in terms
17171of the @code{weekday} function?).
17172
5d67986c
RS
17173@ignore
17174@starindex
17175@end ignore
d7b8e6c6
EZ
17176@tindex pwday
17177The @samp{pwday(@var{date})} function (not on any key) computes the
17178day-of-month number of the Sunday on or before @var{date}. With
17179two arguments, @samp{pwday(@var{date}, @var{day})} computes the day
17180number of the Sunday on or before day number @var{day} of the month
17181specified by @var{date}. The @var{day} must be in the range from
171827 to 31; if the day number is greater than the actual number of days
17183in the month, the true number of days is used instead. Thus
17184@samp{pwday(@var{date}, 7)} finds the first Sunday of the month, and
17185@samp{pwday(@var{date}, 31)} finds the last Sunday of the month.
17186With a third @var{weekday} argument, @code{pwday} can be made to look
17187for any day of the week instead of Sunday.
17188
17189@kindex t I
17190@pindex calc-inc-month
17191@tindex incmonth
17192The @kbd{t I} (@code{calc-inc-month}) [@code{incmonth}] command
17193increases a date form by one month, or by an arbitrary number of
17194months specified by a numeric prefix argument. The time portion,
17195if any, of the date form stays the same. The day also stays the
17196same, except that if the new month has fewer days the day
17197number may be reduced to lie in the valid range. For example,
17198@samp{incmonth(<Jan 31, 1991>)} produces @samp{<Feb 28, 1991>}.
17199Because of this, @kbd{t I t I} and @kbd{M-2 t I} do not always give
17200the same results (@samp{<Mar 28, 1991>} versus @samp{<Mar 31, 1991>}
17201in this case).
17202
5d67986c
RS
17203@ignore
17204@starindex
17205@end ignore
d7b8e6c6
EZ
17206@tindex incyear
17207The @samp{incyear(@var{date}, @var{step})} function increases
17208a date form by the specified number of years, which may be
17209any positive or negative integer. Note that @samp{incyear(d, n)}
17210is equivalent to @w{@samp{incmonth(d, 12*n)}}, but these do not have
17211simple equivalents in terms of day arithmetic because
17212months and years have varying lengths. If the @var{step}
17213argument is omitted, 1 year is assumed. There is no keyboard
17214command for this function; use @kbd{C-u 12 t I} instead.
17215
17216There is no @code{newday} function at all because @kbd{F} [@code{floor}]
17217serves this purpose. Similarly, instead of @code{incday} and
a4231b04 17218@code{incweek} simply use @expr{d + n} or @expr{d + 7 n}.
d7b8e6c6
EZ
17219
17220@xref{Basic Arithmetic}, for the @kbd{f ]} [@code{incr}] command
17221which can adjust a date/time form by a certain number of seconds.
17222
17223@node Business Days, Time Zones, Date Functions, Date Arithmetic
17224@subsection Business Days
17225
17226@noindent
17227Often time is measured in ``business days'' or ``working days,''
17228where weekends and holidays are skipped. Calc's normal date
17229arithmetic functions use calendar days, so that subtracting two
17230consecutive Mondays will yield a difference of 7 days. By contrast,
17231subtracting two consecutive Mondays would yield 5 business days
17232(assuming two-day weekends and the absence of holidays).
17233
17234@kindex t +
17235@kindex t -
17236@tindex badd
17237@tindex bsub
17238@pindex calc-business-days-plus
17239@pindex calc-business-days-minus
17240The @kbd{t +} (@code{calc-business-days-plus}) [@code{badd}]
17241and @kbd{t -} (@code{calc-business-days-minus}) [@code{bsub}]
17242commands perform arithmetic using business days. For @kbd{t +},
17243one argument must be a date form and the other must be a real
17244number (positive or negative). If the number is not an integer,
17245then a certain amount of time is added as well as a number of
17246days; for example, adding 0.5 business days to a time in Friday
17247evening will produce a time in Monday morning. It is also
17248possible to add an HMS form; adding @samp{12@@ 0' 0"} also adds
17249half a business day. For @kbd{t -}, the arguments are either a
17250date form and a number or HMS form, or two date forms, in which
17251case the result is the number of business days between the two
17252dates.
17253
17254@cindex @code{Holidays} variable
17255@vindex Holidays
17256By default, Calc considers any day that is not a Saturday or
17257Sunday to be a business day. You can define any number of
17258additional holidays by editing the variable @code{Holidays}.
17259(There is an @w{@kbd{s H}} convenience command for editing this
17260variable.) Initially, @code{Holidays} contains the vector
17261@samp{[sat, sun]}. Entries in the @code{Holidays} vector may
17262be any of the following kinds of objects:
17263
17264@itemize @bullet
17265@item
17266Date forms (pure dates, not date/time forms). These specify
17267particular days which are to be treated as holidays.
17268
17269@item
17270Intervals of date forms. These specify a range of days, all of
17271which are holidays (e.g., Christmas week). @xref{Interval Forms}.
17272
17273@item
17274Nested vectors of date forms. Each date form in the vector is
17275considered to be a holiday.
17276
17277@item
17278Any Calc formula which evaluates to one of the above three things.
a4231b04
JB
17279If the formula involves the variable @expr{y}, it stands for a
17280yearly repeating holiday; @expr{y} will take on various year
d7b8e6c6
EZ
17281numbers like 1992. For example, @samp{date(y, 12, 25)} specifies
17282Christmas day, and @samp{newweek(date(y, 11, 7), 4) + 21} specifies
17283Thanksgiving (which is held on the fourth Thursday of November).
a4231b04 17284If the formula involves the variable @expr{m}, that variable
d7b8e6c6
EZ
17285takes on month numbers from 1 to 12: @samp{date(y, m, 15)} is
17286a holiday that takes place on the 15th of every month.
17287
17288@item
17289A weekday name, such as @code{sat} or @code{sun}. This is really
17290a variable whose name is a three-letter, lower-case day name.
17291
17292@item
17293An interval of year numbers (integers). This specifies the span of
17294years over which this holiday list is to be considered valid. Any
17295business-day arithmetic that goes outside this range will result
17296in an error message. Use this if you are including an explicit
17297list of holidays, rather than a formula to generate them, and you
17298want to make sure you don't accidentally go beyond the last point
17299where the holidays you entered are complete. If there is no
17300limiting interval in the @code{Holidays} vector, the default
17301@samp{[1 .. 2737]} is used. (This is the absolute range of years
17302for which Calc's business-day algorithms will operate.)
17303
17304@item
17305An interval of HMS forms. This specifies the span of hours that
17306are to be considered one business day. For example, if this
17307range is @samp{[9@@ 0' 0" .. 17@@ 0' 0"]} (i.e., 9am to 5pm), then
17308the business day is only eight hours long, so that @kbd{1.5 t +}
17309on @samp{<4:00pm Fri Dec 13, 1991>} will add one business day and
17310four business hours to produce @samp{<12:00pm Tue Dec 17, 1991>}.
17311Likewise, @kbd{t -} will now express differences in time as
17312fractions of an eight-hour day. Times before 9am will be treated
17313as 9am by business date arithmetic, and times at or after 5pm will
17314be treated as 4:59:59pm. If there is no HMS interval in @code{Holidays},
17315the full 24-hour day @samp{[0@ 0' 0" .. 24@ 0' 0"]} is assumed.
17316(Regardless of the type of bounds you specify, the interval is
17317treated as inclusive on the low end and exclusive on the high end,
17318so that the work day goes from 9am up to, but not including, 5pm.)
17319@end itemize
17320
17321If the @code{Holidays} vector is empty, then @kbd{t +} and
17322@kbd{t -} will act just like @kbd{+} and @kbd{-} because there will
17323then be no difference between business days and calendar days.
17324
17325Calc expands the intervals and formulas you give into a complete
17326list of holidays for internal use. This is done mainly to make
17327sure it can detect multiple holidays. (For example,
17328@samp{<Jan 1, 1989>} is both New Year's Day and a Sunday, but
17329Calc's algorithms take care to count it only once when figuring
17330the number of holidays between two dates.)
17331
17332Since the complete list of holidays for all the years from 1 to
173332737 would be huge, Calc actually computes only the part of the
17334list between the smallest and largest years that have been involved
17335in business-day calculations so far. Normally, you won't have to
17336worry about this. Keep in mind, however, that if you do one
17337calculation for 1992, and another for 1792, even if both involve
17338only a small range of years, Calc will still work out all the
17339holidays that fall in that 200-year span.
17340
17341If you add a (positive) number of days to a date form that falls on a
17342weekend or holiday, the date form is treated as if it were the most
17343recent business day. (Thus adding one business day to a Friday,
17344Saturday, or Sunday will all yield the following Monday.) If you
17345subtract a number of days from a weekend or holiday, the date is
17346effectively on the following business day. (So subtracting one business
17347day from Saturday, Sunday, or Monday yields the preceding Friday.) The
17348difference between two dates one or both of which fall on holidays
17349equals the number of actual business days between them. These
17350conventions are consistent in the sense that, if you add @var{n}
17351business days to any date, the difference between the result and the
17352original date will come out to @var{n} business days. (It can't be
17353completely consistent though; a subtraction followed by an addition
17354might come out a bit differently, since @kbd{t +} is incapable of
17355producing a date that falls on a weekend or holiday.)
17356
5d67986c
RS
17357@ignore
17358@starindex
17359@end ignore
d7b8e6c6
EZ
17360@tindex holiday
17361There is a @code{holiday} function, not on any keys, that takes
17362any date form and returns 1 if that date falls on a weekend or
17363holiday, as defined in @code{Holidays}, or 0 if the date is a
17364business day.
17365
17366@node Time Zones, , Business Days, Date Arithmetic
17367@subsection Time Zones
17368
17369@noindent
17370@cindex Time zones
17371@cindex Daylight savings time
17372Time zones and daylight savings time are a complicated business.
17373The conversions to and from Julian and Unix-style dates automatically
17374compute the correct time zone and daylight savings adjustment to use,
17375provided they can figure out this information. This section describes
17376Calc's time zone adjustment algorithm in detail, in case you want to
17377do conversions in different time zones or in case Calc's algorithms
17378can't determine the right correction to use.
17379
17380Adjustments for time zones and daylight savings time are done by
17381@kbd{t U}, @kbd{t J}, @kbd{t N}, and @kbd{t C}, but not by any other
17382commands. In particular, @samp{<may 1 1991> - <apr 1 1991>} evaluates
17383to exactly 30 days even though there is a daylight-savings
17384transition in between. This is also true for Julian pure dates:
17385@samp{julian(<may 1 1991>) - julian(<apr 1 1991>)}. But Julian
17386and Unix date/times will adjust for daylight savings time:
17387@samp{julian(<12am may 1 1991>) - julian(<12am apr 1 1991>)}
17388evaluates to @samp{29.95834} (that's 29 days and 23 hours)
17389because one hour was lost when daylight savings commenced on
17390April 7, 1991.
17391
17392In brief, the idiom @samp{julian(@var{date1}) - julian(@var{date2})}
17393computes the actual number of 24-hour periods between two dates, whereas
17394@samp{@var{date1} - @var{date2}} computes the number of calendar
17395days between two dates without taking daylight savings into account.
17396
17397@pindex calc-time-zone
5d67986c
RS
17398@ignore
17399@starindex
17400@end ignore
d7b8e6c6
EZ
17401@tindex tzone
17402The @code{calc-time-zone} [@code{tzone}] command converts the time
17403zone specified by its numeric prefix argument into a number of
17404seconds difference from Greenwich mean time (GMT). If the argument
17405is a number, the result is simply that value multiplied by 3600.
17406Typical arguments for North America are 5 (Eastern) or 8 (Pacific). If
17407Daylight Savings time is in effect, one hour should be subtracted from
17408the normal difference.
17409
17410If you give a prefix of plain @kbd{C-u}, @code{calc-time-zone} (like other
17411date arithmetic commands that include a time zone argument) takes the
17412zone argument from the top of the stack. (In the case of @kbd{t J}
17413and @kbd{t U}, the normal argument is then taken from the second-to-top
17414stack position.) This allows you to give a non-integer time zone
17415adjustment. The time-zone argument can also be an HMS form, or
17416it can be a variable which is a time zone name in upper- or lower-case.
17417For example @samp{tzone(PST) = tzone(8)} and @samp{tzone(pdt) = tzone(7)}
17418(for Pacific standard and daylight savings times, respectively).
17419
17420North American and European time zone names are defined as follows;
17421note that for each time zone there is one name for standard time,
17422another for daylight savings time, and a third for ``generalized'' time
17423in which the daylight savings adjustment is computed from context.
17424
d7b8e6c6 17425@smallexample
5d67986c 17426@group
d7b8e6c6
EZ
17427YST PST MST CST EST AST NST GMT WET MET MEZ
17428 9 8 7 6 5 4 3.5 0 -1 -2 -2
17429
17430YDT PDT MDT CDT EDT ADT NDT BST WETDST METDST MESZ
17431 8 7 6 5 4 3 2.5 -1 -2 -3 -3
17432
17433YGT PGT MGT CGT EGT AGT NGT BGT WEGT MEGT MEGZ
174349/8 8/7 7/6 6/5 5/4 4/3 3.5/2.5 0/-1 -1/-2 -2/-3 -2/-3
d7b8e6c6 17435@end group
5d67986c 17436@end smallexample
d7b8e6c6
EZ
17437
17438@vindex math-tzone-names
17439To define time zone names that do not appear in the above table,
17440you must modify the Lisp variable @code{math-tzone-names}. This
17441is a list of lists describing the different time zone names; its
17442structure is best explained by an example. The three entries for
17443Pacific Time look like this:
17444
d7b8e6c6 17445@smallexample
5d67986c 17446@group
d7b8e6c6
EZ
17447( ( "PST" 8 0 ) ; Name as an upper-case string, then standard
17448 ( "PDT" 8 -1 ) ; adjustment, then daylight savings adjustment.
17449 ( "PGT" 8 "PST" "PDT" ) ) ; Generalized time zone.
d7b8e6c6 17450@end group
5d67986c 17451@end smallexample
d7b8e6c6
EZ
17452
17453@cindex @code{TimeZone} variable
17454@vindex TimeZone
17455With no arguments, @code{calc-time-zone} or @samp{tzone()} obtains an
17456argument from the Calc variable @code{TimeZone} if a value has been
17457stored for that variable. If not, Calc runs the Unix @samp{date}
17458command and looks for one of the above time zone names in the output;
17459if this does not succeed, @samp{tzone()} leaves itself unevaluated.
17460The time zone name in the @samp{date} output may be followed by a signed
17461adjustment, e.g., @samp{GMT+5} or @samp{GMT+0500} which specifies a
17462number of hours and minutes to be added to the base time zone.
17463Calc stores the time zone it finds into @code{TimeZone} to speed
17464later calls to @samp{tzone()}.
17465
17466The special time zone name @code{local} is equivalent to no argument,
17467i.e., it uses the local time zone as obtained from the @code{date}
17468command.
17469
17470If the time zone name found is one of the standard or daylight
17471savings zone names from the above table, and Calc's internal
17472daylight savings algorithm says that time and zone are consistent
17473(e.g., @code{PDT} accompanies a date that Calc's algorithm would also
17474consider to be daylight savings, or @code{PST} accompanies a date
17475that Calc would consider to be standard time), then Calc substitutes
17476the corresponding generalized time zone (like @code{PGT}).
17477
17478If your system does not have a suitable @samp{date} command, you
17479may wish to put a @samp{(setq var-TimeZone ...)} in your Emacs
4f38ed98
JB
17480initialization file to set the time zone. (Since you are interacting
17481with the variable @code{TimeZone} directly from Emacs Lisp, the
17482@code{var-} prefix needs to be present.) The easiest way to do
d7b8e6c6
EZ
17483this is to edit the @code{TimeZone} variable using Calc's @kbd{s T}
17484command, then use the @kbd{s p} (@code{calc-permanent-variable})
17485command to save the value of @code{TimeZone} permanently.
17486
17487The @kbd{t J} and @code{t U} commands with no numeric prefix
17488arguments do the same thing as @samp{tzone()}. If the current
17489time zone is a generalized time zone, e.g., @code{EGT}, Calc
17490examines the date being converted to tell whether to use standard
17491or daylight savings time. But if the current time zone is explicit,
17492e.g., @code{EST} or @code{EDT}, then that adjustment is used exactly
17493and Calc's daylight savings algorithm is not consulted.
17494
17495Some places don't follow the usual rules for daylight savings time.
17496The state of Arizona, for example, does not observe daylight savings
17497time. If you run Calc during the winter season in Arizona, the
17498Unix @code{date} command will report @code{MST} time zone, which
17499Calc will change to @code{MGT}. If you then convert a time that
17500lies in the summer months, Calc will apply an incorrect daylight
17501savings time adjustment. To avoid this, set your @code{TimeZone}
17502variable explicitly to @code{MST} to force the use of standard,
17503non-daylight-savings time.
17504
17505@vindex math-daylight-savings-hook
17506@findex math-std-daylight-savings
17507By default Calc always considers daylight savings time to begin at
175082 a.m.@: on the first Sunday of April, and to end at 2 a.m.@: on the
17509last Sunday of October. This is the rule that has been in effect
17510in North America since 1987. If you are in a country that uses
17511different rules for computing daylight savings time, you have two
17512choices: Write your own daylight savings hook, or control time
17513zones explicitly by setting the @code{TimeZone} variable and/or
17514always giving a time-zone argument for the conversion functions.
17515
17516The Lisp variable @code{math-daylight-savings-hook} holds the
17517name of a function that is used to compute the daylight savings
17518adjustment for a given date. The default is
17519@code{math-std-daylight-savings}, which computes an adjustment
8e04863e 17520(either 0 or @mathit{-1}) using the North American rules given above.
d7b8e6c6
EZ
17521
17522The daylight savings hook function is called with four arguments:
17523The date, as a floating-point number in standard Calc format;
17524a six-element list of the date decomposed into year, month, day,
17525hour, minute, and second, respectively; a string which contains
17526the generalized time zone name in upper-case, e.g., @code{"WEGT"};
17527and a special adjustment to be applied to the hour value when
17528converting into a generalized time zone (see below).
17529
17530@findex math-prev-weekday-in-month
17531The Lisp function @code{math-prev-weekday-in-month} is useful for
17532daylight savings computations. This is an internal version of
17533the user-level @code{pwday} function described in the previous
17534section. It takes four arguments: The floating-point date value,
17535the corresponding six-element date list, the day-of-month number,
17536and the weekday number (0-6).
17537
17538The default daylight savings hook ignores the time zone name, but a
17539more sophisticated hook could use different algorithms for different
17540time zones. It would also be possible to use different algorithms
17541depending on the year number, but the default hook always uses the
17542algorithm for 1987 and later. Here is a listing of the default
17543daylight savings hook:
17544
17545@smallexample
17546(defun math-std-daylight-savings (date dt zone bump)
17547 (cond ((< (nth 1 dt) 4) 0)
17548 ((= (nth 1 dt) 4)
17549 (let ((sunday (math-prev-weekday-in-month date dt 7 0)))
17550 (cond ((< (nth 2 dt) sunday) 0)
17551 ((= (nth 2 dt) sunday)
17552 (if (>= (nth 3 dt) (+ 3 bump)) -1 0))
17553 (t -1))))
17554 ((< (nth 1 dt) 10) -1)
17555 ((= (nth 1 dt) 10)
17556 (let ((sunday (math-prev-weekday-in-month date dt 31 0)))
17557 (cond ((< (nth 2 dt) sunday) -1)
17558 ((= (nth 2 dt) sunday)
17559 (if (>= (nth 3 dt) (+ 2 bump)) 0 -1))
17560 (t 0))))
17561 (t 0))
17562)
17563@end smallexample
17564
17565@noindent
17566The @code{bump} parameter is equal to zero when Calc is converting
17567from a date form in a generalized time zone into a GMT date value.
8e04863e 17568It is @mathit{-1} when Calc is converting in the other direction. The
d7b8e6c6
EZ
17569adjustments shown above ensure that the conversion behaves correctly
17570and reasonably around the 2 a.m.@: transition in each direction.
17571
17572There is a ``missing'' hour between 2 a.m.@: and 3 a.m.@: at the
17573beginning of daylight savings time; converting a date/time form that
17574falls in this hour results in a time value for the following hour,
17575from 3 a.m.@: to 4 a.m. At the end of daylight savings time, the
17576hour from 1 a.m.@: to 2 a.m.@: repeats itself; converting a date/time
17577form that falls in in this hour results in a time value for the first
28665d46 17578manifestation of that time (@emph{not} the one that occurs one hour later).
d7b8e6c6
EZ
17579
17580If @code{math-daylight-savings-hook} is @code{nil}, then the
17581daylight savings adjustment is always taken to be zero.
17582
17583In algebraic formulas, @samp{tzone(@var{zone}, @var{date})}
17584computes the time zone adjustment for a given zone name at a
17585given date. The @var{date} is ignored unless @var{zone} is a
17586generalized time zone. If @var{date} is a date form, the
17587daylight savings computation is applied to it as it appears.
17588If @var{date} is a numeric date value, it is adjusted for the
17589daylight-savings version of @var{zone} before being given to
17590the daylight savings hook. This odd-sounding rule ensures
17591that the daylight-savings computation is always done in
17592local time, not in the GMT time that a numeric @var{date}
17593is typically represented in.
17594
5d67986c
RS
17595@ignore
17596@starindex
17597@end ignore
d7b8e6c6
EZ
17598@tindex dsadj
17599The @samp{dsadj(@var{date}, @var{zone})} function computes the
17600daylight savings adjustment that is appropriate for @var{date} in
17601time zone @var{zone}. If @var{zone} is explicitly in or not in
17602daylight savings time (e.g., @code{PDT} or @code{PST}) the
17603@var{date} is ignored. If @var{zone} is a generalized time zone,
17604the algorithms described above are used. If @var{zone} is omitted,
17605the computation is done for the current time zone.
17606
17607@xref{Reporting Bugs}, for the address of Calc's author, if you
17608should wish to contribute your improved versions of
17609@code{math-tzone-names} and @code{math-daylight-savings-hook}
17610to the Calc distribution.
17611
17612@node Financial Functions, Binary Functions, Date Arithmetic, Arithmetic
17613@section Financial Functions
17614
17615@noindent
17616Calc's financial or business functions use the @kbd{b} prefix
17617key followed by a shifted letter. (The @kbd{b} prefix followed by
17618a lower-case letter is used for operations on binary numbers.)
17619
17620Note that the rate and the number of intervals given to these
17621functions must be on the same time scale, e.g., both months or
17622both years. Mixing an annual interest rate with a time expressed
17623in months will give you very wrong answers!
17624
17625It is wise to compute these functions to a higher precision than
17626you really need, just to make sure your answer is correct to the
17627last penny; also, you may wish to check the definitions at the end
17628of this section to make sure the functions have the meaning you expect.
17629
17630@menu
17631* Percentages::
17632* Future Value::
17633* Present Value::
17634* Related Financial Functions::
17635* Depreciation Functions::
17636* Definitions of Financial Functions::
17637@end menu
17638
17639@node Percentages, Future Value, Financial Functions, Financial Functions
17640@subsection Percentages
17641
17642@kindex M-%
17643@pindex calc-percent
17644@tindex %
17645@tindex percent
17646The @kbd{M-%} (@code{calc-percent}) command takes a percentage value,
17647say 5.4, and converts it to an equivalent actual number. For example,
17648@kbd{5.4 M-%} enters 0.054 on the stack. (That's the @key{META} or
17649@key{ESC} key combined with @kbd{%}.)
17650
17651Actually, @kbd{M-%} creates a formula of the form @samp{5.4%}.
17652You can enter @samp{5.4%} yourself during algebraic entry. The
17653@samp{%} operator simply means, ``the preceding value divided by
17654100.'' The @samp{%} operator has very high precedence, so that
17655@samp{1+8%} is interpreted as @samp{1+(8%)}, not as @samp{(1+8)%}.
17656(The @samp{%} operator is just a postfix notation for the
17657@code{percent} function, just like @samp{20!} is the notation for
17658@samp{fact(20)}, or twenty-factorial.)
17659
17660The formula @samp{5.4%} would normally evaluate immediately to
176610.054, but the @kbd{M-%} command suppresses evaluation as it puts
17662the formula onto the stack. However, the next Calc command that
17663uses the formula @samp{5.4%} will evaluate it as its first step.
17664The net effect is that you get to look at @samp{5.4%} on the stack,
17665but Calc commands see it as @samp{0.054}, which is what they expect.
17666
17667In particular, @samp{5.4%} and @samp{0.054} are suitable values
17668for the @var{rate} arguments of the various financial functions,
17669but the number @samp{5.4} is probably @emph{not} suitable---it
17670represents a rate of 540 percent!
17671
17672The key sequence @kbd{M-% *} effectively means ``percent-of.''
5d67986c 17673For example, @kbd{68 @key{RET} 25 M-% *} computes 17, which is 25% of
d7b8e6c6
EZ
1767468 (and also 68% of 25, which comes out to the same thing).
17675
17676@kindex c %
17677@pindex calc-convert-percent
17678The @kbd{c %} (@code{calc-convert-percent}) command converts the
17679value on the top of the stack from numeric to percentage form.
17680For example, if 0.08 is on the stack, @kbd{c %} converts it to
17681@samp{8%}. The quantity is the same, it's just represented
17682differently. (Contrast this with @kbd{M-%}, which would convert
17683this number to @samp{0.08%}.) The @kbd{=} key is a convenient way
17684to convert a formula like @samp{8%} back to numeric form, 0.08.
17685
17686To compute what percentage one quantity is of another quantity,
5d67986c 17687use @kbd{/ c %}. For example, @w{@kbd{17 @key{RET} 68 / c %}} displays
d7b8e6c6
EZ
17688@samp{25%}.
17689
17690@kindex b %
17691@pindex calc-percent-change
17692@tindex relch
17693The @kbd{b %} (@code{calc-percent-change}) [@code{relch}] command
17694calculates the percentage change from one number to another.
5d67986c 17695For example, @kbd{40 @key{RET} 50 b %} produces the answer @samp{25%},
d7b8e6c6 17696since 50 is 25% larger than 40. A negative result represents a
5d67986c 17697decrease: @kbd{50 @key{RET} 40 b %} produces @samp{-20%}, since 40 is
d7b8e6c6
EZ
1769820% smaller than 50. (The answers are different in magnitude
17699because, in the first case, we're increasing by 25% of 40, but
17700in the second case, we're decreasing by 20% of 50.) The effect
a4231b04 17701of @kbd{40 @key{RET} 50 b %} is to compute @expr{(50-40)/40}, converting
d7b8e6c6
EZ
17702the answer to percentage form as if by @kbd{c %}.
17703
17704@node Future Value, Present Value, Percentages, Financial Functions
17705@subsection Future Value
17706
17707@noindent
17708@kindex b F
17709@pindex calc-fin-fv
17710@tindex fv
17711The @kbd{b F} (@code{calc-fin-fv}) [@code{fv}] command computes
17712the future value of an investment. It takes three arguments
17713from the stack: @samp{fv(@var{rate}, @var{n}, @var{payment})}.
17714If you give payments of @var{payment} every year for @var{n}
17715years, and the money you have paid earns interest at @var{rate} per
17716year, then this function tells you what your investment would be
17717worth at the end of the period. (The actual interval doesn't
17718have to be years, as long as @var{n} and @var{rate} are expressed
17719in terms of the same intervals.) This function assumes payments
17720occur at the @emph{end} of each interval.
17721
17722@kindex I b F
17723@tindex fvb
17724The @kbd{I b F} [@code{fvb}] command does the same computation,
17725but assuming your payments are at the beginning of each interval.
17726Suppose you plan to deposit $1000 per year in a savings account
17727earning 5.4% interest, starting right now. How much will be
17728in the account after five years? @code{fvb(5.4%, 5, 1000) = 5870.73}.
17729Thus you will have earned $870 worth of interest over the years.
17730Using the stack, this calculation would have been
5d67986c 17731@kbd{5.4 M-% 5 @key{RET} 1000 I b F}. Note that the rate is expressed
d7b8e6c6
EZ
17732as a number between 0 and 1, @emph{not} as a percentage.
17733
17734@kindex H b F
17735@tindex fvl
17736The @kbd{H b F} [@code{fvl}] command computes the future value
17737of an initial lump sum investment. Suppose you could deposit
17738those five thousand dollars in the bank right now; how much would
17739they be worth in five years? @code{fvl(5.4%, 5, 5000) = 6503.89}.
17740
17741The algebraic functions @code{fv} and @code{fvb} accept an optional
17742fourth argument, which is used as an initial lump sum in the sense
17743of @code{fvl}. In other words, @code{fv(@var{rate}, @var{n},
17744@var{payment}, @var{initial}) = fv(@var{rate}, @var{n}, @var{payment})
a4231b04 17745+ fvl(@var{rate}, @var{n}, @var{initial})}.
d7b8e6c6
EZ
17746
17747To illustrate the relationships between these functions, we could
17748do the @code{fvb} calculation ``by hand'' using @code{fvl}. The
17749final balance will be the sum of the contributions of our five
17750deposits at various times. The first deposit earns interest for
17751five years: @code{fvl(5.4%, 5, 1000) = 1300.78}. The second
17752deposit only earns interest for four years: @code{fvl(5.4%, 4, 1000) =
177531234.13}. And so on down to the last deposit, which earns one
17754year's interest: @code{fvl(5.4%, 1, 1000) = 1054.00}. The sum of
17755these five values is, sure enough, $5870.73, just as was computed
17756by @code{fvb} directly.
17757
17758What does @code{fv(5.4%, 5, 1000) = 5569.96} mean? The payments
17759are now at the ends of the periods. The end of one year is the same
17760as the beginning of the next, so what this really means is that we've
17761lost the payment at year zero (which contributed $1300.78), but we're
17762now counting the payment at year five (which, since it didn't have
a4231b04 17763a chance to earn interest, counts as $1000). Indeed, @expr{5569.96 =
d7b8e6c6
EZ
177645870.73 - 1300.78 + 1000} (give or take a bit of roundoff error).
17765
17766@node Present Value, Related Financial Functions, Future Value, Financial Functions
17767@subsection Present Value
17768
17769@noindent
17770@kindex b P
17771@pindex calc-fin-pv
17772@tindex pv
17773The @kbd{b P} (@code{calc-fin-pv}) [@code{pv}] command computes
17774the present value of an investment. Like @code{fv}, it takes
17775three arguments: @code{pv(@var{rate}, @var{n}, @var{payment})}.
17776It computes the present value of a series of regular payments.
17777Suppose you have the chance to make an investment that will
17778pay $2000 per year over the next four years; as you receive
17779these payments you can put them in the bank at 9% interest.
17780You want to know whether it is better to make the investment, or
17781to keep the money in the bank where it earns 9% interest right
17782from the start. The calculation @code{pv(9%, 4, 2000)} gives the
17783result 6479.44. If your initial investment must be less than this,
17784say, $6000, then the investment is worthwhile. But if you had to
17785put up $7000, then it would be better just to leave it in the bank.
17786
17787Here is the interpretation of the result of @code{pv}: You are
17788trying to compare the return from the investment you are
17789considering, which is @code{fv(9%, 4, 2000) = 9146.26}, with
17790the return from leaving the money in the bank, which is
17791@code{fvl(9%, 4, @var{x})} where @var{x} is the amount of money
17792you would have to put up in advance. The @code{pv} function
a4231b04 17793finds the break-even point, @expr{x = 6479.44}, at which
d7b8e6c6
EZ
17794@code{fvl(9%, 4, 6479.44)} is also equal to 9146.26. This is
17795the largest amount you should be willing to invest.
17796
17797@kindex I b P
17798@tindex pvb
17799The @kbd{I b P} [@code{pvb}] command solves the same problem,
17800but with payments occurring at the beginning of each interval.
17801It has the same relationship to @code{fvb} as @code{pv} has
17802to @code{fv}. For example @code{pvb(9%, 4, 2000) = 7062.59},
17803a larger number than @code{pv} produced because we get to start
17804earning interest on the return from our investment sooner.
17805
17806@kindex H b P
17807@tindex pvl
17808The @kbd{H b P} [@code{pvl}] command computes the present value of
17809an investment that will pay off in one lump sum at the end of the
17810period. For example, if we get our $8000 all at the end of the
17811four years, @code{pvl(9%, 4, 8000) = 5667.40}. This is much
17812less than @code{pv} reported, because we don't earn any interest
17813on the return from this investment. Note that @code{pvl} and
17814@code{fvl} are simple inverses: @code{fvl(9%, 4, 5667.40) = 8000}.
17815
17816You can give an optional fourth lump-sum argument to @code{pv}
17817and @code{pvb}; this is handled in exactly the same way as the
17818fourth argument for @code{fv} and @code{fvb}.
17819
17820@kindex b N
17821@pindex calc-fin-npv
17822@tindex npv
17823The @kbd{b N} (@code{calc-fin-npv}) [@code{npv}] command computes
17824the net present value of a series of irregular investments.
17825The first argument is the interest rate. The second argument is
17826a vector which represents the expected return from the investment
17827at the end of each interval. For example, if the rate represents
17828a yearly interest rate, then the vector elements are the return
17829from the first year, second year, and so on.
17830
17831Thus, @code{npv(9%, [2000,2000,2000,2000]) = pv(9%, 4, 2000) = 6479.44}.
17832Obviously this function is more interesting when the payments are
17833not all the same!
17834
17835The @code{npv} function can actually have two or more arguments.
17836Multiple arguments are interpreted in the same way as for the
17837vector statistical functions like @code{vsum}.
17838@xref{Single-Variable Statistics}. Basically, if there are several
17839payment arguments, each either a vector or a plain number, all these
17840values are collected left-to-right into the complete list of payments.
17841A numeric prefix argument on the @kbd{b N} command says how many
a4231b04 17842payment values or vectors to take from the stack.
d7b8e6c6
EZ
17843
17844@kindex I b N
17845@tindex npvb
17846The @kbd{I b N} [@code{npvb}] command computes the net present
17847value where payments occur at the beginning of each interval
17848rather than at the end.
17849
17850@node Related Financial Functions, Depreciation Functions, Present Value, Financial Functions
17851@subsection Related Financial Functions
17852
17853@noindent
17854The functions in this section are basically inverses of the
17855present value functions with respect to the various arguments.
17856
17857@kindex b M
17858@pindex calc-fin-pmt
17859@tindex pmt
17860The @kbd{b M} (@code{calc-fin-pmt}) [@code{pmt}] command computes
17861the amount of periodic payment necessary to amortize a loan.
17862Thus @code{pmt(@var{rate}, @var{n}, @var{amount})} equals the
17863value of @var{payment} such that @code{pv(@var{rate}, @var{n},
a4231b04 17864@var{payment}) = @var{amount}}.
d7b8e6c6
EZ
17865
17866@kindex I b M
17867@tindex pmtb
17868The @kbd{I b M} [@code{pmtb}] command does the same computation
17869but using @code{pvb} instead of @code{pv}. Like @code{pv} and
17870@code{pvb}, these functions can also take a fourth argument which
17871represents an initial lump-sum investment.
17872
17873@kindex H b M
17874The @kbd{H b M} key just invokes the @code{fvl} function, which is
17875the inverse of @code{pvl}. There is no explicit @code{pmtl} function.
17876
17877@kindex b #
17878@pindex calc-fin-nper
17879@tindex nper
17880The @kbd{b #} (@code{calc-fin-nper}) [@code{nper}] command computes
17881the number of regular payments necessary to amortize a loan.
17882Thus @code{nper(@var{rate}, @var{payment}, @var{amount})} equals
17883the value of @var{n} such that @code{pv(@var{rate}, @var{n},
17884@var{payment}) = @var{amount}}. If @var{payment} is too small
17885ever to amortize a loan for @var{amount} at interest rate @var{rate},
a4231b04 17886the @code{nper} function is left in symbolic form.
d7b8e6c6
EZ
17887
17888@kindex I b #
17889@tindex nperb
17890The @kbd{I b #} [@code{nperb}] command does the same computation
17891but using @code{pvb} instead of @code{pv}. You can give a fourth
17892lump-sum argument to these functions, but the computation will be
a4231b04 17893rather slow in the four-argument case.
d7b8e6c6
EZ
17894
17895@kindex H b #
17896@tindex nperl
17897The @kbd{H b #} [@code{nperl}] command does the same computation
17898using @code{pvl}. By exchanging @var{payment} and @var{amount} you
17899can also get the solution for @code{fvl}. For example,
17900@code{nperl(8%, 2000, 1000) = 9.006}, so if you place $1000 in a
a4231b04 17901bank account earning 8%, it will take nine years to grow to $2000.
d7b8e6c6
EZ
17902
17903@kindex b T
17904@pindex calc-fin-rate
17905@tindex rate
17906The @kbd{b T} (@code{calc-fin-rate}) [@code{rate}] command computes
17907the rate of return on an investment. This is also an inverse of @code{pv}:
17908@code{rate(@var{n}, @var{payment}, @var{amount})} computes the value of
17909@var{rate} such that @code{pv(@var{rate}, @var{n}, @var{payment}) =
a4231b04 17910@var{amount}}. The result is expressed as a formula like @samp{6.3%}.
d7b8e6c6
EZ
17911
17912@kindex I b T
17913@kindex H b T
17914@tindex rateb
17915@tindex ratel
17916The @kbd{I b T} [@code{rateb}] and @kbd{H b T} [@code{ratel}]
17917commands solve the analogous equations with @code{pvb} or @code{pvl}
17918in place of @code{pv}. Also, @code{rate} and @code{rateb} can
17919accept an optional fourth argument just like @code{pv} and @code{pvb}.
17920To redo the above example from a different perspective,
17921@code{ratel(9, 2000, 1000) = 8.00597%}, which says you will need an
a4231b04 17922interest rate of 8% in order to double your account in nine years.
d7b8e6c6
EZ
17923
17924@kindex b I
17925@pindex calc-fin-irr
17926@tindex irr
17927The @kbd{b I} (@code{calc-fin-irr}) [@code{irr}] command is the
17928analogous function to @code{rate} but for net present value.
17929Its argument is a vector of payments. Thus @code{irr(@var{payments})}
17930computes the @var{rate} such that @code{npv(@var{rate}, @var{payments}) = 0};
17931this rate is known as the @dfn{internal rate of return}.
17932
17933@kindex I b I
17934@tindex irrb
17935The @kbd{I b I} [@code{irrb}] command computes the internal rate of
17936return assuming payments occur at the beginning of each period.
17937
17938@node Depreciation Functions, Definitions of Financial Functions, Related Financial Functions, Financial Functions
17939@subsection Depreciation Functions
17940
17941@noindent
17942The functions in this section calculate @dfn{depreciation}, which is
17943the amount of value that a possession loses over time. These functions
17944are characterized by three parameters: @var{cost}, the original cost
17945of the asset; @var{salvage}, the value the asset will have at the end
17946of its expected ``useful life''; and @var{life}, the number of years
17947(or other periods) of the expected useful life.
17948
17949There are several methods for calculating depreciation that differ in
17950the way they spread the depreciation over the lifetime of the asset.
17951
17952@kindex b S
17953@pindex calc-fin-sln
17954@tindex sln
17955The @kbd{b S} (@code{calc-fin-sln}) [@code{sln}] command computes the
17956``straight-line'' depreciation. In this method, the asset depreciates
17957by the same amount every year (or period). For example,
17958@samp{sln(12000, 2000, 5)} returns 2000. The asset costs $12000
17959initially and will be worth $2000 after five years; it loses $2000
17960per year.
17961
17962@kindex b Y
17963@pindex calc-fin-syd
17964@tindex syd
17965The @kbd{b Y} (@code{calc-fin-syd}) [@code{syd}] command computes the
17966accelerated ``sum-of-years'-digits'' depreciation. Here the depreciation
17967is higher during the early years of the asset's life. Since the
17968depreciation is different each year, @kbd{b Y} takes a fourth @var{period}
17969parameter which specifies which year is requested, from 1 to @var{life}.
17970If @var{period} is outside this range, the @code{syd} function will
17971return zero.
17972
17973@kindex b D
17974@pindex calc-fin-ddb
17975@tindex ddb
17976The @kbd{b D} (@code{calc-fin-ddb}) [@code{ddb}] command computes an
17977accelerated depreciation using the double-declining balance method.
17978It also takes a fourth @var{period} parameter.
17979
17980For symmetry, the @code{sln} function will accept a @var{period}
17981parameter as well, although it will ignore its value except that the
17982return value will as usual be zero if @var{period} is out of range.
17983
a4231b04 17984For example, pushing the vector @expr{[1,2,3,4,5]} (perhaps with @kbd{v x 5})
d7b8e6c6 17985and then mapping @kbd{V M ' [sln(12000,2000,5,$), syd(12000,2000,5,$),
5d67986c 17986ddb(12000,2000,5,$)] @key{RET}} produces a matrix that allows us to compare
d7b8e6c6
EZ
17987the three depreciation methods:
17988
d7b8e6c6 17989@example
5d67986c 17990@group
d7b8e6c6
EZ
17991[ [ 2000, 3333, 4800 ]
17992 [ 2000, 2667, 2880 ]
17993 [ 2000, 2000, 1728 ]
17994 [ 2000, 1333, 592 ]
17995 [ 2000, 667, 0 ] ]
d7b8e6c6 17996@end group
5d67986c 17997@end example
d7b8e6c6
EZ
17998
17999@noindent
18000(Values have been rounded to nearest integers in this figure.)
18001We see that @code{sln} depreciates by the same amount each year,
18002@kbd{syd} depreciates more at the beginning and less at the end,
18003and @kbd{ddb} weights the depreciation even more toward the beginning.
18004
a4231b04 18005Summing columns with @kbd{V R : +} yields @expr{[10000, 10000, 10000]};
d7b8e6c6
EZ
18006the total depreciation in any method is (by definition) the
18007difference between the cost and the salvage value.
18008
18009@node Definitions of Financial Functions, , Depreciation Functions, Financial Functions
18010@subsection Definitions
18011
18012@noindent
18013For your reference, here are the actual formulas used to compute
18014Calc's financial functions.
18015
18016Calc will not evaluate a financial function unless the @var{rate} or
18017@var{n} argument is known. However, @var{payment} or @var{amount} can
18018be a variable. Calc expands these functions according to the
18019formulas below for symbolic arguments only when you use the @kbd{a "}
18020(@code{calc-expand-formula}) command, or when taking derivatives or
18021integrals or solving equations involving the functions.
18022
18023@ifinfo
07ce2eb3 18024These formulas are shown using the conventions of Big display
d7b8e6c6
EZ
18025mode (@kbd{d B}); for example, the formula for @code{fv} written
18026linearly is @samp{pmt * ((1 + rate)^n) - 1) / rate}.
18027
18028@example
18029 n
18030 (1 + rate) - 1
18031fv(rate, n, pmt) = pmt * ---------------
18032 rate
18033
18034 n
18035 ((1 + rate) - 1) (1 + rate)
18036fvb(rate, n, pmt) = pmt * ----------------------------
18037 rate
18038
18039 n
18040fvl(rate, n, pmt) = pmt * (1 + rate)
18041
18042 -n
177c0ea7 18043 1 - (1 + rate)
d7b8e6c6
EZ
18044pv(rate, n, pmt) = pmt * ----------------
18045 rate
18046
18047 -n
18048 (1 - (1 + rate) ) (1 + rate)
18049pvb(rate, n, pmt) = pmt * -----------------------------
18050 rate
18051
18052 -n
18053pvl(rate, n, pmt) = pmt * (1 + rate)
18054
18055 -1 -2 -3
18056npv(rate, [a, b, c]) = a*(1 + rate) + b*(1 + rate) + c*(1 + rate)
18057
18058 -1 -2
18059npvb(rate, [a, b, c]) = a + b*(1 + rate) + c*(1 + rate)
18060
18061 -n
18062 (amt - x * (1 + rate) ) * rate
18063pmt(rate, n, amt, x) = -------------------------------
18064 -n
18065 1 - (1 + rate)
18066
18067 -n
18068 (amt - x * (1 + rate) ) * rate
18069pmtb(rate, n, amt, x) = -------------------------------
18070 -n
18071 (1 - (1 + rate) ) (1 + rate)
18072
18073 amt * rate
18074nper(rate, pmt, amt) = - log(1 - ------------, 1 + rate)
18075 pmt
18076
18077 amt * rate
18078nperb(rate, pmt, amt) = - log(1 - ---------------, 1 + rate)
18079 pmt * (1 + rate)
18080
18081 amt
18082nperl(rate, pmt, amt) = - log(---, 1 + rate)
18083 pmt
18084
18085 1/n
18086 pmt
18087ratel(n, pmt, amt) = ------ - 1
18088 1/n
18089 amt
18090
18091 cost - salv
18092sln(cost, salv, life) = -----------
18093 life
18094
18095 (cost - salv) * (life - per + 1)
18096syd(cost, salv, life, per) = --------------------------------
18097 life * (life + 1) / 2
18098
18099 book * 2
18100ddb(cost, salv, life, per) = --------, book = cost - depreciation so far
18101 life
18102@end example
18103@end ifinfo
18104@tex
18105\turnoffactive
18106$$ \code{fv}(r, n, p) = p { (1 + r)^n - 1 \over r } $$
18107$$ \code{fvb}(r, n, p) = p { ((1 + r)^n - 1) (1 + r) \over r } $$
18108$$ \code{fvl}(r, n, p) = p (1 + r)^n $$
18109$$ \code{pv}(r, n, p) = p { 1 - (1 + r)^{-n} \over r } $$
18110$$ \code{pvb}(r, n, p) = p { (1 - (1 + r)^{-n}) (1 + r) \over r } $$
18111$$ \code{pvl}(r, n, p) = p (1 + r)^{-n} $$
18112$$ \code{npv}(r, [a,b,c]) = a (1 + r)^{-1} + b (1 + r)^{-2} + c (1 + r)^{-3} $$
18113$$ \code{npvb}(r, [a,b,c]) = a + b (1 + r)^{-1} + c (1 + r)^{-2} $$
18114$$ \code{pmt}(r, n, a, x) = { (a - x (1 + r)^{-n}) r \over 1 - (1 + r)^{-n} }$$
18115$$ \code{pmtb}(r, n, a, x) = { (a - x (1 + r)^{-n}) r \over
18116 (1 - (1 + r)^{-n}) (1 + r) } $$
18117$$ \code{nper}(r, p, a) = -\code{log}(1 - { a r \over p }, 1 + r) $$
18118$$ \code{nperb}(r, p, a) = -\code{log}(1 - { a r \over p (1 + r) }, 1 + r) $$
18119$$ \code{nperl}(r, p, a) = -\code{log}({a \over p}, 1 + r) $$
18120$$ \code{ratel}(n, p, a) = { p^{1/n} \over a^{1/n} } - 1 $$
18121$$ \code{sln}(c, s, l) = { c - s \over l } $$
18122$$ \code{syd}(c, s, l, p) = { (c - s) (l - p + 1) \over l (l+1) / 2 } $$
18123$$ \code{ddb}(c, s, l, p) = { 2 (c - \hbox{depreciation so far}) \over l } $$
18124@end tex
18125
18126@noindent
a4231b04 18127In @code{pmt} and @code{pmtb}, @expr{x=0} if omitted.
d7b8e6c6
EZ
18128
18129These functions accept any numeric objects, including error forms,
18130intervals, and even (though not very usefully) complex numbers. The
18131above formulas specify exactly the behavior of these functions with
18132all sorts of inputs.
18133
18134Note that if the first argument to the @code{log} in @code{nper} is
18135negative, @code{nper} leaves itself in symbolic form rather than
18136returning a (financially meaningless) complex number.
18137
18138@samp{rate(num, pmt, amt)} solves the equation
18139@samp{pv(rate, num, pmt) = amt} for @samp{rate} using @kbd{H a R}
18140(@code{calc-find-root}), with the interval @samp{[.01% .. 100%]}
18141for an initial guess. The @code{rateb} function is the same except
18142that it uses @code{pvb}. Note that @code{ratel} can be solved
18143directly; its formula is shown in the above list.
18144
18145Similarly, @samp{irr(pmts)} solves the equation @samp{npv(rate, pmts) = 0}
18146for @samp{rate}.
18147
18148If you give a fourth argument to @code{nper} or @code{nperb}, Calc
18149will also use @kbd{H a R} to solve the equation using an initial
18150guess interval of @samp{[0 .. 100]}.
18151
18152A fourth argument to @code{fv} simply sums the two components
18153calculated from the above formulas for @code{fv} and @code{fvl}.
18154The same is true of @code{fvb}, @code{pv}, and @code{pvb}.
18155
18156The @kbd{ddb} function is computed iteratively; the ``book'' value
18157starts out equal to @var{cost}, and decreases according to the above
18158formula for the specified number of periods. If the book value
18159would decrease below @var{salvage}, it only decreases to @var{salvage}
18160and the depreciation is zero for all subsequent periods. The @code{ddb}
18161function returns the amount the book value decreased in the specified
18162period.
18163
d7b8e6c6
EZ
18164@node Binary Functions, , Financial Functions, Arithmetic
18165@section Binary Number Functions
18166
18167@noindent
18168The commands in this chapter all use two-letter sequences beginning with
18169the @kbd{b} prefix.
18170
18171@cindex Binary numbers
18172The ``binary'' operations actually work regardless of the currently
18173displayed radix, although their results make the most sense in a radix
18174like 2, 8, or 16 (as obtained by the @kbd{d 2}, @kbd{d 8}, or @w{@kbd{d 6}}
18175commands, respectively). You may also wish to enable display of leading
18176zeros with @kbd{d z}. @xref{Radix Modes}.
18177
18178@cindex Word size for binary operations
a4231b04 18179The Calculator maintains a current @dfn{word size} @expr{w}, an
d7b8e6c6 18180arbitrary positive or negative integer. For a positive word size, all
a4231b04 18181of the binary operations described here operate modulo @expr{2^w}. In
d7b8e6c6 18182particular, negative arguments are converted to positive integers modulo
a4231b04 18183@expr{2^w} by all binary functions.
d7b8e6c6
EZ
18184
18185If the word size is negative, binary operations produce 2's complement
a4231b04 18186integers from
8e04863e 18187@texline @math{-2^{-w-1}}
a4231b04
JB
18188@infoline @expr{-(2^(-w-1))}
18189to
8e04863e 18190@texline @math{2^{-w-1}-1}
a4231b04
JB
18191@infoline @expr{2^(-w-1)-1}
18192inclusive. Either mode accepts inputs in any range; the sign of
18193@expr{w} affects only the results produced.
d7b8e6c6
EZ
18194
18195@kindex b c
18196@pindex calc-clip
18197@tindex clip
18198The @kbd{b c} (@code{calc-clip})
18199[@code{clip}] command can be used to clip a number by reducing it modulo
a4231b04 18200@expr{2^w}. The commands described in this chapter automatically clip
d7b8e6c6
EZ
18201their results to the current word size. Note that other operations like
18202addition do not use the current word size, since integer addition
18203generally is not ``binary.'' (However, @pxref{Simplification Modes},
18204@code{calc-bin-simplify-mode}.) For example, with a word size of 8
18205bits @kbd{b c} converts a number to the range 0 to 255; with a word
8e04863e 18206size of @mathit{-8} @kbd{b c} converts to the range @mathit{-128} to 127.
d7b8e6c6
EZ
18207
18208@kindex b w
18209@pindex calc-word-size
18210The default word size is 32 bits. All operations except the shifts and
18211rotates allow you to specify a different word size for that one
18212operation by giving a numeric prefix argument: @kbd{C-u 8 b c} clips the
18213top of stack to the range 0 to 255 regardless of the current word size.
18214To set the word size permanently, use @kbd{b w} (@code{calc-word-size}).
18215This command displays a prompt with the current word size; press @key{RET}
18216immediately to keep this word size, or type a new word size at the prompt.
18217
18218When the binary operations are written in symbolic form, they take an
18219optional second (or third) word-size parameter. When a formula like
18220@samp{and(a,b)} is finally evaluated, the word size current at that time
18221will be used, but when @samp{and(a,b,-8)} is evaluated, a word size of
8e04863e 18222@mathit{-8} will always be used. A symbolic binary function will be left
d7b8e6c6
EZ
18223in symbolic form unless the all of its argument(s) are integers or
18224integer-valued floats.
18225
a4231b04 18226If either or both arguments are modulo forms for which @expr{M} is a
d7b8e6c6
EZ
18227power of two, that power of two is taken as the word size unless a
18228numeric prefix argument overrides it. The current word size is never
18229consulted when modulo-power-of-two forms are involved.
18230
18231@kindex b a
18232@pindex calc-and
18233@tindex and
18234The @kbd{b a} (@code{calc-and}) [@code{and}] command computes the bitwise
18235AND of the two numbers on the top of the stack. In other words, for each
a4231b04 18236of the @expr{w} binary digits of the two numbers (pairwise), the corresponding
d7b8e6c6
EZ
18237bit of the result is 1 if and only if both input bits are 1:
18238@samp{and(2#1100, 2#1010) = 2#1000}.
18239
18240@kindex b o
18241@pindex calc-or
18242@tindex or
18243The @kbd{b o} (@code{calc-or}) [@code{or}] command computes the bitwise
18244inclusive OR of two numbers. A bit is 1 if either of the input bits, or
18245both, are 1: @samp{or(2#1100, 2#1010) = 2#1110}.
18246
18247@kindex b x
18248@pindex calc-xor
18249@tindex xor
18250The @kbd{b x} (@code{calc-xor}) [@code{xor}] command computes the bitwise
18251exclusive OR of two numbers. A bit is 1 if exactly one of the input bits
18252is 1: @samp{xor(2#1100, 2#1010) = 2#0110}.
18253
18254@kindex b d
18255@pindex calc-diff
18256@tindex diff
18257The @kbd{b d} (@code{calc-diff}) [@code{diff}] command computes the bitwise
18258difference of two numbers; this is defined by @samp{diff(a,b) = and(a,not(b))},
18259so that @samp{diff(2#1100, 2#1010) = 2#0100}.
18260
18261@kindex b n
18262@pindex calc-not
18263@tindex not
18264The @kbd{b n} (@code{calc-not}) [@code{not}] command computes the bitwise
18265NOT of a number. A bit is 1 if the input bit is 0 and vice-versa.
18266
18267@kindex b l
18268@pindex calc-lshift-binary
18269@tindex lsh
18270The @kbd{b l} (@code{calc-lshift-binary}) [@code{lsh}] command shifts a
18271number left by one bit, or by the number of bits specified in the numeric
18272prefix argument. A negative prefix argument performs a logical right shift,
18273in which zeros are shifted in on the left. In symbolic form, @samp{lsh(a)}
18274is short for @samp{lsh(a,1)}, which in turn is short for @samp{lsh(a,n,w)}.
18275Bits shifted ``off the end,'' according to the current word size, are lost.
18276
18277@kindex H b l
18278@kindex H b r
5d67986c
RS
18279@ignore
18280@mindex @idots
18281@end ignore
d7b8e6c6 18282@kindex H b L
5d67986c
RS
18283@ignore
18284@mindex @null
18285@end ignore
d7b8e6c6 18286@kindex H b R
5d67986c
RS
18287@ignore
18288@mindex @null
18289@end ignore
d7b8e6c6
EZ
18290@kindex H b t
18291The @kbd{H b l} command also does a left shift, but it takes two arguments
18292from the stack (the value to shift, and, at top-of-stack, the number of
18293bits to shift). This version interprets the prefix argument just like
18294the regular binary operations, i.e., as a word size. The Hyperbolic flag
18295has a similar effect on the rest of the binary shift and rotate commands.
18296
18297@kindex b r
18298@pindex calc-rshift-binary
18299@tindex rsh
18300The @kbd{b r} (@code{calc-rshift-binary}) [@code{rsh}] command shifts a
18301number right by one bit, or by the number of bits specified in the numeric
18302prefix argument: @samp{rsh(a,n) = lsh(a,-n)}.
18303
18304@kindex b L
18305@pindex calc-lshift-arith
18306@tindex ash
18307The @kbd{b L} (@code{calc-lshift-arith}) [@code{ash}] command shifts a
18308number left. It is analogous to @code{lsh}, except that if the shift
18309is rightward (the prefix argument is negative), an arithmetic shift
18310is performed as described below.
18311
18312@kindex b R
18313@pindex calc-rshift-arith
18314@tindex rash
18315The @kbd{b R} (@code{calc-rshift-arith}) [@code{rash}] command performs
18316an ``arithmetic'' shift to the right, in which the leftmost bit (according
18317to the current word size) is duplicated rather than shifting in zeros.
18318This corresponds to dividing by a power of two where the input is interpreted
18319as a signed, twos-complement number. (The distinction between the @samp{rsh}
18320and @samp{rash} operations is totally independent from whether the word
18321size is positive or negative.) With a negative prefix argument, this
18322performs a standard left shift.
18323
18324@kindex b t
18325@pindex calc-rotate-binary
18326@tindex rot
18327The @kbd{b t} (@code{calc-rotate-binary}) [@code{rot}] command rotates a
18328number one bit to the left. The leftmost bit (according to the current
18329word size) is dropped off the left and shifted in on the right. With a
18330numeric prefix argument, the number is rotated that many bits to the left
18331or right.
18332
18333@xref{Set Operations}, for the @kbd{b p} and @kbd{b u} commands that
18334pack and unpack binary integers into sets. (For example, @kbd{b u}
18335unpacks the number @samp{2#11001} to the set of bit-numbers
18336@samp{[0, 3, 4]}.) Type @kbd{b u V #} to count the number of ``1''
18337bits in a binary integer.
18338
18339Another interesting use of the set representation of binary integers
18340is to reverse the bits in, say, a 32-bit integer. Type @kbd{b u} to
5d67986c 18341unpack; type @kbd{31 @key{TAB} -} to replace each bit-number in the set
d7b8e6c6
EZ
18342with 31 minus that bit-number; type @kbd{b p} to pack the set back
18343into a binary integer.
18344
18345@node Scientific Functions, Matrix Functions, Arithmetic, Top
18346@chapter Scientific Functions
18347
18348@noindent
18349The functions described here perform trigonometric and other transcendental
18350calculations. They generally produce floating-point answers correct to the
18351full current precision. The @kbd{H} (Hyperbolic) and @kbd{I} (Inverse)
18352flag keys must be used to get some of these functions from the keyboard.
18353
18354@kindex P
18355@pindex calc-pi
18356@cindex @code{pi} variable
18357@vindex pi
18358@kindex H P
18359@cindex @code{e} variable
18360@vindex e
18361@kindex I P
18362@cindex @code{gamma} variable
18363@vindex gamma
18364@cindex Gamma constant, Euler's
18365@cindex Euler's gamma constant
18366@kindex H I P
18367@cindex @code{phi} variable
18368@cindex Phi, golden ratio
18369@cindex Golden ratio
28665d46 18370One miscellaneous command is shift-@kbd{P} (@code{calc-pi}), which pushes
a4231b04
JB
18371the value of @cpi{} (at the current precision) onto the stack. With the
18372Hyperbolic flag, it pushes the value @expr{e}, the base of natural logarithms.
18373With the Inverse flag, it pushes Euler's constant
8e04863e 18374@texline @math{\gamma}
a4231b04
JB
18375@infoline @expr{gamma}
18376(about 0.5772). With both Inverse and Hyperbolic, it
18377pushes the ``golden ratio''
8e04863e 18378@texline @math{\phi}
a4231b04
JB
18379@infoline @expr{phi}
18380(about 1.618). (At present, Euler's constant is not available
d7b8e6c6
EZ
18381to unlimited precision; Calc knows only the first 100 digits.)
18382In Symbolic mode, these commands push the
18383actual variables @samp{pi}, @samp{e}, @samp{gamma}, and @samp{phi},
a4231b04 18384respectively, instead of their values; @pxref{Symbolic Mode}.
d7b8e6c6 18385
5d67986c
RS
18386@ignore
18387@mindex Q
18388@end ignore
18389@ignore
18390@mindex I Q
18391@end ignore
d7b8e6c6
EZ
18392@kindex I Q
18393@tindex sqr
18394The @kbd{Q} (@code{calc-sqrt}) [@code{sqrt}] function is described elsewhere;
18395@pxref{Basic Arithmetic}. With the Inverse flag [@code{sqr}], this command
18396computes the square of the argument.
18397
18398@xref{Prefix Arguments}, for a discussion of the effect of numeric
18399prefix arguments on commands in this chapter which do not otherwise
18400interpret a prefix argument.
18401
18402@menu
18403* Logarithmic Functions::
18404* Trigonometric and Hyperbolic Functions::
18405* Advanced Math Functions::
18406* Branch Cuts::
18407* Random Numbers::
18408* Combinatorial Functions::
18409* Probability Distribution Functions::
18410@end menu
18411
18412@node Logarithmic Functions, Trigonometric and Hyperbolic Functions, Scientific Functions, Scientific Functions
18413@section Logarithmic Functions
18414
18415@noindent
18416@kindex L
18417@pindex calc-ln
18418@tindex ln
5d67986c
RS
18419@ignore
18420@mindex @null
18421@end ignore
d7b8e6c6
EZ
18422@kindex I E
18423The shift-@kbd{L} (@code{calc-ln}) [@code{ln}] command computes the natural
18424logarithm of the real or complex number on the top of the stack. With
18425the Inverse flag it computes the exponential function instead, although
18426this is redundant with the @kbd{E} command.
18427
18428@kindex E
18429@pindex calc-exp
18430@tindex exp
5d67986c
RS
18431@ignore
18432@mindex @null
18433@end ignore
d7b8e6c6
EZ
18434@kindex I L
18435The shift-@kbd{E} (@code{calc-exp}) [@code{exp}] command computes the
a4231b04 18436exponential, i.e., @expr{e} raised to the power of the number on the stack.
d7b8e6c6
EZ
18437The meanings of the Inverse and Hyperbolic flags follow from those for
18438the @code{calc-ln} command.
18439
18440@kindex H L
18441@kindex H E
18442@pindex calc-log10
18443@tindex log10
18444@tindex exp10
5d67986c
RS
18445@ignore
18446@mindex @null
18447@end ignore
d7b8e6c6 18448@kindex H I L
5d67986c
RS
18449@ignore
18450@mindex @null
18451@end ignore
d7b8e6c6
EZ
18452@kindex H I E
18453The @kbd{H L} (@code{calc-log10}) [@code{log10}] command computes the common
18454(base-10) logarithm of a number. (With the Inverse flag [@code{exp10}],
18455it raises ten to a given power.) Note that the common logarithm of a
18456complex number is computed by taking the natural logarithm and dividing
a4231b04 18457by
8e04863e 18458@texline @math{\ln10}.
a4231b04 18459@infoline @expr{ln(10)}.
d7b8e6c6
EZ
18460
18461@kindex B
18462@kindex I B
18463@pindex calc-log
18464@tindex log
18465@tindex alog
18466The @kbd{B} (@code{calc-log}) [@code{log}] command computes a logarithm
18467to any base. For example, @kbd{1024 @key{RET} 2 B} produces 10, since
8e04863e 18468@texline @math{2^{10} = 1024}.
a4231b04
JB
18469@infoline @expr{2^10 = 1024}.
18470In certain cases like @samp{log(3,9)}, the result
18471will be either @expr{1:2} or @expr{0.5} depending on the current Fraction
07ce2eb3 18472mode setting. With the Inverse flag [@code{alog}], this command is
d7b8e6c6
EZ
18473similar to @kbd{^} except that the order of the arguments is reversed.
18474
18475@kindex f I
18476@pindex calc-ilog
18477@tindex ilog
18478The @kbd{f I} (@code{calc-ilog}) [@code{ilog}] command computes the
18479integer logarithm of a number to any base. The number and the base must
18480themselves be positive integers. This is the true logarithm, rounded
a4231b04 18481down to an integer. Thus @kbd{ilog(x,10)} is 3 for all @expr{x} in the
d7b8e6c6
EZ
18482range from 1000 to 9999. If both arguments are positive integers, exact
18483integer arithmetic is used; otherwise, this is equivalent to
18484@samp{floor(log(x,b))}.
18485
18486@kindex f E
18487@pindex calc-expm1
18488@tindex expm1
18489The @kbd{f E} (@code{calc-expm1}) [@code{expm1}] command computes
8e04863e 18490@texline @math{e^x - 1},
a4231b04
JB
18491@infoline @expr{exp(x)-1},
18492but using an algorithm that produces a more accurate
18493answer when the result is close to zero, i.e., when
8e04863e 18494@texline @math{e^x}
a4231b04
JB
18495@infoline @expr{exp(x)}
18496is close to one.
d7b8e6c6
EZ
18497
18498@kindex f L
18499@pindex calc-lnp1
18500@tindex lnp1
18501The @kbd{f L} (@code{calc-lnp1}) [@code{lnp1}] command computes
8e04863e 18502@texline @math{\ln(x+1)},
a4231b04
JB
18503@infoline @expr{ln(x+1)},
18504producing a more accurate answer when @expr{x} is close to zero.
d7b8e6c6
EZ
18505
18506@node Trigonometric and Hyperbolic Functions, Advanced Math Functions, Logarithmic Functions, Scientific Functions
18507@section Trigonometric/Hyperbolic Functions
18508
18509@noindent
18510@kindex S
18511@pindex calc-sin
18512@tindex sin
18513The shift-@kbd{S} (@code{calc-sin}) [@code{sin}] command computes the sine
18514of an angle or complex number. If the input is an HMS form, it is interpreted
18515as degrees-minutes-seconds; otherwise, the input is interpreted according
18516to the current angular mode. It is best to use Radians mode when operating
a4231b04 18517on complex numbers.
d7b8e6c6
EZ
18518
18519Calc's ``units'' mechanism includes angular units like @code{deg},
18520@code{rad}, and @code{grad}. While @samp{sin(45 deg)} is not evaluated
18521all the time, the @kbd{u s} (@code{calc-simplify-units}) command will
18522simplify @samp{sin(45 deg)} by taking the sine of 45 degrees, regardless
18523of the current angular mode. @xref{Basic Operations on Units}.
18524
18525Also, the symbolic variable @code{pi} is not ordinarily recognized in
18526arguments to trigonometric functions, as in @samp{sin(3 pi / 4)}, but
18527the @kbd{a s} (@code{calc-simplify}) command recognizes many such
07ce2eb3 18528formulas when the current angular mode is Radians @emph{and} Symbolic
d7b8e6c6
EZ
18529mode is enabled; this example would be replaced by @samp{sqrt(2) / 2}.
18530@xref{Symbolic Mode}. Beware, this simplification occurs even if you
18531have stored a different value in the variable @samp{pi}; this is one
18532reason why changing built-in variables is a bad idea. Arguments of
a4231b04
JB
18533the form @expr{x} plus a multiple of @cpiover{2} are also simplified.
18534Calc includes similar formulas for @code{cos} and @code{tan}.
d7b8e6c6
EZ
18535
18536The @kbd{a s} command knows all angles which are integer multiples of
07ce2eb3 18537@cpiover{12}, @cpiover{10}, or @cpiover{8} radians. In Degrees mode,
d7b8e6c6
EZ
18538analogous simplifications occur for integer multiples of 15 or 18
18539degrees, and for arguments plus multiples of 90 degrees.
18540
18541@kindex I S
18542@pindex calc-arcsin
18543@tindex arcsin
18544With the Inverse flag, @code{calc-sin} computes an arcsine. This is also
18545available as the @code{calc-arcsin} command or @code{arcsin} algebraic
18546function. The returned argument is converted to degrees, radians, or HMS
18547notation depending on the current angular mode.
18548
18549@kindex H S
18550@pindex calc-sinh
18551@tindex sinh
18552@kindex H I S
18553@pindex calc-arcsinh
18554@tindex arcsinh
18555With the Hyperbolic flag, @code{calc-sin} computes the hyperbolic
18556sine, also available as @code{calc-sinh} [@code{sinh}]. With the
18557Hyperbolic and Inverse flags, it computes the hyperbolic arcsine
18558(@code{calc-arcsinh}) [@code{arcsinh}].
18559
18560@kindex C
18561@pindex calc-cos
18562@tindex cos
5d67986c
RS
18563@ignore
18564@mindex @idots
18565@end ignore
d7b8e6c6
EZ
18566@kindex I C
18567@pindex calc-arccos
5d67986c
RS
18568@ignore
18569@mindex @null
18570@end ignore
d7b8e6c6 18571@tindex arccos
5d67986c
RS
18572@ignore
18573@mindex @null
18574@end ignore
d7b8e6c6
EZ
18575@kindex H C
18576@pindex calc-cosh
5d67986c
RS
18577@ignore
18578@mindex @null
18579@end ignore
d7b8e6c6 18580@tindex cosh
5d67986c
RS
18581@ignore
18582@mindex @null
18583@end ignore
d7b8e6c6
EZ
18584@kindex H I C
18585@pindex calc-arccosh
5d67986c
RS
18586@ignore
18587@mindex @null
18588@end ignore
d7b8e6c6 18589@tindex arccosh
5d67986c
RS
18590@ignore
18591@mindex @null
18592@end ignore
d7b8e6c6
EZ
18593@kindex T
18594@pindex calc-tan
5d67986c
RS
18595@ignore
18596@mindex @null
18597@end ignore
d7b8e6c6 18598@tindex tan
5d67986c
RS
18599@ignore
18600@mindex @null
18601@end ignore
d7b8e6c6
EZ
18602@kindex I T
18603@pindex calc-arctan
5d67986c
RS
18604@ignore
18605@mindex @null
18606@end ignore
d7b8e6c6 18607@tindex arctan
5d67986c
RS
18608@ignore
18609@mindex @null
18610@end ignore
d7b8e6c6
EZ
18611@kindex H T
18612@pindex calc-tanh
5d67986c
RS
18613@ignore
18614@mindex @null
18615@end ignore
d7b8e6c6 18616@tindex tanh
5d67986c
RS
18617@ignore
18618@mindex @null
18619@end ignore
d7b8e6c6
EZ
18620@kindex H I T
18621@pindex calc-arctanh
5d67986c
RS
18622@ignore
18623@mindex @null
18624@end ignore
d7b8e6c6
EZ
18625@tindex arctanh
18626The shift-@kbd{C} (@code{calc-cos}) [@code{cos}] command computes the cosine
18627of an angle or complex number, and shift-@kbd{T} (@code{calc-tan}) [@code{tan}]
18628computes the tangent, along with all the various inverse and hyperbolic
18629variants of these functions.
18630
18631@kindex f T
18632@pindex calc-arctan2
18633@tindex arctan2
18634The @kbd{f T} (@code{calc-arctan2}) [@code{arctan2}] command takes two
18635numbers from the stack and computes the arc tangent of their ratio. The
8e04863e 18636result is in the full range from @mathit{-180} (exclusive) to @mathit{+180}
d7b8e6c6
EZ
18637(inclusive) degrees, or the analogous range in radians. A similar
18638result would be obtained with @kbd{/} followed by @kbd{I T}, but the
8e04863e 18639value would only be in the range from @mathit{-90} to @mathit{+90} degrees
d7b8e6c6
EZ
18640since the division loses information about the signs of the two
18641components, and an error might result from an explicit division by zero
18642which @code{arctan2} would avoid. By (arbitrary) definition,
18643@samp{arctan2(0,0)=0}.
18644
18645@pindex calc-sincos
5d67986c
RS
18646@ignore
18647@starindex
18648@end ignore
d7b8e6c6 18649@tindex sincos
5d67986c
RS
18650@ignore
18651@starindex
18652@end ignore
18653@ignore
18654@mindex arc@idots
18655@end ignore
d7b8e6c6
EZ
18656@tindex arcsincos
18657The @code{calc-sincos} [@code{sincos}] command computes the sine and
18658cosine of a number, returning them as a vector of the form
18659@samp{[@var{cos}, @var{sin}]}.
18660With the Inverse flag [@code{arcsincos}], this command takes a two-element
18661vector as an argument and computes @code{arctan2} of the elements.
a4231b04 18662(This command does not accept the Hyperbolic flag.)
d7b8e6c6 18663
31c912fc
JB
18664@pindex calc-sec
18665@tindex sec
18666@pindex calc-csc
18667@tindex csc
18668@pindex calc-cot
18669@tindex cot
18670@pindex calc-sech
18671@tindex sech
18672@pindex calc-csch
18673@tindex csch
18674@pindex calc-coth
18675@tindex coth
18676The remaining trigonometric functions, @code{calc-sec} [@code{sec}],
18677@code{calc-csc} [@code{csc}] and @code{calc-sec} [@code{sec}], are also
18678available. With the Hyperbolic flag, these compute their hyperbolic
18679counterparts, which are also available separately as @code{calc-sech}
18680[@code{sech}], @code{calc-csch} [@code{csch}] and @code{calc-sech}
18681[@code{sech}]. (These commmands do not accept the Inverse flag.)
18682
d7b8e6c6
EZ
18683@node Advanced Math Functions, Branch Cuts, Trigonometric and Hyperbolic Functions, Scientific Functions
18684@section Advanced Mathematical Functions
18685
18686@noindent
18687Calc can compute a variety of less common functions that arise in
18688various branches of mathematics. All of the functions described in
18689this section allow arbitrary complex arguments and, except as noted,
18690will work to arbitrarily large precisions. They can not at present
18691handle error forms or intervals as arguments.
18692
18693NOTE: These functions are still experimental. In particular, their
18694accuracy is not guaranteed in all domains. It is advisable to set the
18695current precision comfortably higher than you actually need when
18696using these functions. Also, these functions may be impractically
18697slow for some values of the arguments.
18698
18699@kindex f g
18700@pindex calc-gamma
18701@tindex gamma
18702The @kbd{f g} (@code{calc-gamma}) [@code{gamma}] command computes the Euler
18703gamma function. For positive integer arguments, this is related to the
18704factorial function: @samp{gamma(n+1) = fact(n)}. For general complex
18705arguments the gamma function can be defined by the following definite
a4231b04 18706integral:
8e04863e 18707@texline @math{\Gamma(a) = \int_0^\infty t^{a-1} e^t dt}.
a4231b04 18708@infoline @expr{gamma(a) = integ(t^(a-1) exp(t), t, 0, inf)}.
d7b8e6c6
EZ
18709(The actual implementation uses far more efficient computational methods.)
18710
18711@kindex f G
18712@tindex gammaP
5d67986c
RS
18713@ignore
18714@mindex @idots
18715@end ignore
d7b8e6c6 18716@kindex I f G
5d67986c
RS
18717@ignore
18718@mindex @null
18719@end ignore
d7b8e6c6 18720@kindex H f G
5d67986c
RS
18721@ignore
18722@mindex @null
18723@end ignore
d7b8e6c6
EZ
18724@kindex H I f G
18725@pindex calc-inc-gamma
5d67986c
RS
18726@ignore
18727@mindex @null
18728@end ignore
d7b8e6c6 18729@tindex gammaQ
5d67986c
RS
18730@ignore
18731@mindex @null
18732@end ignore
d7b8e6c6 18733@tindex gammag
5d67986c
RS
18734@ignore
18735@mindex @null
18736@end ignore
d7b8e6c6
EZ
18737@tindex gammaG
18738The @kbd{f G} (@code{calc-inc-gamma}) [@code{gammaP}] command computes
18739the incomplete gamma function, denoted @samp{P(a,x)}. This is defined by
a4231b04 18740the integral,
8e04863e 18741@texline @math{P(a,x) = \left( \int_0^x t^{a-1} e^t dt \right) / \Gamma(a)}.
a4231b04
JB
18742@infoline @expr{gammaP(a,x) = integ(t^(a-1) exp(t), t, 0, x) / gamma(a)}.
18743This implies that @samp{gammaP(a,inf) = 1} for any @expr{a} (see the
d7b8e6c6
EZ
18744definition of the normal gamma function).
18745
18746Several other varieties of incomplete gamma function are defined.
a4231b04 18747The complement of @expr{P(a,x)}, called @expr{Q(a,x) = 1-P(a,x)} by
d7b8e6c6
EZ
18748some authors, is computed by the @kbd{I f G} [@code{gammaQ}] command.
18749You can think of this as taking the other half of the integral, from
a4231b04 18750@expr{x} to infinity.
d7b8e6c6
EZ
18751
18752@ifinfo
a4231b04
JB
18753The functions corresponding to the integrals that define @expr{P(a,x)}
18754and @expr{Q(a,x)} but without the normalizing @expr{1/gamma(a)}
18755factor are called @expr{g(a,x)} and @expr{G(a,x)}, respectively
18756(where @expr{g} and @expr{G} represent the lower- and upper-case Greek
d7b8e6c6
EZ
18757letter gamma). You can obtain these using the @kbd{H f G} [@code{gammag}]
18758and @kbd{H I f G} [@code{gammaG}] commands.
18759@end ifinfo
18760@tex
18761\turnoffactive
18762The functions corresponding to the integrals that define $P(a,x)$
18763and $Q(a,x)$ but without the normalizing $1/\Gamma(a)$
18764factor are called $\gamma(a,x)$ and $\Gamma(a,x)$, respectively.
18765You can obtain these using the \kbd{H f G} [\code{gammag}] and
18766\kbd{I H f G} [\code{gammaG}] commands.
18767@end tex
18768
18769@kindex f b
18770@pindex calc-beta
18771@tindex beta
18772The @kbd{f b} (@code{calc-beta}) [@code{beta}] command computes the
18773Euler beta function, which is defined in terms of the gamma function as
8e04863e 18774@texline @math{B(a,b) = \Gamma(a) \Gamma(b) / \Gamma(a+b)},
a4231b04
JB
18775@infoline @expr{beta(a,b) = gamma(a) gamma(b) / gamma(a+b)},
18776or by
8e04863e 18777@texline @math{B(a,b) = \int_0^1 t^{a-1} (1-t)^{b-1} dt}.
a4231b04 18778@infoline @expr{beta(a,b) = integ(t^(a-1) (1-t)^(b-1), t, 0, 1)}.
d7b8e6c6
EZ
18779
18780@kindex f B
18781@kindex H f B
18782@pindex calc-inc-beta
18783@tindex betaI
18784@tindex betaB
18785The @kbd{f B} (@code{calc-inc-beta}) [@code{betaI}] command computes
a4231b04 18786the incomplete beta function @expr{I(x,a,b)}. It is defined by
8e04863e 18787@texline @math{I(x,a,b) = \left( \int_0^x t^{a-1} (1-t)^{b-1} dt \right) / B(a,b)}.
a4231b04 18788@infoline @expr{betaI(x,a,b) = integ(t^(a-1) (1-t)^(b-1), t, 0, x) / beta(a,b)}.
d7b8e6c6
EZ
18789Once again, the @kbd{H} (hyperbolic) prefix gives the corresponding
18790un-normalized version [@code{betaB}].
18791
18792@kindex f e
18793@kindex I f e
18794@pindex calc-erf
18795@tindex erf
18796@tindex erfc
18797The @kbd{f e} (@code{calc-erf}) [@code{erf}] command computes the
a4231b04 18798error function
8e04863e 18799@texline @math{\hbox{erf}(x) = {2 \over \sqrt{\pi}} \int_0^x e^{-t^2} dt}.
a4231b04 18800@infoline @expr{erf(x) = 2 integ(exp(-(t^2)), t, 0, x) / sqrt(pi)}.
d7b8e6c6
EZ
18801The complementary error function @kbd{I f e} (@code{calc-erfc}) [@code{erfc}]
18802is the corresponding integral from @samp{x} to infinity; the sum
8e04863e 18803@texline @math{\hbox{erf}(x) + \hbox{erfc}(x) = 1}.
a4231b04 18804@infoline @expr{erf(x) + erfc(x) = 1}.
d7b8e6c6
EZ
18805
18806@kindex f j
18807@kindex f y
18808@pindex calc-bessel-J
18809@pindex calc-bessel-Y
18810@tindex besJ
18811@tindex besY
18812The @kbd{f j} (@code{calc-bessel-J}) [@code{besJ}] and @kbd{f y}
18813(@code{calc-bessel-Y}) [@code{besY}] commands compute the Bessel
18814functions of the first and second kinds, respectively.
18815In @samp{besJ(n,x)} and @samp{besY(n,x)} the ``order'' parameter
a4231b04 18816@expr{n} is often an integer, but is not required to be one.
d7b8e6c6
EZ
18817Calc's implementation of the Bessel functions currently limits the
18818precision to 8 digits, and may not be exact even to that precision.
a4231b04 18819Use with care!
d7b8e6c6
EZ
18820
18821@node Branch Cuts, Random Numbers, Advanced Math Functions, Scientific Functions
18822@section Branch Cuts and Principal Values
18823
18824@noindent
18825@cindex Branch cuts
18826@cindex Principal values
18827All of the logarithmic, trigonometric, and other scientific functions are
18828defined for complex numbers as well as for reals.
18829This section describes the values
18830returned in cases where the general result is a family of possible values.
18831Calc follows section 12.5.3 of Steele's @dfn{Common Lisp, the Language},
18832second edition, in these matters. This section will describe each
18833function briefly; for a more detailed discussion (including some nifty
18834diagrams), consult Steele's book.
18835
18836Note that the branch cuts for @code{arctan} and @code{arctanh} were
18837changed between the first and second editions of Steele. Versions of
18838Calc starting with 2.00 follow the second edition.
18839
18840The new branch cuts exactly match those of the HP-28/48 calculators.
18841They also match those of Mathematica 1.2, except that Mathematica's
18842@code{arctan} cut is always in the right half of the complex plane,
18843and its @code{arctanh} cut is always in the top half of the plane.
18844Calc's cuts are continuous with quadrants I and III for @code{arctan},
18845or II and IV for @code{arctanh}.
18846
18847Note: The current implementations of these functions with complex arguments
18848are designed with proper behavior around the branch cuts in mind, @emph{not}
18849efficiency or accuracy. You may need to increase the floating precision
18850and wait a while to get suitable answers from them.
18851
a4231b04
JB
18852For @samp{sqrt(a+bi)}: When @expr{a<0} and @expr{b} is small but positive
18853or zero, the result is close to the @expr{+i} axis. For @expr{b} small and
18854negative, the result is close to the @expr{-i} axis. The result always lies
d7b8e6c6
EZ
18855in the right half of the complex plane.
18856
18857For @samp{ln(a+bi)}: The real part is defined as @samp{ln(abs(a+bi))}.
18858The imaginary part is defined as @samp{arg(a+bi) = arctan2(b,a)}.
18859Thus the branch cuts for @code{sqrt} and @code{ln} both lie on the
18860negative real axis.
18861
18862The following table describes these branch cuts in another way.
a4231b04
JB
18863If the real and imaginary parts of @expr{z} are as shown, then
18864the real and imaginary parts of @expr{f(z)} will be as shown.
d7b8e6c6
EZ
18865Here @code{eps} stands for a small positive value; each
18866occurrence of @code{eps} may stand for a different small value.
18867
18868@smallexample
18869 z sqrt(z) ln(z)
18870----------------------------------------
18871 +, 0 +, 0 any, 0
18872 -, 0 0, + any, pi
18873 -, +eps +eps, + +eps, +
18874 -, -eps +eps, - +eps, -
18875@end smallexample
18876
18877For @samp{z1^z2}: This is defined by @samp{exp(ln(z1)*z2)}.
18878One interesting consequence of this is that @samp{(-8)^1:3} does
8e04863e 18879not evaluate to @mathit{-2} as you might expect, but to the complex
a4231b04 18880number @expr{(1., 1.732)}. Both of these are valid cube roots
8e04863e 18881of @mathit{-8} (as is @expr{(1., -1.732)}); Calc chooses a perhaps
d7b8e6c6
EZ
18882less-obvious root for the sake of mathematical consistency.
18883
18884For @samp{arcsin(z)}: This is defined by @samp{-i*ln(i*z + sqrt(1-z^2))}.
8e04863e 18885The branch cuts are on the real axis, less than @mathit{-1} and greater than 1.
d7b8e6c6
EZ
18886
18887For @samp{arccos(z)}: This is defined by @samp{-i*ln(z + i*sqrt(1-z^2))},
18888or equivalently by @samp{pi/2 - arcsin(z)}. The branch cuts are on
8e04863e 18889the real axis, less than @mathit{-1} and greater than 1.
d7b8e6c6
EZ
18890
18891For @samp{arctan(z)}: This is defined by
18892@samp{(ln(1+i*z) - ln(1-i*z)) / (2*i)}. The branch cuts are on the
a4231b04 18893imaginary axis, below @expr{-i} and above @expr{i}.
d7b8e6c6
EZ
18894
18895For @samp{arcsinh(z)}: This is defined by @samp{ln(z + sqrt(1+z^2))}.
a4231b04
JB
18896The branch cuts are on the imaginary axis, below @expr{-i} and
18897above @expr{i}.
d7b8e6c6
EZ
18898
18899For @samp{arccosh(z)}: This is defined by
18900@samp{ln(z + (z+1)*sqrt((z-1)/(z+1)))}. The branch cut is on the
18901real axis less than 1.
18902
18903For @samp{arctanh(z)}: This is defined by @samp{(ln(1+z) - ln(1-z)) / 2}.
8e04863e 18904The branch cuts are on the real axis, less than @mathit{-1} and greater than 1.
d7b8e6c6
EZ
18905
18906The following tables for @code{arcsin}, @code{arccos}, and
07ce2eb3 18907@code{arctan} assume the current angular mode is Radians. The
d7b8e6c6
EZ
18908hyperbolic functions operate independently of the angular mode.
18909
18910@smallexample
18911 z arcsin(z) arccos(z)
18912-------------------------------------------------------
18913 (-1..1), 0 (-pi/2..pi/2), 0 (0..pi), 0
18914 (-1..1), +eps (-pi/2..pi/2), +eps (0..pi), -eps
18915 (-1..1), -eps (-pi/2..pi/2), -eps (0..pi), +eps
18916 <-1, 0 -pi/2, + pi, -
18917 <-1, +eps -pi/2 + eps, + pi - eps, -
18918 <-1, -eps -pi/2 + eps, - pi - eps, +
18919 >1, 0 pi/2, - 0, +
18920 >1, +eps pi/2 - eps, + +eps, -
18921 >1, -eps pi/2 - eps, - +eps, +
18922@end smallexample
18923
18924@smallexample
18925 z arccosh(z) arctanh(z)
18926-----------------------------------------------------
18927 (-1..1), 0 0, (0..pi) any, 0
18928 (-1..1), +eps +eps, (0..pi) any, +eps
18929 (-1..1), -eps +eps, (-pi..0) any, -eps
18930 <-1, 0 +, pi -, pi/2
18931 <-1, +eps +, pi - eps -, pi/2 - eps
18932 <-1, -eps +, -pi + eps -, -pi/2 + eps
18933 >1, 0 +, 0 +, -pi/2
18934 >1, +eps +, +eps +, pi/2 - eps
18935 >1, -eps +, -eps +, -pi/2 + eps
18936@end smallexample
18937
18938@smallexample
18939 z arcsinh(z) arctan(z)
18940-----------------------------------------------------
18941 0, (-1..1) 0, (-pi/2..pi/2) 0, any
18942 0, <-1 -, -pi/2 -pi/2, -
18943 +eps, <-1 +, -pi/2 + eps pi/2 - eps, -
18944 -eps, <-1 -, -pi/2 + eps -pi/2 + eps, -
18945 0, >1 +, pi/2 pi/2, +
18946 +eps, >1 +, pi/2 - eps pi/2 - eps, +
18947 -eps, >1 -, pi/2 - eps -pi/2 + eps, +
18948@end smallexample
18949
18950Finally, the following identities help to illustrate the relationship
18951between the complex trigonometric and hyperbolic functions. They
18952are valid everywhere, including on the branch cuts.
18953
18954@smallexample
18955sin(i*z) = i*sinh(z) arcsin(i*z) = i*arcsinh(z)
18956cos(i*z) = cosh(z) arcsinh(i*z) = i*arcsin(z)
18957tan(i*z) = i*tanh(z) arctan(i*z) = i*arctanh(z)
18958sinh(i*z) = i*sin(z) cosh(i*z) = cos(z)
18959@end smallexample
18960
18961The ``advanced math'' functions (gamma, Bessel, etc.@:) are also defined
18962for general complex arguments, but their branch cuts and principal values
18963are not rigorously specified at present.
18964
18965@node Random Numbers, Combinatorial Functions, Branch Cuts, Scientific Functions
18966@section Random Numbers
18967
18968@noindent
18969@kindex k r
18970@pindex calc-random
18971@tindex random
18972The @kbd{k r} (@code{calc-random}) [@code{random}] command produces
18973random numbers of various sorts.
18974
a4231b04
JB
18975Given a positive numeric prefix argument @expr{M}, it produces a random
18976integer @expr{N} in the range
8e04863e 18977@texline @math{0 \le N < M}.
a4231b04
JB
18978@infoline @expr{0 <= N < M}.
18979Each of the @expr{M} values appears with equal probability.
d7b8e6c6
EZ
18980
18981With no numeric prefix argument, the @kbd{k r} command takes its argument
a4231b04
JB
18982from the stack instead. Once again, if this is a positive integer @expr{M}
18983the result is a random integer less than @expr{M}. However, note that
18984while numeric prefix arguments are limited to six digits or so, an @expr{M}
18985taken from the stack can be arbitrarily large. If @expr{M} is negative,
18986the result is a random integer in the range
8e04863e 18987@texline @math{M < N \le 0}.
a4231b04
JB
18988@infoline @expr{M < N <= 0}.
18989
18990If the value on the stack is a floating-point number @expr{M}, the result
18991is a random floating-point number @expr{N} in the range
8e04863e 18992@texline @math{0 \le N < M}
a4231b04
JB
18993@infoline @expr{0 <= N < M}
18994or
8e04863e 18995@texline @math{M < N \le 0},
a4231b04
JB
18996@infoline @expr{M < N <= 0},
18997according to the sign of @expr{M}.
18998
18999If @expr{M} is zero, the result is a Gaussian-distributed random real
d7b8e6c6
EZ
19000number; the distribution has a mean of zero and a standard deviation
19001of one. The algorithm used generates random numbers in pairs; thus,
19002every other call to this function will be especially fast.
19003
a4231b04 19004If @expr{M} is an error form
8e04863e 19005@texline @math{m} @code{+/-} @math{\sigma}
a4231b04
JB
19006@infoline @samp{m +/- s}
19007where @var{m} and
8e04863e 19008@texline @math{\sigma}
a4231b04
JB
19009@infoline @var{s}
19010are both real numbers, the result uses a Gaussian distribution with mean
19011@var{m} and standard deviation
8e04863e 19012@texline @math{\sigma}.
bd712b70 19013@infoline @var{s}.
d7b8e6c6 19014
a4231b04 19015If @expr{M} is an interval form, the lower and upper bounds specify the
d7b8e6c6
EZ
19016acceptable limits of the random numbers. If both bounds are integers,
19017the result is a random integer in the specified range. If either bound
19018is floating-point, the result is a random real number in the specified
19019range. If the interval is open at either end, the result will be sure
19020not to equal that end value. (This makes a big difference for integer
19021intervals, but for floating-point intervals it's relatively minor:
19022with a precision of 6, @samp{random([1.0..2.0))} will return any of one
19023million numbers from 1.00000 to 1.99999; @samp{random([1.0..2.0])} may
19024additionally return 2.00000, but the probability of this happening is
19025extremely small.)
19026
a4231b04 19027If @expr{M} is a vector, the result is one element taken at random from
d7b8e6c6
EZ
19028the vector. All elements of the vector are given equal probabilities.
19029
19030@vindex RandSeed
19031The sequence of numbers produced by @kbd{k r} is completely random by
19032default, i.e., the sequence is seeded each time you start Calc using
19033the current time and other information. You can get a reproducible
19034sequence by storing a particular ``seed value'' in the Calc variable
19035@code{RandSeed}. Any integer will do for a seed; integers of from 1
19036to 12 digits are good. If you later store a different integer into
19037@code{RandSeed}, Calc will switch to a different pseudo-random
19038sequence. If you ``unstore'' @code{RandSeed}, Calc will re-seed itself
19039from the current time. If you store the same integer that you used
19040before back into @code{RandSeed}, you will get the exact same sequence
19041of random numbers as before.
19042
19043@pindex calc-rrandom
19044The @code{calc-rrandom} command (not on any key) produces a random real
19045number between zero and one. It is equivalent to @samp{random(1.0)}.
19046
19047@kindex k a
19048@pindex calc-random-again
19049The @kbd{k a} (@code{calc-random-again}) command produces another random
a4231b04 19050number, re-using the most recent value of @expr{M}. With a numeric
d7b8e6c6 19051prefix argument @var{n}, it produces @var{n} more random numbers using
a4231b04 19052that value of @expr{M}.
d7b8e6c6
EZ
19053
19054@kindex k h
19055@pindex calc-shuffle
19056@tindex shuffle
19057The @kbd{k h} (@code{calc-shuffle}) command produces a vector of several
19058random values with no duplicates. The value on the top of the stack
19059specifies the set from which the random values are drawn, and may be any
a4231b04 19060of the @expr{M} formats described above. The numeric prefix argument
d7b8e6c6
EZ
19061gives the length of the desired list. (If you do not provide a numeric
19062prefix argument, the length of the list is taken from the top of the
a4231b04 19063stack, and @expr{M} from second-to-top.)
d7b8e6c6 19064
a4231b04 19065If @expr{M} is a floating-point number, zero, or an error form (so
d7b8e6c6
EZ
19066that the random values are being drawn from the set of real numbers)
19067there is little practical difference between using @kbd{k h} and using
19068@kbd{k r} several times. But if the set of possible values consists
19069of just a few integers, or the elements of a vector, then there is
19070a very real chance that multiple @kbd{k r}'s will produce the same
19071number more than once. The @kbd{k h} command produces a vector whose
19072elements are always distinct. (Actually, there is a slight exception:
a4231b04
JB
19073If @expr{M} is a vector, no given vector element will be drawn more
19074than once, but if several elements of @expr{M} are equal, they may
d7b8e6c6
EZ
19075each make it into the result vector.)
19076
19077One use of @kbd{k h} is to rearrange a list at random. This happens
19078if the prefix argument is equal to the number of values in the list:
19079@kbd{[1, 1.5, 2, 2.5, 3] 5 k h} might produce the permuted list
19080@samp{[2.5, 1, 1.5, 3, 2]}. As a convenient feature, if the argument
19081@var{n} is negative it is replaced by the size of the set represented
a4231b04 19082by @expr{M}. Naturally, this is allowed only when @expr{M} specifies
d7b8e6c6
EZ
19083a small discrete set of possibilities.
19084
19085To do the equivalent of @kbd{k h} but with duplications allowed,
a4231b04
JB
19086given @expr{M} on the stack and with @var{n} just entered as a numeric
19087prefix, use @kbd{v b} to build a vector of copies of @expr{M}, then use
d7b8e6c6
EZ
19088@kbd{V M k r} to ``map'' the normal @kbd{k r} function over the
19089elements of this vector. @xref{Matrix Functions}.
19090
19091@menu
19092* Random Number Generator:: (Complete description of Calc's algorithm)
19093@end menu
19094
19095@node Random Number Generator, , Random Numbers, Random Numbers
19096@subsection Random Number Generator
19097
19098Calc's random number generator uses several methods to ensure that
19099the numbers it produces are highly random. Knuth's @emph{Art of
19100Computer Programming}, Volume II, contains a thorough description
19101of the theory of random number generators and their measurement and
19102characterization.
19103
19104If @code{RandSeed} has no stored value, Calc calls Emacs' built-in
19105@code{random} function to get a stream of random numbers, which it
19106then treats in various ways to avoid problems inherent in the simple
19107random number generators that many systems use to implement @code{random}.
19108
19109When Calc's random number generator is first invoked, it ``seeds''
19110the low-level random sequence using the time of day, so that the
19111random number sequence will be different every time you use Calc.
19112
19113Since Emacs Lisp doesn't specify the range of values that will be
19114returned by its @code{random} function, Calc exercises the function
19115several times to estimate the range. When Calc subsequently uses
19116the @code{random} function, it takes only 10 bits of the result
19117near the most-significant end. (It avoids at least the bottom
19118four bits, preferably more, and also tries to avoid the top two
19119bits.) This strategy works well with the linear congruential
19120generators that are typically used to implement @code{random}.
19121
19122If @code{RandSeed} contains an integer, Calc uses this integer to
19123seed an ``additive congruential'' method (Knuth's algorithm 3.2.2A,
a4231b04 19124computing
8e04863e 19125@texline @math{X_{n-55} - X_{n-24}}.
a4231b04
JB
19126@infoline @expr{X_n-55 - X_n-24}).
19127This method expands the seed
d7b8e6c6 19128value into a large table which is maintained internally; the variable
a4231b04 19129@code{RandSeed} is changed from, e.g., 42 to the vector @expr{[42]}
d7b8e6c6
EZ
19130to indicate that the seed has been absorbed into this table. When
19131@code{RandSeed} contains a vector, @kbd{k r} and related commands
19132continue to use the same internal table as last time. There is no
19133way to extract the complete state of the random number generator
19134so that you can restart it from any point; you can only restart it
19135from the same initial seed value. A simple way to restart from the
19136same seed is to type @kbd{s r RandSeed} to get the seed vector,
19137@kbd{v u} to unpack it back into a number, then @kbd{s t RandSeed}
19138to reseed the generator with that number.
19139
19140Calc uses a ``shuffling'' method as described in algorithm 3.2.2B
19141of Knuth. It fills a table with 13 random 10-bit numbers. Then,
19142to generate a new random number, it uses the previous number to
19143index into the table, picks the value it finds there as the new
19144random number, then replaces that table entry with a new value
19145obtained from a call to the base random number generator (either
19146the additive congruential generator or the @code{random} function
19147supplied by the system). If there are any flaws in the base
19148generator, shuffling will tend to even them out. But if the system
19149provides an excellent @code{random} function, shuffling will not
19150damage its randomness.
19151
19152To create a random integer of a certain number of digits, Calc
19153builds the integer three decimal digits at a time. For each group
19154of three digits, Calc calls its 10-bit shuffling random number generator
19155(which returns a value from 0 to 1023); if the random value is 1000
19156or more, Calc throws it out and tries again until it gets a suitable
19157value.
19158
19159To create a random floating-point number with precision @var{p}, Calc
19160simply creates a random @var{p}-digit integer and multiplies by
8e04863e 19161@texline @math{10^{-p}}.
a4231b04
JB
19162@infoline @expr{10^-p}.
19163The resulting random numbers should be very clean, but note
d7b8e6c6
EZ
19164that relatively small numbers will have few significant random digits.
19165In other words, with a precision of 12, you will occasionally get
a4231b04 19166numbers on the order of
8e04863e 19167@texline @math{10^{-9}}
a4231b04
JB
19168@infoline @expr{10^-9}
19169or
8e04863e 19170@texline @math{10^{-10}},
a4231b04
JB
19171@infoline @expr{10^-10},
19172but those numbers will only have two or three random digits since they
19173correspond to small integers times
8e04863e 19174@texline @math{10^{-12}}.
a4231b04 19175@infoline @expr{10^-12}.
d7b8e6c6
EZ
19176
19177To create a random integer in the interval @samp{[0 .. @var{m})}, Calc
19178counts the digits in @var{m}, creates a random integer with three
19179additional digits, then reduces modulo @var{m}. Unless @var{m} is a
19180power of ten the resulting values will be very slightly biased toward
19181the lower numbers, but this bias will be less than 0.1%. (For example,
19182if @var{m} is 42, Calc will reduce a random integer less than 100000
19183modulo 42 to get a result less than 42. It is easy to show that the
19184numbers 40 and 41 will be only 2380/2381 as likely to result from this
19185modulo operation as numbers 39 and below.) If @var{m} is a power of
19186ten, however, the numbers should be completely unbiased.
19187
19188The Gaussian random numbers generated by @samp{random(0.0)} use the
19189``polar'' method described in Knuth section 3.4.1C. This method
19190generates a pair of Gaussian random numbers at a time, so only every
19191other call to @samp{random(0.0)} will require significant calculations.
19192
19193@node Combinatorial Functions, Probability Distribution Functions, Random Numbers, Scientific Functions
19194@section Combinatorial Functions
19195
19196@noindent
19197Commands relating to combinatorics and number theory begin with the
19198@kbd{k} key prefix.
19199
19200@kindex k g
19201@pindex calc-gcd
19202@tindex gcd
19203The @kbd{k g} (@code{calc-gcd}) [@code{gcd}] command computes the
19204Greatest Common Divisor of two integers. It also accepts fractions;
19205the GCD of two fractions is defined by taking the GCD of the
19206numerators, and the LCM of the denominators. This definition is
19207consistent with the idea that @samp{a / gcd(a,x)} should yield an
19208integer for any @samp{a} and @samp{x}. For other types of arguments,
a4231b04 19209the operation is left in symbolic form.
d7b8e6c6
EZ
19210
19211@kindex k l
19212@pindex calc-lcm
19213@tindex lcm
19214The @kbd{k l} (@code{calc-lcm}) [@code{lcm}] command computes the
19215Least Common Multiple of two integers or fractions. The product of
19216the LCM and GCD of two numbers is equal to the product of the
a4231b04 19217numbers.
d7b8e6c6
EZ
19218
19219@kindex k E
19220@pindex calc-extended-gcd
19221@tindex egcd
19222The @kbd{k E} (@code{calc-extended-gcd}) [@code{egcd}] command computes
a4231b04
JB
19223the GCD of two integers @expr{x} and @expr{y} and returns a vector
19224@expr{[g, a, b]} where
8e04863e 19225@texline @math{g = \gcd(x,y) = a x + b y}.
a4231b04 19226@infoline @expr{g = gcd(x,y) = a x + b y}.
d7b8e6c6
EZ
19227
19228@kindex !
19229@pindex calc-factorial
19230@tindex fact
5d67986c
RS
19231@ignore
19232@mindex @null
19233@end ignore
d7b8e6c6
EZ
19234@tindex !
19235The @kbd{!} (@code{calc-factorial}) [@code{fact}] command computes the
19236factorial of the number at the top of the stack. If the number is an
19237integer, the result is an exact integer. If the number is an
19238integer-valued float, the result is a floating-point approximation. If
19239the number is a non-integral real number, the generalized factorial is used,
19240as defined by the Euler Gamma function. Please note that computation of
19241large factorials can be slow; using floating-point format will help
19242since fewer digits must be maintained. The same is true of many of
a4231b04 19243the commands in this section.
d7b8e6c6
EZ
19244
19245@kindex k d
19246@pindex calc-double-factorial
19247@tindex dfact
5d67986c
RS
19248@ignore
19249@mindex @null
19250@end ignore
d7b8e6c6
EZ
19251@tindex !!
19252The @kbd{k d} (@code{calc-double-factorial}) [@code{dfact}] command
19253computes the ``double factorial'' of an integer. For an even integer,
a4231b04
JB
19254this is the product of even integers from 2 to @expr{N}. For an odd
19255integer, this is the product of odd integers from 3 to @expr{N}. If
d7b8e6c6
EZ
19256the argument is an integer-valued float, the result is a floating-point
19257approximation. This function is undefined for negative even integers.
a4231b04 19258The notation @expr{N!!} is also recognized for double factorials.
d7b8e6c6
EZ
19259
19260@kindex k c
19261@pindex calc-choose
19262@tindex choose
19263The @kbd{k c} (@code{calc-choose}) [@code{choose}] command computes the
a4231b04
JB
19264binomial coefficient @expr{N}-choose-@expr{M}, where @expr{M} is the number
19265on the top of the stack and @expr{N} is second-to-top. If both arguments
d7b8e6c6
EZ
19266are integers, the result is an exact integer. Otherwise, the result is a
19267floating-point approximation. The binomial coefficient is defined for all
a4231b04 19268real numbers by
8e04863e 19269@texline @math{N! \over M! (N-M)!\,}.
a4231b04 19270@infoline @expr{N! / M! (N-M)!}.
d7b8e6c6
EZ
19271
19272@kindex H k c
19273@pindex calc-perm
19274@tindex perm
19275@ifinfo
19276The @kbd{H k c} (@code{calc-perm}) [@code{perm}] command computes the
a4231b04 19277number-of-permutations function @expr{N! / (N-M)!}.
d7b8e6c6
EZ
19278@end ifinfo
19279@tex
19280The \kbd{H k c} (\code{calc-perm}) [\code{perm}] command computes the
19281number-of-perm\-utations function $N! \over (N-M)!\,$.
19282@end tex
19283
19284@kindex k b
19285@kindex H k b
19286@pindex calc-bernoulli-number
19287@tindex bern
19288The @kbd{k b} (@code{calc-bernoulli-number}) [@code{bern}] command
19289computes a given Bernoulli number. The value at the top of the stack
a4231b04 19290is a nonnegative integer @expr{n} that specifies which Bernoulli number
d7b8e6c6 19291is desired. The @kbd{H k b} command computes a Bernoulli polynomial,
a4231b04
JB
19292taking @expr{n} from the second-to-top position and @expr{x} from the
19293top of the stack. If @expr{x} is a variable or formula the result is
19294a polynomial in @expr{x}; if @expr{x} is a number the result is a number.
d7b8e6c6
EZ
19295
19296@kindex k e
19297@kindex H k e
19298@pindex calc-euler-number
19299@tindex euler
19300The @kbd{k e} (@code{calc-euler-number}) [@code{euler}] command similarly
19301computes an Euler number, and @w{@kbd{H k e}} computes an Euler polynomial.
19302Bernoulli and Euler numbers occur in the Taylor expansions of several
19303functions.
19304
19305@kindex k s
19306@kindex H k s
19307@pindex calc-stirling-number
19308@tindex stir1
19309@tindex stir2
19310The @kbd{k s} (@code{calc-stirling-number}) [@code{stir1}] command
a4231b04 19311computes a Stirling number of the first
8e04863e 19312@texline kind@tie{}@math{n \brack m},
a4231b04
JB
19313@infoline kind,
19314given two integers @expr{n} and @expr{m} on the stack. The @kbd{H k s}
19315[@code{stir2}] command computes a Stirling number of the second
8e04863e 19316@texline kind@tie{}@math{n \brace m}.
a4231b04
JB
19317@infoline kind.
19318These are the number of @expr{m}-cycle permutations of @expr{n} objects,
19319and the number of ways to partition @expr{n} objects into @expr{m}
d7b8e6c6
EZ
19320non-empty sets, respectively.
19321
19322@kindex k p
19323@pindex calc-prime-test
19324@cindex Primes
19325The @kbd{k p} (@code{calc-prime-test}) command checks if the integer on
19326the top of the stack is prime. For integers less than eight million, the
19327answer is always exact and reasonably fast. For larger integers, a
19328probabilistic method is used (see Knuth vol. II, section 4.5.4, algorithm P).
19329The number is first checked against small prime factors (up to 13). Then,
19330any number of iterations of the algorithm are performed. Each step either
19331discovers that the number is non-prime, or substantially increases the
19332certainty that the number is prime. After a few steps, the chance that
19333a number was mistakenly described as prime will be less than one percent.
19334(Indeed, this is a worst-case estimate of the probability; in practice
19335even a single iteration is quite reliable.) After the @kbd{k p} command,
19336the number will be reported as definitely prime or non-prime if possible,
19337or otherwise ``probably'' prime with a certain probability of error.
19338
5d67986c
RS
19339@ignore
19340@starindex
19341@end ignore
d7b8e6c6
EZ
19342@tindex prime
19343The normal @kbd{k p} command performs one iteration of the primality
19344test. Pressing @kbd{k p} repeatedly for the same integer will perform
19345additional iterations. Also, @kbd{k p} with a numeric prefix performs
19346the specified number of iterations. There is also an algebraic function
a4231b04 19347@samp{prime(n)} or @samp{prime(n,iters)} which returns 1 if @expr{n}
d7b8e6c6
EZ
19348is (probably) prime and 0 if not.
19349
19350@kindex k f
19351@pindex calc-prime-factors
19352@tindex prfac
19353The @kbd{k f} (@code{calc-prime-factors}) [@code{prfac}] command
19354attempts to decompose an integer into its prime factors. For numbers up
19355to 25 million, the answer is exact although it may take some time. The
19356result is a vector of the prime factors in increasing order. For larger
19357inputs, prime factors above 5000 may not be found, in which case the
19358last number in the vector will be an unfactored integer greater than 25
19359million (with a warning message). For negative integers, the first
8e04863e
JB
19360element of the list will be @mathit{-1}. For inputs @mathit{-1}, @mathit{0}, and
19361@mathit{1}, the result is a list of the same number.
d7b8e6c6
EZ
19362
19363@kindex k n
19364@pindex calc-next-prime
5d67986c
RS
19365@ignore
19366@mindex nextpr@idots
19367@end ignore
d7b8e6c6
EZ
19368@tindex nextprime
19369The @kbd{k n} (@code{calc-next-prime}) [@code{nextprime}] command finds
19370the next prime above a given number. Essentially, it searches by calling
19371@code{calc-prime-test} on successive integers until it finds one that
19372passes the test. This is quite fast for integers less than eight million,
19373but once the probabilistic test comes into play the search may be rather
19374slow. Ordinarily this command stops for any prime that passes one iteration
19375of the primality test. With a numeric prefix argument, a number must pass
19376the specified number of iterations before the search stops. (This only
19377matters when searching above eight million.) You can always use additional
19378@kbd{k p} commands to increase your certainty that the number is indeed
19379prime.
19380
19381@kindex I k n
19382@pindex calc-prev-prime
5d67986c
RS
19383@ignore
19384@mindex prevpr@idots
19385@end ignore
d7b8e6c6
EZ
19386@tindex prevprime
19387The @kbd{I k n} (@code{calc-prev-prime}) [@code{prevprime}] command
19388analogously finds the next prime less than a given number.
19389
19390@kindex k t
19391@pindex calc-totient
19392@tindex totient
19393The @kbd{k t} (@code{calc-totient}) [@code{totient}] command computes the
a4231b04 19394Euler ``totient''
8e04863e 19395@texline function@tie{}@math{\phi(n)},
a4231b04
JB
19396@infoline function,
19397the number of integers less than @expr{n} which
19398are relatively prime to @expr{n}.
d7b8e6c6
EZ
19399
19400@kindex k m
19401@pindex calc-moebius
19402@tindex moebius
19403The @kbd{k m} (@code{calc-moebius}) [@code{moebius}] command computes the
8e04863e 19404@texline M@"obius @math{\mu}
a4231b04
JB
19405@infoline Moebius ``mu''
19406function. If the input number is a product of @expr{k}
19407distinct factors, this is @expr{(-1)^k}. If the input number has any
d7b8e6c6
EZ
19408duplicate factors (i.e., can be divided by the same prime more than once),
19409the result is zero.
19410
19411@node Probability Distribution Functions, , Combinatorial Functions, Scientific Functions
19412@section Probability Distribution Functions
19413
19414@noindent
19415The functions in this section compute various probability distributions.
19416For continuous distributions, this is the integral of the probability
a4231b04 19417density function from @expr{x} to infinity. (These are the ``upper
d7b8e6c6 19418tail'' distribution functions; there are also corresponding ``lower
a4231b04 19419tail'' functions which integrate from minus infinity to @expr{x}.)
d7b8e6c6 19420For discrete distributions, the upper tail function gives the sum
a4231b04
JB
19421from @expr{x} to infinity; the lower tail function gives the sum
19422from minus infinity up to, but not including,@w{ }@expr{x}.
d7b8e6c6 19423
a4231b04 19424To integrate from @expr{x} to @expr{y}, just use the distribution
d7b8e6c6
EZ
19425function twice and subtract. For example, the probability that a
19426Gaussian random variable with mean 2 and standard deviation 1 will
19427lie in the range from 2.5 to 2.8 is @samp{utpn(2.5,2,1) - utpn(2.8,2,1)}
19428(``the probability that it is greater than 2.5, but not greater than 2.8''),
19429or equivalently @samp{ltpn(2.8,2,1) - ltpn(2.5,2,1)}.
19430
19431@kindex k B
19432@kindex I k B
19433@pindex calc-utpb
19434@tindex utpb
19435@tindex ltpb
19436The @kbd{k B} (@code{calc-utpb}) [@code{utpb}] function uses the
19437binomial distribution. Push the parameters @var{n}, @var{p}, and
19438then @var{x} onto the stack; the result (@samp{utpb(x,n,p)}) is the
19439probability that an event will occur @var{x} or more times out
19440of @var{n} trials, if its probability of occurring in any given
19441trial is @var{p}. The @kbd{I k B} [@code{ltpb}] function is
19442the probability that the event will occur fewer than @var{x} times.
19443
19444The other probability distribution functions similarly take the
19445form @kbd{k @var{X}} (@code{calc-utp@var{x}}) [@code{utp@var{x}}]
19446and @kbd{I k @var{X}} [@code{ltp@var{x}}], for various letters
19447@var{x}. The arguments to the algebraic functions are the value of
19448the random variable first, then whatever other parameters define the
19449distribution. Note these are among the few Calc functions where the
19450order of the arguments in algebraic form differs from the order of
19451arguments as found on the stack. (The random variable comes last on
19452the stack, so that you can type, e.g., @kbd{2 @key{RET} 1 @key{RET} 2.5
19453k N M-@key{RET} @key{DEL} 2.8 k N -}, using @kbd{M-@key{RET} @key{DEL}} to
a4231b04 19454recover the original arguments but substitute a new value for @expr{x}.)
d7b8e6c6
EZ
19455
19456@kindex k C
19457@pindex calc-utpc
19458@tindex utpc
5d67986c
RS
19459@ignore
19460@mindex @idots
19461@end ignore
d7b8e6c6 19462@kindex I k C
5d67986c
RS
19463@ignore
19464@mindex @null
19465@end ignore
d7b8e6c6
EZ
19466@tindex ltpc
19467The @samp{utpc(x,v)} function uses the chi-square distribution with
8e04863e 19468@texline @math{\nu}
a4231b04
JB
19469@infoline @expr{v}
19470degrees of freedom. It is the probability that a model is
19471correct if its chi-square statistic is @expr{x}.
d7b8e6c6
EZ
19472
19473@kindex k F
19474@pindex calc-utpf
19475@tindex utpf
5d67986c
RS
19476@ignore
19477@mindex @idots
19478@end ignore
d7b8e6c6 19479@kindex I k F
5d67986c
RS
19480@ignore
19481@mindex @null
19482@end ignore
d7b8e6c6
EZ
19483@tindex ltpf
19484The @samp{utpf(F,v1,v2)} function uses the F distribution, used in
a4231b04 19485various statistical tests. The parameters
8e04863e 19486@texline @math{\nu_1}
a4231b04
JB
19487@infoline @expr{v1}
19488and
8e04863e 19489@texline @math{\nu_2}
a4231b04 19490@infoline @expr{v2}
d7b8e6c6 19491are the degrees of freedom in the numerator and denominator,
a4231b04 19492respectively, used in computing the statistic @expr{F}.
d7b8e6c6
EZ
19493
19494@kindex k N
19495@pindex calc-utpn
19496@tindex utpn
5d67986c
RS
19497@ignore
19498@mindex @idots
19499@end ignore
d7b8e6c6 19500@kindex I k N
5d67986c
RS
19501@ignore
19502@mindex @null
19503@end ignore
d7b8e6c6
EZ
19504@tindex ltpn
19505The @samp{utpn(x,m,s)} function uses a normal (Gaussian) distribution
a4231b04 19506with mean @expr{m} and standard deviation
8e04863e 19507@texline @math{\sigma}.
a4231b04
JB
19508@infoline @expr{s}.
19509It is the probability that such a normal-distributed random variable
19510would exceed @expr{x}.
d7b8e6c6
EZ
19511
19512@kindex k P
19513@pindex calc-utpp
19514@tindex utpp
5d67986c
RS
19515@ignore
19516@mindex @idots
19517@end ignore
d7b8e6c6 19518@kindex I k P
5d67986c
RS
19519@ignore
19520@mindex @null
19521@end ignore
d7b8e6c6
EZ
19522@tindex ltpp
19523The @samp{utpp(n,x)} function uses a Poisson distribution with
a4231b04 19524mean @expr{x}. It is the probability that @expr{n} or more such
d7b8e6c6
EZ
19525Poisson random events will occur.
19526
19527@kindex k T
19528@pindex calc-ltpt
19529@tindex utpt
5d67986c
RS
19530@ignore
19531@mindex @idots
19532@end ignore
d7b8e6c6 19533@kindex I k T
5d67986c
RS
19534@ignore
19535@mindex @null
19536@end ignore
d7b8e6c6
EZ
19537@tindex ltpt
19538The @samp{utpt(t,v)} function uses the Student's ``t'' distribution
a4231b04 19539with
8e04863e 19540@texline @math{\nu}
a4231b04
JB
19541@infoline @expr{v}
19542degrees of freedom. It is the probability that a
19543t-distributed random variable will be greater than @expr{t}.
19544(Note: This computes the distribution function
8e04863e 19545@texline @math{A(t|\nu)}
a4231b04
JB
19546@infoline @expr{A(t|v)}
19547where
8e04863e 19548@texline @math{A(0|\nu) = 1}
a4231b04
JB
19549@infoline @expr{A(0|v) = 1}
19550and
8e04863e 19551@texline @math{A(\infty|\nu) \to 0}.
a4231b04
JB
19552@infoline @expr{A(inf|v) -> 0}.
19553The @code{UTPT} operation on the HP-48 uses a different definition which
19554returns half of Calc's value: @samp{UTPT(t,v) = .5*utpt(t,v)}.)
d7b8e6c6
EZ
19555
19556While Calc does not provide inverses of the probability distribution
19557functions, the @kbd{a R} command can be used to solve for the inverse.
19558Since the distribution functions are monotonic, @kbd{a R} is guaranteed
19559to be able to find a solution given any initial guess.
19560@xref{Numerical Solutions}.
19561
19562@node Matrix Functions, Algebra, Scientific Functions, Top
19563@chapter Vector/Matrix Functions
19564
19565@noindent
19566Many of the commands described here begin with the @kbd{v} prefix.
19567(For convenience, the shift-@kbd{V} prefix is equivalent to @kbd{v}.)
19568The commands usually apply to both plain vectors and matrices; some
19569apply only to matrices or only to square matrices. If the argument
19570has the wrong dimensions the operation is left in symbolic form.
19571
19572Vectors are entered and displayed using @samp{[a,b,c]} notation.
19573Matrices are vectors of which all elements are vectors of equal length.
19574(Though none of the standard Calc commands use this concept, a
19575three-dimensional matrix or rank-3 tensor could be defined as a
19576vector of matrices, and so on.)
19577
19578@menu
19579* Packing and Unpacking::
19580* Building Vectors::
19581* Extracting Elements::
19582* Manipulating Vectors::
19583* Vector and Matrix Arithmetic::
19584* Set Operations::
19585* Statistical Operations::
19586* Reducing and Mapping::
19587* Vector and Matrix Formats::
19588@end menu
19589
19590@node Packing and Unpacking, Building Vectors, Matrix Functions, Matrix Functions
19591@section Packing and Unpacking
19592
19593@noindent
19594Calc's ``pack'' and ``unpack'' commands collect stack entries to build
19595composite objects such as vectors and complex numbers. They are
19596described in this chapter because they are most often used to build
19597vectors.
19598
19599@kindex v p
19600@pindex calc-pack
19601The @kbd{v p} (@code{calc-pack}) [@code{pack}] command collects several
19602elements from the stack into a matrix, complex number, HMS form, error
19603form, etc. It uses a numeric prefix argument to specify the kind of
19604object to be built; this argument is referred to as the ``packing mode.''
19605If the packing mode is a nonnegative integer, a vector of that
19606length is created. For example, @kbd{C-u 5 v p} will pop the top
19607five stack elements and push back a single vector of those five
19608elements. (@kbd{C-u 0 v p} simply creates an empty vector.)
19609
19610The same effect can be had by pressing @kbd{[} to push an incomplete
19611vector on the stack, using @key{TAB} (@code{calc-roll-down}) to sneak
19612the incomplete object up past a certain number of elements, and
19613then pressing @kbd{]} to complete the vector.
19614
19615Negative packing modes create other kinds of composite objects:
19616
19617@table @cite
19618@item -1
19619Two values are collected to build a complex number. For example,
19620@kbd{5 @key{RET} 7 C-u -1 v p} creates the complex number
a4231b04 19621@expr{(5, 7)}. The result is always a rectangular complex
d7b8e6c6
EZ
19622number. The two input values must both be real numbers,
19623i.e., integers, fractions, or floats. If they are not, Calc
19624will instead build a formula like @samp{a + (0, 1) b}. (The
19625other packing modes also create a symbolic answer if the
19626components are not suitable.)
19627
19628@item -2
19629Two values are collected to build a polar complex number.
19630The first is the magnitude; the second is the phase expressed
19631in either degrees or radians according to the current angular
19632mode.
19633
19634@item -3
19635Three values are collected into an HMS form. The first
19636two values (hours and minutes) must be integers or
19637integer-valued floats. The third value may be any real
19638number.
19639
19640@item -4
19641Two values are collected into an error form. The inputs
19642may be real numbers or formulas.
19643
19644@item -5
19645Two values are collected into a modulo form. The inputs
19646must be real numbers.
19647
19648@item -6
19649Two values are collected into the interval @samp{[a .. b]}.
19650The inputs may be real numbers, HMS or date forms, or formulas.
19651
19652@item -7
19653Two values are collected into the interval @samp{[a .. b)}.
19654
19655@item -8
19656Two values are collected into the interval @samp{(a .. b]}.
19657
19658@item -9
19659Two values are collected into the interval @samp{(a .. b)}.
19660
19661@item -10
19662Two integer values are collected into a fraction.
19663
19664@item -11
19665Two values are collected into a floating-point number.
19666The first is the mantissa; the second, which must be an
19667integer, is the exponent. The result is the mantissa
19668times ten to the power of the exponent.
19669
19670@item -12
8e04863e
JB
19671This is treated the same as @mathit{-11} by the @kbd{v p} command.
19672When unpacking, @mathit{-12} specifies that a floating-point mantissa
d7b8e6c6
EZ
19673is desired.
19674
19675@item -13
19676A real number is converted into a date form.
19677
19678@item -14
19679Three numbers (year, month, day) are packed into a pure date form.
19680
19681@item -15
19682Six numbers are packed into a date/time form.
19683@end table
19684
19685With any of the two-input negative packing modes, either or both
19686of the inputs may be vectors. If both are vectors of the same
19687length, the result is another vector made by packing corresponding
19688elements of the input vectors. If one input is a vector and the
19689other is a plain number, the number is packed along with each vector
19690element to produce a new vector. For example, @kbd{C-u -4 v p}
19691could be used to convert a vector of numbers and a vector of errors
19692into a single vector of error forms; @kbd{C-u -5 v p} could convert
19693a vector of numbers and a single number @var{M} into a vector of
19694numbers modulo @var{M}.
19695
19696If you don't give a prefix argument to @kbd{v p}, it takes
19697the packing mode from the top of the stack. The elements to
19698be packed then begin at stack level 2. Thus
19699@kbd{1 @key{RET} 2 @key{RET} 4 n v p} is another way to
19700enter the error form @samp{1 +/- 2}.
19701
19702If the packing mode taken from the stack is a vector, the result is a
19703matrix with the dimensions specified by the elements of the vector,
19704which must each be integers. For example, if the packing mode is
19705@samp{[2, 3]}, then six numbers will be taken from the stack and
19706returned in the form @samp{[@w{[a, b, c]}, [d, e, f]]}.
19707
19708If any elements of the vector are negative, other kinds of
19709packing are done at that level as described above. For
19710example, @samp{[2, 3, -4]} takes 12 objects and creates a
8e04863e 19711@texline @math{2\times3}
a4231b04
JB
19712@infoline 2x3
19713matrix of error forms: @samp{[[a +/- b, c +/- d ... ]]}.
d7b8e6c6
EZ
19714Also, @samp{[-4, -10]} will convert four integers into an
19715error form consisting of two fractions: @samp{a:b +/- c:d}.
19716
5d67986c
RS
19717@ignore
19718@starindex
19719@end ignore
d7b8e6c6
EZ
19720@tindex pack
19721There is an equivalent algebraic function,
19722@samp{pack(@var{mode}, @var{items})} where @var{mode} is a
19723packing mode (an integer or a vector of integers) and @var{items}
19724is a vector of objects to be packed (re-packed, really) according
19725to that mode. For example, @samp{pack([3, -4], [a,b,c,d,e,f])}
19726yields @samp{[a +/- b, @w{c +/- d}, e +/- f]}. The function is
ce7c7522 19727left in symbolic form if the packing mode is invalid, or if the
d7b8e6c6
EZ
19728number of data items does not match the number of items required
19729by the mode.
19730
19731@kindex v u
19732@pindex calc-unpack
19733The @kbd{v u} (@code{calc-unpack}) command takes the vector, complex
19734number, HMS form, or other composite object on the top of the stack and
19735``unpacks'' it, pushing each of its elements onto the stack as separate
19736objects. Thus, it is the ``inverse'' of @kbd{v p}. If the value
19737at the top of the stack is a formula, @kbd{v u} unpacks it by pushing
19738each of the arguments of the top-level operator onto the stack.
19739
19740You can optionally give a numeric prefix argument to @kbd{v u}
19741to specify an explicit (un)packing mode. If the packing mode is
19742negative and the input is actually a vector or matrix, the result
19743will be two or more similar vectors or matrices of the elements.
19744For example, given the vector @samp{[@w{a +/- b}, c^2, d +/- 7]},
19745the result of @kbd{C-u -4 v u} will be the two vectors
19746@samp{[a, c^2, d]} and @w{@samp{[b, 0, 7]}}.
19747
19748Note that the prefix argument can have an effect even when the input is
8e04863e
JB
19749not a vector. For example, if the input is the number @mathit{-5}, then
19750@kbd{c-u -1 v u} yields @mathit{-5} and 0 (the components of @mathit{-5}
d7b8e6c6 19751when viewed as a rectangular complex number); @kbd{C-u -2 v u} yields 5
07ce2eb3 19752and 180 (assuming Degrees mode); and @kbd{C-u -10 v u} yields @mathit{-5}
8e04863e 19753and 1 (the numerator and denominator of @mathit{-5}, viewed as a rational
d7b8e6c6
EZ
19754number). Plain @kbd{v u} with this input would complain that the input
19755is not a composite object.
19756
8e04863e 19757Unpacking mode @mathit{-11} converts a float into an integer mantissa and
d7b8e6c6
EZ
19758an integer exponent, where the mantissa is not divisible by 10
19759(except that 0.0 is represented by a mantissa and exponent of 0).
8e04863e 19760Unpacking mode @mathit{-12} converts a float into a floating-point mantissa
d7b8e6c6
EZ
19761and integer exponent, where the mantissa (for non-zero numbers)
19762is guaranteed to lie in the range [1 .. 10). In both cases,
19763the mantissa is shifted left or right (and the exponent adjusted
19764to compensate) in order to satisfy these constraints.
19765
19766Positive unpacking modes are treated differently than for @kbd{v p}.
19767A mode of 1 is much like plain @kbd{v u} with no prefix argument,
19768except that in addition to the components of the input object,
19769a suitable packing mode to re-pack the object is also pushed.
19770Thus, @kbd{C-u 1 v u} followed by @kbd{v p} will re-build the
19771original object.
19772
19773A mode of 2 unpacks two levels of the object; the resulting
19774re-packing mode will be a vector of length 2. This might be used
19775to unpack a matrix, say, or a vector of error forms. Higher
19776unpacking modes unpack the input even more deeply.
19777
5d67986c
RS
19778@ignore
19779@starindex
19780@end ignore
d7b8e6c6
EZ
19781@tindex unpack
19782There are two algebraic functions analogous to @kbd{v u}.
19783The @samp{unpack(@var{mode}, @var{item})} function unpacks the
19784@var{item} using the given @var{mode}, returning the result as
19785a vector of components. Here the @var{mode} must be an
19786integer, not a vector. For example, @samp{unpack(-4, a +/- b)}
19787returns @samp{[a, b]}, as does @samp{unpack(1, a +/- b)}.
19788
5d67986c
RS
19789@ignore
19790@starindex
19791@end ignore
d7b8e6c6
EZ
19792@tindex unpackt
19793The @code{unpackt} function is like @code{unpack} but instead
19794of returning a simple vector of items, it returns a vector of
19795two things: The mode, and the vector of items. For example,
19796@samp{unpackt(1, 2:3 +/- 1:4)} returns @samp{[-4, [2:3, 1:4]]},
19797and @samp{unpackt(2, 2:3 +/- 1:4)} returns @samp{[[-4, -10], [2, 3, 1, 4]]}.
19798The identity for re-building the original object is
19799@samp{apply(pack, unpackt(@var{n}, @var{x})) = @var{x}}. (The
19800@code{apply} function builds a function call given the function
19801name and a vector of arguments.)
19802
19803@cindex Numerator of a fraction, extracting
19804Subscript notation is a useful way to extract a particular part
19805of an object. For example, to get the numerator of a rational
19806number, you can use @samp{unpack(-10, @var{x})_1}.
19807
19808@node Building Vectors, Extracting Elements, Packing and Unpacking, Matrix Functions
19809@section Building Vectors
19810
19811@noindent
19812Vectors and matrices can be added,
a4231b04 19813subtracted, multiplied, and divided; @pxref{Basic Arithmetic}.
d7b8e6c6
EZ
19814
19815@kindex |
19816@pindex calc-concat
5d67986c
RS
19817@ignore
19818@mindex @null
19819@end ignore
d7b8e6c6 19820@tindex |
029b2a44 19821The @kbd{|} (@code{calc-concat}) [@code{vconcat}] command ``concatenates'' two vectors
d7b8e6c6
EZ
19822into one. For example, after @kbd{@w{[ 1 , 2 ]} [ 3 , 4 ] |}, the stack
19823will contain the single vector @samp{[1, 2, 3, 4]}. If the arguments
19824are matrices, the rows of the first matrix are concatenated with the
19825rows of the second. (In other words, two matrices are just two vectors
19826of row-vectors as far as @kbd{|} is concerned.)
19827
19828If either argument to @kbd{|} is a scalar (a non-vector), it is treated
19829like a one-element vector for purposes of concatenation: @kbd{1 [ 2 , 3 ] |}
19830produces the vector @samp{[1, 2, 3]}. Likewise, if one argument is a
19831matrix and the other is a plain vector, the vector is treated as a
19832one-row matrix.
19833
19834@kindex H |
19835@tindex append
19836The @kbd{H |} (@code{calc-append}) [@code{append}] command concatenates
19837two vectors without any special cases. Both inputs must be vectors.
19838Whether or not they are matrices is not taken into account. If either
19839argument is a scalar, the @code{append} function is left in symbolic form.
19840See also @code{cons} and @code{rcons} below.
19841
19842@kindex I |
19843@kindex H I |
19844The @kbd{I |} and @kbd{H I |} commands are similar, but they use their
19845two stack arguments in the opposite order. Thus @kbd{I |} is equivalent
5d67986c 19846to @kbd{@key{TAB} |}, but possibly more convenient and also a bit faster.
d7b8e6c6
EZ
19847
19848@kindex v d
19849@pindex calc-diag
19850@tindex diag
19851The @kbd{v d} (@code{calc-diag}) [@code{diag}] function builds a diagonal
19852square matrix. The optional numeric prefix gives the number of rows
19853and columns in the matrix. If the value at the top of the stack is a
19854vector, the elements of the vector are used as the diagonal elements; the
19855prefix, if specified, must match the size of the vector. If the value on
19856the stack is a scalar, it is used for each element on the diagonal, and
19857the prefix argument is required.
19858
a4231b04 19859To build a constant square matrix, e.g., a
8e04863e 19860@texline @math{3\times3}
a4231b04
JB
19861@infoline 3x3
19862matrix filled with ones, use @kbd{0 M-3 v d 1 +}, i.e., build a zero
19863matrix first and then add a constant value to that matrix. (Another
19864alternative would be to use @kbd{v b} and @kbd{v a}; see below.)
d7b8e6c6
EZ
19865
19866@kindex v i
19867@pindex calc-ident
19868@tindex idn
19869The @kbd{v i} (@code{calc-ident}) [@code{idn}] function builds an identity
19870matrix of the specified size. It is a convenient form of @kbd{v d}
19871where the diagonal element is always one. If no prefix argument is given,
19872this command prompts for one.
19873
19874In algebraic notation, @samp{idn(a,n)} acts much like @samp{diag(a,n)},
a4231b04
JB
19875except that @expr{a} is required to be a scalar (non-vector) quantity.
19876If @expr{n} is omitted, @samp{idn(a)} represents @expr{a} times an
d7b8e6c6
EZ
19877identity matrix of unknown size. Calc can operate algebraically on
19878such generic identity matrices, and if one is combined with a matrix
19879whose size is known, it is converted automatically to an identity
19880matrix of a suitable matching size. The @kbd{v i} command with an
19881argument of zero creates a generic identity matrix, @samp{idn(1)}.
07ce2eb3 19882Note that in dimensioned Matrix mode (@pxref{Matrix Mode}), generic
d7b8e6c6
EZ
19883identity matrices are immediately expanded to the current default
19884dimensions.
19885
19886@kindex v x
19887@pindex calc-index
19888@tindex index
19889The @kbd{v x} (@code{calc-index}) [@code{index}] function builds a vector
19890of consecutive integers from 1 to @var{n}, where @var{n} is the numeric
19891prefix argument. If you do not provide a prefix argument, you will be
19892prompted to enter a suitable number. If @var{n} is negative, the result
8e04863e 19893is a vector of negative integers from @var{n} to @mathit{-1}.
d7b8e6c6
EZ
19894
19895With a prefix argument of just @kbd{C-u}, the @kbd{v x} command takes
19896three values from the stack: @var{n}, @var{start}, and @var{incr} (with
19897@var{incr} at top-of-stack). Counting starts at @var{start} and increases
19898by @var{incr} for successive vector elements. If @var{start} or @var{n}
19899is in floating-point format, the resulting vector elements will also be
19900floats. Note that @var{start} and @var{incr} may in fact be any kind
19901of numbers or formulas.
19902
19903When @var{start} and @var{incr} are specified, a negative @var{n} has a
19904different interpretation: It causes a geometric instead of arithmetic
19905sequence to be generated. For example, @samp{index(-3, a, b)} produces
19906@samp{[a, a b, a b^2]}. If you omit @var{incr} in the algebraic form,
19907@samp{index(@var{n}, @var{start})}, the default value for @var{incr}
19908is one for positive @var{n} or two for negative @var{n}.
19909
19910@kindex v b
19911@pindex calc-build-vector
19912@tindex cvec
19913The @kbd{v b} (@code{calc-build-vector}) [@code{cvec}] function builds a
19914vector of @var{n} copies of the value on the top of the stack, where @var{n}
19915is the numeric prefix argument. In algebraic formulas, @samp{cvec(x,n,m)}
19916can also be used to build an @var{n}-by-@var{m} matrix of copies of @var{x}.
19917(Interactively, just use @kbd{v b} twice: once to build a row, then again
19918to build a matrix of copies of that row.)
19919
19920@kindex v h
19921@kindex I v h
19922@pindex calc-head
19923@pindex calc-tail
19924@tindex head
19925@tindex tail
19926The @kbd{v h} (@code{calc-head}) [@code{head}] function returns the first
19927element of a vector. The @kbd{I v h} (@code{calc-tail}) [@code{tail}]
19928function returns the vector with its first element removed. In both
19929cases, the argument must be a non-empty vector.
19930
19931@kindex v k
19932@pindex calc-cons
19933@tindex cons
19934The @kbd{v k} (@code{calc-cons}) [@code{cons}] function takes a value @var{h}
19935and a vector @var{t} from the stack, and produces the vector whose head is
19936@var{h} and whose tail is @var{t}. This is similar to @kbd{|}, except
19937if @var{h} is itself a vector, @kbd{|} will concatenate the two vectors
19938whereas @code{cons} will insert @var{h} at the front of the vector @var{t}.
19939
19940@kindex H v h
19941@tindex rhead
5d67986c
RS
19942@ignore
19943@mindex @idots
19944@end ignore
d7b8e6c6 19945@kindex H I v h
5d67986c
RS
19946@ignore
19947@mindex @null
19948@end ignore
d7b8e6c6 19949@kindex H v k
5d67986c
RS
19950@ignore
19951@mindex @null
19952@end ignore
d7b8e6c6 19953@tindex rtail
5d67986c
RS
19954@ignore
19955@mindex @null
19956@end ignore
d7b8e6c6
EZ
19957@tindex rcons
19958Each of these three functions also accepts the Hyperbolic flag [@code{rhead},
19959@code{rtail}, @code{rcons}] in which case @var{t} instead represents
19960the @emph{last} single element of the vector, with @var{h}
19961representing the remainder of the vector. Thus the vector
19962@samp{[a, b, c, d] = cons(a, [b, c, d]) = rcons([a, b, c], d)}.
19963Also, @samp{head([a, b, c, d]) = a}, @samp{tail([a, b, c, d]) = [b, c, d]},
19964@samp{rhead([a, b, c, d]) = [a, b, c]}, and @samp{rtail([a, b, c, d]) = d}.
19965
19966@node Extracting Elements, Manipulating Vectors, Building Vectors, Matrix Functions
19967@section Extracting Vector Elements
19968
19969@noindent
19970@kindex v r
19971@pindex calc-mrow
19972@tindex mrow
19973The @kbd{v r} (@code{calc-mrow}) [@code{mrow}] command extracts one row of
19974the matrix on the top of the stack, or one element of the plain vector on
19975the top of the stack. The row or element is specified by the numeric
19976prefix argument; the default is to prompt for the row or element number.
19977The matrix or vector is replaced by the specified row or element in the
19978form of a vector or scalar, respectively.
19979
19980@cindex Permutations, applying
19981With a prefix argument of @kbd{C-u} only, @kbd{v r} takes the index of
19982the element or row from the top of the stack, and the vector or matrix
19983from the second-to-top position. If the index is itself a vector of
19984integers, the result is a vector of the corresponding elements of the
19985input vector, or a matrix of the corresponding rows of the input matrix.
19986This command can be used to obtain any permutation of a vector.
19987
19988With @kbd{C-u}, if the index is an interval form with integer components,
19989it is interpreted as a range of indices and the corresponding subvector or
19990submatrix is returned.
19991
19992@cindex Subscript notation
19993@kindex a _
19994@pindex calc-subscript
19995@tindex subscr
19996@tindex _
19997Subscript notation in algebraic formulas (@samp{a_b}) stands for the
19998Calc function @code{subscr}, which is synonymous with @code{mrow}.
a4231b04
JB
19999Thus, @samp{[x, y, z]_k} produces @expr{x}, @expr{y}, or @expr{z} if
20000@expr{k} is one, two, or three, respectively. A double subscript
d7b8e6c6 20001(@samp{M_i_j}, equivalent to @samp{subscr(subscr(M, i), j)}) will
a4231b04 20002access the element at row @expr{i}, column @expr{j} of a matrix.
d7b8e6c6
EZ
20003The @kbd{a _} (@code{calc-subscript}) command creates a subscript
20004formula @samp{a_b} out of two stack entries. (It is on the @kbd{a}
20005``algebra'' prefix because subscripted variables are often used
20006purely as an algebraic notation.)
20007
20008@tindex mrrow
20009Given a negative prefix argument, @kbd{v r} instead deletes one row or
20010element from the matrix or vector on the top of the stack. Thus
20011@kbd{C-u 2 v r} replaces a matrix with its second row, but @kbd{C-u -2 v r}
20012replaces the matrix with the same matrix with its second row removed.
20013In algebraic form this function is called @code{mrrow}.
20014
20015@tindex getdiag
20016Given a prefix argument of zero, @kbd{v r} extracts the diagonal elements
20017of a square matrix in the form of a vector. In algebraic form this
20018function is called @code{getdiag}.
20019
20020@kindex v c
20021@pindex calc-mcol
20022@tindex mcol
20023@tindex mrcol
20024The @kbd{v c} (@code{calc-mcol}) [@code{mcol} or @code{mrcol}] command is
20025the analogous operation on columns of a matrix. Given a plain vector
20026it extracts (or removes) one element, just like @kbd{v r}. If the
20027index in @kbd{C-u v c} is an interval or vector and the argument is a
20028matrix, the result is a submatrix with only the specified columns
a4231b04 20029retained (and possibly permuted in the case of a vector index).
d7b8e6c6
EZ
20030
20031To extract a matrix element at a given row and column, use @kbd{v r} to
20032extract the row as a vector, then @kbd{v c} to extract the column element
20033from that vector. In algebraic formulas, it is often more convenient to
a4231b04
JB
20034use subscript notation: @samp{m_i_j} gives row @expr{i}, column @expr{j}
20035of matrix @expr{m}.
d7b8e6c6
EZ
20036
20037@kindex v s
20038@pindex calc-subvector
20039@tindex subvec
20040The @kbd{v s} (@code{calc-subvector}) [@code{subvec}] command extracts
20041a subvector of a vector. The arguments are the vector, the starting
20042index, and the ending index, with the ending index in the top-of-stack
20043position. The starting index indicates the first element of the vector
20044to take. The ending index indicates the first element @emph{past} the
20045range to be taken. Thus, @samp{subvec([a, b, c, d, e], 2, 4)} produces
20046the subvector @samp{[b, c]}. You could get the same result using
20047@samp{mrow([a, b, c, d, e], @w{[2 .. 4)})}.
20048
20049If either the start or the end index is zero or negative, it is
20050interpreted as relative to the end of the vector. Thus
20051@samp{subvec([a, b, c, d, e], 2, -2)} also produces @samp{[b, c]}. In
20052the algebraic form, the end index can be omitted in which case it
20053is taken as zero, i.e., elements from the starting element to the
20054end of the vector are used. The infinity symbol, @code{inf}, also
20055has this effect when used as the ending index.
20056
20057@kindex I v s
20058@tindex rsubvec
20059With the Inverse flag, @kbd{I v s} [@code{rsubvec}] removes a subvector
20060from a vector. The arguments are interpreted the same as for the
20061normal @kbd{v s} command. Thus, @samp{rsubvec([a, b, c, d, e], 2, 4)}
20062produces @samp{[a, d, e]}. It is always true that @code{subvec} and
20063@code{rsubvec} return complementary parts of the input vector.
20064
20065@xref{Selecting Subformulas}, for an alternative way to operate on
20066vectors one element at a time.
20067
20068@node Manipulating Vectors, Vector and Matrix Arithmetic, Extracting Elements, Matrix Functions
20069@section Manipulating Vectors
20070
20071@noindent
20072@kindex v l
20073@pindex calc-vlength
20074@tindex vlen
20075The @kbd{v l} (@code{calc-vlength}) [@code{vlen}] command computes the
20076length of a vector. The length of a non-vector is considered to be zero.
20077Note that matrices are just vectors of vectors for the purposes of this
a4231b04 20078command.
d7b8e6c6
EZ
20079
20080@kindex H v l
20081@tindex mdims
20082With the Hyperbolic flag, @kbd{H v l} [@code{mdims}] computes a vector
20083of the dimensions of a vector, matrix, or higher-order object. For
20084example, @samp{mdims([[a,b,c],[d,e,f]])} returns @samp{[2, 3]} since
a4231b04 20085its argument is a
8e04863e 20086@texline @math{2\times3}
a4231b04
JB
20087@infoline 2x3
20088matrix.
d7b8e6c6
EZ
20089
20090@kindex v f
20091@pindex calc-vector-find
20092@tindex find
20093The @kbd{v f} (@code{calc-vector-find}) [@code{find}] command searches
20094along a vector for the first element equal to a given target. The target
20095is on the top of the stack; the vector is in the second-to-top position.
20096If a match is found, the result is the index of the matching element.
20097Otherwise, the result is zero. The numeric prefix argument, if given,
20098allows you to select any starting index for the search.
20099
20100@kindex v a
20101@pindex calc-arrange-vector
20102@tindex arrange
20103@cindex Arranging a matrix
20104@cindex Reshaping a matrix
20105@cindex Flattening a matrix
20106The @kbd{v a} (@code{calc-arrange-vector}) [@code{arrange}] command
20107rearranges a vector to have a certain number of columns and rows. The
20108numeric prefix argument specifies the number of columns; if you do not
20109provide an argument, you will be prompted for the number of columns.
20110The vector or matrix on the top of the stack is @dfn{flattened} into a
20111plain vector. If the number of columns is nonzero, this vector is
20112then formed into a matrix by taking successive groups of @var{n} elements.
20113If the number of columns does not evenly divide the number of elements
20114in the vector, the last row will be short and the result will not be
20115suitable for use as a matrix. For example, with the matrix
20116@samp{[[1, 2], @w{[3, 4]}]} on the stack, @kbd{v a 4} produces
a4231b04 20117@samp{[[1, 2, 3, 4]]} (a
8e04863e 20118@texline @math{1\times4}
a4231b04
JB
20119@infoline 1x4
20120matrix), @kbd{v a 1} produces @samp{[[1], [2], [3], [4]]} (a
8e04863e 20121@texline @math{4\times1}
a4231b04
JB
20122@infoline 4x1
20123matrix), @kbd{v a 2} produces @samp{[[1, 2], [3, 4]]} (the original
8e04863e 20124@texline @math{2\times2}
a4231b04
JB
20125@infoline 2x2
20126matrix), @w{@kbd{v a 3}} produces @samp{[[1, 2, 3], [4]]} (not a
20127matrix), and @kbd{v a 0} produces the flattened list
20128@samp{[1, 2, @w{3, 4}]}.
d7b8e6c6
EZ
20129
20130@cindex Sorting data
20131@kindex V S
20132@kindex I V S
20133@pindex calc-sort
20134@tindex sort
20135@tindex rsort
20136The @kbd{V S} (@code{calc-sort}) [@code{sort}] command sorts the elements of
20137a vector into increasing order. Real numbers, real infinities, and
20138constant interval forms come first in this ordering; next come other
20139kinds of numbers, then variables (in alphabetical order), then finally
20140come formulas and other kinds of objects; these are sorted according
20141to a kind of lexicographic ordering with the useful property that
20142one vector is less or greater than another if the first corresponding
20143unequal elements are less or greater, respectively. Since quoted strings
20144are stored by Calc internally as vectors of ASCII character codes
20145(@pxref{Strings}), this means vectors of strings are also sorted into
20146alphabetical order by this command.
20147
20148The @kbd{I V S} [@code{rsort}] command sorts a vector into decreasing order.
20149
20150@cindex Permutation, inverse of
20151@cindex Inverse of permutation
20152@cindex Index tables
20153@cindex Rank tables
20154@kindex V G
20155@kindex I V G
20156@pindex calc-grade
20157@tindex grade
20158@tindex rgrade
20159The @kbd{V G} (@code{calc-grade}) [@code{grade}, @code{rgrade}] command
20160produces an index table or permutation vector which, if applied to the
20161input vector (as the index of @kbd{C-u v r}, say), would sort the vector.
20162A permutation vector is just a vector of integers from 1 to @var{n}, where
20163each integer occurs exactly once. One application of this is to sort a
20164matrix of data rows using one column as the sort key; extract that column,
20165grade it with @kbd{V G}, then use the result to reorder the original matrix
20166with @kbd{C-u v r}. Another interesting property of the @code{V G} command
20167is that, if the input is itself a permutation vector, the result will
20168be the inverse of the permutation. The inverse of an index table is
20169a rank table, whose @var{k}th element says where the @var{k}th original
20170vector element will rest when the vector is sorted. To get a rank
20171table, just use @kbd{V G V G}.
20172
20173With the Inverse flag, @kbd{I V G} produces an index table that would
20174sort the input into decreasing order. Note that @kbd{V S} and @kbd{V G}
20175use a ``stable'' sorting algorithm, i.e., any two elements which are equal
20176will not be moved out of their original order. Generally there is no way
20177to tell with @kbd{V S}, since two elements which are equal look the same,
20178but with @kbd{V G} this can be an important issue. In the matrix-of-rows
20179example, suppose you have names and telephone numbers as two columns and
20180you wish to sort by phone number primarily, and by name when the numbers
20181are equal. You can sort the data matrix by names first, and then again
20182by phone numbers. Because the sort is stable, any two rows with equal
20183phone numbers will remain sorted by name even after the second sort.
20184
20185@cindex Histograms
20186@kindex V H
20187@pindex calc-histogram
5d67986c
RS
20188@ignore
20189@mindex histo@idots
20190@end ignore
d7b8e6c6
EZ
20191@tindex histogram
20192The @kbd{V H} (@code{calc-histogram}) [@code{histogram}] command builds a
20193histogram of a vector of numbers. Vector elements are assumed to be
20194integers or real numbers in the range [0..@var{n}) for some ``number of
20195bins'' @var{n}, which is the numeric prefix argument given to the
20196command. The result is a vector of @var{n} counts of how many times
20197each value appeared in the original vector. Non-integers in the input
20198are rounded down to integers. Any vector elements outside the specified
20199range are ignored. (You can tell if elements have been ignored by noting
20200that the counts in the result vector don't add up to the length of the
20201input vector.)
20202
20203@kindex H V H
20204With the Hyperbolic flag, @kbd{H V H} pulls two vectors from the stack.
20205The second-to-top vector is the list of numbers as before. The top
20206vector is an equal-sized list of ``weights'' to attach to the elements
20207of the data vector. For example, if the first data element is 4.2 and
20208the first weight is 10, then 10 will be added to bin 4 of the result
20209vector. Without the hyperbolic flag, every element has a weight of one.
20210
20211@kindex v t
20212@pindex calc-transpose
20213@tindex trn
20214The @kbd{v t} (@code{calc-transpose}) [@code{trn}] command computes
20215the transpose of the matrix at the top of the stack. If the argument
20216is a plain vector, it is treated as a row vector and transposed into
20217a one-column matrix.
20218
20219@kindex v v
20220@pindex calc-reverse-vector
20221@tindex rev
029b2a44 20222The @kbd{v v} (@code{calc-reverse-vector}) [@code{rev}] command reverses
d7b8e6c6
EZ
20223a vector end-for-end. Given a matrix, it reverses the order of the rows.
20224(To reverse the columns instead, just use @kbd{v t v v v t}. The same
20225principle can be used to apply other vector commands to the columns of
20226a matrix.)
20227
20228@kindex v m
20229@pindex calc-mask-vector
20230@tindex vmask
20231The @kbd{v m} (@code{calc-mask-vector}) [@code{vmask}] command uses
20232one vector as a mask to extract elements of another vector. The mask
20233is in the second-to-top position; the target vector is on the top of
20234the stack. These vectors must have the same length. The result is
20235the same as the target vector, but with all elements which correspond
20236to zeros in the mask vector deleted. Thus, for example,
20237@samp{vmask([1, 0, 1, 0, 1], [a, b, c, d, e])} produces @samp{[a, c, e]}.
20238@xref{Logical Operations}.
20239
20240@kindex v e
20241@pindex calc-expand-vector
20242@tindex vexp
20243The @kbd{v e} (@code{calc-expand-vector}) [@code{vexp}] command
20244expands a vector according to another mask vector. The result is a
20245vector the same length as the mask, but with nonzero elements replaced
20246by successive elements from the target vector. The length of the target
20247vector is normally the number of nonzero elements in the mask. If the
20248target vector is longer, its last few elements are lost. If the target
20249vector is shorter, the last few nonzero mask elements are left
20250unreplaced in the result. Thus @samp{vexp([2, 0, 3, 0, 7], [a, b])}
20251produces @samp{[a, 0, b, 0, 7]}.
20252
20253@kindex H v e
20254With the Hyperbolic flag, @kbd{H v e} takes a filler value from the
20255top of the stack; the mask and target vectors come from the third and
20256second elements of the stack. This filler is used where the mask is
20257zero: @samp{vexp([2, 0, 3, 0, 7], [a, b], z)} produces
20258@samp{[a, z, c, z, 7]}. If the filler value is itself a vector,
20259then successive values are taken from it, so that the effect is to
20260interleave two vectors according to the mask:
20261@samp{vexp([2, 0, 3, 7, 0, 0], [a, b], [x, y])} produces
20262@samp{[a, x, b, 7, y, 0]}.
20263
20264Another variation on the masking idea is to combine @samp{[a, b, c, d, e]}
20265with the mask @samp{[1, 0, 1, 0, 1]} to produce @samp{[a, 0, c, 0, e]}.
20266You can accomplish this with @kbd{V M a &}, mapping the logical ``and''
20267operation across the two vectors. @xref{Logical Operations}. Note that
20268the @code{? :} operation also discussed there allows other types of
20269masking using vectors.
20270
20271@node Vector and Matrix Arithmetic, Set Operations, Manipulating Vectors, Matrix Functions
20272@section Vector and Matrix Arithmetic
20273
20274@noindent
20275Basic arithmetic operations like addition and multiplication are defined
20276for vectors and matrices as well as for numbers. Division of matrices, in
20277the sense of multiplying by the inverse, is supported. (Division by a
20278matrix actually uses LU-decomposition for greater accuracy and speed.)
20279@xref{Basic Arithmetic}.
20280
20281The following functions are applied element-wise if their arguments are
20282vectors or matrices: @code{change-sign}, @code{conj}, @code{arg},
20283@code{re}, @code{im}, @code{polar}, @code{rect}, @code{clean},
a4231b04 20284@code{float}, @code{frac}. @xref{Function Index}.
d7b8e6c6
EZ
20285
20286@kindex V J
20287@pindex calc-conj-transpose
20288@tindex ctrn
20289The @kbd{V J} (@code{calc-conj-transpose}) [@code{ctrn}] command computes
20290the conjugate transpose of its argument, i.e., @samp{conj(trn(x))}.
20291
5d67986c
RS
20292@ignore
20293@mindex A
20294@end ignore
d7b8e6c6
EZ
20295@kindex A (vectors)
20296@pindex calc-abs (vectors)
5d67986c
RS
20297@ignore
20298@mindex abs
20299@end ignore
d7b8e6c6
EZ
20300@tindex abs (vectors)
20301The @kbd{A} (@code{calc-abs}) [@code{abs}] command computes the
20302Frobenius norm of a vector or matrix argument. This is the square
20303root of the sum of the squares of the absolute values of the
20304elements of the vector or matrix. If the vector is interpreted as
20305a point in two- or three-dimensional space, this is the distance
a4231b04 20306from that point to the origin.
d7b8e6c6
EZ
20307
20308@kindex v n
20309@pindex calc-rnorm
20310@tindex rnorm
20311The @kbd{v n} (@code{calc-rnorm}) [@code{rnorm}] command computes
20312the row norm, or infinity-norm, of a vector or matrix. For a plain
20313vector, this is the maximum of the absolute values of the elements.
20314For a matrix, this is the maximum of the row-absolute-value-sums,
20315i.e., of the sums of the absolute values of the elements along the
20316various rows.
20317
20318@kindex V N
20319@pindex calc-cnorm
20320@tindex cnorm
20321The @kbd{V N} (@code{calc-cnorm}) [@code{cnorm}] command computes
20322the column norm, or one-norm, of a vector or matrix. For a plain
20323vector, this is the sum of the absolute values of the elements.
20324For a matrix, this is the maximum of the column-absolute-value-sums.
a4231b04 20325General @expr{k}-norms for @expr{k} other than one or infinity are
d7b8e6c6
EZ
20326not provided.
20327
20328@kindex V C
20329@pindex calc-cross
20330@tindex cross
20331The @kbd{V C} (@code{calc-cross}) [@code{cross}] command computes the
20332right-handed cross product of two vectors, each of which must have
20333exactly three elements.
20334
5d67986c
RS
20335@ignore
20336@mindex &
20337@end ignore
d7b8e6c6
EZ
20338@kindex & (matrices)
20339@pindex calc-inv (matrices)
5d67986c
RS
20340@ignore
20341@mindex inv
20342@end ignore
d7b8e6c6
EZ
20343@tindex inv (matrices)
20344The @kbd{&} (@code{calc-inv}) [@code{inv}] command computes the
20345inverse of a square matrix. If the matrix is singular, the inverse
20346operation is left in symbolic form. Matrix inverses are recorded so
20347that once an inverse (or determinant) of a particular matrix has been
20348computed, the inverse and determinant of the matrix can be recomputed
20349quickly in the future.
20350
a4231b04
JB
20351If the argument to @kbd{&} is a plain number @expr{x}, this
20352command simply computes @expr{1/x}. This is okay, because the
d7b8e6c6
EZ
20353@samp{/} operator also does a matrix inversion when dividing one
20354by a matrix.
20355
20356@kindex V D
20357@pindex calc-mdet
20358@tindex det
20359The @kbd{V D} (@code{calc-mdet}) [@code{det}] command computes the
20360determinant of a square matrix.
20361
20362@kindex V L
20363@pindex calc-mlud
20364@tindex lud
20365The @kbd{V L} (@code{calc-mlud}) [@code{lud}] command computes the
20366LU decomposition of a matrix. The result is a list of three matrices
20367which, when multiplied together left-to-right, form the original matrix.
20368The first is a permutation matrix that arises from pivoting in the
20369algorithm, the second is lower-triangular with ones on the diagonal,
20370and the third is upper-triangular.
20371
20372@kindex V T
20373@pindex calc-mtrace
20374@tindex tr
20375The @kbd{V T} (@code{calc-mtrace}) [@code{tr}] command computes the
20376trace of a square matrix. This is defined as the sum of the diagonal
20377elements of the matrix.
20378
20379@node Set Operations, Statistical Operations, Vector and Matrix Arithmetic, Matrix Functions
20380@section Set Operations using Vectors
20381
20382@noindent
20383@cindex Sets, as vectors
20384Calc includes several commands which interpret vectors as @dfn{sets} of
20385objects. A set is a collection of objects; any given object can appear
20386only once in the set. Calc stores sets as vectors of objects in
20387sorted order. Objects in a Calc set can be any of the usual things,
20388such as numbers, variables, or formulas. Two set elements are considered
20389equal if they are identical, except that numerically equal numbers like
20390the integer 4 and the float 4.0 are considered equal even though they
20391are not ``identical.'' Variables are treated like plain symbols without
20392attached values by the set operations; subtracting the set @samp{[b]}
20393from @samp{[a, b]} always yields the set @samp{[a]} even though if
28665d46 20394the variables @samp{a} and @samp{b} both equaled 17, you might
d7b8e6c6
EZ
20395expect the answer @samp{[]}.
20396
20397If a set contains interval forms, then it is assumed to be a set of
20398real numbers. In this case, all set operations require the elements
20399of the set to be only things that are allowed in intervals: Real
20400numbers, plus and minus infinity, HMS forms, and date forms. If
20401there are variables or other non-real objects present in a real set,
20402all set operations on it will be left in unevaluated form.
20403
20404If the input to a set operation is a plain number or interval form
20405@var{a}, it is treated like the one-element vector @samp{[@var{a}]}.
20406The result is always a vector, except that if the set consists of a
20407single interval, the interval itself is returned instead.
20408
20409@xref{Logical Operations}, for the @code{in} function which tests if
a4231b04
JB
20410a certain value is a member of a given set. To test if the set @expr{A}
20411is a subset of the set @expr{B}, use @samp{vdiff(A, B) = []}.
d7b8e6c6
EZ
20412
20413@kindex V +
20414@pindex calc-remove-duplicates
20415@tindex rdup
20416The @kbd{V +} (@code{calc-remove-duplicates}) [@code{rdup}] command
20417converts an arbitrary vector into set notation. It works by sorting
20418the vector as if by @kbd{V S}, then removing duplicates. (For example,
20419@kbd{[a, 5, 4, a, 4.0]} is sorted to @samp{[4, 4.0, 5, a, a]} and then
20420reduced to @samp{[4, 5, a]}). Overlapping intervals are merged as
20421necessary. You rarely need to use @kbd{V +} explicitly, since all the
20422other set-based commands apply @kbd{V +} to their inputs before using
20423them.
20424
20425@kindex V V
20426@pindex calc-set-union
20427@tindex vunion
20428The @kbd{V V} (@code{calc-set-union}) [@code{vunion}] command computes
20429the union of two sets. An object is in the union of two sets if and
20430only if it is in either (or both) of the input sets. (You could
20431accomplish the same thing by concatenating the sets with @kbd{|},
20432then using @kbd{V +}.)
20433
20434@kindex V ^
20435@pindex calc-set-intersect
20436@tindex vint
20437The @kbd{V ^} (@code{calc-set-intersect}) [@code{vint}] command computes
20438the intersection of two sets. An object is in the intersection if
20439and only if it is in both of the input sets. Thus if the input
20440sets are disjoint, i.e., if they share no common elements, the result
20441will be the empty vector @samp{[]}. Note that the characters @kbd{V}
20442and @kbd{^} were chosen to be close to the conventional mathematical
a4231b04 20443notation for set
8e04863e 20444@texline union@tie{}(@math{A \cup B})
a4231b04
JB
20445@infoline union
20446and
8e04863e 20447@texline intersection@tie{}(@math{A \cap B}).
a4231b04 20448@infoline intersection.
d7b8e6c6
EZ
20449
20450@kindex V -
20451@pindex calc-set-difference
20452@tindex vdiff
20453The @kbd{V -} (@code{calc-set-difference}) [@code{vdiff}] command computes
20454the difference between two sets. An object is in the difference
a4231b04 20455@expr{A - B} if and only if it is in @expr{A} but not in @expr{B}.
d7b8e6c6
EZ
20456Thus subtracting @samp{[y,z]} from a set will remove the elements
20457@samp{y} and @samp{z} if they are present. You can also think of this
a4231b04
JB
20458as a general @dfn{set complement} operator; if @expr{A} is the set of
20459all possible values, then @expr{A - B} is the ``complement'' of @expr{B}.
d7b8e6c6
EZ
20460Obviously this is only practical if the set of all possible values in
20461your problem is small enough to list in a Calc vector (or simple
20462enough to express in a few intervals).
20463
20464@kindex V X
20465@pindex calc-set-xor
20466@tindex vxor
20467The @kbd{V X} (@code{calc-set-xor}) [@code{vxor}] command computes
20468the ``exclusive-or,'' or ``symmetric difference'' of two sets.
20469An object is in the symmetric difference of two sets if and only
20470if it is in one, but @emph{not} both, of the sets. Objects that
20471occur in both sets ``cancel out.''
20472
20473@kindex V ~
20474@pindex calc-set-complement
20475@tindex vcompl
20476The @kbd{V ~} (@code{calc-set-complement}) [@code{vcompl}] command
20477computes the complement of a set with respect to the real numbers.
20478Thus @samp{vcompl(x)} is equivalent to @samp{vdiff([-inf .. inf], x)}.
20479For example, @samp{vcompl([2, (3 .. 4]])} evaluates to
20480@samp{[[-inf .. 2), (2 .. 3], (4 .. inf]]}.
20481
20482@kindex V F
20483@pindex calc-set-floor
20484@tindex vfloor
20485The @kbd{V F} (@code{calc-set-floor}) [@code{vfloor}] command
20486reinterprets a set as a set of integers. Any non-integer values,
20487and intervals that do not enclose any integers, are removed. Open
20488intervals are converted to equivalent closed intervals. Successive
20489integers are converted into intervals of integers. For example, the
20490complement of the set @samp{[2, 6, 7, 8]} is messy, but if you wanted
20491the complement with respect to the set of integers you could type
20492@kbd{V ~ V F} to get @samp{[[-inf .. 1], [3 .. 5], [9 .. inf]]}.
20493
20494@kindex V E
20495@pindex calc-set-enumerate
20496@tindex venum
20497The @kbd{V E} (@code{calc-set-enumerate}) [@code{venum}] command
20498converts a set of integers into an explicit vector. Intervals in
20499the set are expanded out to lists of all integers encompassed by
20500the intervals. This only works for finite sets (i.e., sets which
20501do not involve @samp{-inf} or @samp{inf}).
20502
20503@kindex V :
20504@pindex calc-set-span
20505@tindex vspan
20506The @kbd{V :} (@code{calc-set-span}) [@code{vspan}] command converts any
20507set of reals into an interval form that encompasses all its elements.
20508The lower limit will be the smallest element in the set; the upper
20509limit will be the largest element. For an empty set, @samp{vspan([])}
20510returns the empty interval @w{@samp{[0 .. 0)}}.
20511
20512@kindex V #
20513@pindex calc-set-cardinality
20514@tindex vcard
20515The @kbd{V #} (@code{calc-set-cardinality}) [@code{vcard}] command counts
20516the number of integers in a set. The result is the length of the vector
20517that would be produced by @kbd{V E}, although the computation is much
20518more efficient than actually producing that vector.
20519
20520@cindex Sets, as binary numbers
20521Another representation for sets that may be more appropriate in some
20522cases is binary numbers. If you are dealing with sets of integers
20523in the range 0 to 49, you can use a 50-bit binary number where a
20524particular bit is 1 if the corresponding element is in the set.
20525@xref{Binary Functions}, for a list of commands that operate on
20526binary numbers. Note that many of the above set operations have
20527direct equivalents in binary arithmetic: @kbd{b o} (@code{calc-or}),
20528@kbd{b a} (@code{calc-and}), @kbd{b d} (@code{calc-diff}),
20529@kbd{b x} (@code{calc-xor}), and @kbd{b n} (@code{calc-not}),
20530respectively. You can use whatever representation for sets is most
20531convenient to you.
20532
20533@kindex b p
20534@kindex b u
20535@pindex calc-pack-bits
20536@pindex calc-unpack-bits
20537@tindex vpack
20538@tindex vunpack
20539The @kbd{b u} (@code{calc-unpack-bits}) [@code{vunpack}] command
20540converts an integer that represents a set in binary into a set
20541in vector/interval notation. For example, @samp{vunpack(67)}
20542returns @samp{[[0 .. 1], 6]}. If the input is negative, the set
20543it represents is semi-infinite: @samp{vunpack(-4) = [2 .. inf)}.
20544Use @kbd{V E} afterwards to expand intervals to individual
20545values if you wish. Note that this command uses the @kbd{b}
20546(binary) prefix key.
20547
20548The @kbd{b p} (@code{calc-pack-bits}) [@code{vpack}] command
20549converts the other way, from a vector or interval representing
20550a set of nonnegative integers into a binary integer describing
20551the same set. The set may include positive infinity, but must
20552not include any negative numbers. The input is interpreted as a
20553set of integers in the sense of @kbd{V F} (@code{vfloor}). Beware
20554that a simple input like @samp{[100]} can result in a huge integer
a4231b04 20555representation
8e04863e 20556@texline (@math{2^{100}}, a 31-digit integer, in this case).
a4231b04 20557@infoline (@expr{2^100}, a 31-digit integer, in this case).
d7b8e6c6
EZ
20558
20559@node Statistical Operations, Reducing and Mapping, Set Operations, Matrix Functions
20560@section Statistical Operations on Vectors
20561
20562@noindent
20563@cindex Statistical functions
20564The commands in this section take vectors as arguments and compute
20565various statistical measures on the data stored in the vectors. The
20566references used in the definitions of these functions are Bevington's
20567@emph{Data Reduction and Error Analysis for the Physical Sciences},
20568and @emph{Numerical Recipes} by Press, Flannery, Teukolsky and
20569Vetterling.
20570
20571The statistical commands use the @kbd{u} prefix key followed by
20572a shifted letter or other character.
20573
20574@xref{Manipulating Vectors}, for a description of @kbd{V H}
20575(@code{calc-histogram}).
20576
20577@xref{Curve Fitting}, for the @kbd{a F} command for doing
20578least-squares fits to statistical data.
20579
20580@xref{Probability Distribution Functions}, for several common
20581probability distribution functions.
20582
20583@menu
20584* Single-Variable Statistics::
20585* Paired-Sample Statistics::
20586@end menu
20587
20588@node Single-Variable Statistics, Paired-Sample Statistics, Statistical Operations, Statistical Operations
20589@subsection Single-Variable Statistics
20590
20591@noindent
20592These functions do various statistical computations on single
20593vectors. Given a numeric prefix argument, they actually pop
20594@var{n} objects from the stack and combine them into a data
20595vector. Each object may be either a number or a vector; if a
20596vector, any sub-vectors inside it are ``flattened'' as if by
20597@kbd{v a 0}; @pxref{Manipulating Vectors}. By default one object
20598is popped, which (in order to be useful) is usually a vector.
20599
20600If an argument is a variable name, and the value stored in that
20601variable is a vector, then the stored vector is used. This method
20602has the advantage that if your data vector is large, you can avoid
20603the slow process of manipulating it directly on the stack.
20604
20605These functions are left in symbolic form if any of their arguments
20606are not numbers or vectors, e.g., if an argument is a formula, or
20607a non-vector variable. However, formulas embedded within vector
20608arguments are accepted; the result is a symbolic representation
20609of the computation, based on the assumption that the formula does
20610not itself represent a vector. All varieties of numbers such as
20611error forms and interval forms are acceptable.
20612
20613Some of the functions in this section also accept a single error form
20614or interval as an argument. They then describe a property of the
20615normal or uniform (respectively) statistical distribution described
20616by the argument. The arguments are interpreted in the same way as
20617the @var{M} argument of the random number function @kbd{k r}. In
20618particular, an interval with integer limits is considered an integer
20619distribution, so that @samp{[2 .. 6)} is the same as @samp{[2 .. 5]}.
20620An interval with at least one floating-point limit is a continuous
20621distribution: @samp{[2.0 .. 6.0)} is @emph{not} the same as
20622@samp{[2.0 .. 5.0]}!
20623
20624@kindex u #
20625@pindex calc-vector-count
20626@tindex vcount
20627The @kbd{u #} (@code{calc-vector-count}) [@code{vcount}] command
20628computes the number of data values represented by the inputs.
20629For example, @samp{vcount(1, [2, 3], [[4, 5], [], x, y])} returns 7.
20630If the argument is a single vector with no sub-vectors, this
20631simply computes the length of the vector.
20632
20633@kindex u +
20634@kindex u *
20635@pindex calc-vector-sum
20636@pindex calc-vector-prod
20637@tindex vsum
20638@tindex vprod
20639@cindex Summations (statistical)
20640The @kbd{u +} (@code{calc-vector-sum}) [@code{vsum}] command
20641computes the sum of the data values. The @kbd{u *}
20642(@code{calc-vector-prod}) [@code{vprod}] command computes the
20643product of the data values. If the input is a single flat vector,
20644these are the same as @kbd{V R +} and @kbd{V R *}
a4231b04 20645(@pxref{Reducing and Mapping}).
d7b8e6c6
EZ
20646
20647@kindex u X
20648@kindex u N
20649@pindex calc-vector-max
20650@pindex calc-vector-min
20651@tindex vmax
20652@tindex vmin
20653The @kbd{u X} (@code{calc-vector-max}) [@code{vmax}] command
20654computes the maximum of the data values, and the @kbd{u N}
20655(@code{calc-vector-min}) [@code{vmin}] command computes the minimum.
20656If the argument is an interval, this finds the minimum or maximum
20657value in the interval. (Note that @samp{vmax([2..6)) = 5} as
20658described above.) If the argument is an error form, this returns
20659plus or minus infinity.
20660
20661@kindex u M
20662@pindex calc-vector-mean
20663@tindex vmean
20664@cindex Mean of data values
20665The @kbd{u M} (@code{calc-vector-mean}) [@code{vmean}] command
20666computes the average (arithmetic mean) of the data values.
a4231b04 20667If the inputs are error forms
8e04863e 20668@texline @math{x \pm \sigma},
a4231b04
JB
20669@infoline @samp{x +/- s},
20670this is the weighted mean of the @expr{x} values with weights
8e04863e 20671@texline @math{1 /\sigma^2}.
a4231b04 20672@infoline @expr{1 / s^2}.
d7b8e6c6
EZ
20673@tex
20674\turnoffactive
20675$$ \mu = { \displaystyle \sum { x_i \over \sigma_i^2 } \over
20676 \displaystyle \sum { 1 \over \sigma_i^2 } } $$
20677@end tex
20678If the inputs are not error forms, this is simply the sum of the
a4231b04 20679values divided by the count of the values.
d7b8e6c6
EZ
20680
20681Note that a plain number can be considered an error form with
a4231b04 20682error
8e04863e 20683@texline @math{\sigma = 0}.
a4231b04
JB
20684@infoline @expr{s = 0}.
20685If the input to @kbd{u M} is a mixture of
d7b8e6c6
EZ
20686plain numbers and error forms, the result is the mean of the
20687plain numbers, ignoring all values with non-zero errors. (By the
20688above definitions it's clear that a plain number effectively
20689has an infinite weight, next to which an error form with a finite
20690weight is completely negligible.)
20691
20692This function also works for distributions (error forms or
bd712b70 20693intervals). The mean of an error form `@var{a} @tfn{+/-} @var{b}' is simply
a4231b04 20694@expr{a}. The mean of an interval is the mean of the minimum
d7b8e6c6
EZ
20695and maximum values of the interval.
20696
20697@kindex I u M
20698@pindex calc-vector-mean-error
20699@tindex vmeane
20700The @kbd{I u M} (@code{calc-vector-mean-error}) [@code{vmeane}]
20701command computes the mean of the data points expressed as an
20702error form. This includes the estimated error associated with
20703the mean. If the inputs are error forms, the error is the square
20704root of the reciprocal of the sum of the reciprocals of the squares
20705of the input errors. (I.e., the variance is the reciprocal of the
20706sum of the reciprocals of the variances.)
20707@tex
20708\turnoffactive
20709$$ \sigma_\mu^2 = {1 \over \displaystyle \sum {1 \over \sigma_i^2}} $$
20710@end tex
20711If the inputs are plain
20712numbers, the error is equal to the standard deviation of the values
20713divided by the square root of the number of values. (This works
20714out to be equivalent to calculating the standard deviation and
20715then assuming each value's error is equal to this standard
a4231b04 20716deviation.)
d7b8e6c6
EZ
20717@tex
20718\turnoffactive
20719$$ \sigma_\mu^2 = {\sigma^2 \over N} $$
20720@end tex
20721
20722@kindex H u M
20723@pindex calc-vector-median
20724@tindex vmedian
20725@cindex Median of data values
20726The @kbd{H u M} (@code{calc-vector-median}) [@code{vmedian}]
20727command computes the median of the data values. The values are
20728first sorted into numerical order; the median is the middle
20729value after sorting. (If the number of data values is even,
20730the median is taken to be the average of the two middle values.)
20731The median function is different from the other functions in
20732this section in that the arguments must all be real numbers;
20733variables are not accepted even when nested inside vectors.
20734(Otherwise it is not possible to sort the data values.) If
20735any of the input values are error forms, their error parts are
20736ignored.
20737
20738The median function also accepts distributions. For both normal
20739(error form) and uniform (interval) distributions, the median is
20740the same as the mean.
20741
20742@kindex H I u M
20743@pindex calc-vector-harmonic-mean
20744@tindex vhmean
20745@cindex Harmonic mean
20746The @kbd{H I u M} (@code{calc-vector-harmonic-mean}) [@code{vhmean}]
20747command computes the harmonic mean of the data values. This is
20748defined as the reciprocal of the arithmetic mean of the reciprocals
20749of the values.
20750@tex
20751\turnoffactive
20752$$ { N \over \displaystyle \sum {1 \over x_i} } $$
20753@end tex
20754
20755@kindex u G
20756@pindex calc-vector-geometric-mean
20757@tindex vgmean
20758@cindex Geometric mean
20759The @kbd{u G} (@code{calc-vector-geometric-mean}) [@code{vgmean}]
20760command computes the geometric mean of the data values. This
5d67986c 20761is the @var{n}th root of the product of the values. This is also
d7b8e6c6
EZ
20762equal to the @code{exp} of the arithmetic mean of the logarithms
20763of the data values.
20764@tex
20765\turnoffactive
20766$$ \exp \left ( \sum { \ln x_i } \right ) =
20767 \left ( \prod { x_i } \right)^{1 / N} $$
20768@end tex
20769
20770@kindex H u G
20771@tindex agmean
20772The @kbd{H u G} [@code{agmean}] command computes the ``arithmetic-geometric
20773mean'' of two numbers taken from the stack. This is computed by
20774replacing the two numbers with their arithmetic mean and geometric
20775mean, then repeating until the two values converge.
20776@tex
20777\turnoffactive
20778$$ a_{i+1} = { a_i + b_i \over 2 } , \qquad b_{i+1} = \sqrt{a_i b_i} $$
20779@end tex
20780
20781@cindex Root-mean-square
20782Another commonly used mean, the RMS (root-mean-square), can be computed
20783for a vector of numbers simply by using the @kbd{A} command.
20784
20785@kindex u S
20786@pindex calc-vector-sdev
20787@tindex vsdev
20788@cindex Standard deviation
20789@cindex Sample statistics
20790The @kbd{u S} (@code{calc-vector-sdev}) [@code{vsdev}] command
a4231b04 20791computes the standard
8e04863e 20792@texline deviation@tie{}@math{\sigma}
a4231b04
JB
20793@infoline deviation
20794of the data values. If the values are error forms, the errors are used
20795as weights just as for @kbd{u M}. This is the @emph{sample} standard
20796deviation, whose value is the square root of the sum of the squares of
20797the differences between the values and the mean of the @expr{N} values,
20798divided by @expr{N-1}.
d7b8e6c6
EZ
20799@tex
20800\turnoffactive
20801$$ \sigma^2 = {1 \over N - 1} \sum (x_i - \mu)^2 $$
20802@end tex
20803
20804This function also applies to distributions. The standard deviation
20805of a single error form is simply the error part. The standard deviation
20806of a continuous interval happens to equal the difference between the
a4231b04 20807limits, divided by
8e04863e 20808@texline @math{\sqrt{12}}.
a4231b04
JB
20809@infoline @expr{sqrt(12)}.
20810The standard deviation of an integer interval is the same as the
20811standard deviation of a vector of those integers.
d7b8e6c6
EZ
20812
20813@kindex I u S
20814@pindex calc-vector-pop-sdev
20815@tindex vpsdev
20816@cindex Population statistics
20817The @kbd{I u S} (@code{calc-vector-pop-sdev}) [@code{vpsdev}]
20818command computes the @emph{population} standard deviation.
20819It is defined by the same formula as above but dividing
a4231b04 20820by @expr{N} instead of by @expr{N-1}. The population standard
d7b8e6c6
EZ
20821deviation is used when the input represents the entire set of
20822data values in the distribution; the sample standard deviation
20823is used when the input represents a sample of the set of all
20824data values, so that the mean computed from the input is itself
20825only an estimate of the true mean.
20826@tex
20827\turnoffactive
20828$$ \sigma^2 = {1 \over N} \sum (x_i - \mu)^2 $$
20829@end tex
20830
20831For error forms and continuous intervals, @code{vpsdev} works
20832exactly like @code{vsdev}. For integer intervals, it computes the
20833population standard deviation of the equivalent vector of integers.
20834
20835@kindex H u S
20836@kindex H I u S
20837@pindex calc-vector-variance
20838@pindex calc-vector-pop-variance
20839@tindex vvar
20840@tindex vpvar
20841@cindex Variance of data values
20842The @kbd{H u S} (@code{calc-vector-variance}) [@code{vvar}] and
20843@kbd{H I u S} (@code{calc-vector-pop-variance}) [@code{vpvar}]
20844commands compute the variance of the data values. The variance
a4231b04 20845is the
8e04863e 20846@texline square@tie{}@math{\sigma^2}
a4231b04
JB
20847@infoline square
20848of the standard deviation, i.e., the sum of the
d7b8e6c6
EZ
20849squares of the deviations of the data values from the mean.
20850(This definition also applies when the argument is a distribution.)
20851
5d67986c
RS
20852@ignore
20853@starindex
20854@end ignore
d7b8e6c6
EZ
20855@tindex vflat
20856The @code{vflat} algebraic function returns a vector of its
20857arguments, interpreted in the same way as the other functions
20858in this section. For example, @samp{vflat(1, [2, [3, 4]], 5)}
20859returns @samp{[1, 2, 3, 4, 5]}.
20860
20861@node Paired-Sample Statistics, , Single-Variable Statistics, Statistical Operations
20862@subsection Paired-Sample Statistics
20863
20864@noindent
20865The functions in this section take two arguments, which must be
20866vectors of equal size. The vectors are each flattened in the same
20867way as by the single-variable statistical functions. Given a numeric
20868prefix argument of 1, these functions instead take one object from
a4231b04 20869the stack, which must be an
8e04863e 20870@texline @math{N\times2}
a4231b04
JB
20871@infoline Nx2
20872matrix of data values. Once again, variable names can be used in place
20873of actual vectors and matrices.
d7b8e6c6
EZ
20874
20875@kindex u C
20876@pindex calc-vector-covariance
20877@tindex vcov
20878@cindex Covariance
20879The @kbd{u C} (@code{calc-vector-covariance}) [@code{vcov}] command
20880computes the sample covariance of two vectors. The covariance
20881of vectors @var{x} and @var{y} is the sum of the products of the
20882differences between the elements of @var{x} and the mean of @var{x}
20883times the differences between the corresponding elements of @var{y}
a4231b04 20884and the mean of @var{y}, all divided by @expr{N-1}. Note that
d7b8e6c6
EZ
20885the variance of a vector is just the covariance of the vector
20886with itself. Once again, if the inputs are error forms the
20887errors are used as weight factors. If both @var{x} and @var{y}
20888are composed of error forms, the error for a given data point
20889is taken as the square root of the sum of the squares of the two
20890input errors.
20891@tex
20892\turnoffactive
20893$$ \sigma_{x\!y}^2 = {1 \over N-1} \sum (x_i - \mu_x) (y_i - \mu_y) $$
20894$$ \sigma_{x\!y}^2 =
20895 {\displaystyle {1 \over N-1}
20896 \sum {(x_i - \mu_x) (y_i - \mu_y) \over \sigma_i^2}
20897 \over \displaystyle {1 \over N} \sum {1 \over \sigma_i^2}}
20898$$
20899@end tex
20900
20901@kindex I u C
20902@pindex calc-vector-pop-covariance
20903@tindex vpcov
20904The @kbd{I u C} (@code{calc-vector-pop-covariance}) [@code{vpcov}]
20905command computes the population covariance, which is the same as the
a4231b04
JB
20906sample covariance computed by @kbd{u C} except dividing by @expr{N}
20907instead of @expr{N-1}.
d7b8e6c6
EZ
20908
20909@kindex H u C
20910@pindex calc-vector-correlation
20911@tindex vcorr
20912@cindex Correlation coefficient
20913@cindex Linear correlation
20914The @kbd{H u C} (@code{calc-vector-correlation}) [@code{vcorr}]
20915command computes the linear correlation coefficient of two vectors.
20916This is defined by the covariance of the vectors divided by the
20917product of their standard deviations. (There is no difference
20918between sample or population statistics here.)
20919@tex
20920\turnoffactive
20921$$ r_{x\!y} = { \sigma_{x\!y}^2 \over \sigma_x^2 \sigma_y^2 } $$
20922@end tex
20923
20924@node Reducing and Mapping, Vector and Matrix Formats, Statistical Operations, Matrix Functions
20925@section Reducing and Mapping Vectors
20926
20927@noindent
20928The commands in this section allow for more general operations on the
20929elements of vectors.
20930
20931@kindex V A
20932@pindex calc-apply
20933@tindex apply
20934The simplest of these operations is @kbd{V A} (@code{calc-apply})
20935[@code{apply}], which applies a given operator to the elements of a vector.
20936For example, applying the hypothetical function @code{f} to the vector
20937@w{@samp{[1, 2, 3]}} would produce the function call @samp{f(1, 2, 3)}.
20938Applying the @code{+} function to the vector @samp{[a, b]} gives
20939@samp{a + b}. Applying @code{+} to the vector @samp{[a, b, c]} is an
20940error, since the @code{+} function expects exactly two arguments.
20941
20942While @kbd{V A} is useful in some cases, you will usually find that either
20943@kbd{V R} or @kbd{V M}, described below, is closer to what you want.
20944
20945@menu
20946* Specifying Operators::
20947* Mapping::
20948* Reducing::
20949* Nesting and Fixed Points::
20950* Generalized Products::
20951@end menu
20952
20953@node Specifying Operators, Mapping, Reducing and Mapping, Reducing and Mapping
20954@subsection Specifying Operators
20955
20956@noindent
20957Commands in this section (like @kbd{V A}) prompt you to press the key
20958corresponding to the desired operator. Press @kbd{?} for a partial
20959list of the available operators. Generally, an operator is any key or
20960sequence of keys that would normally take one or more arguments from
20961the stack and replace them with a result. For example, @kbd{V A H C}
20962uses the hyperbolic cosine operator, @code{cosh}. (Since @code{cosh}
20963expects one argument, @kbd{V A H C} requires a vector with a single
20964element as its argument.)
20965
20966You can press @kbd{x} at the operator prompt to select any algebraic
20967function by name to use as the operator. This includes functions you
20968have defined yourself using the @kbd{Z F} command. (@xref{Algebraic
20969Definitions}.) If you give a name for which no function has been
20970defined, the result is left in symbolic form, as in @samp{f(1, 2, 3)}.
20971Calc will prompt for the number of arguments the function takes if it
20972can't figure it out on its own (say, because you named a function that
20973is currently undefined). It is also possible to type a digit key before
20974the function name to specify the number of arguments, e.g.,
5d67986c 20975@kbd{V M 3 x f @key{RET}} calls @code{f} with three arguments even if it
d7b8e6c6
EZ
20976looks like it ought to have only two. This technique may be necessary
20977if the function allows a variable number of arguments. For example,
20978the @kbd{v e} [@code{vexp}] function accepts two or three arguments;
20979if you want to map with the three-argument version, you will have to
20980type @kbd{V M 3 v e}.
20981
20982It is also possible to apply any formula to a vector by treating that
20983formula as a function. When prompted for the operator to use, press
20984@kbd{'} (the apostrophe) and type your formula as an algebraic entry.
20985You will then be prompted for the argument list, which defaults to a
20986list of all variables that appear in the formula, sorted into alphabetic
20987order. For example, suppose you enter the formula @w{@samp{x + 2y^x}}.
20988The default argument list would be @samp{(x y)}, which means that if
20989this function is applied to the arguments @samp{[3, 10]} the result will
20990be @samp{3 + 2*10^3}. (If you plan to use a certain formula in this
20991way often, you might consider defining it as a function with @kbd{Z F}.)
20992
20993Another way to specify the arguments to the formula you enter is with
20994@kbd{$}, @kbd{$$}, and so on. For example, @kbd{V A ' $$ + 2$^$$}
20995has the same effect as the previous example. The argument list is
20996automatically taken to be @samp{($$ $)}. (The order of the arguments
20997may seem backwards, but it is analogous to the way normal algebraic
20998entry interacts with the stack.)
20999
21000If you press @kbd{$} at the operator prompt, the effect is similar to
21001the apostrophe except that the relevant formula is taken from top-of-stack
21002instead. The actual vector arguments of the @kbd{V A $} or related command
21003then start at the second-to-top stack position. You will still be
21004prompted for an argument list.
21005
21006@cindex Nameless functions
21007@cindex Generic functions
21008A function can be written without a name using the notation @samp{<#1 - #2>},
21009which means ``a function of two arguments that computes the first
21010argument minus the second argument.'' The symbols @samp{#1} and @samp{#2}
21011are placeholders for the arguments. You can use any names for these
21012placeholders if you wish, by including an argument list followed by a
5d67986c 21013colon: @samp{<x, y : x - y>}. When you type @kbd{V A ' $$ + 2$^$$ @key{RET}},
d7b8e6c6 21014Calc builds the nameless function @samp{<#1 + 2 #2^#1>} as the function
5d67986c 21015to map across the vectors. When you type @kbd{V A ' x + 2y^x @key{RET} @key{RET}},
d7b8e6c6
EZ
21016Calc builds the nameless function @w{@samp{<x, y : x + 2 y^x>}}. In both
21017cases, Calc also writes the nameless function to the Trail so that you
21018can get it back later if you wish.
21019
21020If there is only one argument, you can write @samp{#} in place of @samp{#1}.
21021(Note that @samp{< >} notation is also used for date forms. Calc tells
21022that @samp{<@var{stuff}>} is a nameless function by the presence of
21023@samp{#} signs inside @var{stuff}, or by the fact that @var{stuff}
21024begins with a list of variables followed by a colon.)
21025
21026You can type a nameless function directly to @kbd{V A '}, or put one on
21027the stack and use it with @w{@kbd{V A $}}. Calc will not prompt for an
21028argument list in this case, since the nameless function specifies the
21029argument list as well as the function itself. In @kbd{V A '}, you can
21030omit the @samp{< >} marks if you use @samp{#} notation for the arguments,
5d67986c
RS
21031so that @kbd{V A ' #1+#2 @key{RET}} is the same as @kbd{V A ' <#1+#2> @key{RET}},
21032which in turn is the same as @kbd{V A ' $$+$ @key{RET}}.
d7b8e6c6
EZ
21033
21034@cindex Lambda expressions
5d67986c
RS
21035@ignore
21036@starindex
21037@end ignore
d7b8e6c6
EZ
21038@tindex lambda
21039The internal format for @samp{<x, y : x + y>} is @samp{lambda(x, y, x + y)}.
21040(The word @code{lambda} derives from Lisp notation and the theory of
21041functions.) The internal format for @samp{<#1 + #2>} is @samp{lambda(ArgA,
21042ArgB, ArgA + ArgB)}. Note that there is no actual Calc function called
21043@code{lambda}; the whole point is that the @code{lambda} expression is
21044used in its symbolic form, not evaluated for an answer until it is applied
21045to specific arguments by a command like @kbd{V A} or @kbd{V M}.
21046
21047(Actually, @code{lambda} does have one special property: Its arguments
21048are never evaluated; for example, putting @samp{<(2/3) #>} on the stack
21049will not simplify the @samp{2/3} until the nameless function is actually
21050called.)
21051
21052@tindex add
21053@tindex sub
5d67986c
RS
21054@ignore
21055@mindex @idots
21056@end ignore
d7b8e6c6 21057@tindex mul
5d67986c
RS
21058@ignore
21059@mindex @null
21060@end ignore
d7b8e6c6 21061@tindex div
5d67986c
RS
21062@ignore
21063@mindex @null
21064@end ignore
d7b8e6c6 21065@tindex pow
5d67986c
RS
21066@ignore
21067@mindex @null
21068@end ignore
d7b8e6c6 21069@tindex neg
5d67986c
RS
21070@ignore
21071@mindex @null
21072@end ignore
d7b8e6c6 21073@tindex mod
5d67986c
RS
21074@ignore
21075@mindex @null
21076@end ignore
d7b8e6c6
EZ
21077@tindex vconcat
21078As usual, commands like @kbd{V A} have algebraic function name equivalents.
21079For example, @kbd{V A k g} with an argument of @samp{v} is equivalent to
21080@samp{apply(gcd, v)}. The first argument specifies the operator name,
21081and is either a variable whose name is the same as the function name,
21082or a nameless function like @samp{<#^3+1>}. Operators that are normally
21083written as algebraic symbols have the names @code{add}, @code{sub},
21084@code{mul}, @code{div}, @code{pow}, @code{neg}, @code{mod}, and
a4231b04 21085@code{vconcat}.
d7b8e6c6 21086
5d67986c
RS
21087@ignore
21088@starindex
21089@end ignore
d7b8e6c6
EZ
21090@tindex call
21091The @code{call} function builds a function call out of several arguments:
21092@samp{call(gcd, x, y)} is the same as @samp{apply(gcd, [x, y])}, which
21093in turn is the same as @samp{gcd(x, y)}. The first argument of @code{call},
21094like the other functions described here, may be either a variable naming a
21095function, or a nameless function (@samp{call(<#1+2#2>, x, y)} is the same
21096as @samp{x + 2y}).
21097
21098(Experts will notice that it's not quite proper to use a variable to name
21099a function, since the name @code{gcd} corresponds to the Lisp variable
21100@code{var-gcd} but to the Lisp function @code{calcFunc-gcd}. Calc
21101automatically makes this translation, so you don't have to worry
21102about it.)
21103
21104@node Mapping, Reducing, Specifying Operators, Reducing and Mapping
21105@subsection Mapping
21106
21107@noindent
21108@kindex V M
21109@pindex calc-map
21110@tindex map
21111The @kbd{V M} (@code{calc-map}) [@code{map}] command applies a given
21112operator elementwise to one or more vectors. For example, mapping
21113@code{A} [@code{abs}] produces a vector of the absolute values of the
21114elements in the input vector. Mapping @code{+} pops two vectors from
21115the stack, which must be of equal length, and produces a vector of the
21116pairwise sums of the elements. If either argument is a non-vector, it
21117is duplicated for each element of the other vector. For example,
21118@kbd{[1,2,3] 2 V M ^} squares the elements of the specified vector.
21119With the 2 listed first, it would have computed a vector of powers of
21120two. Mapping a user-defined function pops as many arguments from the
21121stack as the function requires. If you give an undefined name, you will
a4231b04 21122be prompted for the number of arguments to use.
d7b8e6c6
EZ
21123
21124If any argument to @kbd{V M} is a matrix, the operator is normally mapped
21125across all elements of the matrix. For example, given the matrix
a4231b04
JB
21126@expr{[[1, -2, 3], [-4, 5, -6]]}, @kbd{V M A} takes six absolute values to
21127produce another
8e04863e 21128@texline @math{3\times2}
a4231b04
JB
21129@infoline 3x2
21130matrix, @expr{[[1, 2, 3], [4, 5, 6]]}.
d7b8e6c6
EZ
21131
21132@tindex mapr
21133The command @kbd{V M _} [@code{mapr}] (i.e., type an underscore at the
21134operator prompt) maps by rows instead. For example, @kbd{V M _ A} views
21135the above matrix as a vector of two 3-element row vectors. It produces
21136a new vector which contains the absolute values of those row vectors,
a4231b04 21137namely @expr{[3.74, 8.77]}. (Recall, the absolute value of a vector is
d7b8e6c6
EZ
21138defined as the square root of the sum of the squares of the elements.)
21139Some operators accept vectors and return new vectors; for example,
21140@kbd{v v} reverses a vector, so @kbd{V M _ v v} would reverse each row
a4231b04 21141of the matrix to get a new matrix, @expr{[[3, -2, 1], [-6, 5, -4]]}.
d7b8e6c6
EZ
21142
21143Sometimes a vector of vectors (representing, say, strings, sets, or lists)
21144happens to look like a matrix. If so, remember to use @kbd{V M _} if you
21145want to map a function across the whole strings or sets rather than across
21146their individual elements.
21147
21148@tindex mapc
21149The command @kbd{V M :} [@code{mapc}] maps by columns. Basically, it
21150transposes the input matrix, maps by rows, and then, if the result is a
21151matrix, transposes again. For example, @kbd{V M : A} takes the absolute
21152values of the three columns of the matrix, treating each as a 2-vector,
21153and @kbd{V M : v v} reverses the columns to get the matrix
a4231b04 21154@expr{[[-4, 5, -6], [1, -2, 3]]}.
d7b8e6c6
EZ
21155
21156(The symbols @kbd{_} and @kbd{:} were chosen because they had row-like
21157and column-like appearances, and were not already taken by useful
21158operators. Also, they appear shifted on most keyboards so they are easy
21159to type after @kbd{V M}.)
21160
21161The @kbd{_} and @kbd{:} modifiers have no effect on arguments that are
21162not matrices (so if none of the arguments are matrices, they have no
21163effect at all). If some of the arguments are matrices and others are
21164plain numbers, the plain numbers are held constant for all rows of the
21165matrix (so that @kbd{2 V M _ ^} squares every row of a matrix; squaring
21166a vector takes a dot product of the vector with itself).
21167
21168If some of the arguments are vectors with the same lengths as the
21169rows (for @kbd{V M _}) or columns (for @kbd{V M :}) of the matrix
21170arguments, those vectors are also held constant for every row or
21171column.
21172
21173Sometimes it is useful to specify another mapping command as the operator
21174to use with @kbd{V M}. For example, @kbd{V M _ V A +} applies @kbd{V A +}
21175to each row of the input matrix, which in turn adds the two values on that
21176row. If you give another vector-operator command as the operator for
21177@kbd{V M}, it automatically uses map-by-rows mode if you don't specify
21178otherwise; thus @kbd{V M V A +} is equivalent to @kbd{V M _ V A +}. (If
21179you really want to map-by-elements another mapping command, you can use
21180a triple-nested mapping command: @kbd{V M V M V A +} means to map
21181@kbd{V M V A +} over the rows of the matrix; in turn, @kbd{V A +} is
21182mapped over the elements of each row.)
21183
21184@tindex mapa
21185@tindex mapd
21186Previous versions of Calc had ``map across'' and ``map down'' modes
21187that are now considered obsolete; the old ``map across'' is now simply
21188@kbd{V M V A}, and ``map down'' is now @kbd{V M : V A}. The algebraic
21189functions @code{mapa} and @code{mapd} are still supported, though.
21190Note also that, while the old mapping modes were persistent (once you
21191set the mode, it would apply to later mapping commands until you reset
21192it), the new @kbd{:} and @kbd{_} modifiers apply only to the current
21193mapping command. The default @kbd{V M} always means map-by-elements.
21194
21195@xref{Algebraic Manipulation}, for the @kbd{a M} command, which is like
21196@kbd{V M} but for equations and inequalities instead of vectors.
21197@xref{Storing Variables}, for the @kbd{s m} command which modifies a
21198variable's stored value using a @kbd{V M}-like operator.
21199
21200@node Reducing, Nesting and Fixed Points, Mapping, Reducing and Mapping
21201@subsection Reducing
21202
21203@noindent
21204@kindex V R
21205@pindex calc-reduce
21206@tindex reduce
21207The @kbd{V R} (@code{calc-reduce}) [@code{reduce}] command applies a given
21208binary operator across all the elements of a vector. A binary operator is
21209a function such as @code{+} or @code{max} which takes two arguments. For
21210example, reducing @code{+} over a vector computes the sum of the elements
21211of the vector. Reducing @code{-} computes the first element minus each of
21212the remaining elements. Reducing @code{max} computes the maximum element
21213and so on. In general, reducing @code{f} over the vector @samp{[a, b, c, d]}
21214produces @samp{f(f(f(a, b), c), d)}.
21215
21216@kindex I V R
21217@tindex rreduce
21218The @kbd{I V R} [@code{rreduce}] command is similar to @kbd{V R} except
21219that works from right to left through the vector. For example, plain
21220@kbd{V R -} on the vector @samp{[a, b, c, d]} produces @samp{a - b - c - d}
21221but @kbd{I V R -} on the same vector produces @samp{a - (b - (c - d))},
21222or @samp{a - b + c - d}. This ``alternating sum'' occurs frequently
21223in power series expansions.
21224
21225@kindex V U
21226@tindex accum
21227The @kbd{V U} (@code{calc-accumulate}) [@code{accum}] command does an
21228accumulation operation. Here Calc does the corresponding reduction
21229operation, but instead of producing only the final result, it produces
21230a vector of all the intermediate results. Accumulating @code{+} over
21231the vector @samp{[a, b, c, d]} produces the vector
21232@samp{[a, a + b, a + b + c, a + b + c + d]}.
21233
21234@kindex I V U
21235@tindex raccum
21236The @kbd{I V U} [@code{raccum}] command does a right-to-left accumulation.
21237For example, @kbd{I V U -} on the vector @samp{[a, b, c, d]} produces the
21238vector @samp{[a - b + c - d, b - c + d, c - d, d]}.
21239
21240@tindex reducea
21241@tindex rreducea
21242@tindex reduced
21243@tindex rreduced
21244As for @kbd{V M}, @kbd{V R} normally reduces a matrix elementwise. For
a4231b04
JB
21245example, given the matrix @expr{[[a, b, c], [d, e, f]]}, @kbd{V R +} will
21246compute @expr{a + b + c + d + e + f}. You can type @kbd{V R _} or
d7b8e6c6
EZ
21247@kbd{V R :} to modify this behavior. The @kbd{V R _} [@code{reducea}]
21248command reduces ``across'' the matrix; it reduces each row of the matrix
21249as a vector, then collects the results. Thus @kbd{V R _ +} of this
a4231b04
JB
21250matrix would produce @expr{[a + b + c, d + e + f]}. Similarly, @kbd{V R :}
21251[@code{reduced}] reduces down; @kbd{V R : +} would produce @expr{[a + d,
d7b8e6c6
EZ
21252b + e, c + f]}.
21253
21254@tindex reducer
21255@tindex rreducer
21256There is a third ``by rows'' mode for reduction that is occasionally
21257useful; @kbd{V R =} [@code{reducer}] simply reduces the operator over
21258the rows of the matrix themselves. Thus @kbd{V R = +} on the above
21259matrix would get the same result as @kbd{V R : +}, since adding two
21260row vectors is equivalent to adding their elements. But @kbd{V R = *}
21261would multiply the two rows (to get a single number, their dot product),
21262while @kbd{V R : *} would produce a vector of the products of the columns.
21263
21264These three matrix reduction modes work with @kbd{V R} and @kbd{I V R},
21265but they are not currently supported with @kbd{V U} or @kbd{I V U}.
21266
21267@tindex reducec
21268@tindex rreducec
21269The obsolete reduce-by-columns function, @code{reducec}, is still
21270supported but there is no way to get it through the @kbd{V R} command.
21271
21272The commands @kbd{M-# :} and @kbd{M-# _} are equivalent to typing
21273@kbd{M-# r} to grab a rectangle of data into Calc, and then typing
21274@kbd{V R : +} or @kbd{V R _ +}, respectively, to sum the columns or
21275rows of the matrix. @xref{Grabbing From Buffers}.
21276
21277@node Nesting and Fixed Points, Generalized Products, Reducing, Reducing and Mapping
21278@subsection Nesting and Fixed Points
21279
21280@noindent
21281@kindex H V R
21282@tindex nest
21283The @kbd{H V R} [@code{nest}] command applies a function to a given
21284argument repeatedly. It takes two values, @samp{a} and @samp{n}, from
21285the stack, where @samp{n} must be an integer. It then applies the
21286function nested @samp{n} times; if the function is @samp{f} and @samp{n}
21287is 3, the result is @samp{f(f(f(a)))}. The number @samp{n} may be
21288negative if Calc knows an inverse for the function @samp{f}; for
21289example, @samp{nest(sin, a, -2)} returns @samp{arcsin(arcsin(a))}.
21290
21291@kindex H V U
21292@tindex anest
21293The @kbd{H V U} [@code{anest}] command is an accumulating version of
21294@code{nest}: It returns a vector of @samp{n+1} values, e.g.,
21295@samp{[a, f(a), f(f(a)), f(f(f(a)))]}. If @samp{n} is negative and
21296@samp{F} is the inverse of @samp{f}, then the result is of the
21297form @samp{[a, F(a), F(F(a)), F(F(F(a)))]}.
21298
21299@kindex H I V R
21300@tindex fixp
21301@cindex Fixed points
21302The @kbd{H I V R} [@code{fixp}] command is like @kbd{H V R}, except
21303that it takes only an @samp{a} value from the stack; the function is
21304applied until it reaches a ``fixed point,'' i.e., until the result
21305no longer changes.
21306
21307@kindex H I V U
21308@tindex afixp
21309The @kbd{H I V U} [@code{afixp}] command is an accumulating @code{fixp}.
21310The first element of the return vector will be the initial value @samp{a};
21311the last element will be the final result that would have been returned
21312by @code{fixp}.
21313
21314For example, 0.739085 is a fixed point of the cosine function (in radians):
21315@samp{cos(0.739085) = 0.739085}. You can find this value by putting, say,
213161.0 on the stack and typing @kbd{H I V U C}. (We use the accumulating
21317version so we can see the intermediate results: @samp{[1, 0.540302, 0.857553,
213180.65329, ...]}. With a precision of six, this command will take 36 steps
21319to converge to 0.739085.)
21320
21321Newton's method for finding roots is a classic example of iteration
21322to a fixed point. To find the square root of five starting with an
21323initial guess, Newton's method would look for a fixed point of the
21324function @samp{(x + 5/x) / 2}. Putting a guess of 1 on the stack
5d67986c 21325and typing @kbd{H I V R ' ($ + 5/$)/2 @key{RET}} quickly yields the result
d7b8e6c6
EZ
213262.23607. This is equivalent to using the @kbd{a R} (@code{calc-find-root})
21327command to find a root of the equation @samp{x^2 = 5}.
21328
21329These examples used numbers for @samp{a} values. Calc keeps applying
21330the function until two successive results are equal to within the
21331current precision. For complex numbers, both the real parts and the
21332imaginary parts must be equal to within the current precision. If
21333@samp{a} is a formula (say, a variable name), then the function is
21334applied until two successive results are exactly the same formula.
21335It is up to you to ensure that the function will eventually converge;
21336if it doesn't, you may have to press @kbd{C-g} to stop the Calculator.
21337
21338The algebraic @code{fixp} function takes two optional arguments, @samp{n}
21339and @samp{tol}. The first is the maximum number of steps to be allowed,
21340and must be either an integer or the symbol @samp{inf} (infinity, the
21341default). The second is a convergence tolerance. If a tolerance is
21342specified, all results during the calculation must be numbers, not
21343formulas, and the iteration stops when the magnitude of the difference
21344between two successive results is less than or equal to the tolerance.
21345(This implies that a tolerance of zero iterates until the results are
21346exactly equal.)
21347
21348Putting it all together, @samp{fixp(<(# + A/#)/2>, B, 20, 1e-10)}
21349computes the square root of @samp{A} given the initial guess @samp{B},
21350stopping when the result is correct within the specified tolerance, or
21351when 20 steps have been taken, whichever is sooner.
21352
21353@node Generalized Products, , Nesting and Fixed Points, Reducing and Mapping
21354@subsection Generalized Products
21355
21356@kindex V O
21357@pindex calc-outer-product
21358@tindex outer
21359The @kbd{V O} (@code{calc-outer-product}) [@code{outer}] command applies
21360a given binary operator to all possible pairs of elements from two
21361vectors, to produce a matrix. For example, @kbd{V O *} with @samp{[a, b]}
21362and @samp{[x, y, z]} on the stack produces a multiplication table:
21363@samp{[[a x, a y, a z], [b x, b y, b z]]}. Element @var{r},@var{c} of
21364the result matrix is obtained by applying the operator to element @var{r}
21365of the lefthand vector and element @var{c} of the righthand vector.
21366
21367@kindex V I
21368@pindex calc-inner-product
21369@tindex inner
21370The @kbd{V I} (@code{calc-inner-product}) [@code{inner}] command computes
21371the generalized inner product of two vectors or matrices, given a
21372``multiplicative'' operator and an ``additive'' operator. These can each
21373actually be any binary operators; if they are @samp{*} and @samp{+},
21374respectively, the result is a standard matrix multiplication. Element
21375@var{r},@var{c} of the result matrix is obtained by mapping the
21376multiplicative operator across row @var{r} of the lefthand matrix and
21377column @var{c} of the righthand matrix, and then reducing with the additive
21378operator. Just as for the standard @kbd{*} command, this can also do a
21379vector-matrix or matrix-vector inner product, or a vector-vector
21380generalized dot product.
21381
21382Since @kbd{V I} requires two operators, it prompts twice. In each case,
21383you can use any of the usual methods for entering the operator. If you
21384use @kbd{$} twice to take both operator formulas from the stack, the
21385first (multiplicative) operator is taken from the top of the stack
21386and the second (additive) operator is taken from second-to-top.
21387
21388@node Vector and Matrix Formats, , Reducing and Mapping, Matrix Functions
21389@section Vector and Matrix Display Formats
21390
21391@noindent
21392Commands for controlling vector and matrix display use the @kbd{v} prefix
21393instead of the usual @kbd{d} prefix. But they are display modes; in
21394particular, they are influenced by the @kbd{I} and @kbd{H} prefix keys
21395in the same way (@pxref{Display Modes}). Matrix display is also
21396influenced by the @kbd{d O} (@code{calc-flat-language}) mode;
21397@pxref{Normal Language Modes}.
21398
21399@kindex V <
21400@pindex calc-matrix-left-justify
21401@kindex V =
21402@pindex calc-matrix-center-justify
21403@kindex V >
21404@pindex calc-matrix-right-justify
21405The commands @kbd{v <} (@code{calc-matrix-left-justify}), @kbd{v >}
21406(@code{calc-matrix-right-justify}), and @w{@kbd{v =}}
21407(@code{calc-matrix-center-justify}) control whether matrix elements
a4231b04 21408are justified to the left, right, or center of their columns.
d7b8e6c6
EZ
21409
21410@kindex V [
21411@pindex calc-vector-brackets
21412@kindex V @{
21413@pindex calc-vector-braces
21414@kindex V (
21415@pindex calc-vector-parens
21416The @kbd{v [} (@code{calc-vector-brackets}) command turns the square
21417brackets that surround vectors and matrices displayed in the stack on
21418and off. The @kbd{v @{} (@code{calc-vector-braces}) and @kbd{v (}
21419(@code{calc-vector-parens}) commands use curly braces or parentheses,
21420respectively, instead of square brackets. For example, @kbd{v @{} might
21421be used in preparation for yanking a matrix into a buffer running
21422Mathematica. (In fact, the Mathematica language mode uses this mode;
21423@pxref{Mathematica Language Mode}.) Note that, regardless of the
21424display mode, either brackets or braces may be used to enter vectors,
a4231b04 21425and parentheses may never be used for this purpose.
d7b8e6c6
EZ
21426
21427@kindex V ]
21428@pindex calc-matrix-brackets
21429The @kbd{v ]} (@code{calc-matrix-brackets}) command controls the
21430``big'' style display of matrices. It prompts for a string of code
21431letters; currently implemented letters are @code{R}, which enables
21432brackets on each row of the matrix; @code{O}, which enables outer
21433brackets in opposite corners of the matrix; and @code{C}, which
21434enables commas or semicolons at the ends of all rows but the last.
21435The default format is @samp{RO}. (Before Calc 2.00, the format
21436was fixed at @samp{ROC}.) Here are some example matrices:
21437
d7b8e6c6 21438@example
5d67986c 21439@group
d7b8e6c6
EZ
21440[ [ 123, 0, 0 ] [ [ 123, 0, 0 ],
21441 [ 0, 123, 0 ] [ 0, 123, 0 ],
21442 [ 0, 0, 123 ] ] [ 0, 0, 123 ] ]
21443
21444 RO ROC
21445
d7b8e6c6 21446@end group
5d67986c 21447@end example
d7b8e6c6 21448@noindent
d7b8e6c6 21449@example
5d67986c 21450@group
d7b8e6c6
EZ
21451 [ 123, 0, 0 [ 123, 0, 0 ;
21452 0, 123, 0 0, 123, 0 ;
21453 0, 0, 123 ] 0, 0, 123 ]
21454
21455 O OC
21456
d7b8e6c6 21457@end group
5d67986c 21458@end example
d7b8e6c6 21459@noindent
d7b8e6c6 21460@example
5d67986c 21461@group
d7b8e6c6
EZ
21462 [ 123, 0, 0 ] 123, 0, 0
21463 [ 0, 123, 0 ] 0, 123, 0
21464 [ 0, 0, 123 ] 0, 0, 123
21465
21466 R @r{blank}
d7b8e6c6 21467@end group
5d67986c 21468@end example
d7b8e6c6
EZ
21469
21470@noindent
21471Note that of the formats shown here, @samp{RO}, @samp{ROC}, and
21472@samp{OC} are all recognized as matrices during reading, while
21473the others are useful for display only.
21474
21475@kindex V ,
21476@pindex calc-vector-commas
21477The @kbd{v ,} (@code{calc-vector-commas}) command turns commas on and
a4231b04 21478off in vector and matrix display.
d7b8e6c6
EZ
21479
21480In vectors of length one, and in all vectors when commas have been
21481turned off, Calc adds extra parentheses around formulas that might
21482otherwise be ambiguous. For example, @samp{[a b]} could be a vector
21483of the one formula @samp{a b}, or it could be a vector of two
21484variables with commas turned off. Calc will display the former
21485case as @samp{[(a b)]}. You can disable these extra parentheses
21486(to make the output less cluttered at the expense of allowing some
21487ambiguity) by adding the letter @code{P} to the control string you
21488give to @kbd{v ]} (as described above).
21489
21490@kindex V .
21491@pindex calc-full-vectors
21492The @kbd{v .} (@code{calc-full-vectors}) command turns abbreviated
21493display of long vectors on and off. In this mode, vectors of six
21494or more elements, or matrices of six or more rows or columns, will
21495be displayed in an abbreviated form that displays only the first
21496three elements and the last element: @samp{[a, b, c, ..., z]}.
21497When very large vectors are involved this will substantially
21498improve Calc's display speed.
21499
21500@kindex t .
21501@pindex calc-full-trail-vectors
21502The @kbd{t .} (@code{calc-full-trail-vectors}) command controls a
21503similar mode for recording vectors in the Trail. If you turn on
21504this mode, vectors of six or more elements and matrices of six or
21505more rows or columns will be abbreviated when they are put in the
21506Trail. The @kbd{t y} (@code{calc-trail-yank}) command will be
21507unable to recover those vectors. If you are working with very
21508large vectors, this mode will improve the speed of all operations
21509that involve the trail.
21510
21511@kindex V /
21512@pindex calc-break-vectors
21513The @kbd{v /} (@code{calc-break-vectors}) command turns multi-line
21514vector display on and off. Normally, matrices are displayed with one
21515row per line but all other types of vectors are displayed in a single
21516line. This mode causes all vectors, whether matrices or not, to be
21517displayed with a single element per line. Sub-vectors within the
21518vectors will still use the normal linear form.
21519
21520@node Algebra, Units, Matrix Functions, Top
21521@chapter Algebra
21522
21523@noindent
21524This section covers the Calc features that help you work with
21525algebraic formulas. First, the general sub-formula selection
21526mechanism is described; this works in conjunction with any Calc
21527commands. Then, commands for specific algebraic operations are
21528described. Finally, the flexible @dfn{rewrite rule} mechanism
21529is discussed.
21530
21531The algebraic commands use the @kbd{a} key prefix; selection
21532commands use the @kbd{j} (for ``just a letter that wasn't used
21533for anything else'') prefix.
21534
21535@xref{Editing Stack Entries}, to see how to manipulate formulas
a4231b04 21536using regular Emacs editing commands.
d7b8e6c6
EZ
21537
21538When doing algebraic work, you may find several of the Calculator's
07ce2eb3
JB
21539modes to be helpful, including Algebraic Simplification mode (@kbd{m A})
21540or No-Simplification mode (@kbd{m O}),
21541Algebraic entry mode (@kbd{m a}), Fraction mode (@kbd{m f}), and
21542Symbolic mode (@kbd{m s}). @xref{Mode Settings}, for discussions
21543of these modes. You may also wish to select Big display mode (@kbd{d B}).
a4231b04 21544@xref{Normal Language Modes}.
d7b8e6c6
EZ
21545
21546@menu
21547* Selecting Subformulas::
21548* Algebraic Manipulation::
21549* Simplifying Formulas::
21550* Polynomials::
21551* Calculus::
21552* Solving Equations::
21553* Numerical Solutions::
21554* Curve Fitting::
21555* Summations::
21556* Logical Operations::
21557* Rewrite Rules::
21558@end menu
21559
21560@node Selecting Subformulas, Algebraic Manipulation, Algebra, Algebra
21561@section Selecting Sub-Formulas
21562
21563@noindent
21564@cindex Selections
21565@cindex Sub-formulas
21566@cindex Parts of formulas
21567When working with an algebraic formula it is often necessary to
21568manipulate a portion of the formula rather than the formula as a
21569whole. Calc allows you to ``select'' a portion of any formula on
21570the stack. Commands which would normally operate on that stack
21571entry will now operate only on the sub-formula, leaving the
21572surrounding part of the stack entry alone.
21573
21574One common non-algebraic use for selection involves vectors. To work
21575on one element of a vector in-place, simply select that element as a
21576``sub-formula'' of the vector.
21577
21578@menu
21579* Making Selections::
21580* Changing Selections::
21581* Displaying Selections::
21582* Operating on Selections::
21583* Rearranging with Selections::
21584@end menu
21585
21586@node Making Selections, Changing Selections, Selecting Subformulas, Selecting Subformulas
21587@subsection Making Selections
21588
21589@noindent
21590@kindex j s
21591@pindex calc-select-here
21592To select a sub-formula, move the Emacs cursor to any character in that
21593sub-formula, and press @w{@kbd{j s}} (@code{calc-select-here}). Calc will
21594highlight the smallest portion of the formula that contains that
21595character. By default the sub-formula is highlighted by blanking out
21596all of the rest of the formula with dots. Selection works in any
07ce2eb3 21597display mode but is perhaps easiest in Big mode (@kbd{d B}).
d7b8e6c6
EZ
21598Suppose you enter the following formula:
21599
d7b8e6c6 21600@smallexample
5d67986c 21601@group
d7b8e6c6
EZ
21602 3 ___
21603 (a + b) + V c
216041: ---------------
21605 2 x + 1
d7b8e6c6 21606@end group
5d67986c 21607@end smallexample
d7b8e6c6
EZ
21608
21609@noindent
21610(by typing @kbd{' ((a+b)^3 + sqrt(c)) / (2x+1)}). If you move the
21611cursor to the letter @samp{b} and press @w{@kbd{j s}}, the display changes
21612to
21613
d7b8e6c6 21614@smallexample
5d67986c 21615@group
d7b8e6c6
EZ
21616 . ...
21617 .. . b. . . .
216181* ...............
21619 . . . .
d7b8e6c6 21620@end group
5d67986c 21621@end smallexample
d7b8e6c6
EZ
21622
21623@noindent
21624Every character not part of the sub-formula @samp{b} has been changed
21625to a dot. The @samp{*} next to the line number is to remind you that
21626the formula has a portion of it selected. (In this case, it's very
07ce2eb3 21627obvious, but it might not always be. If Embedded mode is enabled,
d7b8e6c6
EZ
21628the word @samp{Sel} also appears in the mode line because the stack
21629may not be visible. @pxref{Embedded Mode}.)
21630
21631If you had instead placed the cursor on the parenthesis immediately to
21632the right of the @samp{b}, the selection would have been:
21633
d7b8e6c6 21634@smallexample
5d67986c 21635@group
d7b8e6c6
EZ
21636 . ...
21637 (a + b) . . .
216381* ...............
21639 . . . .
d7b8e6c6 21640@end group
5d67986c 21641@end smallexample
d7b8e6c6
EZ
21642
21643@noindent
21644The portion selected is always large enough to be considered a complete
21645formula all by itself, so selecting the parenthesis selects the whole
269b7745 21646formula that it encloses. Putting the cursor on the @samp{+} sign
d7b8e6c6
EZ
21647would have had the same effect.
21648
21649(Strictly speaking, the Emacs cursor is really the manifestation of
21650the Emacs ``point,'' which is a position @emph{between} two characters
21651in the buffer. So purists would say that Calc selects the smallest
21652sub-formula which contains the character to the right of ``point.'')
21653
21654If you supply a numeric prefix argument @var{n}, the selection is
21655expanded to the @var{n}th enclosing sub-formula. Thus, positioning
21656the cursor on the @samp{b} and typing @kbd{C-u 1 j s} will select
21657@samp{a + b}; typing @kbd{C-u 2 j s} will select @samp{(a + b)^3},
21658and so on.
21659
21660If the cursor is not on any part of the formula, or if you give a
21661numeric prefix that is too large, the entire formula is selected.
21662
21663If the cursor is on the @samp{.} line that marks the top of the stack
21664(i.e., its normal ``rest position''), this command selects the entire
21665formula at stack level 1. Most selection commands similarly operate
21666on the formula at the top of the stack if you haven't positioned the
21667cursor on any stack entry.
21668
21669@kindex j a
21670@pindex calc-select-additional
21671The @kbd{j a} (@code{calc-select-additional}) command enlarges the
21672current selection to encompass the cursor. To select the smallest
21673sub-formula defined by two different points, move to the first and
21674press @kbd{j s}, then move to the other and press @kbd{j a}. This
21675is roughly analogous to using @kbd{C-@@} (@code{set-mark-command}) to
21676select the two ends of a region of text during normal Emacs editing.
21677
21678@kindex j o
21679@pindex calc-select-once
21680The @kbd{j o} (@code{calc-select-once}) command selects a formula in
21681exactly the same way as @kbd{j s}, except that the selection will
21682last only as long as the next command that uses it. For example,
21683@kbd{j o 1 +} is a handy way to add one to the sub-formula indicated
21684by the cursor.
21685
21686(A somewhat more precise definition: The @kbd{j o} command sets a flag
21687such that the next command involving selected stack entries will clear
21688the selections on those stack entries afterwards. All other selection
21689commands except @kbd{j a} and @kbd{j O} clear this flag.)
21690
21691@kindex j S
21692@kindex j O
21693@pindex calc-select-here-maybe
21694@pindex calc-select-once-maybe
21695The @kbd{j S} (@code{calc-select-here-maybe}) and @kbd{j O}
21696(@code{calc-select-once-maybe}) commands are equivalent to @kbd{j s}
21697and @kbd{j o}, respectively, except that if the formula already
21698has a selection they have no effect. This is analogous to the
21699behavior of some commands such as @kbd{j r} (@code{calc-rewrite-selection};
21700@pxref{Selections with Rewrite Rules}) and is mainly intended to be
21701used in keyboard macros that implement your own selection-oriented
a4231b04 21702commands.
d7b8e6c6
EZ
21703
21704Selection of sub-formulas normally treats associative terms like
21705@samp{a + b - c + d} and @samp{x * y * z} as single levels of the formula.
21706If you place the cursor anywhere inside @samp{a + b - c + d} except
21707on one of the variable names and use @kbd{j s}, you will select the
21708entire four-term sum.
21709
21710@kindex j b
21711@pindex calc-break-selections
21712The @kbd{j b} (@code{calc-break-selections}) command controls a mode
21713in which the ``deep structure'' of these associative formulas shows
21714through. Calc actually stores the above formulas as @samp{((a + b) - c) + d}
21715and @samp{x * (y * z)}. (Note that for certain obscure reasons, Calc
21716treats multiplication as right-associative.) Once you have enabled
21717@kbd{j b} mode, selecting with the cursor on the @samp{-} sign would
21718only select the @samp{a + b - c} portion, which makes sense when the
21719deep structure of the sum is considered. There is no way to select
21720the @samp{b - c + d} portion; although this might initially look
21721like just as legitimate a sub-formula as @samp{a + b - c}, the deep
21722structure shows that it isn't. The @kbd{d U} command can be used
21723to view the deep structure of any formula (@pxref{Normal Language Modes}).
21724
21725When @kbd{j b} mode has not been enabled, the deep structure is
21726generally hidden by the selection commands---what you see is what
21727you get.
21728
21729@kindex j u
21730@pindex calc-unselect
21731The @kbd{j u} (@code{calc-unselect}) command unselects the formula
21732that the cursor is on. If there was no selection in the formula,
21733this command has no effect. With a numeric prefix argument, it
21734unselects the @var{n}th stack element rather than using the cursor
21735position.
21736
21737@kindex j c
21738@pindex calc-clear-selections
21739The @kbd{j c} (@code{calc-clear-selections}) command unselects all
21740stack elements.
21741
21742@node Changing Selections, Displaying Selections, Making Selections, Selecting Subformulas
21743@subsection Changing Selections
21744
21745@noindent
21746@kindex j m
21747@pindex calc-select-more
21748Once you have selected a sub-formula, you can expand it using the
21749@w{@kbd{j m}} (@code{calc-select-more}) command. If @samp{a + b} is
21750selected, pressing @w{@kbd{j m}} repeatedly works as follows:
21751
d7b8e6c6 21752@smallexample
5d67986c 21753@group
d7b8e6c6
EZ
21754 3 ... 3 ___ 3 ___
21755 (a + b) . . . (a + b) + V c (a + b) + V c
217561* ............... 1* ............... 1* ---------------
21757 . . . . . . . . 2 x + 1
d7b8e6c6 21758@end group
5d67986c 21759@end smallexample
d7b8e6c6
EZ
21760
21761@noindent
21762In the last example, the entire formula is selected. This is roughly
21763the same as having no selection at all, but because there are subtle
21764differences the @samp{*} character is still there on the line number.
21765
21766With a numeric prefix argument @var{n}, @kbd{j m} expands @var{n}
21767times (or until the entire formula is selected). Note that @kbd{j s}
21768with argument @var{n} is equivalent to plain @kbd{j s} followed by
21769@kbd{j m} with argument @var{n}. If @w{@kbd{j m}} is used when there
21770is no current selection, it is equivalent to @w{@kbd{j s}}.
21771
21772Even though @kbd{j m} does not explicitly use the location of the
21773cursor within the formula, it nevertheless uses the cursor to determine
21774which stack element to operate on. As usual, @kbd{j m} when the cursor
21775is not on any stack element operates on the top stack element.
21776
21777@kindex j l
21778@pindex calc-select-less
21779The @kbd{j l} (@code{calc-select-less}) command reduces the current
21780selection around the cursor position. That is, it selects the
21781immediate sub-formula of the current selection which contains the
21782cursor, the opposite of @kbd{j m}. If the cursor is not inside the
21783current selection, the command de-selects the formula.
21784
21785@kindex j 1-9
21786@pindex calc-select-part
21787The @kbd{j 1} through @kbd{j 9} (@code{calc-select-part}) commands
21788select the @var{n}th sub-formula of the current selection. They are
21789like @kbd{j l} (@code{calc-select-less}) except they use counting
21790rather than the cursor position to decide which sub-formula to select.
21791For example, if the current selection is @kbd{a + b + c} or
21792@kbd{f(a, b, c)} or @kbd{[a, b, c]}, then @kbd{j 1} selects @samp{a},
21793@kbd{j 2} selects @samp{b}, and @kbd{j 3} selects @samp{c}; in each of
21794these cases, @kbd{j 4} through @kbd{j 9} would be errors.
21795
21796If there is no current selection, @kbd{j 1} through @kbd{j 9} select
21797the @var{n}th top-level sub-formula. (In other words, they act as if
21798the entire stack entry were selected first.) To select the @var{n}th
21799sub-formula where @var{n} is greater than nine, you must instead invoke
a4231b04 21800@w{@kbd{j 1}} with @var{n} as a numeric prefix argument.
d7b8e6c6
EZ
21801
21802@kindex j n
21803@kindex j p
21804@pindex calc-select-next
21805@pindex calc-select-previous
21806The @kbd{j n} (@code{calc-select-next}) and @kbd{j p}
21807(@code{calc-select-previous}) commands change the current selection
21808to the next or previous sub-formula at the same level. For example,
21809if @samp{b} is selected in @w{@samp{2 + a*b*c + x}}, then @kbd{j n}
21810selects @samp{c}. Further @kbd{j n} commands would be in error because,
21811even though there is something to the right of @samp{c} (namely, @samp{x}),
21812it is not at the same level; in this case, it is not a term of the
21813same product as @samp{b} and @samp{c}. However, @kbd{j m} (to select
21814the whole product @samp{a*b*c} as a term of the sum) followed by
21815@w{@kbd{j n}} would successfully select the @samp{x}.
21816
21817Similarly, @kbd{j p} moves the selection from the @samp{b} in this
21818sample formula to the @samp{a}. Both commands accept numeric prefix
21819arguments to move several steps at a time.
21820
21821It is interesting to compare Calc's selection commands with the
21822Emacs Info system's commands for navigating through hierarchically
21823organized documentation. Calc's @kbd{j n} command is completely
21824analogous to Info's @kbd{n} command. Likewise, @kbd{j p} maps to
21825@kbd{p}, @kbd{j 2} maps to @kbd{2}, and Info's @kbd{u} is like @kbd{j m}.
21826(Note that @kbd{j u} stands for @code{calc-unselect}, not ``up''.)
21827The Info @kbd{m} command is somewhat similar to Calc's @kbd{j s} and
21828@kbd{j l}; in each case, you can jump directly to a sub-component
21829of the hierarchy simply by pointing to it with the cursor.
21830
21831@node Displaying Selections, Operating on Selections, Changing Selections, Selecting Subformulas
21832@subsection Displaying Selections
21833
21834@noindent
21835@kindex j d
21836@pindex calc-show-selections
21837The @kbd{j d} (@code{calc-show-selections}) command controls how
21838selected sub-formulas are displayed. One of the alternatives is
21839illustrated in the above examples; if we press @kbd{j d} we switch
21840to the other style in which the selected portion itself is obscured
21841by @samp{#} signs:
21842
d7b8e6c6 21843@smallexample
5d67986c 21844@group
d7b8e6c6
EZ
21845 3 ... # ___
21846 (a + b) . . . ## # ## + V c
218471* ............... 1* ---------------
21848 . . . . 2 x + 1
d7b8e6c6 21849@end group
5d67986c 21850@end smallexample
d7b8e6c6
EZ
21851
21852@node Operating on Selections, Rearranging with Selections, Displaying Selections, Selecting Subformulas
21853@subsection Operating on Selections
21854
21855@noindent
21856Once a selection is made, all Calc commands that manipulate items
21857on the stack will operate on the selected portions of the items
21858instead. (Note that several stack elements may have selections
21859at once, though there can be only one selection at a time in any
21860given stack element.)
21861
21862@kindex j e
21863@pindex calc-enable-selections
21864The @kbd{j e} (@code{calc-enable-selections}) command disables the
21865effect that selections have on Calc commands. The current selections
21866still exist, but Calc commands operate on whole stack elements anyway.
21867This mode can be identified by the fact that the @samp{*} markers on
21868the line numbers are gone, even though selections are visible. To
21869reactivate the selections, press @kbd{j e} again.
21870
21871To extract a sub-formula as a new formula, simply select the
21872sub-formula and press @key{RET}. This normally duplicates the top
21873stack element; here it duplicates only the selected portion of that
21874element.
21875
21876To replace a sub-formula with something different, you can enter the
21877new value onto the stack and press @key{TAB}. This normally exchanges
21878the top two stack elements; here it swaps the value you entered into
21879the selected portion of the formula, returning the old selected
21880portion to the top of the stack.
21881
d7b8e6c6 21882@smallexample
5d67986c 21883@group
d7b8e6c6
EZ
21884 3 ... ... ___
21885 (a + b) . . . 17 x y . . . 17 x y + V c
218862* ............... 2* ............. 2: -------------
21887 . . . . . . . . 2 x + 1
21888
21889 3 3
218901: 17 x y 1: (a + b) 1: (a + b)
d7b8e6c6 21891@end group
5d67986c 21892@end smallexample
d7b8e6c6
EZ
21893
21894In this example we select a sub-formula of our original example,
21895enter a new formula, @key{TAB} it into place, then deselect to see
21896the complete, edited formula.
21897
21898If you want to swap whole formulas around even though they contain
21899selections, just use @kbd{j e} before and after.
21900
21901@kindex j '
21902@pindex calc-enter-selection
21903The @kbd{j '} (@code{calc-enter-selection}) command is another way
21904to replace a selected sub-formula. This command does an algebraic
21905entry just like the regular @kbd{'} key. When you press @key{RET},
21906the formula you type replaces the original selection. You can use
21907the @samp{$} symbol in the formula to refer to the original
21908selection. If there is no selection in the formula under the cursor,
21909the cursor is used to make a temporary selection for the purposes of
21910the command. Thus, to change a term of a formula, all you have to
21911do is move the Emacs cursor to that term and press @kbd{j '}.
21912
21913@kindex j `
21914@pindex calc-edit-selection
21915The @kbd{j `} (@code{calc-edit-selection}) command is a similar
21916analogue of the @kbd{`} (@code{calc-edit}) command. It edits the
21917selected sub-formula in a separate buffer. If there is no
21918selection, it edits the sub-formula indicated by the cursor.
21919
21920To delete a sub-formula, press @key{DEL}. This generally replaces
21921the sub-formula with the constant zero, but in a few suitable contexts
21922it uses the constant one instead. The @key{DEL} key automatically
21923deselects and re-simplifies the entire formula afterwards. Thus:
21924
d7b8e6c6 21925@smallexample
5d67986c 21926@group
d7b8e6c6
EZ
21927 ###
21928 17 x y + # # 17 x y 17 # y 17 y
219291* ------------- 1: ------- 1* ------- 1: -------
21930 2 x + 1 2 x + 1 2 x + 1 2 x + 1
d7b8e6c6 21931@end group
5d67986c 21932@end smallexample
d7b8e6c6
EZ
21933
21934In this example, we first delete the @samp{sqrt(c)} term; Calc
21935accomplishes this by replacing @samp{sqrt(c)} with zero and
21936resimplifying. We then delete the @kbd{x} in the numerator;
21937since this is part of a product, Calc replaces it with @samp{1}
21938and resimplifies.
21939
21940If you select an element of a vector and press @key{DEL}, that
21941element is deleted from the vector. If you delete one side of
21942an equation or inequality, only the opposite side remains.
21943
5d67986c 21944@kindex j @key{DEL}
d7b8e6c6
EZ
21945@pindex calc-del-selection
21946The @kbd{j @key{DEL}} (@code{calc-del-selection}) command is like
21947@key{DEL} but with the auto-selecting behavior of @kbd{j '} and
21948@kbd{j `}. It deletes the selected portion of the formula
21949indicated by the cursor, or, in the absence of a selection, it
21950deletes the sub-formula indicated by the cursor position.
21951
5d67986c 21952@kindex j @key{RET}
d7b8e6c6
EZ
21953@pindex calc-grab-selection
21954(There is also an auto-selecting @kbd{j @key{RET}} (@code{calc-copy-selection})
21955command.)
21956
21957Normal arithmetic operations also apply to sub-formulas. Here we
21958select the denominator, press @kbd{5 -} to subtract five from the
21959denominator, press @kbd{n} to negate the denominator, then
21960press @kbd{Q} to take the square root.
21961
d7b8e6c6 21962@smallexample
5d67986c 21963@group
d7b8e6c6
EZ
21964 .. . .. . .. . .. .
219651* ....... 1* ....... 1* ....... 1* ..........
21966 2 x + 1 2 x - 4 4 - 2 x _________
21967 V 4 - 2 x
d7b8e6c6 21968@end group
5d67986c 21969@end smallexample
d7b8e6c6
EZ
21970
21971Certain types of operations on selections are not allowed. For
21972example, for an arithmetic function like @kbd{-} no more than one of
21973the arguments may be a selected sub-formula. (As the above example
21974shows, the result of the subtraction is spliced back into the argument
21975which had the selection; if there were more than one selection involved,
21976this would not be well-defined.) If you try to subtract two selections,
21977the command will abort with an error message.
21978
21979Operations on sub-formulas sometimes leave the formula as a whole
21980in an ``un-natural'' state. Consider negating the @samp{2 x} term
21981of our sample formula by selecting it and pressing @kbd{n}
a4231b04 21982(@code{calc-change-sign}).
d7b8e6c6 21983
d7b8e6c6 21984@smallexample
5d67986c 21985@group
d7b8e6c6
EZ
21986 .. . .. .
219871* .......... 1* ...........
21988 ......... ..........
21989 . . . 2 x . . . -2 x
d7b8e6c6 21990@end group
5d67986c 21991@end smallexample
d7b8e6c6
EZ
21992
21993Unselecting the sub-formula reveals that the minus sign, which would
21994normally have cancelled out with the subtraction automatically, has
21995not been able to do so because the subtraction was not part of the
21996selected portion. Pressing @kbd{=} (@code{calc-evaluate}) or doing
21997any other mathematical operation on the whole formula will cause it
21998to be simplified.
21999
d7b8e6c6 22000@smallexample
5d67986c 22001@group
d7b8e6c6
EZ
22002 17 y 17 y
220031: ----------- 1: ----------
22004 __________ _________
22005 V 4 - -2 x V 4 + 2 x
d7b8e6c6 22006@end group
5d67986c 22007@end smallexample
d7b8e6c6
EZ
22008
22009@node Rearranging with Selections, , Operating on Selections, Selecting Subformulas
22010@subsection Rearranging Formulas using Selections
22011
22012@noindent
22013@kindex j R
22014@pindex calc-commute-right
22015The @kbd{j R} (@code{calc-commute-right}) command moves the selected
22016sub-formula to the right in its surrounding formula. Generally the
22017selection is one term of a sum or product; the sum or product is
22018rearranged according to the commutative laws of algebra.
22019
5d67986c 22020As with @kbd{j '} and @kbd{j @key{DEL}}, the term under the cursor is used
d7b8e6c6
EZ
22021if there is no selection in the current formula. All commands described
22022in this section share this property. In this example, we place the
22023cursor on the @samp{a} and type @kbd{j R}, then repeat.
22024
22025@smallexample
220261: a + b - c 1: b + a - c 1: b - c + a
22027@end smallexample
22028
22029@noindent
22030Note that in the final step above, the @samp{a} is switched with
22031the @samp{c} but the signs are adjusted accordingly. When moving
22032terms of sums and products, @kbd{j R} will never change the
22033mathematical meaning of the formula.
22034
22035The selected term may also be an element of a vector or an argument
22036of a function. The term is exchanged with the one to its right.
22037In this case, the ``meaning'' of the vector or function may of
22038course be drastically changed.
22039
22040@smallexample
220411: [a, b, c] 1: [b, a, c] 1: [b, c, a]
22042
220431: f(a, b, c) 1: f(b, a, c) 1: f(b, c, a)
22044@end smallexample
22045
22046@kindex j L
22047@pindex calc-commute-left
22048The @kbd{j L} (@code{calc-commute-left}) command is like @kbd{j R}
22049except that it swaps the selected term with the one to its left.
22050
22051With numeric prefix arguments, these commands move the selected
22052term several steps at a time. It is an error to try to move a
22053term left or right past the end of its enclosing formula.
22054With numeric prefix arguments of zero, these commands move the
22055selected term as far as possible in the given direction.
22056
22057@kindex j D
22058@pindex calc-sel-distribute
22059The @kbd{j D} (@code{calc-sel-distribute}) command mixes the selected
22060sum or product into the surrounding formula using the distributive
22061law. For example, in @samp{a * (b - c)} with the @samp{b - c}
22062selected, the result is @samp{a b - a c}. This also distributes
22063products or quotients into surrounding powers, and can also do
22064transformations like @samp{exp(a + b)} to @samp{exp(a) exp(b)},
22065where @samp{a + b} is the selected term, and @samp{ln(a ^ b)}
22066to @samp{ln(a) b}, where @samp{a ^ b} is the selected term.
22067
22068For multiple-term sums or products, @kbd{j D} takes off one term
22069at a time: @samp{a * (b + c - d)} goes to @samp{a * (c - d) + a b}
22070with the @samp{c - d} selected so that you can type @kbd{j D}
22071repeatedly to expand completely. The @kbd{j D} command allows a
22072numeric prefix argument which specifies the maximum number of
22073times to expand at once; the default is one time only.
22074
22075@vindex DistribRules
22076The @kbd{j D} command is implemented using rewrite rules.
22077@xref{Selections with Rewrite Rules}. The rules are stored in
22078the Calc variable @code{DistribRules}. A convenient way to view
22079these rules is to use @kbd{s e} (@code{calc-edit-variable}) which
33108698 22080displays and edits the stored value of a variable. Press @kbd{C-c C-c}
d7b8e6c6
EZ
22081to return from editing mode; be careful not to make any actual changes
22082or else you will affect the behavior of future @kbd{j D} commands!
22083
22084To extend @kbd{j D} to handle new cases, just edit @code{DistribRules}
22085as described above. You can then use the @kbd{s p} command to save
22086this variable's value permanently for future Calc sessions.
22087@xref{Operations on Variables}.
22088
22089@kindex j M
22090@pindex calc-sel-merge
22091@vindex MergeRules
22092The @kbd{j M} (@code{calc-sel-merge}) command is the complement
22093of @kbd{j D}; given @samp{a b - a c} with either @samp{a b} or
22094@samp{a c} selected, the result is @samp{a * (b - c)}. Once
22095again, @kbd{j M} can also merge calls to functions like @code{exp}
22096and @code{ln}; examine the variable @code{MergeRules} to see all
22097the relevant rules.
22098
22099@kindex j C
22100@pindex calc-sel-commute
22101@vindex CommuteRules
22102The @kbd{j C} (@code{calc-sel-commute}) command swaps the arguments
22103of the selected sum, product, or equation. It always behaves as
22104if @kbd{j b} mode were in effect, i.e., the sum @samp{a + b + c} is
22105treated as the nested sums @samp{(a + b) + c} by this command.
22106If you put the cursor on the first @samp{+}, the result is
22107@samp{(b + a) + c}; if you put the cursor on the second @samp{+}, the
22108result is @samp{c + (a + b)} (which the default simplifications
22109will rearrange to @samp{(c + a) + b}). The relevant rules are stored
22110in the variable @code{CommuteRules}.
22111
22112You may need to turn default simplifications off (with the @kbd{m O}
22113command) in order to get the full benefit of @kbd{j C}. For example,
22114commuting @samp{a - b} produces @samp{-b + a}, but the default
22115simplifications will ``simplify'' this right back to @samp{a - b} if
22116you don't turn them off. The same is true of some of the other
22117manipulations described in this section.
22118
22119@kindex j N
22120@pindex calc-sel-negate
22121@vindex NegateRules
22122The @kbd{j N} (@code{calc-sel-negate}) command replaces the selected
22123term with the negative of that term, then adjusts the surrounding
22124formula in order to preserve the meaning. For example, given
22125@samp{exp(a - b)} where @samp{a - b} is selected, the result is
22126@samp{1 / exp(b - a)}. By contrast, selecting a term and using the
22127regular @kbd{n} (@code{calc-change-sign}) command negates the
22128term without adjusting the surroundings, thus changing the meaning
22129of the formula as a whole. The rules variable is @code{NegateRules}.
22130
22131@kindex j &
22132@pindex calc-sel-invert
22133@vindex InvertRules
22134The @kbd{j &} (@code{calc-sel-invert}) command is similar to @kbd{j N}
22135except it takes the reciprocal of the selected term. For example,
22136given @samp{a - ln(b)} with @samp{b} selected, the result is
22137@samp{a + ln(1/b)}. The rules variable is @code{InvertRules}.
22138
22139@kindex j E
22140@pindex calc-sel-jump-equals
22141@vindex JumpRules
22142The @kbd{j E} (@code{calc-sel-jump-equals}) command moves the
22143selected term from one side of an equation to the other. Given
22144@samp{a + b = c + d} with @samp{c} selected, the result is
22145@samp{a + b - c = d}. This command also works if the selected
22146term is part of a @samp{*}, @samp{/}, or @samp{^} formula. The
22147relevant rules variable is @code{JumpRules}.
22148
22149@kindex j I
22150@kindex H j I
22151@pindex calc-sel-isolate
22152The @kbd{j I} (@code{calc-sel-isolate}) command isolates the
22153selected term on its side of an equation. It uses the @kbd{a S}
22154(@code{calc-solve-for}) command to solve the equation, and the
22155Hyperbolic flag affects it in the same way. @xref{Solving Equations}.
22156When it applies, @kbd{j I} is often easier to use than @kbd{j E}.
22157It understands more rules of algebra, and works for inequalities
22158as well as equations.
22159
22160@kindex j *
22161@kindex j /
22162@pindex calc-sel-mult-both-sides
22163@pindex calc-sel-div-both-sides
22164The @kbd{j *} (@code{calc-sel-mult-both-sides}) command prompts for a
22165formula using algebraic entry, then multiplies both sides of the
22166selected quotient or equation by that formula. It simplifies each
22167side with @kbd{a s} (@code{calc-simplify}) before re-forming the
22168quotient or equation. You can suppress this simplification by
22169providing any numeric prefix argument. There is also a @kbd{j /}
22170(@code{calc-sel-div-both-sides}) which is similar to @kbd{j *} but
22171dividing instead of multiplying by the factor you enter.
22172
22173As a special feature, if the numerator of the quotient is 1, then
22174the denominator is expanded at the top level using the distributive
22175law (i.e., using the @kbd{C-u -1 a x} command). Suppose the
22176formula on the stack is @samp{1 / (sqrt(a) + 1)}, and you wish
22177to eliminate the square root in the denominator by multiplying both
22178sides by @samp{sqrt(a) - 1}. Calc's default simplifications would
22179change the result @samp{(sqrt(a) - 1) / (sqrt(a) - 1) (sqrt(a) + 1)}
22180right back to the original form by cancellation; Calc expands the
22181denominator to @samp{sqrt(a) (sqrt(a) - 1) + sqrt(a) - 1} to prevent
22182this. (You would now want to use an @kbd{a x} command to expand
22183the rest of the way, whereupon the denominator would cancel out to
22184the desired form, @samp{a - 1}.) When the numerator is not 1, this
22185initial expansion is not necessary because Calc's default
22186simplifications will not notice the potential cancellation.
22187
22188If the selection is an inequality, @kbd{j *} and @kbd{j /} will
22189accept any factor, but will warn unless they can prove the factor
22190is either positive or negative. (In the latter case the direction
22191of the inequality will be switched appropriately.) @xref{Declarations},
22192for ways to inform Calc that a given variable is positive or
22193negative. If Calc can't tell for sure what the sign of the factor
22194will be, it will assume it is positive and display a warning
22195message.
22196
22197For selections that are not quotients, equations, or inequalities,
22198these commands pull out a multiplicative factor: They divide (or
22199multiply) by the entered formula, simplify, then multiply (or divide)
22200back by the formula.
22201
22202@kindex j +
22203@kindex j -
22204@pindex calc-sel-add-both-sides
22205@pindex calc-sel-sub-both-sides
22206The @kbd{j +} (@code{calc-sel-add-both-sides}) and @kbd{j -}
22207(@code{calc-sel-sub-both-sides}) commands analogously add to or
22208subtract from both sides of an equation or inequality. For other
22209types of selections, they extract an additive factor. A numeric
22210prefix argument suppresses simplification of the intermediate
22211results.
22212
22213@kindex j U
22214@pindex calc-sel-unpack
22215The @kbd{j U} (@code{calc-sel-unpack}) command replaces the
22216selected function call with its argument. For example, given
22217@samp{a + sin(x^2)} with @samp{sin(x^2)} selected, the result
22218is @samp{a + x^2}. (The @samp{x^2} will remain selected; if you
22219wanted to change the @code{sin} to @code{cos}, just press @kbd{C}
22220now to take the cosine of the selected part.)
22221
22222@kindex j v
22223@pindex calc-sel-evaluate
22224The @kbd{j v} (@code{calc-sel-evaluate}) command performs the
22225normal default simplifications on the selected sub-formula.
22226These are the simplifications that are normally done automatically
22227on all results, but which may have been partially inhibited by
22228previous selection-related operations, or turned off altogether
22229by the @kbd{m O} command. This command is just an auto-selecting
22230version of the @w{@kbd{a v}} command (@pxref{Algebraic Manipulation}).
22231
22232With a numeric prefix argument of 2, @kbd{C-u 2 j v} applies
22233the @kbd{a s} (@code{calc-simplify}) command to the selected
22234sub-formula. With a prefix argument of 3 or more, e.g., @kbd{C-u j v}
22235applies the @kbd{a e} (@code{calc-simplify-extended}) command.
22236@xref{Simplifying Formulas}. With a negative prefix argument
22237it simplifies at the top level only, just as with @kbd{a v}.
22238Here the ``top'' level refers to the top level of the selected
22239sub-formula.
22240
22241@kindex j "
22242@pindex calc-sel-expand-formula
22243The @kbd{j "} (@code{calc-sel-expand-formula}) command is to @kbd{a "}
22244(@pxref{Algebraic Manipulation}) what @kbd{j v} is to @kbd{a v}.
22245
22246You can use the @kbd{j r} (@code{calc-rewrite-selection}) command
22247to define other algebraic operations on sub-formulas. @xref{Rewrite Rules}.
22248
22249@node Algebraic Manipulation, Simplifying Formulas, Selecting Subformulas, Algebra
22250@section Algebraic Manipulation
22251
22252@noindent
22253The commands in this section perform general-purpose algebraic
22254manipulations. They work on the whole formula at the top of the
22255stack (unless, of course, you have made a selection in that
22256formula).
22257
22258Many algebra commands prompt for a variable name or formula. If you
22259answer the prompt with a blank line, the variable or formula is taken
22260from top-of-stack, and the normal argument for the command is taken
22261from the second-to-top stack level.
22262
22263@kindex a v
22264@pindex calc-alg-evaluate
22265The @kbd{a v} (@code{calc-alg-evaluate}) command performs the normal
22266default simplifications on a formula; for example, @samp{a - -b} is
22267changed to @samp{a + b}. These simplifications are normally done
22268automatically on all Calc results, so this command is useful only if
22269you have turned default simplifications off with an @kbd{m O}
22270command. @xref{Simplification Modes}.
22271
22272It is often more convenient to type @kbd{=}, which is like @kbd{a v}
22273but which also substitutes stored values for variables in the formula.
22274Use @kbd{a v} if you want the variables to ignore their stored values.
22275
22276If you give a numeric prefix argument of 2 to @kbd{a v}, it simplifies
07ce2eb3 22277as if in Algebraic Simplification mode. This is equivalent to typing
d7b8e6c6 22278@kbd{a s}; @pxref{Simplifying Formulas}. If you give a numeric prefix
07ce2eb3 22279of 3 or more, it uses Extended Simplification mode (@kbd{a e}).
d7b8e6c6 22280
8e04863e 22281If you give a negative prefix argument @mathit{-1}, @mathit{-2}, or @mathit{-3},
d7b8e6c6
EZ
22282it simplifies in the corresponding mode but only works on the top-level
22283function call of the formula. For example, @samp{(2 + 3) * (2 + 3)} will
22284simplify to @samp{(2 + 3)^2}, without simplifying the sub-formulas
22285@samp{2 + 3}. As another example, typing @kbd{V R +} to sum the vector
22286@samp{[1, 2, 3, 4]} produces the formula @samp{reduce(add, [1, 2, 3, 4])}
07ce2eb3 22287in No-Simplify mode. Using @kbd{a v} will evaluate this all the way to
d7b8e6c6
EZ
2228810; using @kbd{C-u - a v} will evaluate it only to @samp{1 + 2 + 3 + 4}.
22289(@xref{Reducing and Mapping}.)
22290
22291@tindex evalv
22292@tindex evalvn
22293The @kbd{=} command corresponds to the @code{evalv} function, and
22294the related @kbd{N} command, which is like @kbd{=} but temporarily
07ce2eb3 22295disables Symbolic mode (@kbd{m s}) during the evaluation, corresponds
d7b8e6c6
EZ
22296to the @code{evalvn} function. (These commands interpret their prefix
22297arguments differently than @kbd{a v}; @kbd{=} treats the prefix as
22298the number of stack elements to evaluate at once, and @kbd{N} treats
22299it as a temporary different working precision.)
22300
22301The @code{evalvn} function can take an alternate working precision
22302as an optional second argument. This argument can be either an
22303integer, to set the precision absolutely, or a vector containing
22304a single integer, to adjust the precision relative to the current
22305precision. Note that @code{evalvn} with a larger than current
22306precision will do the calculation at this higher precision, but the
22307result will as usual be rounded back down to the current precision
22308afterward. For example, @samp{evalvn(pi - 3.1415)} at a precision
22309of 12 will return @samp{9.265359e-5}; @samp{evalvn(pi - 3.1415, 30)}
22310will return @samp{9.26535897932e-5} (computing a 25-digit result which
22311is then rounded down to 12); and @samp{evalvn(pi - 3.1415, [-2])}
22312will return @samp{9.2654e-5}.
22313
22314@kindex a "
22315@pindex calc-expand-formula
22316The @kbd{a "} (@code{calc-expand-formula}) command expands functions
22317into their defining formulas wherever possible. For example,
22318@samp{deg(x^2)} is changed to @samp{180 x^2 / pi}. Most functions,
22319like @code{sin} and @code{gcd}, are not defined by simple formulas
22320and so are unaffected by this command. One important class of
22321functions which @emph{can} be expanded is the user-defined functions
22322created by the @kbd{Z F} command. @xref{Algebraic Definitions}.
22323Other functions which @kbd{a "} can expand include the probability
22324distribution functions, most of the financial functions, and the
22325hyperbolic and inverse hyperbolic functions. A numeric prefix argument
22326affects @kbd{a "} in the same way as it does @kbd{a v}: A positive
22327argument expands all functions in the formula and then simplifies in
22328various ways; a negative argument expands and simplifies only the
22329top-level function call.
22330
22331@kindex a M
22332@pindex calc-map-equation
22333@tindex mapeq
22334The @kbd{a M} (@code{calc-map-equation}) [@code{mapeq}] command applies
22335a given function or operator to one or more equations. It is analogous
22336to @kbd{V M}, which operates on vectors instead of equations.
22337@pxref{Reducing and Mapping}. For example, @kbd{a M S} changes
22338@samp{x = y+1} to @samp{sin(x) = sin(y+1)}, and @kbd{a M +} with
a4231b04 22339@samp{x = y+1} and @expr{6} on the stack produces @samp{x+6 = y+7}.
d7b8e6c6
EZ
22340With two equations on the stack, @kbd{a M +} would add the lefthand
22341sides together and the righthand sides together to get the two
22342respective sides of a new equation.
22343
22344Mapping also works on inequalities. Mapping two similar inequalities
22345produces another inequality of the same type. Mapping an inequality
22346with an equation produces an inequality of the same type. Mapping a
22347@samp{<=} with a @samp{<} or @samp{!=} (not-equal) produces a @samp{<}.
22348If inequalities with opposite direction (e.g., @samp{<} and @samp{>})
22349are mapped, the direction of the second inequality is reversed to
22350match the first: Using @kbd{a M +} on @samp{a < b} and @samp{a > 2}
22351reverses the latter to get @samp{2 < a}, which then allows the
22352combination @samp{a + 2 < b + a}, which the @kbd{a s} command can
22353then simplify to get @samp{2 < b}.
22354
22355Using @kbd{a M *}, @kbd{a M /}, @kbd{a M n}, or @kbd{a M &} to negate
22356or invert an inequality will reverse the direction of the inequality.
22357Other adjustments to inequalities are @emph{not} done automatically;
22358@kbd{a M S} will change @w{@samp{x < y}} to @samp{sin(x) < sin(y)} even
22359though this is not true for all values of the variables.
22360
22361@kindex H a M
22362@tindex mapeqp
22363With the Hyperbolic flag, @kbd{H a M} [@code{mapeqp}] does a plain
22364mapping operation without reversing the direction of any inequalities.
22365Thus, @kbd{H a M &} would change @kbd{x > 2} to @kbd{1/x > 0.5}.
22366(This change is mathematically incorrect, but perhaps you were
22367fixing an inequality which was already incorrect.)
22368
22369@kindex I a M
22370@tindex mapeqr
22371With the Inverse flag, @kbd{I a M} [@code{mapeqr}] always reverses
22372the direction of the inequality. You might use @kbd{I a M C} to
22373change @samp{x < y} to @samp{cos(x) > cos(y)} if you know you are
22374working with small positive angles.
22375
22376@kindex a b
22377@pindex calc-substitute
22378@tindex subst
22379The @kbd{a b} (@code{calc-substitute}) [@code{subst}] command substitutes
22380all occurrences
22381of some variable or sub-expression of an expression with a new
22382sub-expression. For example, substituting @samp{sin(x)} with @samp{cos(y)}
22383in @samp{2 sin(x)^2 + x sin(x) + sin(2 x)} produces
22384@samp{2 cos(y)^2 + x cos(y) + @w{sin(2 x)}}.
22385Note that this is a purely structural substitution; the lone @samp{x} and
22386the @samp{sin(2 x)} stayed the same because they did not look like
22387@samp{sin(x)}. @xref{Rewrite Rules}, for a more general method for
a4231b04 22388doing substitutions.
d7b8e6c6
EZ
22389
22390The @kbd{a b} command normally prompts for two formulas, the old
22391one and the new one. If you enter a blank line for the first
22392prompt, all three arguments are taken from the stack (new, then old,
22393then target expression). If you type an old formula but then enter a
22394blank line for the new one, the new formula is taken from top-of-stack
22395and the target from second-to-top. If you answer both prompts, the
22396target is taken from top-of-stack as usual.
22397
22398Note that @kbd{a b} has no understanding of commutativity or
22399associativity. The pattern @samp{x+y} will not match the formula
22400@samp{y+x}. Also, @samp{y+z} will not match inside the formula @samp{x+y+z}
22401because the @samp{+} operator is left-associative, so the ``deep
22402structure'' of that formula is @samp{(x+y) + z}. Use @kbd{d U}
22403(@code{calc-unformatted-language}) mode to see the true structure of
22404a formula. The rewrite rule mechanism, discussed later, does not have
22405these limitations.
22406
22407As an algebraic function, @code{subst} takes three arguments:
22408Target expression, old, new. Note that @code{subst} is always
22409evaluated immediately, even if its arguments are variables, so if
22410you wish to put a call to @code{subst} onto the stack you must
22411turn the default simplifications off first (with @kbd{m O}).
22412
22413@node Simplifying Formulas, Polynomials, Algebraic Manipulation, Algebra
22414@section Simplifying Formulas
22415
22416@noindent
22417@kindex a s
22418@pindex calc-simplify
22419@tindex simplify
22420The @kbd{a s} (@code{calc-simplify}) [@code{simplify}] command applies
22421various algebraic rules to simplify a formula. This includes rules which
22422are not part of the default simplifications because they may be too slow
22423to apply all the time, or may not be desirable all of the time. For
22424example, non-adjacent terms of sums are combined, as in @samp{a + b + 2 a}
22425to @samp{b + 3 a}, and some formulas like @samp{sin(arcsin(x))} are
22426simplified to @samp{x}.
22427
22428The sections below describe all the various kinds of algebraic
22429simplifications Calc provides in full detail. None of Calc's
22430simplification commands are designed to pull rabbits out of hats;
22431they simply apply certain specific rules to put formulas into
22432less redundant or more pleasing forms. Serious algebra in Calc
22433must be done manually, usually with a combination of selections
22434and rewrite rules. @xref{Rearranging with Selections}.
22435@xref{Rewrite Rules}.
22436
22437@xref{Simplification Modes}, for commands to control what level of
22438simplification occurs automatically. Normally only the ``default
22439simplifications'' occur.
22440
22441@menu
22442* Default Simplifications::
22443* Algebraic Simplifications::
22444* Unsafe Simplifications::
22445* Simplification of Units::
22446@end menu
22447
22448@node Default Simplifications, Algebraic Simplifications, Simplifying Formulas, Simplifying Formulas
22449@subsection Default Simplifications
22450
22451@noindent
22452@cindex Default simplifications
22453This section describes the ``default simplifications,'' those which are
22454normally applied to all results. For example, if you enter the variable
a4231b04
JB
22455@expr{x} on the stack twice and push @kbd{+}, Calc's default
22456simplifications automatically change @expr{x + x} to @expr{2 x}.
d7b8e6c6
EZ
22457
22458The @kbd{m O} command turns off the default simplifications, so that
a4231b04 22459@expr{x + x} will remain in this form unless you give an explicit
d7b8e6c6
EZ
22460``simplify'' command like @kbd{=} or @kbd{a v}. @xref{Algebraic
22461Manipulation}. The @kbd{m D} command turns the default simplifications
22462back on.
22463
22464The most basic default simplification is the evaluation of functions.
bd712b70 22465For example, @expr{2 + 3} is evaluated to @expr{5}, and @expr{@tfn{sqrt}(9)}
a4231b04 22466is evaluated to @expr{3}. Evaluation does not occur if the arguments
bd712b70
JB
22467to a function are somehow of the wrong type @expr{@tfn{tan}([2,3,4])}),
22468range (@expr{@tfn{tan}(90)}), or number (@expr{@tfn{tan}(3,5)}),
22469or if the function name is not recognized (@expr{@tfn{f}(5)}), or if
07ce2eb3 22470Symbolic mode (@pxref{Symbolic Mode}) prevents evaluation
bd712b70 22471(@expr{@tfn{sqrt}(2)}).
d7b8e6c6
EZ
22472
22473Calc simplifies (evaluates) the arguments to a function before it
bd712b70
JB
22474simplifies the function itself. Thus @expr{@tfn{sqrt}(5+4)} is
22475simplified to @expr{@tfn{sqrt}(9)} before the @code{sqrt} function
d7b8e6c6
EZ
22476itself is applied. There are very few exceptions to this rule:
22477@code{quote}, @code{lambda}, and @code{condition} (the @code{::}
22478operator) do not evaluate their arguments, @code{if} (the @code{? :}
22479operator) does not evaluate all of its arguments, and @code{evalto}
22480does not evaluate its lefthand argument.
22481
22482Most commands apply the default simplifications to all arguments they
22483take from the stack, perform a particular operation, then simplify
22484the result before pushing it back on the stack. In the common special
22485case of regular arithmetic commands like @kbd{+} and @kbd{Q} [@code{sqrt}],
22486the arguments are simply popped from the stack and collected into a
22487suitable function call, which is then simplified (the arguments being
22488simplified first as part of the process, as described above).
22489
22490The default simplifications are too numerous to describe completely
22491here, but this section will describe the ones that apply to the
22492major arithmetic operators. This list will be rather technical in
22493nature, and will probably be interesting to you only if you are
22494a serious user of Calc's algebra facilities.
22495
22496@tex
22497\bigskip
22498@end tex
22499
22500As well as the simplifications described here, if you have stored
22501any rewrite rules in the variable @code{EvalRules} then these rules
22502will also be applied before any built-in default simplifications.
22503@xref{Automatic Rewrites}, for details.
22504
22505@tex
22506\bigskip
22507@end tex
22508
22509And now, on with the default simplifications:
22510
22511Arithmetic operators like @kbd{+} and @kbd{*} always take two
22512arguments in Calc's internal form. Sums and products of three or
22513more terms are arranged by the associative law of algebra into
a4231b04
JB
22514a left-associative form for sums, @expr{((a + b) + c) + d}, and
22515a right-associative form for products, @expr{a * (b * (c * d))}.
22516Formulas like @expr{(a + b) + (c + d)} are rearranged to
d7b8e6c6
EZ
22517left-associative form, though this rarely matters since Calc's
22518algebra commands are designed to hide the inner structure of
22519sums and products as much as possible. Sums and products in
22520their proper associative form will be written without parentheses
22521in the examples below.
22522
22523Sums and products are @emph{not} rearranged according to the
a4231b04 22524commutative law (@expr{a + b} to @expr{b + a}) except in a few
d7b8e6c6
EZ
22525special cases described below. Some algebra programs always
22526rearrange terms into a canonical order, which enables them to
a4231b04 22527see that @expr{a b + b a} can be simplified to @expr{2 a b}.
d7b8e6c6
EZ
22528Calc assumes you have put the terms into the order you want
22529and generally leaves that order alone, with the consequence
22530that formulas like the above will only be simplified if you
22531explicitly give the @kbd{a s} command. @xref{Algebraic
22532Simplifications}.
22533
a4231b04 22534Differences @expr{a - b} are treated like sums @expr{a + (-b)}
d7b8e6c6 22535for purposes of simplification; one of the default simplifications
a4231b04
JB
22536is to rewrite @expr{a + (-b)} or @expr{(-b) + a}, where @expr{-b}
22537represents a ``negative-looking'' term, into @expr{a - b} form.
d7b8e6c6 22538``Negative-looking'' means negative numbers, negated formulas like
a4231b04 22539@expr{-x}, and products or quotients in which either term is
d7b8e6c6
EZ
22540negative-looking.
22541
a4231b04
JB
22542Other simplifications involving negation are @expr{-(-x)} to @expr{x};
22543@expr{-(a b)} or @expr{-(a/b)} where either @expr{a} or @expr{b} is
d7b8e6c6 22544negative-looking, simplified by negating that term, or else where
a4231b04
JB
22545@expr{a} or @expr{b} is any number, by negating that number;
22546@expr{-(a + b)} to @expr{-a - b}, and @expr{-(b - a)} to @expr{a - b}.
22547(This, and rewriting @expr{(-b) + a} to @expr{a - b}, are the only
d7b8e6c6
EZ
22548cases where the order of terms in a sum is changed by the default
22549simplifications.)
22550
22551The distributive law is used to simplify sums in some cases:
a4231b04 22552@expr{a x + b x} to @expr{(a + b) x}, where @expr{a} represents
8e04863e 22553a number or an implicit 1 or @mathit{-1} (as in @expr{x} or @expr{-x})
a4231b04 22554and similarly for @expr{b}. Use the @kbd{a c}, @w{@kbd{a f}}, or
d7b8e6c6
EZ
22555@kbd{j M} commands to merge sums with non-numeric coefficients
22556using the distributive law.
22557
22558The distributive law is only used for sums of two terms, or
a4231b04
JB
22559for adjacent terms in a larger sum. Thus @expr{a + b + b + c}
22560is simplified to @expr{a + 2 b + c}, but @expr{a + b + c + b}
d7b8e6c6
EZ
22561is not simplified. The reason is that comparing all terms of a
22562sum with one another would require time proportional to the
22563square of the number of terms; Calc relegates potentially slow
22564operations like this to commands that have to be invoked
22565explicitly, like @kbd{a s}.
22566
a4231b04
JB
22567Finally, @expr{a + 0} and @expr{0 + a} are simplified to @expr{a}.
22568A consequence of the above rules is that @expr{0 - a} is simplified
22569to @expr{-a}.
d7b8e6c6
EZ
22570
22571@tex
22572\bigskip
22573@end tex
22574
a4231b04
JB
22575The products @expr{1 a} and @expr{a 1} are simplified to @expr{a};
22576@expr{(-1) a} and @expr{a (-1)} are simplified to @expr{-a};
22577@expr{0 a} and @expr{a 0} are simplified to @expr{0}, except that
07ce2eb3 22578in Matrix mode where @expr{a} is not provably scalar the result
a4231b04 22579is the generic zero matrix @samp{idn(0)}, and that if @expr{a} is
d7b8e6c6
EZ
22580infinite the result is @samp{nan}.
22581
a4231b04 22582Also, @expr{(-a) b} and @expr{a (-b)} are simplified to @expr{-(a b)},
d7b8e6c6
EZ
22583where this occurs for negated formulas but not for regular negative
22584numbers.
22585
22586Products are commuted only to move numbers to the front:
a4231b04 22587@expr{a b 2} is commuted to @expr{2 a b}.
d7b8e6c6 22588
a4231b04
JB
22589The product @expr{a (b + c)} is distributed over the sum only if
22590@expr{a} and at least one of @expr{b} and @expr{c} are numbers:
22591@expr{2 (x + 3)} goes to @expr{2 x + 6}. The formula
22592@expr{(-a) (b - c)}, where @expr{-a} is a negative number, is
22593rewritten to @expr{a (c - b)}.
d7b8e6c6
EZ
22594
22595The distributive law of products and powers is used for adjacent
a4231b04 22596terms of the product: @expr{x^a x^b} goes to
8e04863e 22597@texline @math{x^{a+b}}
a4231b04
JB
22598@infoline @expr{x^(a+b)}
22599where @expr{a} is a number, or an implicit 1 (as in @expr{x}),
bd712b70 22600or the implicit one-half of @expr{@tfn{sqrt}(x)}, and similarly for
a4231b04
JB
22601@expr{b}. The result is written using @samp{sqrt} or @samp{1/sqrt}
22602if the sum of the powers is @expr{1/2} or @expr{-1/2}, respectively.
d7b8e6c6 22603If the sum of the powers is zero, the product is simplified to
07ce2eb3 22604@expr{1} or to @samp{idn(1)} if Matrix mode is enabled.
d7b8e6c6
EZ
22605
22606The product of a negative power times anything but another negative
a4231b04 22607power is changed to use division:
8e04863e 22608@texline @math{x^{-2} y}
a4231b04 22609@infoline @expr{x^(-2) y}
07ce2eb3 22610goes to @expr{y / x^2} unless Matrix mode is
a4231b04 22611in effect and neither @expr{x} nor @expr{y} are scalar (in which
d7b8e6c6
EZ
22612case it is considered unsafe to rearrange the order of the terms).
22613
a4231b04 22614Finally, @expr{a (b/c)} is rewritten to @expr{(a b)/c}, and also
07ce2eb3 22615@expr{(a/b) c} is changed to @expr{(a c)/b} unless in Matrix mode.
d7b8e6c6
EZ
22616
22617@tex
22618\bigskip
22619@end tex
22620
22621Simplifications for quotients are analogous to those for products.
a4231b04
JB
22622The quotient @expr{0 / x} is simplified to @expr{0}, with the same
22623exceptions that were noted for @expr{0 x}. Likewise, @expr{x / 1}
22624and @expr{x / (-1)} are simplified to @expr{x} and @expr{-x},
d7b8e6c6
EZ
22625respectively.
22626
a4231b04 22627The quotient @expr{x / 0} is left unsimplified or changed to an
d7b8e6c6
EZ
22628infinite quantity, as directed by the current infinite mode.
22629@xref{Infinite Mode}.
22630
a4231b04 22631The expression
8e04863e 22632@texline @math{a / b^{-c}}
a4231b04
JB
22633@infoline @expr{a / b^(-c)}
22634is changed to @expr{a b^c}, where @expr{-c} is any negative-looking
22635power. Also, @expr{1 / b^c} is changed to
8e04863e 22636@texline @math{b^{-c}}
a4231b04
JB
22637@infoline @expr{b^(-c)}
22638for any power @expr{c}.
22639
22640Also, @expr{(-a) / b} and @expr{a / (-b)} go to @expr{-(a/b)};
22641@expr{(a/b) / c} goes to @expr{a / (b c)}; and @expr{a / (b/c)}
07ce2eb3 22642goes to @expr{(a c) / b} unless Matrix mode prevents this
a4231b04
JB
22643rearrangement. Similarly, @expr{a / (b:c)} is simplified to
22644@expr{(c:b) a} for any fraction @expr{b:c}.
22645
22646The distributive law is applied to @expr{(a + b) / c} only if
22647@expr{c} and at least one of @expr{a} and @expr{b} are numbers.
d7b8e6c6
EZ
22648Quotients of powers and square roots are distributed just as
22649described for multiplication.
22650
22651Quotients of products cancel only in the leading terms of the
a4231b04
JB
22652numerator and denominator. In other words, @expr{a x b / a y b}
22653is cancelled to @expr{x b / y b} but not to @expr{x / y}. Once
d7b8e6c6
EZ
22654again this is because full cancellation can be slow; use @kbd{a s}
22655to cancel all terms of the quotient.
22656
22657Quotients of negative-looking values are simplified according
a4231b04
JB
22658to @expr{(-a) / (-b)} to @expr{a / b}, @expr{(-a) / (b - c)}
22659to @expr{a / (c - b)}, and @expr{(a - b) / (-c)} to @expr{(b - a) / c}.
d7b8e6c6
EZ
22660
22661@tex
22662\bigskip
22663@end tex
22664
a4231b04 22665The formula @expr{x^0} is simplified to @expr{1}, or to @samp{idn(1)}
07ce2eb3 22666in Matrix mode. The formula @expr{0^x} is simplified to @expr{0}
f317f9ca
JB
22667unless @expr{x} is a negative number, complex number or zero.
22668If @expr{x} is negative, complex or @expr{0.0}, @expr{0^x} is an
22669infinity or an unsimplified formula according to the current infinite
22670mode. The expression @expr{0^0} is simplified to @expr{1}.
a4231b04
JB
22671
22672Powers of products or quotients @expr{(a b)^c}, @expr{(a/b)^c}
22673are distributed to @expr{a^c b^c}, @expr{a^c / b^c} only if @expr{c}
22674is an integer, or if either @expr{a} or @expr{b} are nonnegative
22675real numbers. Powers of powers @expr{(a^b)^c} are simplified to
8e04863e 22676@texline @math{a^{b c}}
a4231b04
JB
22677@infoline @expr{a^(b c)}
22678only when @expr{c} is an integer and @expr{b c} also
d7b8e6c6
EZ
22679evaluates to an integer. Without these restrictions these simplifications
22680would not be safe because of problems with principal values.
a4231b04 22681(In other words,
8e04863e 22682@texline @math{((-3)^{1/2})^2}
a4231b04
JB
22683@infoline @expr{((-3)^1:2)^2}
22684is safe to simplify, but
8e04863e 22685@texline @math{((-3)^2)^{1/2}}
a4231b04
JB
22686@infoline @expr{((-3)^2)^1:2}
22687is not.) @xref{Declarations}, for ways to inform Calc that your
22688variables satisfy these requirements.
22689
bd712b70 22690As a special case of this rule, @expr{@tfn{sqrt}(x)^n} is simplified to
8e04863e 22691@texline @math{x^{n/2}}
a4231b04
JB
22692@infoline @expr{x^(n/2)}
22693only for even integers @expr{n}.
22694
22695If @expr{a} is known to be real, @expr{b} is an even integer, and
22696@expr{c} is a half- or quarter-integer, then @expr{(a^b)^c} is
bd712b70 22697simplified to @expr{@tfn{abs}(a^(b c))}.
a4231b04
JB
22698
22699Also, @expr{(-a)^b} is simplified to @expr{a^b} if @expr{b} is an
22700even integer, or to @expr{-(a^b)} if @expr{b} is an odd integer,
22701for any negative-looking expression @expr{-a}.
22702
bd712b70 22703Square roots @expr{@tfn{sqrt}(x)} generally act like one-half powers
8e04863e 22704@texline @math{x^{1:2}}
a4231b04
JB
22705@infoline @expr{x^1:2}
22706for the purposes of the above-listed simplifications.
22707
22708Also, note that
8e04863e 22709@texline @math{1 / x^{1:2}}
a4231b04
JB
22710@infoline @expr{1 / x^1:2}
22711is changed to
8e04863e 22712@texline @math{x^{-1:2}},
a4231b04 22713@infoline @expr{x^(-1:2)},
bd712b70 22714but @expr{1 / @tfn{sqrt}(x)} is left alone.
d7b8e6c6
EZ
22715
22716@tex
22717\bigskip
22718@end tex
22719
22720Generic identity matrices (@pxref{Matrix Mode}) are simplified by the
bd712b70 22721following rules: @expr{@tfn{idn}(a) + b} to @expr{a + b} if @expr{b}
a4231b04 22722is provably scalar, or expanded out if @expr{b} is a matrix;
bd712b70
JB
22723@expr{@tfn{idn}(a) + @tfn{idn}(b)} to @expr{@tfn{idn}(a + b)};
22724@expr{-@tfn{idn}(a)} to @expr{@tfn{idn}(-a)}; @expr{a @tfn{idn}(b)} to
22725@expr{@tfn{idn}(a b)} if @expr{a} is provably scalar, or to @expr{a b}
22726if @expr{a} is provably non-scalar; @expr{@tfn{idn}(a) @tfn{idn}(b)} to
22727@expr{@tfn{idn}(a b)}; analogous simplifications for quotients involving
22728@code{idn}; and @expr{@tfn{idn}(a)^n} to @expr{@tfn{idn}(a^n)} where
a4231b04 22729@expr{n} is an integer.
d7b8e6c6
EZ
22730
22731@tex
22732\bigskip
22733@end tex
22734
22735The @code{floor} function and other integer truncation functions
22736vanish if the argument is provably integer-valued, so that
bd712b70 22737@expr{@tfn{floor}(@tfn{round}(x))} simplifies to @expr{@tfn{round}(x)}.
d7b8e6c6
EZ
22738Also, combinations of @code{float}, @code{floor} and its friends,
22739and @code{ffloor} and its friends, are simplified in appropriate
22740ways. @xref{Integer Truncation}.
22741
bd712b70
JB
22742The expression @expr{@tfn{abs}(-x)} changes to @expr{@tfn{abs}(x)}.
22743The expression @expr{@tfn{abs}(@tfn{abs}(x))} changes to
22744@expr{@tfn{abs}(x)}; in fact, @expr{@tfn{abs}(x)} changes to @expr{x} or
a4231b04
JB
22745@expr{-x} if @expr{x} is provably nonnegative or nonpositive
22746(@pxref{Declarations}).
d7b8e6c6
EZ
22747
22748While most functions do not recognize the variable @code{i} as an
22749imaginary number, the @code{arg} function does handle the two cases
bd712b70 22750@expr{@tfn{arg}(@tfn{i})} and @expr{@tfn{arg}(-@tfn{i})} just for convenience.
d7b8e6c6 22751
bd712b70 22752The expression @expr{@tfn{conj}(@tfn{conj}(x))} simplifies to @expr{x}.
d7b8e6c6
EZ
22753Various other expressions involving @code{conj}, @code{re}, and
22754@code{im} are simplified, especially if some of the arguments are
22755provably real or involve the constant @code{i}. For example,
bd712b70
JB
22756@expr{@tfn{conj}(a + b i)} is changed to
22757@expr{@tfn{conj}(a) - @tfn{conj}(b) i}, or to @expr{a - b i} if @expr{a}
a4231b04 22758and @expr{b} are known to be real.
d7b8e6c6
EZ
22759
22760Functions like @code{sin} and @code{arctan} generally don't have
22761any default simplifications beyond simply evaluating the functions
22762for suitable numeric arguments and infinity. The @kbd{a s} command
22763described in the next section does provide some simplifications for
22764these functions, though.
22765
a4231b04 22766One important simplification that does occur is that
bd712b70 22767@expr{@tfn{ln}(@tfn{e})} is simplified to 1, and @expr{@tfn{ln}(@tfn{e}^x)} is
a4231b04
JB
22768simplified to @expr{x} for any @expr{x}. This occurs even if you have
22769stored a different value in the Calc variable @samp{e}; but this would
22770be a bad idea in any case if you were also using natural logarithms!
d7b8e6c6 22771
8305d012 22772Among the logical functions, @tfn{!(@var{a} <= @var{b})} changes to
bd712b70 22773@tfn{@var{a} > @var{b}} and so on. Equations and inequalities where both sides
d7b8e6c6
EZ
22774are either negative-looking or zero are simplified by negating both sides
22775and reversing the inequality. While it might seem reasonable to simplify
a4231b04
JB
22776@expr{!!x} to @expr{x}, this would not be valid in general because
22777@expr{!!2} is 1, not 2.
d7b8e6c6
EZ
22778
22779Most other Calc functions have few if any default simplifications
22780defined, aside of course from evaluation when the arguments are
22781suitable numbers.
22782
22783@node Algebraic Simplifications, Unsafe Simplifications, Default Simplifications, Simplifying Formulas
22784@subsection Algebraic Simplifications
22785
22786@noindent
22787@cindex Algebraic simplifications
22788The @kbd{a s} command makes simplifications that may be too slow to
22789do all the time, or that may not be desirable all of the time.
22790If you find these simplifications are worthwhile, you can type
22791@kbd{m A} to have Calc apply them automatically.
22792
22793This section describes all simplifications that are performed by
22794the @kbd{a s} command. Note that these occur in addition to the
22795default simplifications; even if the default simplifications have
22796been turned off by an @kbd{m O} command, @kbd{a s} will turn them
22797back on temporarily while it simplifies the formula.
22798
22799There is a variable, @code{AlgSimpRules}, in which you can put rewrites
22800to be applied by @kbd{a s}. Its use is analogous to @code{EvalRules},
22801but without the special restrictions. Basically, the simplifier does
22802@samp{@w{a r} AlgSimpRules} with an infinite repeat count on the whole
22803expression being simplified, then it traverses the expression applying
22804the built-in rules described below. If the result is different from
22805the original expression, the process repeats with the default
22806simplifications (including @code{EvalRules}), then @code{AlgSimpRules},
22807then the built-in simplifications, and so on.
22808
22809@tex
22810\bigskip
22811@end tex
22812
22813Sums are simplified in two ways. Constant terms are commuted to the
a4231b04 22814end of the sum, so that @expr{a + 2 + b} changes to @expr{a + b + 2}.
d7b8e6c6 22815The only exception is that a constant will not be commuted away
a4231b04
JB
22816from the first position of a difference, i.e., @expr{2 - x} is not
22817commuted to @expr{-x + 2}.
d7b8e6c6
EZ
22818
22819Also, terms of sums are combined by the distributive law, as in
a4231b04 22820@expr{x + y + 2 x} to @expr{y + 3 x}. This always occurs for
d7b8e6c6
EZ
22821adjacent terms, but @kbd{a s} compares all pairs of terms including
22822non-adjacent ones.
22823
22824@tex
22825\bigskip
22826@end tex
22827
22828Products are sorted into a canonical order using the commutative
a4231b04 22829law. For example, @expr{b c a} is commuted to @expr{a b c}.
d7b8e6c6 22830This allows easier comparison of products; for example, the default
a4231b04
JB
22831simplifications will not change @expr{x y + y x} to @expr{2 x y},
22832but @kbd{a s} will; it first rewrites the sum to @expr{x y + x y},
d7b8e6c6
EZ
22833and then the default simplifications are able to recognize a sum
22834of identical terms.
22835
22836The canonical ordering used to sort terms of products has the
22837property that real-valued numbers, interval forms and infinities
22838come first, and are sorted into increasing order. The @kbd{V S}
22839command uses the same ordering when sorting a vector.
22840
07ce2eb3 22841Sorting of terms of products is inhibited when Matrix mode is
d7b8e6c6
EZ
22842turned on; in this case, Calc will never exchange the order of
22843two terms unless it knows at least one of the terms is a scalar.
22844
22845Products of powers are distributed by comparing all pairs of
22846terms, using the same method that the default simplifications
22847use for adjacent terms of products.
22848
22849Even though sums are not sorted, the commutative law is still
22850taken into account when terms of a product are being compared.
a4231b04
JB
22851Thus @expr{(x + y) (y + x)} will be simplified to @expr{(x + y)^2}.
22852A subtle point is that @expr{(x - y) (y - x)} will @emph{not}
22853be simplified to @expr{-(x - y)^2}; Calc does not notice that
d7b8e6c6 22854one term can be written as a constant times the other, even if
8e04863e 22855that constant is @mathit{-1}.
d7b8e6c6 22856
a4231b04
JB
22857A fraction times any expression, @expr{(a:b) x}, is changed to
22858a quotient involving integers: @expr{a x / b}. This is not
22859done for floating-point numbers like @expr{0.5}, however. This
d7b8e6c6
EZ
22860is one reason why you may find it convenient to turn Fraction mode
22861on while doing algebra; @pxref{Fraction Mode}.
22862
22863@tex
22864\bigskip
22865@end tex
22866
22867Quotients are simplified by comparing all terms in the numerator
22868with all terms in the denominator for possible cancellation using
a4231b04 22869the distributive law. For example, @expr{a x^2 b / c x^3 d} will
029b2a44 22870cancel @expr{x^2} from the top and bottom to get @expr{a b / c x d}.
a4231b04 22871(The terms in the denominator will then be rearranged to @expr{c d x}
d7b8e6c6
EZ
22872as described above.) If there is any common integer or fractional
22873factor in the numerator and denominator, it is cancelled out;
a4231b04 22874for example, @expr{(4 x + 6) / 8 x} simplifies to @expr{(2 x + 3) / 4 x}.
d7b8e6c6
EZ
22875
22876Non-constant common factors are not found even by @kbd{a s}. To
a4231b04
JB
22877cancel the factor @expr{a} in @expr{(a x + a) / a^2} you could first
22878use @kbd{j M} on the product @expr{a x} to Merge the numerator to
22879@expr{a (1+x)}, which can then be simplified successfully.
d7b8e6c6
EZ
22880
22881@tex
22882\bigskip
22883@end tex
22884
22885Integer powers of the variable @code{i} are simplified according
a4231b04
JB
22886to the identity @expr{i^2 = -1}. If you store a new value other
22887than the complex number @expr{(0,1)} in @code{i}, this simplification
d7b8e6c6
EZ
22888will no longer occur. This is done by @kbd{a s} instead of by default
22889in case someone (unwisely) uses the name @code{i} for a variable
22890unrelated to complex numbers; it would be unfortunate if Calc
22891quietly and automatically changed this formula for reasons the
22892user might not have been thinking of.
22893
22894Square roots of integer or rational arguments are simplified in
22895several ways. (Note that these will be left unevaluated only in
22896Symbolic mode.) First, square integer or rational factors are
bd712b70
JB
22897pulled out so that @expr{@tfn{sqrt}(8)} is rewritten as
22898@texline @math{2\,@tfn{sqrt}(2)}.
a4231b04
JB
22899@infoline @expr{2 sqrt(2)}.
22900Conceptually speaking this implies factoring the argument into primes
22901and moving pairs of primes out of the square root, but for reasons of
22902efficiency Calc only looks for primes up to 29.
d7b8e6c6
EZ
22903
22904Square roots in the denominator of a quotient are moved to the
bd712b70 22905numerator: @expr{1 / @tfn{sqrt}(3)} changes to @expr{@tfn{sqrt}(3) / 3}.
d7b8e6c6 22906The same effect occurs for the square root of a fraction:
bd712b70 22907@expr{@tfn{sqrt}(2:3)} changes to @expr{@tfn{sqrt}(6) / 3}.
d7b8e6c6
EZ
22908
22909@tex
22910\bigskip
22911@end tex
22912
22913The @code{%} (modulo) operator is simplified in several ways
a4231b04
JB
22914when the modulus @expr{M} is a positive real number. First, if
22915the argument is of the form @expr{x + n} for some real number
22916@expr{n}, then @expr{n} is itself reduced modulo @expr{M}. For
d7b8e6c6
EZ
22917example, @samp{(x - 23) % 10} is simplified to @samp{(x + 7) % 10}.
22918
22919If the argument is multiplied by a constant, and this constant
22920has a common integer divisor with the modulus, then this factor is
22921cancelled out. For example, @samp{12 x % 15} is changed to
22922@samp{3 (4 x % 5)} by factoring out 3. Also, @samp{(12 x + 1) % 15}
22923is changed to @samp{3 ((4 x + 1:3) % 5)}. While these forms may
22924not seem ``simpler,'' they allow Calc to discover useful information
22925about modulo forms in the presence of declarations.
22926
22927If the modulus is 1, then Calc can use @code{int} declarations to
22928evaluate the expression. For example, the idiom @samp{x % 2} is
22929often used to check whether a number is odd or even. As described
22930above, @w{@samp{2 n % 2}} and @samp{(2 n + 1) % 2} are simplified to
22931@samp{2 (n % 1)} and @samp{2 ((n + 1:2) % 1)}, respectively; Calc
22932can simplify these to 0 and 1 (respectively) if @code{n} has been
22933declared to be an integer.
22934
22935@tex
22936\bigskip
22937@end tex
22938
31c912fc
JB
22939Trigonometric functions are simplified in several ways. Whenever a
22940products of two trigonometric functions can be replaced by a single
22941function, the replacement is made; for example,
22942@expr{@tfn{tan}(x) @tfn{cos}(x)} is simplified to @expr{@tfn{sin}(x)}.
22943Reciprocals of trigonometric functions are replaced by their reciprocal
22944function; for example, @expr{1/@tfn{sec}(x)} is simplified to
22945@expr{@tfn{cos}(x)}. The corresponding simplifications for the
22946hyperbolic functions are also handled.
22947
22948Trigonometric functions of their inverse functions are
22949simplified. The expression @expr{@tfn{sin}(@tfn{arcsin}(x))} is
22950simplified to @expr{x}, and similarly for @code{cos} and @code{tan}.
d7b8e6c6 22951Trigonometric functions of inverses of different trigonometric
bd712b70
JB
22952functions can also be simplified, as in @expr{@tfn{sin}(@tfn{arccos}(x))}
22953to @expr{@tfn{sqrt}(1 - x^2)}.
d7b8e6c6 22954
31c912fc
JB
22955If the argument to @code{sin} is negative-looking, it is simplified to
22956@expr{-@tfn{sin}(x)}, and similarly for @code{cos} and @code{tan}.
22957Finally, certain special values of the argument are recognized;
22958@pxref{Trigonometric and Hyperbolic Functions}.
22959
d7b8e6c6
EZ
22960Hyperbolic functions of their inverses and of negative-looking
22961arguments are also handled, as are exponentials of inverse
22962hyperbolic functions.
22963
22964No simplifications for inverse trigonometric and hyperbolic
22965functions are known, except for negative arguments of @code{arcsin},
22966@code{arctan}, @code{arcsinh}, and @code{arctanh}. Note that
bd712b70 22967@expr{@tfn{arcsin}(@tfn{sin}(x))} can @emph{not} safely change to
a4231b04 22968@expr{x}, since this only correct within an integer multiple of
8e04863e 22969@texline @math{2 \pi}
a4231b04 22970@infoline @expr{2 pi}
bd712b70 22971radians or 360 degrees. However, @expr{@tfn{arcsinh}(@tfn{sinh}(x))} is
a4231b04 22972simplified to @expr{x} if @expr{x} is known to be real.
d7b8e6c6
EZ
22973
22974Several simplifications that apply to logarithms and exponentials
bd712b70
JB
22975are that @expr{@tfn{exp}(@tfn{ln}(x))},
22976@texline @tfn{e}@math{^{\ln(x)}},
22977@infoline @expr{e^@tfn{ln}(x)},
a4231b04 22978and
8e04863e 22979@texline @math{10^{{\rm log10}(x)}}
bd712b70
JB
22980@infoline @expr{10^@tfn{log10}(x)}
22981all reduce to @expr{x}. Also, @expr{@tfn{ln}(@tfn{exp}(x))}, etc., can
a4231b04 22982reduce to @expr{x} if @expr{x} is provably real. The form
bd712b70 22983@expr{@tfn{exp}(x)^y} is simplified to @expr{@tfn{exp}(x y)}. If @expr{x}
a4231b04 22984is a suitable multiple of
8e04863e 22985@texline @math{\pi i}
a4231b04
JB
22986@infoline @expr{pi i}
22987(as described above for the trigonometric functions), then
bd712b70
JB
22988@expr{@tfn{exp}(x)} or @expr{e^x} will be expanded. Finally,
22989@expr{@tfn{ln}(x)} is simplified to a form involving @code{pi} and
a4231b04
JB
22990@code{i} where @expr{x} is provably negative, positive imaginary, or
22991negative imaginary.
d7b8e6c6
EZ
22992
22993The error functions @code{erf} and @code{erfc} are simplified when
22994their arguments are negative-looking or are calls to the @code{conj}
22995function.
22996
22997@tex
22998\bigskip
22999@end tex
23000
23001Equations and inequalities are simplified by cancelling factors
23002of products, quotients, or sums on both sides. Inequalities
23003change sign if a negative multiplicative factor is cancelled.
a4231b04 23004Non-constant multiplicative factors as in @expr{a b = a c} are
d7b8e6c6
EZ
23005cancelled from equations only if they are provably nonzero (generally
23006because they were declared so; @pxref{Declarations}). Factors
23007are cancelled from inequalities only if they are nonzero and their
23008sign is known.
23009
23010Simplification also replaces an equation or inequality with
230111 or 0 (``true'' or ``false'') if it can through the use of
a4231b04
JB
23012declarations. If @expr{x} is declared to be an integer greater
23013than 5, then @expr{x < 3}, @expr{x = 3}, and @expr{x = 7.5} are
23014all simplified to 0, but @expr{x > 3} is simplified to 1.
23015By a similar analysis, @expr{abs(x) >= 0} is simplified to 1,
23016as is @expr{x^2 >= 0} if @expr{x} is known to be real.
d7b8e6c6
EZ
23017
23018@node Unsafe Simplifications, Simplification of Units, Algebraic Simplifications, Simplifying Formulas
23019@subsection ``Unsafe'' Simplifications
23020
23021@noindent
23022@cindex Unsafe simplifications
23023@cindex Extended simplification
23024@kindex a e
23025@pindex calc-simplify-extended
5d67986c
RS
23026@ignore
23027@mindex esimpl@idots
23028@end ignore
d7b8e6c6
EZ
23029@tindex esimplify
23030The @kbd{a e} (@code{calc-simplify-extended}) [@code{esimplify}] command
23031is like @kbd{a s}
23032except that it applies some additional simplifications which are not
23033``safe'' in all cases. Use this only if you know the values in your
23034formula lie in the restricted ranges for which these simplifications
23035are valid. The symbolic integrator uses @kbd{a e};
23036one effect of this is that the integrator's results must be used with
23037caution. Where an integral table will often attach conditions like
a4231b04
JB
23038``for positive @expr{a} only,'' Calc (like most other symbolic
23039integration programs) will simply produce an unqualified result.
d7b8e6c6
EZ
23040
23041Because @kbd{a e}'s simplifications are unsafe, it is sometimes better
23042to type @kbd{C-u -3 a v}, which does extended simplification only
23043on the top level of the formula without affecting the sub-formulas.
23044In fact, @kbd{C-u -3 j v} allows you to target extended simplification
23045to any specific part of a formula.
23046
23047The variable @code{ExtSimpRules} contains rewrites to be applied by
23048the @kbd{a e} command. These are applied in addition to
23049@code{EvalRules} and @code{AlgSimpRules}. (The @kbd{a r AlgSimpRules}
23050step described above is simply followed by an @kbd{a r ExtSimpRules} step.)
23051
23052Following is a complete list of ``unsafe'' simplifications performed
23053by @kbd{a e}.
23054
23055@tex
23056\bigskip
23057@end tex
23058
23059Inverse trigonometric or hyperbolic functions, called with their
23060corresponding non-inverse functions as arguments, are simplified
bd712b70
JB
23061by @kbd{a e}. For example, @expr{@tfn{arcsin}(@tfn{sin}(x))} changes
23062to @expr{x}. Also, @expr{@tfn{arcsin}(@tfn{cos}(x))} and
23063@expr{@tfn{arccos}(@tfn{sin}(x))} both change to @expr{@tfn{pi}/2 - x}.
d7b8e6c6 23064These simplifications are unsafe because they are valid only for
a4231b04 23065values of @expr{x} in a certain range; outside that range, values
d7b8e6c6
EZ
23066are folded down to the 360-degree range that the inverse trigonometric
23067functions always produce.
23068
a4231b04 23069Powers of powers @expr{(x^a)^b} are simplified to
8e04863e 23070@texline @math{x^{a b}}
a4231b04
JB
23071@infoline @expr{x^(a b)}
23072for all @expr{a} and @expr{b}. These results will be valid only
23073in a restricted range of @expr{x}; for example, in
8e04863e 23074@texline @math{(x^2)^{1:2}}
a4231b04
JB
23075@infoline @expr{(x^2)^1:2}
23076the powers cancel to get @expr{x}, which is valid for positive values
23077of @expr{x} but not for negative or complex values.
23078
bd712b70 23079Similarly, @expr{@tfn{sqrt}(x^a)} and @expr{@tfn{sqrt}(x)^a} are both
a4231b04 23080simplified (possibly unsafely) to
8e04863e 23081@texline @math{x^{a/2}}.
a4231b04
JB
23082@infoline @expr{x^(a/2)}.
23083
bd712b70
JB
23084Forms like @expr{@tfn{sqrt}(1 - sin(x)^2)} are simplified to, e.g.,
23085@expr{@tfn{cos}(x)}. Calc has identities of this sort for @code{sin},
d7b8e6c6
EZ
23086@code{cos}, @code{tan}, @code{sinh}, and @code{cosh}.
23087
23088Arguments of square roots are partially factored to look for
23089squared terms that can be extracted. For example,
bd712b70
JB
23090@expr{@tfn{sqrt}(a^2 b^3 + a^3 b^2)} simplifies to
23091@expr{a b @tfn{sqrt}(a+b)}.
d7b8e6c6 23092
bd712b70
JB
23093The simplifications of @expr{@tfn{ln}(@tfn{exp}(x))},
23094@expr{@tfn{ln}(@tfn{e}^x)}, and @expr{@tfn{log10}(10^x)} to @expr{x} are also
a4231b04
JB
23095unsafe because of problems with principal values (although these
23096simplifications are safe if @expr{x} is known to be real).
d7b8e6c6
EZ
23097
23098Common factors are cancelled from products on both sides of an
a4231b04
JB
23099equation, even if those factors may be zero: @expr{a x / b x}
23100to @expr{a / b}. Such factors are never cancelled from
d7b8e6c6 23101inequalities: Even @kbd{a e} is not bold enough to reduce
a4231b04
JB
23102@expr{a x < b x} to @expr{a < b} (or @expr{a > b}, depending
23103on whether you believe @expr{x} is positive or negative).
d7b8e6c6
EZ
23104The @kbd{a M /} command can be used to divide a factor out of
23105both sides of an inequality.
23106
23107@node Simplification of Units, , Unsafe Simplifications, Simplifying Formulas
23108@subsection Simplification of Units
23109
23110@noindent
23111The simplifications described in this section are applied by the
23112@kbd{u s} (@code{calc-simplify-units}) command. These are in addition
23113to the regular @kbd{a s} (but not @kbd{a e}) simplifications described
23114earlier. @xref{Basic Operations on Units}.
23115
23116The variable @code{UnitSimpRules} contains rewrites to be applied by
23117the @kbd{u s} command. These are applied in addition to @code{EvalRules}
23118and @code{AlgSimpRules}.
23119
23120Scalar mode is automatically put into effect when simplifying units.
23121@xref{Matrix Mode}.
23122
a4231b04
JB
23123Sums @expr{a + b} involving units are simplified by extracting the
23124units of @expr{a} as if by the @kbd{u x} command (call the result
23125@expr{u_a}), then simplifying the expression @expr{b / u_a}
d7b8e6c6
EZ
23126using @kbd{u b} and @kbd{u s}. If the result has units then the sum
23127is inconsistent and is left alone. Otherwise, it is rewritten
a4231b04 23128in terms of the units @expr{u_a}.
d7b8e6c6
EZ
23129
23130If units auto-ranging mode is enabled, products or quotients in
23131which the first argument is a number which is out of range for the
23132leading unit are modified accordingly.
23133
23134When cancelling and combining units in products and quotients,
23135Calc accounts for unit names that differ only in the prefix letter.
23136For example, @samp{2 km m} is simplified to @samp{2000 m^2}.
23137However, compatible but different units like @code{ft} and @code{in}
23138are not combined in this way.
23139
a4231b04
JB
23140Quotients @expr{a / b} are simplified in three additional ways. First,
23141if @expr{b} is a number or a product beginning with a number, Calc
d7b8e6c6
EZ
23142computes the reciprocal of this number and moves it to the numerator.
23143
23144Second, for each pair of unit names from the numerator and denominator
23145of a quotient, if the units are compatible (e.g., they are both
23146units of area) then they are replaced by the ratio between those
23147units. For example, in @samp{3 s in N / kg cm} the units
a4231b04 23148@samp{in / cm} will be replaced by @expr{2.54}.
d7b8e6c6
EZ
23149
23150Third, if the units in the quotient exactly cancel out, so that
23151a @kbd{u b} command on the quotient would produce a dimensionless
23152number for an answer, then the quotient simplifies to that number.
23153
23154For powers and square roots, the ``unsafe'' simplifications
a4231b04
JB
23155@expr{(a b)^c} to @expr{a^c b^c}, @expr{(a/b)^c} to @expr{a^c / b^c},
23156and @expr{(a^b)^c} to
8e04863e 23157@texline @math{a^{b c}}
a4231b04
JB
23158@infoline @expr{a^(b c)}
23159are done if the powers are real numbers. (These are safe in the context
23160of units because all numbers involved can reasonably be assumed to be
23161real.)
d7b8e6c6
EZ
23162
23163Also, if a unit name is raised to a fractional power, and the
23164base units in that unit name all occur to powers which are a
23165multiple of the denominator of the power, then the unit name
23166is expanded out into its base units, which can then be simplified
23167according to the previous paragraph. For example, @samp{acre^1.5}
a4231b04 23168is simplified by noting that @expr{1.5 = 3:2}, that @samp{acre}
d7b8e6c6 23169is defined in terms of @samp{m^2}, and that the 2 in the power of
a4231b04
JB
23170@code{m} is a multiple of 2 in @expr{3:2}. Thus, @code{acre^1.5} is
23171replaced by approximately
8e04863e 23172@texline @math{(4046 m^2)^{1.5}}
a4231b04
JB
23173@infoline @expr{(4046 m^2)^1.5},
23174which is then changed to
8e04863e 23175@texline @math{4046^{1.5} \, (m^2)^{1.5}},
a4231b04
JB
23176@infoline @expr{4046^1.5 (m^2)^1.5},
23177then to @expr{257440 m^3}.
d7b8e6c6
EZ
23178
23179The functions @code{float}, @code{frac}, @code{clean}, @code{abs},
23180as well as @code{floor} and the other integer truncation functions,
23181applied to unit names or products or quotients involving units, are
23182simplified. For example, @samp{round(1.6 in)} is changed to
23183@samp{round(1.6) round(in)}; the lefthand term evaluates to 2,
23184and the righthand term simplifies to @code{in}.
23185
23186The functions @code{sin}, @code{cos}, and @code{tan} with arguments
23187that have angular units like @code{rad} or @code{arcmin} are
23188simplified by converting to base units (radians), then evaluating
23189with the angular mode temporarily set to radians.
23190
23191@node Polynomials, Calculus, Simplifying Formulas, Algebra
23192@section Polynomials
23193
23194A @dfn{polynomial} is a sum of terms which are coefficients times
a4231b04
JB
23195various powers of a ``base'' variable. For example, @expr{2 x^2 + 3 x - 4}
23196is a polynomial in @expr{x}. Some formulas can be considered
23197polynomials in several different variables: @expr{1 + 2 x + 3 y + 4 x y^2}
23198is a polynomial in both @expr{x} and @expr{y}. Polynomial coefficients
d7b8e6c6
EZ
23199are often numbers, but they may in general be any formulas not
23200involving the base variable.
23201
23202@kindex a f
23203@pindex calc-factor
23204@tindex factor
23205The @kbd{a f} (@code{calc-factor}) [@code{factor}] command factors a
23206polynomial into a product of terms. For example, the polynomial
a4231b04
JB
23207@expr{x^3 + 2 x^2 + x} is factored into @samp{x*(x+1)^2}. As another
23208example, @expr{a c + b d + b c + a d} is factored into the product
23209@expr{(a + b) (c + d)}.
d7b8e6c6
EZ
23210
23211Calc currently has three algorithms for factoring. Formulas which are
23212linear in several variables, such as the second example above, are
23213merged according to the distributive law. Formulas which are
23214polynomials in a single variable, with constant integer or fractional
23215coefficients, are factored into irreducible linear and/or quadratic
23216terms. The first example above factors into three linear terms
a4231b04 23217(@expr{x}, @expr{x+1}, and @expr{x+1} again). Finally, formulas
d7b8e6c6
EZ
23218which do not fit the above criteria are handled by the algebraic
23219rewrite mechanism.
23220
23221Calc's polynomial factorization algorithm works by using the general
23222root-finding command (@w{@kbd{a P}}) to solve for the roots of the
23223polynomial. It then looks for roots which are rational numbers
23224or complex-conjugate pairs, and converts these into linear and
23225quadratic terms, respectively. Because it uses floating-point
23226arithmetic, it may be unable to find terms that involve large
23227integers (whose number of digits approaches the current precision).
23228Also, irreducible factors of degree higher than quadratic are not
23229found, and polynomials in more than one variable are not treated.
23230(A more robust factorization algorithm may be included in a future
23231version of Calc.)
23232
23233@vindex FactorRules
5d67986c
RS
23234@ignore
23235@starindex
23236@end ignore
d7b8e6c6 23237@tindex thecoefs
5d67986c
RS
23238@ignore
23239@starindex
23240@end ignore
23241@ignore
23242@mindex @idots
23243@end ignore
d7b8e6c6
EZ
23244@tindex thefactors
23245The rewrite-based factorization method uses rules stored in the variable
23246@code{FactorRules}. @xref{Rewrite Rules}, for a discussion of the
23247operation of rewrite rules. The default @code{FactorRules} are able
23248to factor quadratic forms symbolically into two linear terms,
a4231b04 23249@expr{(a x + b) (c x + d)}. You can edit these rules to include other
d7b8e6c6
EZ
23250cases if you wish. To use the rules, Calc builds the formula
23251@samp{thecoefs(x, [a, b, c, ...])} where @code{x} is the polynomial
23252base variable and @code{a}, @code{b}, etc., are polynomial coefficients
23253(which may be numbers or formulas). The constant term is written first,
23254i.e., in the @code{a} position. When the rules complete, they should have
23255changed the formula into the form @samp{thefactors(x, [f1, f2, f3, ...])}
23256where each @code{fi} should be a factored term, e.g., @samp{x - ai}.
23257Calc then multiplies these terms together to get the complete
23258factored form of the polynomial. If the rules do not change the
23259@code{thecoefs} call to a @code{thefactors} call, @kbd{a f} leaves the
23260polynomial alone on the assumption that it is unfactorable. (Note that
23261the function names @code{thecoefs} and @code{thefactors} are used only
23262as placeholders; there are no actual Calc functions by those names.)
23263
23264@kindex H a f
23265@tindex factors
23266The @kbd{H a f} [@code{factors}] command also factors a polynomial,
23267but it returns a list of factors instead of an expression which is the
23268product of the factors. Each factor is represented by a sub-vector
23269of the factor, and the power with which it appears. For example,
a4231b04
JB
23270@expr{x^5 + x^4 - 33 x^3 + 63 x^2} factors to @expr{(x + 7) x^2 (x - 3)^2}
23271in @kbd{a f}, or to @expr{[ [x, 2], [x+7, 1], [x-3, 2] ]} in @kbd{H a f}.
d7b8e6c6
EZ
23272If there is an overall numeric factor, it always comes first in the list.
23273The functions @code{factor} and @code{factors} allow a second argument
a4231b04
JB
23274when written in algebraic form; @samp{factor(x,v)} factors @expr{x} with
23275respect to the specific variable @expr{v}. The default is to factor with
23276respect to all the variables that appear in @expr{x}.
d7b8e6c6
EZ
23277
23278@kindex a c
23279@pindex calc-collect
23280@tindex collect
23281The @kbd{a c} (@code{calc-collect}) [@code{collect}] command rearranges a
23282formula as a
23283polynomial in a given variable, ordered in decreasing powers of that
a4231b04
JB
23284variable. For example, given @expr{1 + 2 x + 3 y + 4 x y^2} on
23285the stack, @kbd{a c x} would produce @expr{(2 + 4 y^2) x + (1 + 3 y)},
23286and @kbd{a c y} would produce @expr{(4 x) y^2 + 3 y + (1 + 2 x)}.
d7b8e6c6 23287The polynomial will be expanded out using the distributive law as
a4231b04
JB
23288necessary: Collecting @expr{x} in @expr{(x - 1)^3} produces
23289@expr{x^3 - 3 x^2 + 3 x - 1}. Terms not involving @expr{x} will
d7b8e6c6
EZ
23290not be expanded.
23291
23292The ``variable'' you specify at the prompt can actually be any
23293expression: @kbd{a c ln(x+1)} will collect together all terms multiplied
23294by @samp{ln(x+1)} or integer powers thereof. If @samp{x} also appears
23295in the formula in a context other than @samp{ln(x+1)}, @kbd{a c} will
23296treat those occurrences as unrelated to @samp{ln(x+1)}, i.e., as constants.
23297
23298@kindex a x
23299@pindex calc-expand
23300@tindex expand
23301The @kbd{a x} (@code{calc-expand}) [@code{expand}] command expands an
23302expression by applying the distributive law everywhere. It applies to
23303products, quotients, and powers involving sums. By default, it fully
23304distributes all parts of the expression. With a numeric prefix argument,
23305the distributive law is applied only the specified number of times, then
23306the partially expanded expression is left on the stack.
23307
23308The @kbd{a x} and @kbd{j D} commands are somewhat redundant. Use
23309@kbd{a x} if you want to expand all products of sums in your formula.
23310Use @kbd{j D} if you want to expand a particular specified term of
23311the formula. There is an exactly analogous correspondence between
23312@kbd{a f} and @kbd{j M}. (The @kbd{j D} and @kbd{j M} commands
23313also know many other kinds of expansions, such as
23314@samp{exp(a + b) = exp(a) exp(b)}, which @kbd{a x} and @kbd{a f}
23315do not do.)
23316
23317Calc's automatic simplifications will sometimes reverse a partial
a4231b04
JB
23318expansion. For example, the first step in expanding @expr{(x+1)^3} is
23319to write @expr{(x+1) (x+1)^2}. If @kbd{a x} stops there and tries
d7b8e6c6 23320to put this formula onto the stack, though, Calc will automatically
a4231b04 23321simplify it back to @expr{(x+1)^3} form. The solution is to turn
d7b8e6c6
EZ
23322simplification off first (@pxref{Simplification Modes}), or to run
23323@kbd{a x} without a numeric prefix argument so that it expands all
23324the way in one step.
23325
23326@kindex a a
23327@pindex calc-apart
23328@tindex apart
23329The @kbd{a a} (@code{calc-apart}) [@code{apart}] command expands a
23330rational function by partial fractions. A rational function is the
23331quotient of two polynomials; @code{apart} pulls this apart into a
23332sum of rational functions with simple denominators. In algebraic
23333notation, the @code{apart} function allows a second argument that
23334specifies which variable to use as the ``base''; by default, Calc
23335chooses the base variable automatically.
23336
23337@kindex a n
23338@pindex calc-normalize-rat
23339@tindex nrat
23340The @kbd{a n} (@code{calc-normalize-rat}) [@code{nrat}] command
23341attempts to arrange a formula into a quotient of two polynomials.
a4231b04
JB
23342For example, given @expr{1 + (a + b/c) / d}, the result would be
23343@expr{(b + a c + c d) / c d}. The quotient is reduced, so that
23344@kbd{a n} will simplify @expr{(x^2 + 2x + 1) / (x^2 - 1)} by dividing
23345out the common factor @expr{x + 1}, yielding @expr{(x + 1) / (x - 1)}.
d7b8e6c6
EZ
23346
23347@kindex a \
23348@pindex calc-poly-div
23349@tindex pdiv
23350The @kbd{a \} (@code{calc-poly-div}) [@code{pdiv}] command divides
a4231b04
JB
23351two polynomials @expr{u} and @expr{v}, yielding a new polynomial
23352@expr{q}. If several variables occur in the inputs, the inputs are
d7b8e6c6 23353considered multivariate polynomials. (Calc divides by the variable
a4231b04 23354with the largest power in @expr{u} first, or, in the case of equal
d7b8e6c6 23355powers, chooses the variables in alphabetical order.) For example,
a4231b04 23356dividing @expr{x^2 + 3 x + 2} by @expr{x + 2} yields @expr{x + 1}.
d7b8e6c6
EZ
23357The remainder from the division, if any, is reported at the bottom
23358of the screen and is also placed in the Trail along with the quotient.
23359
23360Using @code{pdiv} in algebraic notation, you can specify the particular
5d67986c 23361variable to be used as the base: @code{pdiv(@var{a},@var{b},@var{x})}.
d7b8e6c6
EZ
23362If @code{pdiv} is given only two arguments (as is always the case with
23363the @kbd{a \} command), then it does a multivariate division as outlined
23364above.
23365
23366@kindex a %
23367@pindex calc-poly-rem
23368@tindex prem
23369The @kbd{a %} (@code{calc-poly-rem}) [@code{prem}] command divides
a4231b04
JB
23370two polynomials and keeps the remainder @expr{r}. The quotient
23371@expr{q} is discarded. For any formulas @expr{a} and @expr{b}, the
23372results of @kbd{a \} and @kbd{a %} satisfy @expr{a = q b + r}.
d7b8e6c6
EZ
23373(This is analogous to plain @kbd{\} and @kbd{%}, which compute the
23374integer quotient and remainder from dividing two numbers.)
23375
23376@kindex a /
23377@kindex H a /
23378@pindex calc-poly-div-rem
23379@tindex pdivrem
23380@tindex pdivide
23381The @kbd{a /} (@code{calc-poly-div-rem}) [@code{pdivrem}] command
23382divides two polynomials and reports both the quotient and the
a4231b04 23383remainder as a vector @expr{[q, r]}. The @kbd{H a /} [@code{pdivide}]
d7b8e6c6 23384command divides two polynomials and constructs the formula
a4231b04
JB
23385@expr{q + r/b} on the stack. (Naturally if the remainder is zero,
23386this will immediately simplify to @expr{q}.)
d7b8e6c6
EZ
23387
23388@kindex a g
23389@pindex calc-poly-gcd
23390@tindex pgcd
23391The @kbd{a g} (@code{calc-poly-gcd}) [@code{pgcd}] command computes
23392the greatest common divisor of two polynomials. (The GCD actually
23393is unique only to within a constant multiplier; Calc attempts to
23394choose a GCD which will be unsurprising.) For example, the @kbd{a n}
23395command uses @kbd{a g} to take the GCD of the numerator and denominator
23396of a quotient, then divides each by the result using @kbd{a \}. (The
23397definition of GCD ensures that this division can take place without
23398leaving a remainder.)
23399
23400While the polynomials used in operations like @kbd{a /} and @kbd{a g}
23401often have integer coefficients, this is not required. Calc can also
23402deal with polynomials over the rationals or floating-point reals.
23403Polynomials with modulo-form coefficients are also useful in many
23404applications; if you enter @samp{(x^2 + 3 x - 1) mod 5}, Calc
23405automatically transforms this into a polynomial over the field of
23406integers mod 5: @samp{(1 mod 5) x^2 + (3 mod 5) x + (4 mod 5)}.
23407
23408Congratulations and thanks go to Ove Ewerlid
23409(@code{ewerlid@@mizar.DoCS.UU.SE}), who contributed many of the
23410polynomial routines used in the above commands.
23411
23412@xref{Decomposing Polynomials}, for several useful functions for
23413extracting the individual coefficients of a polynomial.
23414
23415@node Calculus, Solving Equations, Polynomials, Algebra
23416@section Calculus
23417
23418@noindent
23419The following calculus commands do not automatically simplify their
23420inputs or outputs using @code{calc-simplify}. You may find it helps
23421to do this by hand by typing @kbd{a s} or @kbd{a e}. It may also help
23422to use @kbd{a x} and/or @kbd{a c} to arrange a result in the most
23423readable way.
23424
23425@menu
23426* Differentiation::
23427* Integration::
23428* Customizing the Integrator::
23429* Numerical Integration::
23430* Taylor Series::
23431@end menu
23432
23433@node Differentiation, Integration, Calculus, Calculus
23434@subsection Differentiation
23435
23436@noindent
23437@kindex a d
23438@kindex H a d
23439@pindex calc-derivative
23440@tindex deriv
23441@tindex tderiv
23442The @kbd{a d} (@code{calc-derivative}) [@code{deriv}] command computes
23443the derivative of the expression on the top of the stack with respect to
23444some variable, which it will prompt you to enter. Normally, variables
23445in the formula other than the specified differentiation variable are
23446considered constant, i.e., @samp{deriv(y,x)} is reduced to zero. With
23447the Hyperbolic flag, the @code{tderiv} (total derivative) operation is used
23448instead, in which derivatives of variables are not reduced to zero
23449unless those variables are known to be ``constant,'' i.e., independent
23450of any other variables. (The built-in special variables like @code{pi}
23451are considered constant, as are variables that have been declared
23452@code{const}; @pxref{Declarations}.)
23453
23454With a numeric prefix argument @var{n}, this command computes the
23455@var{n}th derivative.
23456
23457When working with trigonometric functions, it is best to switch to
07ce2eb3 23458Radians mode first (with @w{@kbd{m r}}). The derivative of @samp{sin(x)}
d7b8e6c6
EZ
23459in degrees is @samp{(pi/180) cos(x)}, probably not the expected
23460answer!
23461
23462If you use the @code{deriv} function directly in an algebraic formula,
23463you can write @samp{deriv(f,x,x0)} which represents the derivative
a4231b04 23464of @expr{f} with respect to @expr{x}, evaluated at the point
8e04863e 23465@texline @math{x=x_0}.
a4231b04 23466@infoline @expr{x=x0}.
d7b8e6c6
EZ
23467
23468If the formula being differentiated contains functions which Calc does
23469not know, the derivatives of those functions are produced by adding
23470primes (apostrophe characters). For example, @samp{deriv(f(2x), x)}
23471produces @samp{2 f'(2 x)}, where the function @code{f'} represents the
23472derivative of @code{f}.
23473
23474For functions you have defined with the @kbd{Z F} command, Calc expands
23475the functions according to their defining formulas unless you have
23476also defined @code{f'} suitably. For example, suppose we define
23477@samp{sinc(x) = sin(x)/x} using @kbd{Z F}. If we then differentiate
23478the formula @samp{sinc(2 x)}, the formula will be expanded to
23479@samp{sin(2 x) / (2 x)} and differentiated. However, if we also
23480define @samp{sinc'(x) = dsinc(x)}, say, then Calc will write the
23481result as @samp{2 dsinc(2 x)}. @xref{Algebraic Definitions}.
23482
23483For multi-argument functions @samp{f(x,y,z)}, the derivative with respect
23484to the first argument is written @samp{f'(x,y,z)}; derivatives with
23485respect to the other arguments are @samp{f'2(x,y,z)} and @samp{f'3(x,y,z)}.
23486Various higher-order derivatives can be formed in the obvious way, e.g.,
23487@samp{f'@var{}'(x)} (the second derivative of @code{f}) or
23488@samp{f'@var{}'2'3(x,y,z)} (@code{f} differentiated with respect to each
a4231b04 23489argument once).
d7b8e6c6
EZ
23490
23491@node Integration, Customizing the Integrator, Differentiation, Calculus
23492@subsection Integration
23493
23494@noindent
23495@kindex a i
23496@pindex calc-integral
23497@tindex integ
23498The @kbd{a i} (@code{calc-integral}) [@code{integ}] command computes the
23499indefinite integral of the expression on the top of the stack with
23500respect to a variable. The integrator is not guaranteed to work for
23501all integrable functions, but it is able to integrate several large
23502classes of formulas. In particular, any polynomial or rational function
23503(a polynomial divided by a polynomial) is acceptable. (Rational functions
a4231b04 23504don't have to be in explicit quotient form, however;
8e04863e 23505@texline @math{x/(1+x^{-2})}
a4231b04 23506@infoline @expr{x/(1+x^-2)}
d7b8e6c6 23507is not strictly a quotient of polynomials, but it is equivalent to
a4231b04
JB
23508@expr{x^3/(x^2+1)}, which is.) Also, square roots of terms involving
23509@expr{x} and @expr{x^2} may appear in rational functions being
d7b8e6c6
EZ
23510integrated. Finally, rational functions involving trigonometric or
23511hyperbolic functions can be integrated.
23512
23513@ifinfo
23514If you use the @code{integ} function directly in an algebraic formula,
23515you can also write @samp{integ(f,x,v)} which expresses the resulting
23516indefinite integral in terms of variable @code{v} instead of @code{x}.
23517With four arguments, @samp{integ(f(x),x,a,b)} represents a definite
23518integral from @code{a} to @code{b}.
23519@end ifinfo
177c0ea7 23520@tex
d7b8e6c6
EZ
23521If you use the @code{integ} function directly in an algebraic formula,
23522you can also write @samp{integ(f,x,v)} which expresses the resulting
23523indefinite integral in terms of variable @code{v} instead of @code{x}.
23524With four arguments, @samp{integ(f(x),x,a,b)} represents a definite
23525integral $\int_a^b f(x) \, dx$.
23526@end tex
23527
23528Please note that the current implementation of Calc's integrator sometimes
23529produces results that are significantly more complex than they need to
a4231b04 23530be. For example, the integral Calc finds for
8e04863e 23531@texline @math{1/(x+\sqrt{x^2+1})}
a4231b04 23532@infoline @expr{1/(x+sqrt(x^2+1))}
d7b8e6c6
EZ
23533is several times more complicated than the answer Mathematica
23534returns for the same input, although the two forms are numerically
23535equivalent. Also, any indefinite integral should be considered to have
23536an arbitrary constant of integration added to it, although Calc does not
23537write an explicit constant of integration in its result. For example,
a4231b04 23538Calc's solution for
8e04863e 23539@texline @math{1/(1+\tan x)}
a4231b04
JB
23540@infoline @expr{1/(1+tan(x))}
23541differs from the solution given in the @emph{CRC Math Tables} by a
23542constant factor of
8e04863e 23543@texline @math{\pi i / 2}
a4231b04 23544@infoline @expr{pi i / 2},
d7b8e6c6
EZ
23545due to a different choice of constant of integration.
23546
23547The Calculator remembers all the integrals it has done. If conditions
23548change in a way that would invalidate the old integrals, say, a switch
07ce2eb3 23549from Degrees to Radians mode, then they will be thrown out. If you
d7b8e6c6
EZ
23550suspect this is not happening when it should, use the
23551@code{calc-flush-caches} command; @pxref{Caches}.
23552
23553@vindex IntegLimit
23554Calc normally will pursue integration by substitution or integration by
23555parts up to 3 nested times before abandoning an approach as fruitless.
23556If the integrator is taking too long, you can lower this limit by storing
23557a number (like 2) in the variable @code{IntegLimit}. (The @kbd{s I}
23558command is a convenient way to edit @code{IntegLimit}.) If this variable
23559has no stored value or does not contain a nonnegative integer, a limit
23560of 3 is used. The lower this limit is, the greater the chance that Calc
23561will be unable to integrate a function it could otherwise handle. Raising
23562this limit allows the Calculator to solve more integrals, though the time
23563it takes may grow exponentially. You can monitor the integrator's actions
23564by creating an Emacs buffer called @code{*Trace*}. If such a buffer
23565exists, the @kbd{a i} command will write a log of its actions there.
23566
23567If you want to manipulate integrals in a purely symbolic way, you can
23568set the integration nesting limit to 0 to prevent all but fast
23569table-lookup solutions of integrals. You might then wish to define
23570rewrite rules for integration by parts, various kinds of substitutions,
23571and so on. @xref{Rewrite Rules}.
23572
23573@node Customizing the Integrator, Numerical Integration, Integration, Calculus
23574@subsection Customizing the Integrator
23575
23576@noindent
23577@vindex IntegRules
23578Calc has two built-in rewrite rules called @code{IntegRules} and
23579@code{IntegAfterRules} which you can edit to define new integration
23580methods. @xref{Rewrite Rules}. At each step of the integration process,
23581Calc wraps the current integrand in a call to the fictitious function
23582@samp{integtry(@var{expr},@var{var})}, where @var{expr} is the
23583integrand and @var{var} is the integration variable. If your rules
23584rewrite this to be a plain formula (not a call to @code{integtry}), then
23585Calc will use this formula as the integral of @var{expr}. For example,
23586the rule @samp{integtry(mysin(x),x) := -mycos(x)} would define a rule to
23587integrate a function @code{mysin} that acts like the sine function.
23588Then, putting @samp{4 mysin(2y+1)} on the stack and typing @kbd{a i y}
23589will produce the integral @samp{-2 mycos(2y+1)}. Note that Calc has
23590automatically made various transformations on the integral to allow it
23591to use your rule; integral tables generally give rules for
23592@samp{mysin(a x + b)}, but you don't need to use this much generality
23593in your @code{IntegRules}.
23594
23595@cindex Exponential integral Ei(x)
5d67986c
RS
23596@ignore
23597@starindex
23598@end ignore
d7b8e6c6
EZ
23599@tindex Ei
23600As a more serious example, the expression @samp{exp(x)/x} cannot be
23601integrated in terms of the standard functions, so the ``exponential
a4231b04 23602integral'' function
8e04863e 23603@texline @math{{\rm Ei}(x)}
a4231b04
JB
23604@infoline @expr{Ei(x)}
23605was invented to describe it.
d7b8e6c6
EZ
23606We can get Calc to do this integral in terms of a made-up @code{Ei}
23607function by adding the rule @samp{[integtry(exp(x)/x, x) := Ei(x)]}
23608to @code{IntegRules}. Now entering @samp{exp(2x)/x} on the stack
23609and typing @kbd{a i x} yields @samp{Ei(2 x)}. This new rule will
23610work with Calc's various built-in integration methods (such as
23611integration by substitution) to solve a variety of other problems
23612involving @code{Ei}: For example, now Calc will also be able to
23613integrate @samp{exp(exp(x))} and @samp{ln(ln(x))} (to get @samp{Ei(exp(x))}
23614and @samp{x ln(ln(x)) - Ei(ln(x))}, respectively).
23615
23616Your rule may do further integration by calling @code{integ}. For
23617example, @samp{integtry(twice(u),x) := twice(integ(u))} allows Calc
23618to integrate @samp{twice(sin(x))} to get @samp{twice(-cos(x))}.
23619Note that @code{integ} was called with only one argument. This notation
23620is allowed only within @code{IntegRules}; it means ``integrate this
23621with respect to the same integration variable.'' If Calc is unable
23622to integrate @code{u}, the integration that invoked @code{IntegRules}
23623also fails. Thus integrating @samp{twice(f(x))} fails, returning the
2cbd16b9 23624unevaluated integral @samp{integ(twice(f(x)), x)}. It is still valid
d7b8e6c6
EZ
23625to call @code{integ} with two or more arguments, however; in this case,
23626if @code{u} is not integrable, @code{twice} itself will still be
23627integrated: If the above rule is changed to @samp{... := twice(integ(u,x))},
23628then integrating @samp{twice(f(x))} will yield @samp{twice(integ(f(x),x))}.
23629
23630If a rule instead produces the formula @samp{integsubst(@var{sexpr},
23631@var{svar})}, either replacing the top-level @code{integtry} call or
23632nested anywhere inside the expression, then Calc will apply the
23633substitution @samp{@var{u} = @var{sexpr}(@var{svar})} to try to
23634integrate the original @var{expr}. For example, the rule
23635@samp{sqrt(a) := integsubst(sqrt(x),x)} says that if Calc ever finds
23636a square root in the integrand, it should attempt the substitution
23637@samp{u = sqrt(x)}. (This particular rule is unnecessary because
23638Calc always tries ``obvious'' substitutions where @var{sexpr} actually
23639appears in the integrand.) The variable @var{svar} may be the same
23640as the @var{var} that appeared in the call to @code{integtry}, but
23641it need not be.
23642
23643When integrating according to an @code{integsubst}, Calc uses the
23644equation solver to find the inverse of @var{sexpr} (if the integrand
23645refers to @var{var} anywhere except in subexpressions that exactly
23646match @var{sexpr}). It uses the differentiator to find the derivative
23647of @var{sexpr} and/or its inverse (it has two methods that use one
23648derivative or the other). You can also specify these items by adding
23649extra arguments to the @code{integsubst} your rules construct; the
23650general form is @samp{integsubst(@var{sexpr}, @var{svar}, @var{sinv},
23651@var{sprime})}, where @var{sinv} is the inverse of @var{sexpr} (still
23652written as a function of @var{svar}), and @var{sprime} is the
23653derivative of @var{sexpr} with respect to @var{svar}. If you don't
23654specify these things, and Calc is not able to work them out on its
23655own with the information it knows, then your substitution rule will
23656work only in very specific, simple cases.
23657
23658Calc applies @code{IntegRules} as if by @kbd{C-u 1 a r IntegRules};
23659in other words, Calc stops rewriting as soon as any rule in your rule
23660set succeeds. (If it weren't for this, the @samp{integsubst(sqrt(x),x)}
23661example above would keep on adding layers of @code{integsubst} calls
23662forever!)
23663
23664@vindex IntegSimpRules
23665Another set of rules, stored in @code{IntegSimpRules}, are applied
23666every time the integrator uses @kbd{a s} to simplify an intermediate
23667result. For example, putting the rule @samp{twice(x) := 2 x} into
23668@code{IntegSimpRules} would tell Calc to convert the @code{twice}
23669function into a form it knows whenever integration is attempted.
23670
23671One more way to influence the integrator is to define a function with
23672the @kbd{Z F} command (@pxref{Algebraic Definitions}). Calc's
23673integrator automatically expands such functions according to their
23674defining formulas, even if you originally asked for the function to
23675be left unevaluated for symbolic arguments. (Certain other Calc
23676systems, such as the differentiator and the equation solver, also
23677do this.)
23678
23679@vindex IntegAfterRules
23680Sometimes Calc is able to find a solution to your integral, but it
23681expresses the result in a way that is unnecessarily complicated. If
23682this happens, you can either use @code{integsubst} as described
23683above to try to hint at a more direct path to the desired result, or
23684you can use @code{IntegAfterRules}. This is an extra rule set that
23685runs after the main integrator returns its result; basically, Calc does
23686an @kbd{a r IntegAfterRules} on the result before showing it to you.
23687(It also does an @kbd{a s}, without @code{IntegSimpRules}, after that
23688to further simplify the result.) For example, Calc's integrator
23689sometimes produces expressions of the form @samp{ln(1+x) - ln(1-x)};
23690the default @code{IntegAfterRules} rewrite this into the more readable
23691form @samp{2 arctanh(x)}. Note that, unlike @code{IntegRules},
23692@code{IntegSimpRules} and @code{IntegAfterRules} are applied any number
23693of times until no further changes are possible. Rewriting by
23694@code{IntegAfterRules} occurs only after the main integrator has
23695finished, not at every step as for @code{IntegRules} and
23696@code{IntegSimpRules}.
23697
23698@node Numerical Integration, Taylor Series, Customizing the Integrator, Calculus
23699@subsection Numerical Integration
23700
23701@noindent
23702@kindex a I
23703@pindex calc-num-integral
23704@tindex ninteg
23705If you want a purely numerical answer to an integration problem, you can
23706use the @kbd{a I} (@code{calc-num-integral}) [@code{ninteg}] command. This
23707command prompts for an integration variable, a lower limit, and an
23708upper limit. Except for the integration variable, all other variables
23709that appear in the integrand formula must have stored values. (A stored
23710value, if any, for the integration variable itself is ignored.)
23711
23712Numerical integration works by evaluating your formula at many points in
23713the specified interval. Calc uses an ``open Romberg'' method; this means
23714that it does not evaluate the formula actually at the endpoints (so that
23715it is safe to integrate @samp{sin(x)/x} from zero, for example). Also,
23716the Romberg method works especially well when the function being
23717integrated is fairly smooth. If the function is not smooth, Calc will
23718have to evaluate it at quite a few points before it can accurately
23719determine the value of the integral.
23720
23721Integration is much faster when the current precision is small. It is
23722best to set the precision to the smallest acceptable number of digits
23723before you use @kbd{a I}. If Calc appears to be taking too long, press
23724@kbd{C-g} to halt it and try a lower precision. If Calc still appears
23725to need hundreds of evaluations, check to make sure your function is
23726well-behaved in the specified interval.
23727
23728It is possible for the lower integration limit to be @samp{-inf} (minus
23729infinity). Likewise, the upper limit may be plus infinity. Calc
23730internally transforms the integral into an equivalent one with finite
23731limits. However, integration to or across singularities is not supported:
23732The integral of @samp{1/sqrt(x)} from 0 to 1 exists (it can be found
23733by Calc's symbolic integrator, for example), but @kbd{a I} will fail
23734because the integrand goes to infinity at one of the endpoints.
23735
23736@node Taylor Series, , Numerical Integration, Calculus
23737@subsection Taylor Series
23738
23739@noindent
23740@kindex a t
23741@pindex calc-taylor
23742@tindex taylor
23743The @kbd{a t} (@code{calc-taylor}) [@code{taylor}] command computes a
23744power series expansion or Taylor series of a function. You specify the
23745variable and the desired number of terms. You may give an expression of
23746the form @samp{@var{var} = @var{a}} or @samp{@var{var} - @var{a}} instead
23747of just a variable to produce a Taylor expansion about the point @var{a}.
23748You may specify the number of terms with a numeric prefix argument;
23749otherwise the command will prompt you for the number of terms. Note that
23750many series expansions have coefficients of zero for some terms, so you
a4231b04 23751may appear to get fewer terms than you asked for.
d7b8e6c6
EZ
23752
23753If the @kbd{a i} command is unable to find a symbolic integral for a
23754function, you can get an approximation by integrating the function's
23755Taylor series.
23756
23757@node Solving Equations, Numerical Solutions, Calculus, Algebra
23758@section Solving Equations
23759
23760@noindent
23761@kindex a S
23762@pindex calc-solve-for
23763@tindex solve
23764@cindex Equations, solving
23765@cindex Solving equations
23766The @kbd{a S} (@code{calc-solve-for}) [@code{solve}] command rearranges
23767an equation to solve for a specific variable. An equation is an
a4231b04
JB
23768expression of the form @expr{L = R}. For example, the command @kbd{a S x}
23769will rearrange @expr{y = 3x + 6} to the form, @expr{x = y/3 - 2}. If the
d7b8e6c6 23770input is not an equation, it is treated like an equation of the
a4231b04 23771form @expr{X = 0}.
d7b8e6c6 23772
a4231b04 23773This command also works for inequalities, as in @expr{y < 3x + 6}.
d7b8e6c6 23774Some inequalities cannot be solved where the analogous equation could
a4231b04 23775be; for example, solving
8e04863e 23776@texline @math{a < b \, c}
a4231b04
JB
23777@infoline @expr{a < b c}
23778for @expr{b} is impossible
23779without knowing the sign of @expr{c}. In this case, @kbd{a S} will
23780produce the result
8e04863e 23781@texline @math{b \mathbin{\hbox{\code{!=}}} a/c}
a4231b04
JB
23782@infoline @expr{b != a/c}
23783(using the not-equal-to operator) to signify that the direction of the
23784inequality is now unknown. The inequality
8e04863e 23785@texline @math{a \le b \, c}
a4231b04
JB
23786@infoline @expr{a <= b c}
23787is not even partially solved. @xref{Declarations}, for a way to tell
23788Calc that the signs of the variables in a formula are in fact known.
d7b8e6c6
EZ
23789
23790Two useful commands for working with the result of @kbd{a S} are
a4231b04
JB
23791@kbd{a .} (@pxref{Logical Operations}), which converts @expr{x = y/3 - 2}
23792to @expr{y/3 - 2}, and @kbd{s l} (@pxref{Let Command}) which evaluates
23793another formula with @expr{x} set equal to @expr{y/3 - 2}.
d7b8e6c6 23794
177c0ea7 23795@menu
d7b8e6c6
EZ
23796* Multiple Solutions::
23797* Solving Systems of Equations::
23798* Decomposing Polynomials::
23799@end menu
23800
23801@node Multiple Solutions, Solving Systems of Equations, Solving Equations, Solving Equations
23802@subsection Multiple Solutions
23803
23804@noindent
23805@kindex H a S
23806@tindex fsolve
23807Some equations have more than one solution. The Hyperbolic flag
23808(@code{H a S}) [@code{fsolve}] tells the solver to report the fully
23809general family of solutions. It will invent variables @code{n1},
23810@code{n2}, @dots{}, which represent independent arbitrary integers, and
23811@code{s1}, @code{s2}, @dots{}, which represent independent arbitrary
8e04863e 23812signs (either @mathit{+1} or @mathit{-1}). If you don't use the Hyperbolic
d7b8e6c6
EZ
23813flag, Calc will use zero in place of all arbitrary integers, and plus
23814one in place of all arbitrary signs. Note that variables like @code{n1}
23815and @code{s1} are not given any special interpretation in Calc except by
23816the equation solver itself. As usual, you can use the @w{@kbd{s l}}
23817(@code{calc-let}) command to obtain solutions for various actual values
23818of these variables.
23819
23820For example, @kbd{' x^2 = y @key{RET} H a S x @key{RET}} solves to
23821get @samp{x = s1 sqrt(y)}, indicating that the two solutions to the
23822equation are @samp{sqrt(y)} and @samp{-sqrt(y)}. Another way to
23823think about it is that the square-root operation is really a
23824two-valued function; since every Calc function must return a
23825single result, @code{sqrt} chooses to return the positive result.
23826Then @kbd{H a S} doctors this result using @code{s1} to indicate
23827the full set of possible values of the mathematical square-root.
23828
23829There is a similar phenomenon going the other direction: Suppose
23830we solve @samp{sqrt(y) = x} for @code{y}. Calc squares both sides
23831to get @samp{y = x^2}. This is correct, except that it introduces
23832some dubious solutions. Consider solving @samp{sqrt(y) = -3}:
a4231b04 23833Calc will report @expr{y = 9} as a valid solution, which is true
d7b8e6c6
EZ
23834in the mathematical sense of square-root, but false (there is no
23835solution) for the actual Calc positive-valued @code{sqrt}. This
23836happens for both @kbd{a S} and @kbd{H a S}.
23837
23838@cindex @code{GenCount} variable
23839@vindex GenCount
5d67986c
RS
23840@ignore
23841@starindex
23842@end ignore
d7b8e6c6 23843@tindex an
5d67986c
RS
23844@ignore
23845@starindex
23846@end ignore
d7b8e6c6
EZ
23847@tindex as
23848If you store a positive integer in the Calc variable @code{GenCount},
23849then Calc will generate formulas of the form @samp{as(@var{n})} for
23850arbitrary signs, and @samp{an(@var{n})} for arbitrary integers,
23851where @var{n} represents successive values taken by incrementing
23852@code{GenCount} by one. While the normal arbitrary sign and
23853integer symbols start over at @code{s1} and @code{n1} with each
23854new Calc command, the @code{GenCount} approach will give each
23855arbitrary value a name that is unique throughout the entire Calc
23856session. Also, the arbitrary values are function calls instead
23857of variables, which is advantageous in some cases. For example,
23858you can make a rewrite rule that recognizes all arbitrary signs
23859using a pattern like @samp{as(n)}. The @kbd{s l} command only works
23860on variables, but you can use the @kbd{a b} (@code{calc-substitute})
23861command to substitute actual values for function calls like @samp{as(3)}.
23862
23863The @kbd{s G} (@code{calc-edit-GenCount}) command is a convenient
33108698 23864way to create or edit this variable. Press @kbd{C-c C-c} to finish.
d7b8e6c6
EZ
23865
23866If you have not stored a value in @code{GenCount}, or if the value
23867in that variable is not a positive integer, the regular
23868@code{s1}/@code{n1} notation is used.
23869
23870@kindex I a S
23871@kindex H I a S
23872@tindex finv
23873@tindex ffinv
23874With the Inverse flag, @kbd{I a S} [@code{finv}] treats the expression
23875on top of the stack as a function of the specified variable and solves
23876to find the inverse function, written in terms of the same variable.
a4231b04 23877For example, @kbd{I a S x} inverts @expr{2x + 6} to @expr{x/2 - 3}.
d7b8e6c6
EZ
23878You can use both Inverse and Hyperbolic [@code{ffinv}] to obtain a
23879fully general inverse, as described above.
23880
23881@kindex a P
23882@pindex calc-poly-roots
23883@tindex roots
23884Some equations, specifically polynomials, have a known, finite number
23885of solutions. The @kbd{a P} (@code{calc-poly-roots}) [@code{roots}]
23886command uses @kbd{H a S} to solve an equation in general form, then, for
23887all arbitrary-sign variables like @code{s1}, and all arbitrary-integer
23888variables like @code{n1} for which @code{n1} only usefully varies over
23889a finite range, it expands these variables out to all their possible
23890values. The results are collected into a vector, which is returned.
23891For example, @samp{roots(x^4 = 1, x)} returns the four solutions
23892@samp{[1, -1, (0, 1), (0, -1)]}. Generally an @var{n}th degree
23893polynomial will always have @var{n} roots on the complex plane.
23894(If you have given a @code{real} declaration for the solution
23895variable, then only the real-valued solutions, if any, will be
23896reported; @pxref{Declarations}.)
23897
23898Note that because @kbd{a P} uses @kbd{H a S}, it is able to deliver
23899symbolic solutions if the polynomial has symbolic coefficients. Also
23900note that Calc's solver is not able to get exact symbolic solutions
a4231b04 23901to all polynomials. Polynomials containing powers up to @expr{x^4}
d7b8e6c6 23902can always be solved exactly; polynomials of higher degree sometimes
a4231b04
JB
23903can be: @expr{x^6 + x^3 + 1} is converted to @expr{(x^3)^2 + (x^3) + 1},
23904which can be solved for @expr{x^3} using the quadratic equation, and then
23905for @expr{x} by taking cube roots. But in many cases, like
23906@expr{x^6 + x + 1}, Calc does not know how to rewrite the polynomial
d7b8e6c6 23907into a form it can solve. The @kbd{a P} command can still deliver a
07ce2eb3
JB
23908list of numerical roots, however, provided that Symbolic mode (@kbd{m s})
23909is not turned on. (If you work with Symbolic mode on, recall that the
d7b8e6c6 23910@kbd{N} (@code{calc-eval-num}) key is a handy way to reevaluate the
07ce2eb3 23911formula on the stack with Symbolic mode temporarily off.) Naturally,
28665d46 23912@kbd{a P} can only provide numerical roots if the polynomial coefficients
d7b8e6c6
EZ
23913are all numbers (real or complex).
23914
23915@node Solving Systems of Equations, Decomposing Polynomials, Multiple Solutions, Solving Equations
23916@subsection Solving Systems of Equations
23917
23918@noindent
23919@cindex Systems of equations, symbolic
23920You can also use the commands described above to solve systems of
23921simultaneous equations. Just create a vector of equations, then
23922specify a vector of variables for which to solve. (You can omit
23923the surrounding brackets when entering the vector of variables
23924at the prompt.)
23925
23926For example, putting @samp{[x + y = a, x - y = b]} on the stack
23927and typing @kbd{a S x,y @key{RET}} produces the vector of solutions
23928@samp{[x = a - (a-b)/2, y = (a-b)/2]}. The result vector will
23929have the same length as the variables vector, and the variables
23930will be listed in the same order there. Note that the solutions
23931are not always simplified as far as possible; the solution for
a4231b04 23932@expr{x} here could be improved by an application of the @kbd{a n}
d7b8e6c6
EZ
23933command.
23934
23935Calc's algorithm works by trying to eliminate one variable at a
23936time by solving one of the equations for that variable and then
23937substituting into the other equations. Calc will try all the
23938possibilities, but you can speed things up by noting that Calc
23939first tries to eliminate the first variable with the first
23940equation, then the second variable with the second equation,
23941and so on. It also helps to put the simpler (e.g., more linear)
23942equations toward the front of the list. Calc's algorithm will
23943solve any system of linear equations, and also many kinds of
23944nonlinear systems.
23945
5d67986c
RS
23946@ignore
23947@starindex
23948@end ignore
d7b8e6c6
EZ
23949@tindex elim
23950Normally there will be as many variables as equations. If you
23951give fewer variables than equations (an ``over-determined'' system
23952of equations), Calc will find a partial solution. For example,
23953typing @kbd{a S y @key{RET}} with the above system of equations
23954would produce @samp{[y = a - x]}. There are now several ways to
23955express this solution in terms of the original variables; Calc uses
23956the first one that it finds. You can control the choice by adding
23957variable specifiers of the form @samp{elim(@var{v})} to the
23958variables list. This says that @var{v} should be eliminated from
23959the equations; the variable will not appear at all in the solution.
23960For example, typing @kbd{a S y,elim(x)} would yield
23961@samp{[y = a - (b+a)/2]}.
23962
23963If the variables list contains only @code{elim} specifiers,
23964Calc simply eliminates those variables from the equations
23965and then returns the resulting set of equations. For example,
23966@kbd{a S elim(x)} produces @samp{[a - 2 y = b]}. Every variable
23967eliminated will reduce the number of equations in the system
23968by one.
23969
23970Again, @kbd{a S} gives you one solution to the system of
23971equations. If there are several solutions, you can use @kbd{H a S}
23972to get a general family of solutions, or, if there is a finite
23973number of solutions, you can use @kbd{a P} to get a list. (In
23974the latter case, the result will take the form of a matrix where
23975the rows are different solutions and the columns correspond to the
23976variables you requested.)
23977
23978Another way to deal with certain kinds of overdetermined systems of
23979equations is the @kbd{a F} command, which does least-squares fitting
23980to satisfy the equations. @xref{Curve Fitting}.
23981
23982@node Decomposing Polynomials, , Solving Systems of Equations, Solving Equations
23983@subsection Decomposing Polynomials
23984
23985@noindent
5d67986c
RS
23986@ignore
23987@starindex
23988@end ignore
d7b8e6c6
EZ
23989@tindex poly
23990The @code{poly} function takes a polynomial and a variable as
23991arguments, and returns a vector of polynomial coefficients (constant
23992coefficient first). For example, @samp{poly(x^3 + 2 x, x)} returns
a4231b04 23993@expr{[0, 2, 0, 1]}. If the input is not a polynomial in @expr{x},
d7b8e6c6 23994the call to @code{poly} is left in symbolic form. If the input does
a4231b04 23995not involve the variable @expr{x}, the input is returned in a list
d7b8e6c6 23996of length one, representing a polynomial with only a constant
a4231b04 23997coefficient. The call @samp{poly(x, x)} returns the vector @expr{[0, 1]}.
d7b8e6c6 23998The last element of the returned vector is guaranteed to be nonzero;
a4231b04
JB
23999note that @samp{poly(0, x)} returns the empty vector @expr{[]}.
24000Note also that @expr{x} may actually be any formula; for example,
24001@samp{poly(sin(x)^2 - sin(x) + 3, sin(x))} returns @expr{[3, -1, 1]}.
d7b8e6c6
EZ
24002
24003@cindex Coefficients of polynomial
24004@cindex Degree of polynomial
a4231b04
JB
24005To get the @expr{x^k} coefficient of polynomial @expr{p}, use
24006@samp{poly(p, x)_(k+1)}. To get the degree of polynomial @expr{p},
d7b8e6c6
EZ
24007use @samp{vlen(poly(p, x)) - 1}. For example, @samp{poly((x+1)^4, x)}
24008returns @samp{[1, 4, 6, 4, 1]}, so @samp{poly((x+1)^4, x)_(2+1)}
a4231b04 24009gives the @expr{x^2} coefficient of this polynomial, 6.
d7b8e6c6 24010
5d67986c
RS
24011@ignore
24012@starindex
24013@end ignore
d7b8e6c6
EZ
24014@tindex gpoly
24015One important feature of the solver is its ability to recognize
24016formulas which are ``essentially'' polynomials. This ability is
24017made available to the user through the @code{gpoly} function, which
24018is used just like @code{poly}: @samp{gpoly(@var{expr}, @var{var})}.
24019If @var{expr} is a polynomial in some term which includes @var{var}, then
24020this function will return a vector @samp{[@var{x}, @var{c}, @var{a}]}
24021where @var{x} is the term that depends on @var{var}, @var{c} is a
24022vector of polynomial coefficients (like the one returned by @code{poly}),
24023and @var{a} is a multiplier which is usually 1. Basically,
24024@samp{@var{expr} = @var{a}*(@var{c}_1 + @var{c}_2 @var{x} +
24025@var{c}_3 @var{x}^2 + ...)}. The last element of @var{c} is
24026guaranteed to be non-zero, and @var{c} will not equal @samp{[1]}
24027(i.e., the trivial decomposition @var{expr} = @var{x} is not
24028considered a polynomial). One side effect is that @samp{gpoly(x, x)}
24029and @samp{gpoly(6, x)}, both of which might be expected to recognize
24030their arguments as polynomials, will not because the decomposition
24031is considered trivial.
24032
24033For example, @samp{gpoly((x-2)^2, x)} returns @samp{[x, [4, -4, 1], 1]},
a4231b04 24034since the expanded form of this polynomial is @expr{4 - 4 x + x^2}.
d7b8e6c6
EZ
24035
24036The term @var{x} may itself be a polynomial in @var{var}. This is
24037done to reduce the size of the @var{c} vector. For example,
24038@samp{gpoly(x^4 + x^2 - 1, x)} returns @samp{[x^2, [-1, 1, 1], 1]},
a4231b04
JB
24039since a quadratic polynomial in @expr{x^2} is easier to solve than
24040a quartic polynomial in @expr{x}.
d7b8e6c6
EZ
24041
24042A few more examples of the kinds of polynomials @code{gpoly} can
24043discover:
24044
24045@smallexample
24046sin(x) - 1 [sin(x), [-1, 1], 1]
24047x + 1/x - 1 [x, [1, -1, 1], 1/x]
24048x + 1/x [x^2, [1, 1], 1/x]
24049x^3 + 2 x [x^2, [2, 1], x]
24050x + x^2:3 + sqrt(x) [x^1:6, [1, 1, 0, 1], x^1:2]
24051x^(2a) + 2 x^a + 5 [x^a, [5, 2, 1], 1]
24052(exp(-x) + exp(x)) / 2 [e^(2 x), [0.5, 0.5], e^-x]
24053@end smallexample
24054
24055The @code{poly} and @code{gpoly} functions accept a third integer argument
24056which specifies the largest degree of polynomial that is acceptable.
a4231b04 24057If this is @expr{n}, then only @var{c} vectors of length @expr{n+1}
d7b8e6c6
EZ
24058or less will be returned. Otherwise, the @code{poly} or @code{gpoly}
24059call will remain in symbolic form. For example, the equation solver
24060can handle quartics and smaller polynomials, so it calls
24061@samp{gpoly(@var{expr}, @var{var}, 4)} to discover whether @var{expr}
24062can be treated by its linear, quadratic, cubic, or quartic formulas.
24063
5d67986c
RS
24064@ignore
24065@starindex
24066@end ignore
d7b8e6c6
EZ
24067@tindex pdeg
24068The @code{pdeg} function computes the degree of a polynomial;
24069@samp{pdeg(p,x)} is the highest power of @code{x} that appears in
24070@code{p}. This is the same as @samp{vlen(poly(p,x))-1}, but is
24071much more efficient. If @code{p} is constant with respect to @code{x},
24072then @samp{pdeg(p,x) = 0}. If @code{p} is not a polynomial in @code{x}
24073(e.g., @samp{pdeg(2 cos(x), x)}, the function remains unevaluated.
24074It is possible to omit the second argument @code{x}, in which case
24075@samp{pdeg(p)} returns the highest total degree of any term of the
24076polynomial, counting all variables that appear in @code{p}. Note
24077that @code{pdeg(c) = pdeg(c,x) = 0} for any nonzero constant @code{c};
24078the degree of the constant zero is considered to be @code{-inf}
24079(minus infinity).
24080
5d67986c
RS
24081@ignore
24082@starindex
24083@end ignore
d7b8e6c6
EZ
24084@tindex plead
24085The @code{plead} function finds the leading term of a polynomial.
24086Thus @samp{plead(p,x)} is equivalent to @samp{poly(p,x)_vlen(poly(p,x))},
24087though again more efficient. In particular, @samp{plead((2x+1)^10, x)}
24088returns 1024 without expanding out the list of coefficients. The
a4231b04 24089value of @code{plead(p,x)} will be zero only if @expr{p = 0}.
d7b8e6c6 24090
5d67986c
RS
24091@ignore
24092@starindex
24093@end ignore
d7b8e6c6
EZ
24094@tindex pcont
24095The @code{pcont} function finds the @dfn{content} of a polynomial. This
24096is the greatest common divisor of all the coefficients of the polynomial.
24097With two arguments, @code{pcont(p,x)} effectively uses @samp{poly(p,x)}
24098to get a list of coefficients, then uses @code{pgcd} (the polynomial
24099GCD function) to combine these into an answer. For example,
24100@samp{pcont(4 x y^2 + 6 x^2 y, x)} is @samp{2 y}. The content is
24101basically the ``biggest'' polynomial that can be divided into @code{p}
24102exactly. The sign of the content is the same as the sign of the leading
24103coefficient.
24104
24105With only one argument, @samp{pcont(p)} computes the numerical
24106content of the polynomial, i.e., the @code{gcd} of the numerical
24107coefficients of all the terms in the formula. Note that @code{gcd}
24108is defined on rational numbers as well as integers; it computes
24109the @code{gcd} of the numerators and the @code{lcm} of the
24110denominators. Thus @samp{pcont(4:3 x y^2 + 6 x^2 y)} returns 2:3.
24111Dividing the polynomial by this number will clear all the
24112denominators, as well as dividing by any common content in the
24113numerators. The numerical content of a polynomial is negative only
24114if all the coefficients in the polynomial are negative.
24115
5d67986c
RS
24116@ignore
24117@starindex
24118@end ignore
d7b8e6c6
EZ
24119@tindex pprim
24120The @code{pprim} function finds the @dfn{primitive part} of a
24121polynomial, which is simply the polynomial divided (using @code{pdiv}
24122if necessary) by its content. If the input polynomial has rational
24123coefficients, the result will have integer coefficients in simplest
24124terms.
24125
24126@node Numerical Solutions, Curve Fitting, Solving Equations, Algebra
24127@section Numerical Solutions
24128
24129@noindent
24130Not all equations can be solved symbolically. The commands in this
24131section use numerical algorithms that can find a solution to a specific
24132instance of an equation to any desired accuracy. Note that the
24133numerical commands are slower than their algebraic cousins; it is a
24134good idea to try @kbd{a S} before resorting to these commands.
24135
24136(@xref{Curve Fitting}, for some other, more specialized, operations
24137on numerical data.)
24138
24139@menu
24140* Root Finding::
24141* Minimization::
24142* Numerical Systems of Equations::
24143@end menu
24144
24145@node Root Finding, Minimization, Numerical Solutions, Numerical Solutions
24146@subsection Root Finding
24147
24148@noindent
24149@kindex a R
24150@pindex calc-find-root
24151@tindex root
24152@cindex Newton's method
24153@cindex Roots of equations
24154@cindex Numerical root-finding
24155The @kbd{a R} (@code{calc-find-root}) [@code{root}] command finds a
24156numerical solution (or @dfn{root}) of an equation. (This command treats
24157inequalities the same as equations. If the input is any other kind
a4231b04 24158of formula, it is interpreted as an equation of the form @expr{X = 0}.)
d7b8e6c6
EZ
24159
24160The @kbd{a R} command requires an initial guess on the top of the
24161stack, and a formula in the second-to-top position. It prompts for a
24162solution variable, which must appear in the formula. All other variables
24163that appear in the formula must have assigned values, i.e., when
24164a value is assigned to the solution variable and the formula is
24165evaluated with @kbd{=}, it should evaluate to a number. Any assigned
24166value for the solution variable itself is ignored and unaffected by
24167this command.
24168
24169When the command completes, the initial guess is replaced on the stack
24170by a vector of two numbers: The value of the solution variable that
24171solves the equation, and the difference between the lefthand and
24172righthand sides of the equation at that value. Ordinarily, the second
24173number will be zero or very nearly zero. (Note that Calc uses a
24174slightly higher precision while finding the root, and thus the second
24175number may be slightly different from the value you would compute from
24176the equation yourself.)
24177
24178The @kbd{v h} (@code{calc-head}) command is a handy way to extract
24179the first element of the result vector, discarding the error term.
24180
24181The initial guess can be a real number, in which case Calc searches
24182for a real solution near that number, or a complex number, in which
24183case Calc searches the whole complex plane near that number for a
24184solution, or it can be an interval form which restricts the search
24185to real numbers inside that interval.
24186
24187Calc tries to use @kbd{a d} to take the derivative of the equation.
24188If this succeeds, it uses Newton's method. If the equation is not
24189differentiable Calc uses a bisection method. (If Newton's method
24190appears to be going astray, Calc switches over to bisection if it
24191can, or otherwise gives up. In this case it may help to try again
24192with a slightly different initial guess.) If the initial guess is a
24193complex number, the function must be differentiable.
24194
24195If the formula (or the difference between the sides of an equation)
24196is negative at one end of the interval you specify and positive at
24197the other end, the root finder is guaranteed to find a root.
24198Otherwise, Calc subdivides the interval into small parts looking for
24199positive and negative values to bracket the root. When your guess is
24200an interval, Calc will not look outside that interval for a root.
24201
24202@kindex H a R
24203@tindex wroot
24204The @kbd{H a R} [@code{wroot}] command is similar to @kbd{a R}, except
24205that if the initial guess is an interval for which the function has
24206the same sign at both ends, then rather than subdividing the interval
24207Calc attempts to widen it to enclose a root. Use this mode if
24208you are not sure if the function has a root in your interval.
24209
24210If the function is not differentiable, and you give a simple number
24211instead of an interval as your initial guess, Calc uses this widening
24212process even if you did not type the Hyperbolic flag. (If the function
24213@emph{is} differentiable, Calc uses Newton's method which does not
24214require a bounding interval in order to work.)
24215
24216If Calc leaves the @code{root} or @code{wroot} function in symbolic
24217form on the stack, it will normally display an explanation for why
24218no root was found. If you miss this explanation, press @kbd{w}
24219(@code{calc-why}) to get it back.
24220
24221@node Minimization, Numerical Systems of Equations, Root Finding, Numerical Solutions
24222@subsection Minimization
24223
24224@noindent
24225@kindex a N
24226@kindex H a N
24227@kindex a X
24228@kindex H a X
24229@pindex calc-find-minimum
24230@pindex calc-find-maximum
24231@tindex minimize
24232@tindex maximize
24233@cindex Minimization, numerical
24234The @kbd{a N} (@code{calc-find-minimum}) [@code{minimize}] command
24235finds a minimum value for a formula. It is very similar in operation
24236to @kbd{a R} (@code{calc-find-root}): You give the formula and an initial
24237guess on the stack, and are prompted for the name of a variable. The guess
24238may be either a number near the desired minimum, or an interval enclosing
24239the desired minimum. The function returns a vector containing the
269b7745 24240value of the variable which minimizes the formula's value, along
d7b8e6c6
EZ
24241with the minimum value itself.
24242
24243Note that this command looks for a @emph{local} minimum. Many functions
a4231b04 24244have more than one minimum; some, like
8e04863e 24245@texline @math{x \sin x},
a4231b04
JB
24246@infoline @expr{x sin(x)},
24247have infinitely many. In fact, there is no easy way to define the
24248``global'' minimum of
8e04863e 24249@texline @math{x \sin x}
a4231b04
JB
24250@infoline @expr{x sin(x)}
24251but Calc can still locate any particular local minimum
d7b8e6c6
EZ
24252for you. Calc basically goes downhill from the initial guess until it
24253finds a point at which the function's value is greater both to the left
24254and to the right. Calc does not use derivatives when minimizing a function.
24255
24256If your initial guess is an interval and it looks like the minimum
24257occurs at one or the other endpoint of the interval, Calc will return
a4231b04
JB
24258that endpoint only if that endpoint is closed; thus, minimizing @expr{17 x}
24259over @expr{[2..3]} will return @expr{[2, 38]}, but minimizing over
24260@expr{(2..3]} would report no minimum found. In general, you should
d7b8e6c6 24261use closed intervals to find literally the minimum value in that
a4231b04 24262range of @expr{x}, or open intervals to find the local minimum, if
d7b8e6c6
EZ
24263any, that happens to lie in that range.
24264
24265Most functions are smooth and flat near their minimum values. Because
24266of this flatness, if the current precision is, say, 12 digits, the
24267variable can only be determined meaningfully to about six digits. Thus
24268you should set the precision to twice as many digits as you need in your
24269answer.
24270
5d67986c
RS
24271@ignore
24272@mindex wmin@idots
24273@end ignore
d7b8e6c6 24274@tindex wminimize
5d67986c
RS
24275@ignore
24276@mindex wmax@idots
24277@end ignore
d7b8e6c6
EZ
24278@tindex wmaximize
24279The @kbd{H a N} [@code{wminimize}] command, analogously to @kbd{H a R},
24280expands the guess interval to enclose a minimum rather than requiring
24281that the minimum lie inside the interval you supply.
24282
24283The @kbd{a X} (@code{calc-find-maximum}) [@code{maximize}] and
24284@kbd{H a X} [@code{wmaximize}] commands effectively minimize the
24285negative of the formula you supply.
24286
24287The formula must evaluate to a real number at all points inside the
24288interval (or near the initial guess if the guess is a number). If
24289the initial guess is a complex number the variable will be minimized
24290over the complex numbers; if it is real or an interval it will
24291be minimized over the reals.
24292
24293@node Numerical Systems of Equations, , Minimization, Numerical Solutions
24294@subsection Systems of Equations
24295
24296@noindent
24297@cindex Systems of equations, numerical
24298The @kbd{a R} command can also solve systems of equations. In this
24299case, the equation should instead be a vector of equations, the
24300guess should instead be a vector of numbers (intervals are not
24301supported), and the variable should be a vector of variables. You
24302can omit the brackets while entering the list of variables. Each
24303equation must be differentiable by each variable for this mode to
24304work. The result will be a vector of two vectors: The variable
24305values that solved the system of equations, and the differences
24306between the sides of the equations with those variable values.
24307There must be the same number of equations as variables. Since
24308only plain numbers are allowed as guesses, the Hyperbolic flag has
24309no effect when solving a system of equations.
24310
24311It is also possible to minimize over many variables with @kbd{a N}
24312(or maximize with @kbd{a X}). Once again the variable name should
24313be replaced by a vector of variables, and the initial guess should
24314be an equal-sized vector of initial guesses. But, unlike the case of
24315multidimensional @kbd{a R}, the formula being minimized should
24316still be a single formula, @emph{not} a vector. Beware that
24317multidimensional minimization is currently @emph{very} slow.
24318
24319@node Curve Fitting, Summations, Numerical Solutions, Algebra
24320@section Curve Fitting
24321
24322@noindent
24323The @kbd{a F} command fits a set of data to a @dfn{model formula},
a4231b04 24324such as @expr{y = m x + b} where @expr{m} and @expr{b} are parameters
d7b8e6c6 24325to be determined. For a typical set of measured data there will be
a4231b04 24326no single @expr{m} and @expr{b} that exactly fit the data; in this
d7b8e6c6
EZ
24327case, Calc chooses values of the parameters that provide the closest
24328possible fit.
24329
24330@menu
24331* Linear Fits::
24332* Polynomial and Multilinear Fits::
24333* Error Estimates for Fits::
24334* Standard Nonlinear Models::
24335* Curve Fitting Details::
24336* Interpolation::
24337@end menu
24338
24339@node Linear Fits, Polynomial and Multilinear Fits, Curve Fitting, Curve Fitting
24340@subsection Linear Fits
24341
24342@noindent
24343@kindex a F
24344@pindex calc-curve-fit
24345@tindex fit
24346@cindex Linear regression
24347@cindex Least-squares fits
24348The @kbd{a F} (@code{calc-curve-fit}) [@code{fit}] command attempts
a4231b04
JB
24349to fit a set of data (@expr{x} and @expr{y} vectors of numbers) to a
24350straight line, polynomial, or other function of @expr{x}. For the
d7b8e6c6
EZ
24351moment we will consider only the case of fitting to a line, and we
24352will ignore the issue of whether or not the model was in fact a good
24353fit for the data.
24354
a4231b04
JB
24355In a standard linear least-squares fit, we have a set of @expr{(x,y)}
24356data points that we wish to fit to the model @expr{y = m x + b}
24357by adjusting the parameters @expr{m} and @expr{b} to make the @expr{y}
d7b8e6c6 24358values calculated from the formula be as close as possible to the actual
a4231b04
JB
24359@expr{y} values in the data set. (In a polynomial fit, the model is
24360instead, say, @expr{y = a x^3 + b x^2 + c x + d}. In a multilinear fit,
24361we have data points of the form @expr{(x_1,x_2,x_3,y)} and our model is
24362@expr{y = a x_1 + b x_2 + c x_3 + d}. These will be discussed later.)
24363
24364In the model formula, variables like @expr{x} and @expr{x_2} are called
24365the @dfn{independent variables}, and @expr{y} is the @dfn{dependent
24366variable}. Variables like @expr{m}, @expr{a}, and @expr{b} are called
d7b8e6c6
EZ
24367the @dfn{parameters} of the model.
24368
24369The @kbd{a F} command takes the data set to be fitted from the stack.
24370By default, it expects the data in the form of a matrix. For example,
a4231b04 24371for a linear or polynomial fit, this would be a
8e04863e 24372@texline @math{2\times N}
a4231b04
JB
24373@infoline 2xN
24374matrix where the first row is a list of @expr{x} values and the second
24375row has the corresponding @expr{y} values. For the multilinear fit
24376shown above, the matrix would have four rows (@expr{x_1}, @expr{x_2},
24377@expr{x_3}, and @expr{y}, respectively).
24378
24379If you happen to have an
8e04863e 24380@texline @math{N\times2}
a4231b04
JB
24381@infoline Nx2
24382matrix instead of a
8e04863e 24383@texline @math{2\times N}
a4231b04
JB
24384@infoline 2xN
24385matrix, just press @kbd{v t} first to transpose the matrix.
d7b8e6c6
EZ
24386
24387After you type @kbd{a F}, Calc prompts you to select a model. For a
24388linear fit, press the digit @kbd{1}.
24389
24390Calc then prompts for you to name the variables. By default it chooses
a4231b04
JB
24391high letters like @expr{x} and @expr{y} for independent variables and
24392low letters like @expr{a} and @expr{b} for parameters. (The dependent
d7b8e6c6
EZ
24393variable doesn't need a name.) The two kinds of variables are separated
24394by a semicolon. Since you generally care more about the names of the
24395independent variables than of the parameters, Calc also allows you to
24396name only those and let the parameters use default names.
24397
24398For example, suppose the data matrix
24399
24400@ifinfo
d7b8e6c6 24401@example
5d67986c 24402@group
d7b8e6c6
EZ
24403[ [ 1, 2, 3, 4, 5 ]
24404 [ 5, 7, 9, 11, 13 ] ]
d7b8e6c6 24405@end group
5d67986c 24406@end example
d7b8e6c6
EZ
24407@end ifinfo
24408@tex
24409\turnoffactive
24410\turnoffactive
24411\beforedisplay
24412$$ \pmatrix{ 1 & 2 & 3 & 4 & 5 \cr
24413 5 & 7 & 9 & 11 & 13 }
24414$$
24415\afterdisplay
24416@end tex
24417
24418@noindent
24419is on the stack and we wish to do a simple linear fit. Type
5d67986c 24420@kbd{a F}, then @kbd{1} for the model, then @key{RET} to use
a4231b04 24421the default names. The result will be the formula @expr{3 + 2 x}
d7b8e6c6 24422on the stack. Calc has created the model expression @kbd{a + b x},
a4231b04 24423then found the optimal values of @expr{a} and @expr{b} to fit the
d7b8e6c6 24424data. (In this case, it was able to find an exact fit.) Calc then
a4231b04 24425substituted those values for @expr{a} and @expr{b} in the model
d7b8e6c6
EZ
24426formula.
24427
24428The @kbd{a F} command puts two entries in the trail. One is, as
24429always, a copy of the result that went to the stack; the other is
24430a vector of the actual parameter values, written as equations:
a4231b04 24431@expr{[a = 3, b = 2]}, in case you'd rather read them in a list
d7b8e6c6 24432than pick them out of the formula. (You can type @kbd{t y}
b275eac7 24433to move this vector to the stack; see @ref{Trail Commands}.
d7b8e6c6
EZ
24434
24435Specifying a different independent variable name will affect the
5d67986c
RS
24436resulting formula: @kbd{a F 1 k @key{RET}} produces @kbd{3 + 2 k}.
24437Changing the parameter names (say, @kbd{a F 1 k;b,m @key{RET}}) will affect
d7b8e6c6
EZ
24438the equations that go into the trail.
24439
24440@tex
24441\bigskip
24442@end tex
24443
24444To see what happens when the fit is not exact, we could change
24445the number 13 in the data matrix to 14 and try the fit again.
24446The result is:
24447
24448@example
244492.6 + 2.2 x
24450@end example
24451
5d67986c 24452Evaluating this formula, say with @kbd{v x 5 @key{RET} @key{TAB} V M $ @key{RET}}, shows
d7b8e6c6
EZ
24453a reasonably close match to the y-values in the data.
24454
24455@example
24456[4.8, 7., 9.2, 11.4, 13.6]
24457@end example
24458
5d67986c 24459Since there is no line which passes through all the @var{n} data points,
d7b8e6c6
EZ
24460Calc has chosen a line that best approximates the data points using
24461the method of least squares. The idea is to define the @dfn{chi-square}
24462error measure
24463
24464@ifinfo
24465@example
24466chi^2 = sum((y_i - (a + b x_i))^2, i, 1, N)
24467@end example
24468@end ifinfo
24469@tex
24470\turnoffactive
24471\beforedisplay
24472$$ \chi^2 = \sum_{i=1}^N (y_i - (a + b x_i))^2 $$
24473\afterdisplay
24474@end tex
24475
24476@noindent
a4231b04
JB
24477which is clearly zero if @expr{a + b x} exactly fits all data points,
24478and increases as various @expr{a + b x_i} values fail to match the
24479corresponding @expr{y_i} values. There are several reasons why the
24480summand is squared, one of them being to ensure that
8e04863e 24481@texline @math{\chi^2 \ge 0}.
a4231b04
JB
24482@infoline @expr{chi^2 >= 0}.
24483Least-squares fitting simply chooses the values of @expr{a} and @expr{b}
24484for which the error
8e04863e 24485@texline @math{\chi^2}
a4231b04
JB
24486@infoline @expr{chi^2}
24487is as small as possible.
d7b8e6c6
EZ
24488
24489Other kinds of models do the same thing but with a different model
a4231b04 24490formula in place of @expr{a + b x_i}.
d7b8e6c6
EZ
24491
24492@tex
24493\bigskip
24494@end tex
24495
24496A numeric prefix argument causes the @kbd{a F} command to take the
5d67986c
RS
24497data in some other form than one big matrix. A positive argument @var{n}
24498will take @var{N} items from the stack, corresponding to the @var{n} rows
24499of a data matrix. In the linear case, @var{n} must be 2 since there
d7b8e6c6
EZ
24500is always one independent variable and one dependent variable.
24501
24502A prefix of zero or plain @kbd{C-u} is a compromise; Calc takes two
a4231b04
JB
24503items from the stack, an @var{n}-row matrix of @expr{x} values, and a
24504vector of @expr{y} values. If there is only one independent variable,
24505the @expr{x} values can be either a one-row matrix or a plain vector,
d7b8e6c6
EZ
24506in which case the @kbd{C-u} prefix is the same as a @w{@kbd{C-u 2}} prefix.
24507
24508@node Polynomial and Multilinear Fits, Error Estimates for Fits, Linear Fits, Curve Fitting
24509@subsection Polynomial and Multilinear Fits
24510
24511@noindent
24512To fit the data to higher-order polynomials, just type one of the
24513digits @kbd{2} through @kbd{9} when prompted for a model. For example,
24514we could fit the original data matrix from the previous section
24515(with 13, not 14) to a parabola instead of a line by typing
5d67986c 24516@kbd{a F 2 @key{RET}}.
d7b8e6c6
EZ
24517
24518@example
245192.00000000001 x - 1.5e-12 x^2 + 2.99999999999
24520@end example
24521
24522Note that since the constant and linear terms are enough to fit the
24523data exactly, it's no surprise that Calc chose a tiny contribution
a4231b04 24524for @expr{x^2}. (The fact that it's not exactly zero is due only
d7b8e6c6 24525to roundoff error. Since our data are exact integers, we could get
07ce2eb3 24526an exact answer by typing @kbd{m f} first to get Fraction mode.
a4231b04 24527Then the @expr{x^2} term would vanish altogether. Usually, though,
07ce2eb3 24528the data being fitted will be approximate floats so Fraction mode
d7b8e6c6
EZ
24529won't help.)
24530
24531Doing the @kbd{a F 2} fit on the data set with 14 instead of 13
a4231b04 24532gives a much larger @expr{x^2} contribution, as Calc bends the
d7b8e6c6
EZ
24533line slightly to improve the fit.
24534
24535@example
245360.142857142855 x^2 + 1.34285714287 x + 3.59999999998
24537@end example
24538
24539An important result from the theory of polynomial fitting is that it
5d67986c 24540is always possible to fit @var{n} data points exactly using a polynomial
8e04863e 24541of degree @mathit{@var{n}-1}, sometimes called an @dfn{interpolating polynomial}.
d7b8e6c6
EZ
24542Using the modified (14) data matrix, a model number of 4 gives
24543a polynomial that exactly matches all five data points:
24544
24545@example
245460.04167 x^4 - 0.4167 x^3 + 1.458 x^2 - 0.08333 x + 4.
24547@end example
24548
24549The actual coefficients we get with a precision of 12, like
a4231b04 24550@expr{0.0416666663588}, clearly suffer from loss of precision.
d7b8e6c6
EZ
24551It is a good idea to increase the working precision to several
24552digits beyond what you need when you do a fitting operation.
07ce2eb3 24553Or, if your data are exact, use Fraction mode to get exact
d7b8e6c6
EZ
24554results.
24555
24556You can type @kbd{i} instead of a digit at the model prompt to fit
24557the data exactly to a polynomial. This just counts the number of
24558columns of the data matrix to choose the degree of the polynomial
24559automatically.
24560
24561Fitting data ``exactly'' to high-degree polynomials is not always
24562a good idea, though. High-degree polynomials have a tendency to
24563wiggle uncontrollably in between the fitting data points. Also,
24564if the exact-fit polynomial is going to be used to interpolate or
24565extrapolate the data, it is numerically better to use the @kbd{a p}
24566command described below. @xref{Interpolation}.
24567
24568@tex
24569\bigskip
24570@end tex
24571
24572Another generalization of the linear model is to assume the
a4231b04
JB
24573@expr{y} values are a sum of linear contributions from several
24574@expr{x} values. This is a @dfn{multilinear} fit, and it is also
d7b8e6c6
EZ
24575selected by the @kbd{1} digit key. (Calc decides whether the fit
24576is linear or multilinear by counting the rows in the data matrix.)
24577
24578Given the data matrix,
24579
d7b8e6c6 24580@example
5d67986c 24581@group
d7b8e6c6
EZ
24582[ [ 1, 2, 3, 4, 5 ]
24583 [ 7, 2, 3, 5, 2 ]
24584 [ 14.5, 15, 18.5, 22.5, 24 ] ]
d7b8e6c6 24585@end group
5d67986c 24586@end example
d7b8e6c6
EZ
24587
24588@noindent
a4231b04
JB
24589the command @kbd{a F 1 @key{RET}} will call the first row @expr{x} and the
24590second row @expr{y}, and will fit the values in the third row to the
24591model @expr{a + b x + c y}.
d7b8e6c6
EZ
24592
24593@example
245948. + 3. x + 0.5 y
24595@end example
24596
24597Calc can do multilinear fits with any number of independent variables
24598(i.e., with any number of data rows).
24599
24600@tex
24601\bigskip
24602@end tex
24603
24604Yet another variation is @dfn{homogeneous} linear models, in which
24605the constant term is known to be zero. In the linear case, this
a4231b04
JB
24606means the model formula is simply @expr{a x}; in the multilinear
24607case, the model might be @expr{a x + b y + c z}; and in the polynomial
24608case, the model could be @expr{a x + b x^2 + c x^3}. You can get
d7b8e6c6
EZ
24609a homogeneous linear or multilinear model by pressing the letter
24610@kbd{h} followed by a regular model key, like @kbd{1} or @kbd{2}.
24611
24612It is certainly possible to have other constrained linear models,
a4231b04 24613like @expr{2.3 + a x} or @expr{a - 4 x}. While there is no single
d7b8e6c6
EZ
24614key to select models like these, a later section shows how to enter
24615any desired model by hand. In the first case, for example, you
24616would enter @kbd{a F ' 2.3 + a x}.
24617
24618Another class of models that will work but must be entered by hand
a4231b04 24619are multinomial fits, e.g., @expr{a + b x + c y + d x^2 + e y^2 + f x y}.
d7b8e6c6
EZ
24620
24621@node Error Estimates for Fits, Standard Nonlinear Models, Polynomial and Multilinear Fits, Curve Fitting
24622@subsection Error Estimates for Fits
24623
24624@noindent
24625@kindex H a F
24626@tindex efit
24627With the Hyperbolic flag, @kbd{H a F} [@code{efit}] performs the same
24628fitting operation as @kbd{a F}, but reports the coefficients as error
24629forms instead of plain numbers. Fitting our two data matrices (first
24630with 13, then with 14) to a line with @kbd{H a F} gives the results,
24631
24632@example
246333. + 2. x
246342.6 +/- 0.382970843103 + 2.2 +/- 0.115470053838 x
24635@end example
24636
24637In the first case the estimated errors are zero because the linear
24638fit is perfect. In the second case, the errors are nonzero but
24639moderately small, because the data are still very close to linear.
24640
24641It is also possible for the @emph{input} to a fitting operation to
24642contain error forms. The data values must either all include errors
24643or all be plain numbers. Error forms can go anywhere but generally
24644go on the numbers in the last row of the data matrix. If the last
24645row contains error forms
bd712b70
JB
24646@texline `@var{y_i}@w{ @tfn{+/-} }@math{\sigma_i}',
24647@infoline `@var{y_i}@w{ @tfn{+/-} }@var{sigma_i}',
a4231b04 24648then the
8e04863e 24649@texline @math{\chi^2}
a4231b04 24650@infoline @expr{chi^2}
d7b8e6c6
EZ
24651statistic is now,
24652
24653@ifinfo
24654@example
24655chi^2 = sum(((y_i - (a + b x_i)) / sigma_i)^2, i, 1, N)
24656@end example
24657@end ifinfo
24658@tex
24659\turnoffactive
24660\beforedisplay
24661$$ \chi^2 = \sum_{i=1}^N \left(y_i - (a + b x_i) \over \sigma_i\right)^2 $$
24662\afterdisplay
24663@end tex
24664
24665@noindent
24666so that data points with larger error estimates contribute less to
24667the fitting operation.
24668
24669If there are error forms on other rows of the data matrix, all the
24670errors for a given data point are combined; the square root of the
a4231b04 24671sum of the squares of the errors forms the
8e04863e 24672@texline @math{\sigma_i}
a4231b04
JB
24673@infoline @expr{sigma_i}
24674used for the data point.
d7b8e6c6
EZ
24675
24676Both @kbd{a F} and @kbd{H a F} can accept error forms in the input
24677matrix, although if you are concerned about error analysis you will
24678probably use @kbd{H a F} so that the output also contains error
24679estimates.
24680
a4231b04 24681If the input contains error forms but all the
8e04863e 24682@texline @math{\sigma_i}
a4231b04
JB
24683@infoline @expr{sigma_i}
24684values are the same, it is easy to see that the resulting fitted model
24685will be the same as if the input did not have error forms at all
8e04863e 24686@texline (@math{\chi^2}
a4231b04
JB
24687@infoline (@expr{chi^2}
24688is simply scaled uniformly by
8e04863e 24689@texline @math{1 / \sigma^2},
a4231b04
JB
24690@infoline @expr{1 / sigma^2},
24691which doesn't affect where it has a minimum). But there @emph{will} be
24692a difference in the estimated errors of the coefficients reported by
24693@kbd{H a F}.
d7b8e6c6 24694
28665d46 24695Consult any text on statistical modeling of data for a discussion
d7b8e6c6
EZ
24696of where these error estimates come from and how they should be
24697interpreted.
24698
24699@tex
24700\bigskip
24701@end tex
24702
24703@kindex I a F
24704@tindex xfit
24705With the Inverse flag, @kbd{I a F} [@code{xfit}] produces even more
24706information. The result is a vector of six items:
24707
24708@enumerate
24709@item
24710The model formula with error forms for its coefficients or
24711parameters. This is the result that @kbd{H a F} would have
24712produced.
24713
24714@item
24715A vector of ``raw'' parameter values for the model. These are the
24716polynomial coefficients or other parameters as plain numbers, in the
24717same order as the parameters appeared in the final prompt of the
a4231b04
JB
24718@kbd{I a F} command. For polynomials of degree @expr{d}, this vector
24719will have length @expr{M = d+1} with the constant term first.
d7b8e6c6
EZ
24720
24721@item
a4231b04 24722The covariance matrix @expr{C} computed from the fit. This is
5d67986c 24723an @var{m}x@var{m} symmetric matrix; the diagonal elements
8e04863e 24724@texline @math{C_{jj}}
a4231b04
JB
24725@infoline @expr{C_j_j}
24726are the variances
8e04863e 24727@texline @math{\sigma_j^2}
a4231b04
JB
24728@infoline @expr{sigma_j^2}
24729of the parameters. The other elements are covariances
8e04863e 24730@texline @math{\sigma_{ij}^2}
a4231b04
JB
24731@infoline @expr{sigma_i_j^2}
24732that describe the correlation between pairs of parameters. (A related
24733set of numbers, the @dfn{linear correlation coefficients}
8e04863e 24734@texline @math{r_{ij}},
a4231b04
JB
24735@infoline @expr{r_i_j},
24736are defined as
8e04863e 24737@texline @math{\sigma_{ij}^2 / \sigma_i \, \sigma_j}.)
a4231b04 24738@infoline @expr{sigma_i_j^2 / sigma_i sigma_j}.)
d7b8e6c6
EZ
24739
24740@item
a4231b04 24741A vector of @expr{M} ``parameter filter'' functions whose
d7b8e6c6
EZ
24742meanings are described below. If no filters are necessary this
24743will instead be an empty vector; this is always the case for the
24744polynomial and multilinear fits described so far.
24745
24746@item
a4231b04 24747The value of
8e04863e 24748@texline @math{\chi^2}
a4231b04
JB
24749@infoline @expr{chi^2}
24750for the fit, calculated by the formulas shown above. This gives a
24751measure of the quality of the fit; statisticians consider
8e04863e 24752@texline @math{\chi^2 \approx N - M}
a4231b04
JB
24753@infoline @expr{chi^2 = N - M}
24754to indicate a moderately good fit (where again @expr{N} is the number of
24755data points and @expr{M} is the number of parameters).
d7b8e6c6
EZ
24756
24757@item
a4231b04 24758A measure of goodness of fit expressed as a probability @expr{Q}.
d7b8e6c6 24759This is computed from the @code{utpc} probability distribution
a4231b04 24760function using
8e04863e 24761@texline @math{\chi^2}
a4231b04
JB
24762@infoline @expr{chi^2}
24763with @expr{N - M} degrees of freedom. A
d7b8e6c6 24764value of 0.5 implies a good fit; some texts recommend that often
a4231b04
JB
24765@expr{Q = 0.1} or even 0.001 can signify an acceptable fit. In
24766particular,
8e04863e 24767@texline @math{\chi^2}
a4231b04
JB
24768@infoline @expr{chi^2}
24769statistics assume the errors in your inputs
d7b8e6c6 24770follow a normal (Gaussian) distribution; if they don't, you may
a4231b04 24771have to accept smaller values of @expr{Q}.
d7b8e6c6 24772
a4231b04 24773The @expr{Q} value is computed only if the input included error
d7b8e6c6 24774estimates. Otherwise, Calc will report the symbol @code{nan}
a4231b04 24775for @expr{Q}. The reason is that in this case the
8e04863e 24776@texline @math{\chi^2}
a4231b04 24777@infoline @expr{chi^2}
d7b8e6c6
EZ
24778value has effectively been used to estimate the original errors
24779in the input, and thus there is no redundant information left
24780over to use for a confidence test.
24781@end enumerate
24782
24783@node Standard Nonlinear Models, Curve Fitting Details, Error Estimates for Fits, Curve Fitting
24784@subsection Standard Nonlinear Models
24785
24786@noindent
24787The @kbd{a F} command also accepts other kinds of models besides
24788lines and polynomials. Some common models have quick single-key
24789abbreviations; others must be entered by hand as algebraic formulas.
24790
24791Here is a complete list of the standard models recognized by @kbd{a F}:
24792
24793@table @kbd
24794@item 1
8e04863e 24795Linear or multilinear. @mathit{a + b x + c y + d z}.
d7b8e6c6 24796@item 2-9
8e04863e 24797Polynomials. @mathit{a + b x + c x^2 + d x^3}.
d7b8e6c6 24798@item e
bd712b70 24799Exponential. @mathit{a} @tfn{exp}@mathit{(b x)} @tfn{exp}@mathit{(c y)}.
d7b8e6c6 24800@item E
bd712b70 24801Base-10 exponential. @mathit{a} @tfn{10^}@mathit{(b x)} @tfn{10^}@mathit{(c y)}.
d7b8e6c6 24802@item x
bd712b70 24803Exponential (alternate notation). @tfn{exp}@mathit{(a + b x + c y)}.
d7b8e6c6 24804@item X
bd712b70 24805Base-10 exponential (alternate). @tfn{10^}@mathit{(a + b x + c y)}.
d7b8e6c6 24806@item l
bd712b70 24807Logarithmic. @mathit{a + b} @tfn{ln}@mathit{(x) + c} @tfn{ln}@mathit{(y)}.
d7b8e6c6 24808@item L
bd712b70 24809Base-10 logarithmic. @mathit{a + b} @tfn{log10}@mathit{(x) + c} @tfn{log10}@mathit{(y)}.
d7b8e6c6 24810@item ^
8e04863e 24811General exponential. @mathit{a b^x c^y}.
d7b8e6c6 24812@item p
8e04863e 24813Power law. @mathit{a x^b y^c}.
d7b8e6c6 24814@item q
8e04863e 24815Quadratic. @mathit{a + b (x-c)^2 + d (x-e)^2}.
d7b8e6c6 24816@item g
a4231b04 24817Gaussian.
8e04863e
JB
24818@texline @math{{a \over b \sqrt{2 \pi}} \exp\left( -{1 \over 2} \left( x - c \over b \right)^2 \right)}.
24819@infoline @mathit{(a / b sqrt(2 pi)) exp(-0.5*((x-c)/b)^2)}.
d7b8e6c6
EZ
24820@end table
24821
24822All of these models are used in the usual way; just press the appropriate
24823letter at the model prompt, and choose variable names if you wish. The
24824result will be a formula as shown in the above table, with the best-fit
24825values of the parameters substituted. (You may find it easier to read
24826the parameter values from the vector that is placed in the trail.)
24827
24828All models except Gaussian and polynomials can generalize as shown to any
24829number of independent variables. Also, all the built-in models have an
a4231b04 24830additive or multiplicative parameter shown as @expr{a} in the above table
d7b8e6c6
EZ
24831which can be replaced by zero or one, as appropriate, by typing @kbd{h}
24832before the model key.
24833
24834Note that many of these models are essentially equivalent, but express
a4231b04 24835the parameters slightly differently. For example, @expr{a b^x} and
d7b8e6c6
EZ
24836the other two exponential models are all algebraic rearrangements of
24837each other. Also, the ``quadratic'' model is just a degree-2 polynomial
24838with the parameters expressed differently. Use whichever form best
24839matches the problem.
24840
24841The HP-28/48 calculators support four different models for curve
24842fitting, called @code{LIN}, @code{LOG}, @code{EXP}, and @code{PWR}.
24843These correspond to Calc models @samp{a + b x}, @samp{a + b ln(x)},
24844@samp{a exp(b x)}, and @samp{a x^b}, respectively. In each case,
a4231b04
JB
24845@expr{a} is what the HP-48 identifies as the ``intercept,'' and
24846@expr{b} is what it calls the ``slope.''
d7b8e6c6
EZ
24847
24848@tex
24849\bigskip
24850@end tex
24851
24852If the model you want doesn't appear on this list, press @kbd{'}
24853(the apostrophe key) at the model prompt to enter any algebraic
24854formula, such as @kbd{m x - b}, as the model. (Not all models
24855will work, though---see the next section for details.)
24856
a4231b04 24857The model can also be an equation like @expr{y = m x + b}.
d7b8e6c6
EZ
24858In this case, Calc thinks of all the rows of the data matrix on
24859equal terms; this model effectively has two parameters
a4231b04
JB
24860(@expr{m} and @expr{b}) and two independent variables (@expr{x}
24861and @expr{y}), with no ``dependent'' variables. Model equations
24862do not need to take this @expr{y =} form. For example, the
24863implicit line equation @expr{a x + b y = 1} works fine as a
d7b8e6c6
EZ
24864model.
24865
24866When you enter a model, Calc makes an alphabetical list of all
24867the variables that appear in the model. These are used for the
24868default parameters, independent variables, and dependent variable
24869(in that order). If you enter a plain formula (not an equation),
24870Calc assumes the dependent variable does not appear in the formula
24871and thus does not need a name.
24872
a4231b04 24873For example, if the model formula has the variables @expr{a,mu,sigma,t,x},
d7b8e6c6 24874and the data matrix has three rows (meaning two independent variables),
a4231b04
JB
24875Calc will use @expr{a,mu,sigma} as the default parameters, and the
24876data rows will be named @expr{t} and @expr{x}, respectively. If you
24877enter an equation instead of a plain formula, Calc will use @expr{a,mu}
24878as the parameters, and @expr{sigma,t,x} as the three independent
d7b8e6c6
EZ
24879variables.
24880
24881You can, of course, override these choices by entering something
24882different at the prompt. If you leave some variables out of the list,
24883those variables must have stored values and those stored values will
24884be used as constants in the model. (Stored values for the parameters
24885and independent variables are ignored by the @kbd{a F} command.)
24886If you list only independent variables, all the remaining variables
24887in the model formula will become parameters.
24888
24889If there are @kbd{$} signs in the model you type, they will stand
24890for parameters and all other variables (in alphabetical order)
24891will be independent. Use @kbd{$} for one parameter, @kbd{$$} for
24892another, and so on. Thus @kbd{$ x + $$} is another way to describe
24893a linear model.
24894
24895If you type a @kbd{$} instead of @kbd{'} at the model prompt itself,
24896Calc will take the model formula from the stack. (The data must then
24897appear at the second stack level.) The same conventions are used to
24898choose which variables in the formula are independent by default and
24899which are parameters.
24900
24901Models taken from the stack can also be expressed as vectors of
a4231b04
JB
24902two or three elements, @expr{[@var{model}, @var{vars}]} or
24903@expr{[@var{model}, @var{vars}, @var{params}]}. Each of @var{vars}
d7b8e6c6
EZ
24904and @var{params} may be either a variable or a vector of variables.
24905(If @var{params} is omitted, all variables in @var{model} except
a4231b04 24906those listed as @var{vars} are parameters.)
d7b8e6c6
EZ
24907
24908When you enter a model manually with @kbd{'}, Calc puts a 3-vector
24909describing the model in the trail so you can get it back if you wish.
24910
24911@tex
24912\bigskip
24913@end tex
24914
24915@vindex Model1
24916@vindex Model2
24917Finally, you can store a model in one of the Calc variables
24918@code{Model1} or @code{Model2}, then use this model by typing
24919@kbd{a F u} or @kbd{a F U} (respectively). The value stored in
24920the variable can be any of the formats that @kbd{a F $} would
24921accept for a model on the stack.
24922
24923@tex
24924\bigskip
24925@end tex
24926
24927Calc uses the principal values of inverse functions like @code{ln}
24928and @code{arcsin} when doing fits. For example, when you enter
24929the model @samp{y = sin(a t + b)} Calc actually uses the easier
24930form @samp{arcsin(y) = a t + b}. The @code{arcsin} function always
8e04863e 24931returns results in the range from @mathit{-90} to 90 degrees (or the
d7b8e6c6
EZ
24932equivalent range in radians). Suppose you had data that you
24933believed to represent roughly three oscillations of a sine wave,
a4231b04 24934so that the argument of the sine might go from zero to
8e04863e
JB
24935@texline @math{3\times360}
24936@infoline @mathit{3*360}
a4231b04 24937degrees.
d7b8e6c6
EZ
24938The above model would appear to be a good way to determine the
24939true frequency and phase of the sine wave, but in practice it
24940would fail utterly. The righthand side of the actual model
a4231b04 24941@samp{arcsin(y) = a t + b} will grow smoothly with @expr{t}, but
8e04863e 24942the lefthand side will bounce back and forth between @mathit{-90} and 90.
a4231b04 24943No values of @expr{a} and @expr{b} can make the two sides match,
d7b8e6c6
EZ
24944even approximately.
24945
24946There is no good solution to this problem at present. You could
24947restrict your data to small enough ranges so that the above problem
24948doesn't occur (i.e., not straddling any peaks in the sine wave).
24949Or, in this case, you could use a totally different method such as
24950Fourier analysis, which is beyond the scope of the @kbd{a F} command.
24951(Unfortunately, Calc does not currently have any facilities for
24952taking Fourier and related transforms.)
24953
24954@node Curve Fitting Details, Interpolation, Standard Nonlinear Models, Curve Fitting
24955@subsection Curve Fitting Details
24956
24957@noindent
24958Calc's internal least-squares fitter can only handle multilinear
24959models. More precisely, it can handle any model of the form
a4231b04
JB
24960@expr{a f(x,y,z) + b g(x,y,z) + c h(x,y,z)}, where @expr{a,b,c}
24961are the parameters and @expr{x,y,z} are the independent variables
d7b8e6c6
EZ
24962(of course there can be any number of each, not just three).
24963
24964In a simple multilinear or polynomial fit, it is easy to see how
24965to convert the model into this form. For example, if the model
a4231b04
JB
24966is @expr{a + b x + c x^2}, then @expr{f(x) = 1}, @expr{g(x) = x},
24967and @expr{h(x) = x^2} are suitable functions.
d7b8e6c6
EZ
24968
24969For other models, Calc uses a variety of algebraic manipulations
24970to try to put the problem into the form
24971
24972@smallexample
24973Y(x,y,z) = A(a,b,c) F(x,y,z) + B(a,b,c) G(x,y,z) + C(a,b,c) H(x,y,z)
24974@end smallexample
24975
24976@noindent
a4231b04
JB
24977where @expr{Y,A,B,C,F,G,H} are arbitrary functions. It computes
24978@expr{Y}, @expr{F}, @expr{G}, and @expr{H} for all the data points,
24979does a standard linear fit to find the values of @expr{A}, @expr{B},
24980and @expr{C}, then uses the equation solver to solve for @expr{a,b,c}
24981in terms of @expr{A,B,C}.
d7b8e6c6
EZ
24982
24983A remarkable number of models can be cast into this general form.
24984We'll look at two examples here to see how it works. The power-law
a4231b04 24985model @expr{y = a x^b} with two independent variables and two parameters
d7b8e6c6
EZ
24986can be rewritten as follows:
24987
24988@example
24989y = a x^b
24990y = a exp(b ln(x))
24991y = exp(ln(a) + b ln(x))
24992ln(y) = ln(a) + b ln(x)
24993@end example
24994
24995@noindent
a4231b04 24996which matches the desired form with
8e04863e 24997@texline @math{Y = \ln(y)},
a4231b04 24998@infoline @expr{Y = ln(y)},
8e04863e 24999@texline @math{A = \ln(a)},
a4231b04
JB
25000@infoline @expr{A = ln(a)},
25001@expr{F = 1}, @expr{B = b}, and
8e04863e 25002@texline @math{G = \ln(x)}.
a4231b04
JB
25003@infoline @expr{G = ln(x)}.
25004Calc thus computes the logarithms of your @expr{y} and @expr{x} values,
25005does a linear fit for @expr{A} and @expr{B}, then solves to get
8e04863e 25006@texline @math{a = \exp(A)}
a4231b04
JB
25007@infoline @expr{a = exp(A)}
25008and @expr{b = B}.
d7b8e6c6
EZ
25009
25010Another interesting example is the ``quadratic'' model, which can
25011be handled by expanding according to the distributive law.
25012
25013@example
25014y = a + b*(x - c)^2
25015y = a + b c^2 - 2 b c x + b x^2
25016@end example
25017
25018@noindent
a4231b04 25019which matches with @expr{Y = y}, @expr{A = a + b c^2}, @expr{F = 1},
8e04863e 25020@expr{B = -2 b c}, @expr{G = x} (the @mathit{-2} factor could just as easily
a4231b04
JB
25021have been put into @expr{G} instead of @expr{B}), @expr{C = b}, and
25022@expr{H = x^2}.
d7b8e6c6
EZ
25023
25024The Gaussian model looks quite complicated, but a closer examination
25025shows that it's actually similar to the quadratic model but with an
a4231b04 25026exponential that can be brought to the top and moved into @expr{Y}.
d7b8e6c6
EZ
25027
25028An example of a model that cannot be put into general linear
25029form is a Gaussian with a constant background added on, i.e.,
a4231b04 25030@expr{d} + the regular Gaussian formula. If you have a model like
d7b8e6c6
EZ
25031this, your best bet is to replace enough of your parameters with
25032constants to make the model linearizable, then adjust the constants
25033manually by doing a series of fits. You can compare the fits by
25034graphing them, by examining the goodness-of-fit measures returned by
25035@kbd{I a F}, or by some other method suitable to your application.
25036Note that some models can be linearized in several ways. The
a4231b04
JB
25037Gaussian-plus-@var{d} model can be linearized by setting @expr{d}
25038(the background) to a constant, or by setting @expr{b} (the standard
25039deviation) and @expr{c} (the mean) to constants.
d7b8e6c6
EZ
25040
25041To fit a model with constants substituted for some parameters, just
25042store suitable values in those parameter variables, then omit them
25043from the list of parameters when you answer the variables prompt.
25044
25045@tex
25046\bigskip
25047@end tex
25048
25049A last desperate step would be to use the general-purpose
25050@code{minimize} function rather than @code{fit}. After all, both
a4231b04 25051functions solve the problem of minimizing an expression (the
8e04863e 25052@texline @math{\chi^2}
a4231b04 25053@infoline @expr{chi^2}
d7b8e6c6
EZ
25054sum) by adjusting certain parameters in the expression. The @kbd{a F}
25055command is able to use a vastly more efficient algorithm due to its
25056special knowledge about linear chi-square sums, but the @kbd{a N}
25057command can do the same thing by brute force.
25058
25059A compromise would be to pick out a few parameters without which the
25060fit is linearizable, and use @code{minimize} on a call to @code{fit}
25061which efficiently takes care of the rest of the parameters. The thing
a4231b04 25062to be minimized would be the value of
8e04863e 25063@texline @math{\chi^2}
a4231b04
JB
25064@infoline @expr{chi^2}
25065returned as the fifth result of the @code{xfit} function:
d7b8e6c6
EZ
25066
25067@smallexample
25068minimize(xfit(gaus(a,b,c,d,x), x, [a,b,c], data)_5, d, guess)
25069@end smallexample
25070
25071@noindent
25072where @code{gaus} represents the Gaussian model with background,
25073@code{data} represents the data matrix, and @code{guess} represents
a4231b04 25074the initial guess for @expr{d} that @code{minimize} requires.
d7b8e6c6
EZ
25075This operation will only be, shall we say, extraordinarily slow
25076rather than astronomically slow (as would be the case if @code{minimize}
25077were used by itself to solve the problem).
25078
25079@tex
25080\bigskip
25081@end tex
25082
25083The @kbd{I a F} [@code{xfit}] command is somewhat trickier when
25084nonlinear models are used. The second item in the result is the
a4231b04 25085vector of ``raw'' parameters @expr{A}, @expr{B}, @expr{C}. The
d7b8e6c6
EZ
25086covariance matrix is written in terms of those raw parameters.
25087The fifth item is a vector of @dfn{filter} expressions. This
25088is the empty vector @samp{[]} if the raw parameters were the same
a4231b04 25089as the requested parameters, i.e., if @expr{A = a}, @expr{B = b},
d7b8e6c6
EZ
25090and so on (which is always true if the model is already linear
25091in the parameters as written, e.g., for polynomial fits). If the
25092parameters had to be rearranged, the fifth item is instead a vector
25093of one formula per parameter in the original model. The raw
25094parameters are expressed in these ``filter'' formulas as
a4231b04 25095@samp{fitdummy(1)} for @expr{A}, @samp{fitdummy(2)} for @expr{B},
d7b8e6c6
EZ
25096and so on.
25097
25098When Calc needs to modify the model to return the result, it replaces
25099@samp{fitdummy(1)} in all the filters with the first item in the raw
25100parameters list, and so on for the other raw parameters, then
25101evaluates the resulting filter formulas to get the actual parameter
25102values to be substituted into the original model. In the case of
25103@kbd{H a F} and @kbd{I a F} where the parameters must be error forms,
25104Calc uses the square roots of the diagonal entries of the covariance
25105matrix as error values for the raw parameters, then lets Calc's
25106standard error-form arithmetic take it from there.
25107
25108If you use @kbd{I a F} with a nonlinear model, be sure to remember
25109that the covariance matrix is in terms of the raw parameters,
25110@emph{not} the actual requested parameters. It's up to you to
25111figure out how to interpret the covariances in the presence of
25112nontrivial filter functions.
25113
25114Things are also complicated when the input contains error forms.
a4231b04
JB
25115Suppose there are three independent and dependent variables, @expr{x},
25116@expr{y}, and @expr{z}, one or more of which are error forms in the
d7b8e6c6 25117data. Calc combines all the error values by taking the square root
a4231b04
JB
25118of the sum of the squares of the errors. It then changes @expr{x}
25119and @expr{y} to be plain numbers, and makes @expr{z} into an error
25120form with this combined error. The @expr{Y(x,y,z)} part of the
d7b8e6c6 25121linearized model is evaluated, and the result should be an error
a4231b04 25122form. The error part of that result is used for
8e04863e 25123@texline @math{\sigma_i}
a4231b04
JB
25124@infoline @expr{sigma_i}
25125for the data point. If for some reason @expr{Y(x,y,z)} does not return
25126an error form, the combined error from @expr{z} is used directly for
8e04863e 25127@texline @math{\sigma_i}.
a4231b04
JB
25128@infoline @expr{sigma_i}.
25129Finally, @expr{z} is also stripped of its error
25130for use in computing @expr{F(x,y,z)}, @expr{G(x,y,z)} and so on;
d7b8e6c6
EZ
25131the righthand side of the linearized model is computed in regular
25132arithmetic with no error forms.
25133
25134(While these rules may seem complicated, they are designed to do
a4231b04
JB
25135the most reasonable thing in the typical case that @expr{Y(x,y,z)}
25136depends only on the dependent variable @expr{z}, and in fact is
25137often simply equal to @expr{z}. For common cases like polynomials
d7b8e6c6 25138and multilinear models, the combined error is simply used as the
8e04863e 25139@texline @math{\sigma}
a4231b04
JB
25140@infoline @expr{sigma}
25141for the data point with no further ado.)
d7b8e6c6
EZ
25142
25143@tex
25144\bigskip
25145@end tex
25146
25147@vindex FitRules
25148It may be the case that the model you wish to use is linearizable,
25149but Calc's built-in rules are unable to figure it out. Calc uses
25150its algebraic rewrite mechanism to linearize a model. The rewrite
25151rules are kept in the variable @code{FitRules}. You can edit this
25152variable using the @kbd{s e FitRules} command; in fact, there is
25153a special @kbd{s F} command just for editing @code{FitRules}.
25154@xref{Operations on Variables}.
25155
25156@xref{Rewrite Rules}, for a discussion of rewrite rules.
25157
5d67986c
RS
25158@ignore
25159@starindex
25160@end ignore
d7b8e6c6 25161@tindex fitvar
5d67986c
RS
25162@ignore
25163@starindex
25164@end ignore
25165@ignore
25166@mindex @idots
25167@end ignore
d7b8e6c6 25168@tindex fitparam
5d67986c
RS
25169@ignore
25170@starindex
25171@end ignore
25172@ignore
25173@mindex @null
25174@end ignore
d7b8e6c6 25175@tindex fitmodel
5d67986c
RS
25176@ignore
25177@starindex
25178@end ignore
25179@ignore
25180@mindex @null
25181@end ignore
d7b8e6c6 25182@tindex fitsystem
5d67986c
RS
25183@ignore
25184@starindex
25185@end ignore
25186@ignore
25187@mindex @null
25188@end ignore
d7b8e6c6
EZ
25189@tindex fitdummy
25190Calc uses @code{FitRules} as follows. First, it converts the model
25191to an equation if necessary and encloses the model equation in a
25192call to the function @code{fitmodel} (which is not actually a defined
25193function in Calc; it is only used as a placeholder by the rewrite rules).
25194Parameter variables are renamed to function calls @samp{fitparam(1)},
25195@samp{fitparam(2)}, and so on, and independent variables are renamed
25196to @samp{fitvar(1)}, @samp{fitvar(2)}, etc. The dependent variable
25197is the highest-numbered @code{fitvar}. For example, the power law
a4231b04 25198model @expr{a x^b} is converted to @expr{y = a x^b}, then to
d7b8e6c6 25199
d7b8e6c6 25200@smallexample
5d67986c 25201@group
d7b8e6c6 25202fitmodel(fitvar(2) = fitparam(1) fitvar(1)^fitparam(2))
d7b8e6c6 25203@end group
5d67986c 25204@end smallexample
d7b8e6c6
EZ
25205
25206Calc then applies the rewrites as if by @samp{C-u 0 a r FitRules}.
25207(The zero prefix means that rewriting should continue until no further
25208changes are possible.)
25209
25210When rewriting is complete, the @code{fitmodel} call should have
25211been replaced by a @code{fitsystem} call that looks like this:
25212
25213@example
25214fitsystem(@var{Y}, @var{FGH}, @var{abc})
25215@end example
25216
25217@noindent
a4231b04
JB
25218where @var{Y} is a formula that describes the function @expr{Y(x,y,z)},
25219@var{FGH} is the vector of formulas @expr{[F(x,y,z), G(x,y,z), H(x,y,z)]},
d7b8e6c6 25220and @var{abc} is the vector of parameter filters which refer to the
a4231b04
JB
25221raw parameters as @samp{fitdummy(1)} for @expr{A}, @samp{fitdummy(2)}
25222for @expr{B}, etc. While the number of raw parameters (the length of
d7b8e6c6
EZ
25223the @var{FGH} vector) is usually the same as the number of original
25224parameters (the length of the @var{abc} vector), this is not required.
25225
25226The power law model eventually boils down to
25227
d7b8e6c6 25228@smallexample
5d67986c 25229@group
d7b8e6c6
EZ
25230fitsystem(ln(fitvar(2)),
25231 [1, ln(fitvar(1))],
25232 [exp(fitdummy(1)), fitdummy(2)])
d7b8e6c6 25233@end group
5d67986c 25234@end smallexample
d7b8e6c6
EZ
25235
25236The actual implementation of @code{FitRules} is complicated; it
25237proceeds in four phases. First, common rearrangements are done
25238to try to bring linear terms together and to isolate functions like
25239@code{exp} and @code{ln} either all the way ``out'' (so that they
25240can be put into @var{Y}) or all the way ``in'' (so that they can
25241be put into @var{abc} or @var{FGH}). In particular, all
25242non-constant powers are converted to logs-and-exponentials form,
25243and the distributive law is used to expand products of sums.
25244Quotients are rewritten to use the @samp{fitinv} function, where
a4231b04 25245@samp{fitinv(x)} represents @expr{1/x} while the @code{FitRules}
d7b8e6c6
EZ
25246are operating. (The use of @code{fitinv} makes recognition of
25247linear-looking forms easier.) If you modify @code{FitRules}, you
25248will probably only need to modify the rules for this phase.
25249
25250Phase two, whose rules can actually also apply during phases one
25251and three, first rewrites @code{fitmodel} to a two-argument
25252form @samp{fitmodel(@var{Y}, @var{model})}, where @var{Y} is
a4231b04
JB
25253initially zero and @var{model} has been changed from @expr{a=b}
25254to @expr{a-b} form. It then tries to peel off invertible functions
d7b8e6c6
EZ
25255from the outside of @var{model} and put them into @var{Y} instead,
25256calling the equation solver to invert the functions. Finally, when
25257this is no longer possible, the @code{fitmodel} is changed to a
25258four-argument @code{fitsystem}, where the fourth argument is
25259@var{model} and the @var{FGH} and @var{abc} vectors are initially
25260empty. (The last vector is really @var{ABC}, corresponding to
25261raw parameters, for now.)
25262
25263Phase three converts a sum of items in the @var{model} to a sum
25264of @samp{fitpart(@var{a}, @var{b}, @var{c})} terms which represent
25265terms @samp{@var{a}*@var{b}*@var{c}} of the sum, where @var{a}
25266is all factors that do not involve any variables, @var{b} is all
25267factors that involve only parameters, and @var{c} is the factors
25268that involve only independent variables. (If this decomposition
25269is not possible, the rule set will not complete and Calc will
25270complain that the model is too complex.) Then @code{fitpart}s
25271with equal @var{b} or @var{c} components are merged back together
25272using the distributive law in order to minimize the number of
25273raw parameters needed.
25274
25275Phase four moves the @code{fitpart} terms into the @var{FGH} and
25276@var{ABC} vectors. Also, some of the algebraic expansions that
25277were done in phase 1 are undone now to make the formulas more
25278computationally efficient. Finally, it calls the solver one more
25279time to convert the @var{ABC} vector to an @var{abc} vector, and
25280removes the fourth @var{model} argument (which by now will be zero)
25281to obtain the three-argument @code{fitsystem} that the linear
25282least-squares solver wants to see.
25283
5d67986c
RS
25284@ignore
25285@starindex
25286@end ignore
25287@ignore
25288@mindex hasfit@idots
25289@end ignore
d7b8e6c6 25290@tindex hasfitparams
5d67986c
RS
25291@ignore
25292@starindex
25293@end ignore
25294@ignore
25295@mindex @null
25296@end ignore
d7b8e6c6
EZ
25297@tindex hasfitvars
25298Two functions which are useful in connection with @code{FitRules}
25299are @samp{hasfitparams(x)} and @samp{hasfitvars(x)}, which check
a4231b04 25300whether @expr{x} refers to any parameters or independent variables,
d7b8e6c6
EZ
25301respectively. Specifically, these functions return ``true'' if the
25302argument contains any @code{fitparam} (or @code{fitvar}) function
25303calls, and ``false'' otherwise. (Recall that ``true'' means a
25304nonzero number, and ``false'' means zero. The actual nonzero number
25305returned is the largest @var{n} from all the @samp{fitparam(@var{n})}s
25306or @samp{fitvar(@var{n})}s, respectively, that appear in the formula.)
25307
25308@tex
25309\bigskip
25310@end tex
25311
25312The @code{fit} function in algebraic notation normally takes four
25313arguments, @samp{fit(@var{model}, @var{vars}, @var{params}, @var{data})},
25314where @var{model} is the model formula as it would be typed after
25315@kbd{a F '}, @var{vars} is the independent variable or a vector of
25316independent variables, @var{params} likewise gives the parameter(s),
25317and @var{data} is the data matrix. Note that the length of @var{vars}
25318must be equal to the number of rows in @var{data} if @var{model} is
25319an equation, or one less than the number of rows if @var{model} is
25320a plain formula. (Actually, a name for the dependent variable is
25321allowed but will be ignored in the plain-formula case.)
25322
25323If @var{params} is omitted, the parameters are all variables in
25324@var{model} except those that appear in @var{vars}. If @var{vars}
25325is also omitted, Calc sorts all the variables that appear in
25326@var{model} alphabetically and uses the higher ones for @var{vars}
25327and the lower ones for @var{params}.
25328
25329Alternatively, @samp{fit(@var{modelvec}, @var{data})} is allowed
25330where @var{modelvec} is a 2- or 3-vector describing the model
25331and variables, as discussed previously.
25332
25333If Calc is unable to do the fit, the @code{fit} function is left
25334in symbolic form, ordinarily with an explanatory message. The
25335message will be ``Model expression is too complex'' if the
25336linearizer was unable to put the model into the required form.
25337
25338The @code{efit} (corresponding to @kbd{H a F}) and @code{xfit}
25339(for @kbd{I a F}) functions are completely analogous.
25340
25341@node Interpolation, , Curve Fitting Details, Curve Fitting
25342@subsection Polynomial Interpolation
25343
25344@kindex a p
25345@pindex calc-poly-interp
25346@tindex polint
25347The @kbd{a p} (@code{calc-poly-interp}) [@code{polint}] command does
a4231b04 25348a polynomial interpolation at a particular @expr{x} value. It takes
d7b8e6c6 25349two arguments from the stack: A data matrix of the sort used by
a4231b04 25350@kbd{a F}, and a single number which represents the desired @expr{x}
d7b8e6c6 25351value. Calc effectively does an exact polynomial fit as if by @kbd{a F i},
a4231b04
JB
25352then substitutes the @expr{x} value into the result in order to get an
25353approximate @expr{y} value based on the fit. (Calc does not actually
d7b8e6c6
EZ
25354use @kbd{a F i}, however; it uses a direct method which is both more
25355efficient and more numerically stable.)
25356
a4231b04
JB
25357The result of @kbd{a p} is actually a vector of two values: The @expr{y}
25358value approximation, and an error measure @expr{dy} that reflects Calc's
d7b8e6c6 25359estimation of the probable error of the approximation at that value of
a4231b04
JB
25360@expr{x}. If the input @expr{x} is equal to any of the @expr{x} values
25361in the data matrix, the output @expr{y} will be the corresponding @expr{y}
25362value from the matrix, and the output @expr{dy} will be exactly zero.
d7b8e6c6
EZ
25363
25364A prefix argument of 2 causes @kbd{a p} to take separate x- and
25365y-vectors from the stack instead of one data matrix.
25366
a4231b04
JB
25367If @expr{x} is a vector of numbers, @kbd{a p} will return a matrix of
25368interpolated results for each of those @expr{x} values. (The matrix will
25369have two columns, the @expr{y} values and the @expr{dy} values.)
25370If @expr{x} is a formula instead of a number, the @code{polint} function
d7b8e6c6
EZ
25371remains in symbolic form; use the @kbd{a "} command to expand it out to
25372a formula that describes the fit in symbolic terms.
25373
25374In all cases, the @kbd{a p} command leaves the data vectors or matrix
a4231b04 25375on the stack. Only the @expr{x} value is replaced by the result.
d7b8e6c6
EZ
25376
25377@kindex H a p
25378@tindex ratint
25379The @kbd{H a p} [@code{ratint}] command does a rational function
25380interpolation. It is used exactly like @kbd{a p}, except that it
25381uses as its model the quotient of two polynomials. If there are
a4231b04
JB
25382@expr{N} data points, the numerator and denominator polynomials will
25383each have degree @expr{N/2} (if @expr{N} is odd, the denominator will
d7b8e6c6
EZ
25384have degree one higher than the numerator).
25385
25386Rational approximations have the advantage that they can accurately
25387describe functions that have poles (points at which the function's value
25388goes to infinity, so that the denominator polynomial of the approximation
a4231b04 25389goes to zero). If @expr{x} corresponds to a pole of the fitted rational
d7b8e6c6
EZ
25390function, then the result will be a division by zero. If Infinite mode
25391is enabled, the result will be @samp{[uinf, uinf]}.
25392
25393There is no way to get the actual coefficients of the rational function
25394used by @kbd{H a p}. (The algorithm never generates these coefficients
25395explicitly, and quotients of polynomials are beyond @w{@kbd{a F}}'s
25396capabilities to fit.)
25397
25398@node Summations, Logical Operations, Curve Fitting, Algebra
25399@section Summations
25400
25401@noindent
25402@cindex Summation of a series
25403@kindex a +
25404@pindex calc-summation
25405@tindex sum
25406The @kbd{a +} (@code{calc-summation}) [@code{sum}] command computes
25407the sum of a formula over a certain range of index values. The formula
25408is taken from the top of the stack; the command prompts for the
25409name of the summation index variable, the lower limit of the
25410sum (any formula), and the upper limit of the sum. If you
25411enter a blank line at any of these prompts, that prompt and
25412any later ones are answered by reading additional elements from
5d67986c 25413the stack. Thus, @kbd{' k^2 @key{RET} ' k @key{RET} 1 @key{RET} 5 @key{RET} a + @key{RET}}
d7b8e6c6
EZ
25414produces the result 55.
25415@tex
25416\turnoffactive
25417$$ \sum_{k=1}^5 k^2 = 55 $$
25418@end tex
25419
25420The choice of index variable is arbitrary, but it's best not to
25421use a variable with a stored value. In particular, while
25422@code{i} is often a favorite index variable, it should be avoided
a4231b04 25423in Calc because @code{i} has the imaginary constant @expr{(0, 1)}
d7b8e6c6 25424as a value. If you pressed @kbd{=} on a sum over @code{i}, it would
a4231b04 25425be changed to a nonsensical sum over the ``variable'' @expr{(0, 1)}!
d7b8e6c6 25426If you really want to use @code{i} as an index variable, use
5d67986c 25427@w{@kbd{s u i @key{RET}}} first to ``unstore'' this variable.
d7b8e6c6
EZ
25428(@xref{Storing Variables}.)
25429
25430A numeric prefix argument steps the index by that amount rather
5d67986c 25431than by one. Thus @kbd{' a_k @key{RET} C-u -2 a + k @key{RET} 10 @key{RET} 0 @key{RET}}
d7b8e6c6
EZ
25432yields @samp{a_10 + a_8 + a_6 + a_4 + a_2 + a_0}. A prefix
25433argument of plain @kbd{C-u} causes @kbd{a +} to prompt for the
25434step value, in which case you can enter any formula or enter
25435a blank line to take the step value from the stack. With the
25436@kbd{C-u} prefix, @kbd{a +} can take up to five arguments from
25437the stack: The formula, the variable, the lower limit, the
25438upper limit, and (at the top of the stack), the step value.
25439
25440Calc knows how to do certain sums in closed form. For example,
25441@samp{sum(6 k^2, k, 1, n) = @w{2 n^3} + 3 n^2 + n}. In particular,
25442this is possible if the formula being summed is polynomial or
25443exponential in the index variable. Sums of logarithms are
25444transformed into logarithms of products. Sums of trigonometric
25445and hyperbolic functions are transformed to sums of exponentials
25446and then done in closed form. Also, of course, sums in which the
25447lower and upper limits are both numbers can always be evaluated
25448just by grinding them out, although Calc will use closed forms
25449whenever it can for the sake of efficiency.
25450
25451The notation for sums in algebraic formulas is
25452@samp{sum(@var{expr}, @var{var}, @var{low}, @var{high}, @var{step})}.
25453If @var{step} is omitted, it defaults to one. If @var{high} is
25454omitted, @var{low} is actually the upper limit and the lower limit
25455is one. If @var{low} is also omitted, the limits are @samp{-inf}
25456and @samp{inf}, respectively.
25457
25458Infinite sums can sometimes be evaluated: @samp{sum(.5^k, k, 1, inf)}
a4231b04 25459returns @expr{1}. This is done by evaluating the sum in closed
d7b8e6c6
EZ
25460form (to @samp{1. - 0.5^n} in this case), then evaluating this
25461formula with @code{n} set to @code{inf}. Calc's usual rules
25462for ``infinite'' arithmetic can find the answer from there. If
25463infinite arithmetic yields a @samp{nan}, or if the sum cannot be
25464solved in closed form, Calc leaves the @code{sum} function in
25465symbolic form. @xref{Infinities}.
25466
25467As a special feature, if the limits are infinite (or omitted, as
25468described above) but the formula includes vectors subscripted by
25469expressions that involve the iteration variable, Calc narrows
25470the limits to include only the range of integers which result in
2cbd16b9 25471valid subscripts for the vector. For example, the sum
d7b8e6c6
EZ
25472@samp{sum(k [a,b,c,d,e,f,g]_(2k),k)} evaluates to @samp{b + 2 d + 3 f}.
25473
25474The limits of a sum do not need to be integers. For example,
25475@samp{sum(a_k, k, 0, 2 n, n)} produces @samp{a_0 + a_n + a_(2 n)}.
25476Calc computes the number of iterations using the formula
25477@samp{1 + (@var{high} - @var{low}) / @var{step}}, which must,
25478after simplification as if by @kbd{a s}, evaluate to an integer.
25479
25480If the number of iterations according to the above formula does
ce7c7522 25481not come out to an integer, the sum is invalid and will be left
d7b8e6c6
EZ
25482in symbolic form. However, closed forms are still supplied, and
25483you are on your honor not to misuse the resulting formulas by
25484substituting mismatched bounds into them. For example,
25485@samp{sum(k, k, 1, 10, 2)} is invalid, but Calc will go ahead and
25486evaluate the closed form solution for the limits 1 and 10 to get
25487the rather dubious answer, 29.25.
25488
25489If the lower limit is greater than the upper limit (assuming a
25490positive step size), the result is generally zero. However,
25491Calc only guarantees a zero result when the upper limit is
25492exactly one step less than the lower limit, i.e., if the number
8e04863e 25493of iterations is @mathit{-1}. Thus @samp{sum(f(k), k, n, n-1)} is zero
d7b8e6c6
EZ
25494but the sum from @samp{n} to @samp{n-2} may report a nonzero value
25495if Calc used a closed form solution.
25496
a4231b04 25497Calc's logical predicates like @expr{a < b} return 1 for ``true''
d7b8e6c6
EZ
25498and 0 for ``false.'' @xref{Logical Operations}. This can be
25499used to advantage for building conditional sums. For example,
25500@samp{sum(prime(k)*k^2, k, 1, 20)} is the sum of the squares of all
25501prime numbers from 1 to 20; the @code{prime} predicate returns 1 if
25502its argument is prime and 0 otherwise. You can read this expression
a4231b04 25503as ``the sum of @expr{k^2}, where @expr{k} is prime.'' Indeed,
d7b8e6c6
EZ
25504@samp{sum(prime(k)*k^2, k)} would represent the sum of @emph{all} primes
25505squared, since the limits default to plus and minus infinity, but
25506there are no such sums that Calc's built-in rules can do in
25507closed form.
25508
25509As another example, @samp{sum((k != k_0) * f(k), k, 1, n)} is the
a4231b04
JB
25510sum of @expr{f(k)} for all @expr{k} from 1 to @expr{n}, excluding
25511one value @expr{k_0}. Slightly more tricky is the summand
d7b8e6c6 25512@samp{(k != k_0) / (k - k_0)}, which is an attempt to describe
a4231b04
JB
25513the sum of all @expr{1/(k-k_0)} except at @expr{k = k_0}, where
25514this would be a division by zero. But at @expr{k = k_0}, this
25515formula works out to the indeterminate form @expr{0 / 0}, which
d7b8e6c6
EZ
25516Calc will not assume is zero. Better would be to use
25517@samp{(k != k_0) ? 1/(k-k_0) : 0}; the @samp{? :} operator does
a4231b04 25518an ``if-then-else'' test: This expression says, ``if
8e04863e 25519@texline @math{k \ne k_0},
a4231b04
JB
25520@infoline @expr{k != k_0},
25521then @expr{1/(k-k_0)}, else zero.'' Now the formula @expr{1/(k-k_0)}
25522will not even be evaluated by Calc when @expr{k = k_0}.
d7b8e6c6
EZ
25523
25524@cindex Alternating sums
25525@kindex a -
25526@pindex calc-alt-summation
25527@tindex asum
25528The @kbd{a -} (@code{calc-alt-summation}) [@code{asum}] command
25529computes an alternating sum. Successive terms of the sequence
25530are given alternating signs, with the first term (corresponding
25531to the lower index value) being positive. Alternating sums
25532are converted to normal sums with an extra term of the form
25533@samp{(-1)^(k-@var{low})}. This formula is adjusted appropriately
25534if the step value is other than one. For example, the Taylor
25535series for the sine function is @samp{asum(x^k / k!, k, 1, inf, 2)}.
25536(Calc cannot evaluate this infinite series, but it can approximate
25537it if you replace @code{inf} with any particular odd number.)
25538Calc converts this series to a regular sum with a step of one,
25539namely @samp{sum((-1)^k x^(2k+1) / (2k+1)!, k, 0, inf)}.
25540
25541@cindex Product of a sequence
25542@kindex a *
25543@pindex calc-product
25544@tindex prod
25545The @kbd{a *} (@code{calc-product}) [@code{prod}] command is
25546the analogous way to take a product of many terms. Calc also knows
25547some closed forms for products, such as @samp{prod(k, k, 1, n) = n!}.
25548Conditional products can be written @samp{prod(k^prime(k), k, 1, n)}
25549or @samp{prod(prime(k) ? k : 1, k, 1, n)}.
25550
25551@kindex a T
25552@pindex calc-tabulate
25553@tindex table
25554The @kbd{a T} (@code{calc-tabulate}) [@code{table}] command
25555evaluates a formula at a series of iterated index values, just
25556like @code{sum} and @code{prod}, but its result is simply a
25557vector of the results. For example, @samp{table(a_i, i, 1, 7, 2)}
25558produces @samp{[a_1, a_3, a_5, a_7]}.
25559
25560@node Logical Operations, Rewrite Rules, Summations, Algebra
25561@section Logical Operations
25562
25563@noindent
25564The following commands and algebraic functions return true/false values,
25565where 1 represents ``true'' and 0 represents ``false.'' In cases where
25566a truth value is required (such as for the condition part of a rewrite
25567rule, or as the condition for a @w{@kbd{Z [ Z ]}} control structure), any
25568nonzero value is accepted to mean ``true.'' (Specifically, anything
25569for which @code{dnonzero} returns 1 is ``true,'' and anything for
25570which @code{dnonzero} returns 0 or cannot decide is assumed ``false.''
25571Note that this means that @w{@kbd{Z [ Z ]}} will execute the ``then''
25572portion if its condition is provably true, but it will execute the
a4231b04 25573``else'' portion for any condition like @expr{a = b} that is not
d7b8e6c6
EZ
25574provably true, even if it might be true. Algebraic functions that
25575have conditions as arguments, like @code{? :} and @code{&&}, remain
25576unevaluated if the condition is neither provably true nor provably
25577false. @xref{Declarations}.)
25578
25579@kindex a =
25580@pindex calc-equal-to
25581@tindex eq
25582@tindex =
25583@tindex ==
25584The @kbd{a =} (@code{calc-equal-to}) command, or @samp{eq(a,b)} function
25585(which can also be written @samp{a = b} or @samp{a == b} in an algebraic
a4231b04 25586formula) is true if @expr{a} and @expr{b} are equal, either because they
d7b8e6c6
EZ
25587are identical expressions, or because they are numbers which are
25588numerically equal. (Thus the integer 1 is considered equal to the float
a4231b04 255891.0.) If the equality of @expr{a} and @expr{b} cannot be determined,
d7b8e6c6
EZ
25590the comparison is left in symbolic form. Note that as a command, this
25591operation pops two values from the stack and pushes back either a 1 or
25592a 0, or a formula @samp{a = b} if the values' equality cannot be determined.
25593
25594Many Calc commands use @samp{=} formulas to represent @dfn{equations}.
25595For example, the @kbd{a S} (@code{calc-solve-for}) command rearranges
25596an equation to solve for a given variable. The @kbd{a M}
25597(@code{calc-map-equation}) command can be used to apply any
25598function to both sides of an equation; for example, @kbd{2 a M *}
25599multiplies both sides of the equation by two. Note that just
25600@kbd{2 *} would not do the same thing; it would produce the formula
25601@samp{2 (a = b)} which represents 2 if the equality is true or
25602zero if not.
25603
25604The @code{eq} function with more than two arguments (e.g., @kbd{C-u 3 a =}
25605or @samp{a = b = c}) tests if all of its arguments are equal. In
25606algebraic notation, the @samp{=} operator is unusual in that it is
25607neither left- nor right-associative: @samp{a = b = c} is not the
25608same as @samp{(a = b) = c} or @samp{a = (b = c)} (which each compare
25609one variable with the 1 or 0 that results from comparing two other
25610variables).
25611
25612@kindex a #
25613@pindex calc-not-equal-to
25614@tindex neq
25615@tindex !=
25616The @kbd{a #} (@code{calc-not-equal-to}) command, or @samp{neq(a,b)} or
a4231b04 25617@samp{a != b} function, is true if @expr{a} and @expr{b} are not equal.
d7b8e6c6 25618This also works with more than two arguments; @samp{a != b != c != d}
a4231b04 25619tests that all four of @expr{a}, @expr{b}, @expr{c}, and @expr{d} are
d7b8e6c6
EZ
25620distinct numbers.
25621
25622@kindex a <
25623@tindex lt
5d67986c
RS
25624@ignore
25625@mindex @idots
25626@end ignore
d7b8e6c6 25627@kindex a >
5d67986c
RS
25628@ignore
25629@mindex @null
25630@end ignore
d7b8e6c6 25631@kindex a [
5d67986c
RS
25632@ignore
25633@mindex @null
25634@end ignore
d7b8e6c6
EZ
25635@kindex a ]
25636@pindex calc-less-than
25637@pindex calc-greater-than
25638@pindex calc-less-equal
25639@pindex calc-greater-equal
5d67986c
RS
25640@ignore
25641@mindex @null
25642@end ignore
d7b8e6c6 25643@tindex gt
5d67986c
RS
25644@ignore
25645@mindex @null
25646@end ignore
d7b8e6c6 25647@tindex leq
5d67986c
RS
25648@ignore
25649@mindex @null
25650@end ignore
d7b8e6c6 25651@tindex geq
5d67986c
RS
25652@ignore
25653@mindex @null
25654@end ignore
d7b8e6c6 25655@tindex <
5d67986c
RS
25656@ignore
25657@mindex @null
25658@end ignore
d7b8e6c6 25659@tindex >
5d67986c
RS
25660@ignore
25661@mindex @null
25662@end ignore
d7b8e6c6 25663@tindex <=
5d67986c
RS
25664@ignore
25665@mindex @null
25666@end ignore
d7b8e6c6
EZ
25667@tindex >=
25668The @kbd{a <} (@code{calc-less-than}) [@samp{lt(a,b)} or @samp{a < b}]
a4231b04 25669operation is true if @expr{a} is less than @expr{b}. Similar functions
d7b8e6c6
EZ
25670are @kbd{a >} (@code{calc-greater-than}) [@samp{gt(a,b)} or @samp{a > b}],
25671@kbd{a [} (@code{calc-less-equal}) [@samp{leq(a,b)} or @samp{a <= b}], and
25672@kbd{a ]} (@code{calc-greater-equal}) [@samp{geq(a,b)} or @samp{a >= b}].
25673
25674While the inequality functions like @code{lt} do not accept more
25675than two arguments, the syntax @w{@samp{a <= b < c}} is translated to an
25676equivalent expression involving intervals: @samp{b in [a .. c)}.
25677(See the description of @code{in} below.) All four combinations
25678of @samp{<} and @samp{<=} are allowed, or any of the four combinations
25679of @samp{>} and @samp{>=}. Four-argument constructions like
25680@samp{a < b < c < d}, and mixtures like @w{@samp{a < b = c}} that
25681involve both equalities and inequalities, are not allowed.
25682
25683@kindex a .
25684@pindex calc-remove-equal
25685@tindex rmeq
25686The @kbd{a .} (@code{calc-remove-equal}) [@code{rmeq}] command extracts
25687the righthand side of the equation or inequality on the top of the
25688stack. It also works elementwise on vectors. For example, if
25689@samp{[x = 2.34, y = z / 2]} is on the stack, then @kbd{a .} produces
25690@samp{[2.34, z / 2]}. As a special case, if the righthand side is a
25691variable and the lefthand side is a number (as in @samp{2.34 = x}), then
25692Calc keeps the lefthand side instead. Finally, this command works with
25693assignments @samp{x := 2.34} as well as equations, always taking the
25694the righthand side, and for @samp{=>} (evaluates-to) operators, always
25695taking the lefthand side.
25696
25697@kindex a &
25698@pindex calc-logical-and
25699@tindex land
25700@tindex &&
25701The @kbd{a &} (@code{calc-logical-and}) [@samp{land(a,b)} or @samp{a && b}]
25702function is true if both of its arguments are true, i.e., are
a4231b04
JB
25703non-zero numbers. In this case, the result will be either @expr{a} or
25704@expr{b}, chosen arbitrarily. If either argument is zero, the result is
d7b8e6c6
EZ
25705zero. Otherwise, the formula is left in symbolic form.
25706
25707@kindex a |
25708@pindex calc-logical-or
25709@tindex lor
25710@tindex ||
25711The @kbd{a |} (@code{calc-logical-or}) [@samp{lor(a,b)} or @samp{a || b}]
25712function is true if either or both of its arguments are true (nonzero).
25713The result is whichever argument was nonzero, choosing arbitrarily if both
a4231b04 25714are nonzero. If both @expr{a} and @expr{b} are zero, the result is
d7b8e6c6
EZ
25715zero.
25716
25717@kindex a !
25718@pindex calc-logical-not
25719@tindex lnot
25720@tindex !
25721The @kbd{a !} (@code{calc-logical-not}) [@samp{lnot(a)} or @samp{!@: a}]
a4231b04
JB
25722function is true if @expr{a} is false (zero), or false if @expr{a} is
25723true (nonzero). It is left in symbolic form if @expr{a} is not a
d7b8e6c6
EZ
25724number.
25725
25726@kindex a :
25727@pindex calc-logical-if
25728@tindex if
5d67986c
RS
25729@ignore
25730@mindex ? :
25731@end ignore
d7b8e6c6 25732@tindex ?
5d67986c
RS
25733@ignore
25734@mindex @null
25735@end ignore
d7b8e6c6
EZ
25736@tindex :
25737@cindex Arguments, not evaluated
25738The @kbd{a :} (@code{calc-logical-if}) [@samp{if(a,b,c)} or @samp{a ? b :@: c}]
a4231b04
JB
25739function is equal to either @expr{b} or @expr{c} if @expr{a} is a nonzero
25740number or zero, respectively. If @expr{a} is not a number, the test is
25741left in symbolic form and neither @expr{b} nor @expr{c} is evaluated in
d7b8e6c6
EZ
25742any way. In algebraic formulas, this is one of the few Calc functions
25743whose arguments are not automatically evaluated when the function itself
25744is evaluated. The others are @code{lambda}, @code{quote}, and
25745@code{condition}.
25746
25747One minor surprise to watch out for is that the formula @samp{a?3:4}
25748will not work because the @samp{3:4} is parsed as a fraction instead of
25749as three separate symbols. Type something like @samp{a ? 3 : 4} or
25750@samp{a?(3):4} instead.
25751
a4231b04
JB
25752As a special case, if @expr{a} evaluates to a vector, then both @expr{b}
25753and @expr{c} are evaluated; the result is a vector of the same length
25754as @expr{a} whose elements are chosen from corresponding elements of
25755@expr{b} and @expr{c} according to whether each element of @expr{a}
25756is zero or nonzero. Each of @expr{b} and @expr{c} must be either a
25757vector of the same length as @expr{a}, or a non-vector which is matched
25758with all elements of @expr{a}.
d7b8e6c6
EZ
25759
25760@kindex a @{
25761@pindex calc-in-set
25762@tindex in
25763The @kbd{a @{} (@code{calc-in-set}) [@samp{in(a,b)}] function is true if
a4231b04
JB
25764the number @expr{a} is in the set of numbers represented by @expr{b}.
25765If @expr{b} is an interval form, @expr{a} must be one of the values
25766encompassed by the interval. If @expr{b} is a vector, @expr{a} must be
d7b8e6c6 25767equal to one of the elements of the vector. (If any vector elements are
a4231b04
JB
25768intervals, @expr{a} must be in any of the intervals.) If @expr{b} is a
25769plain number, @expr{a} must be numerically equal to @expr{b}.
d7b8e6c6
EZ
25770@xref{Set Operations}, for a group of commands that manipulate sets
25771of this sort.
25772
5d67986c
RS
25773@ignore
25774@starindex
25775@end ignore
d7b8e6c6
EZ
25776@tindex typeof
25777The @samp{typeof(a)} function produces an integer or variable which
a4231b04 25778characterizes @expr{a}. If @expr{a} is a number, vector, or variable,
d7b8e6c6
EZ
25779the result will be one of the following numbers:
25780
25781@example
25782 1 Integer
25783 2 Fraction
25784 3 Floating-point number
25785 4 HMS form
25786 5 Rectangular complex number
25787 6 Polar complex number
25788 7 Error form
25789 8 Interval form
25790 9 Modulo form
2579110 Date-only form
2579211 Date/time form
2579312 Infinity (inf, uinf, or nan)
25794100 Variable
25795101 Vector (but not a matrix)
25796102 Matrix
25797@end example
25798
a4231b04 25799Otherwise, @expr{a} is a formula, and the result is a variable which
d7b8e6c6
EZ
25800represents the name of the top-level function call.
25801
5d67986c
RS
25802@ignore
25803@starindex
25804@end ignore
d7b8e6c6 25805@tindex integer
5d67986c
RS
25806@ignore
25807@starindex
25808@end ignore
d7b8e6c6 25809@tindex real
5d67986c
RS
25810@ignore
25811@starindex
25812@end ignore
d7b8e6c6 25813@tindex constant
a4231b04 25814The @samp{integer(a)} function returns true if @expr{a} is an integer.
d7b8e6c6 25815The @samp{real(a)} function
a4231b04
JB
25816is true if @expr{a} is a real number, either integer, fraction, or
25817float. The @samp{constant(a)} function returns true if @expr{a} is
d7b8e6c6
EZ
25818any of the objects for which @code{typeof} would produce an integer
25819code result except for variables, and provided that the components of
25820an object like a vector or error form are themselves constant.
25821Note that infinities do not satisfy any of these tests, nor do
a4231b04 25822special constants like @code{pi} and @code{e}.
d7b8e6c6
EZ
25823
25824@xref{Declarations}, for a set of similar functions that recognize
25825formulas as well as actual numbers. For example, @samp{dint(floor(x))}
25826is true because @samp{floor(x)} is provably integer-valued, but
25827@samp{integer(floor(x))} does not because @samp{floor(x)} is not
25828literally an integer constant.
25829
5d67986c
RS
25830@ignore
25831@starindex
25832@end ignore
d7b8e6c6
EZ
25833@tindex refers
25834The @samp{refers(a,b)} function is true if the variable (or sub-expression)
a4231b04 25835@expr{b} appears in @expr{a}, or false otherwise. Unlike the other
d7b8e6c6
EZ
25836tests described here, this function returns a definite ``no'' answer
25837even if its arguments are still in symbolic form. The only case where
a4231b04
JB
25838@code{refers} will be left unevaluated is if @expr{a} is a plain
25839variable (different from @expr{b}).
d7b8e6c6 25840
5d67986c
RS
25841@ignore
25842@starindex
25843@end ignore
d7b8e6c6 25844@tindex negative
a4231b04
JB
25845The @samp{negative(a)} function returns true if @expr{a} ``looks'' negative,
25846because it is a negative number, because it is of the form @expr{-x},
d7b8e6c6
EZ
25847or because it is a product or quotient with a term that looks negative.
25848This is most useful in rewrite rules. Beware that @samp{negative(a)}
a4231b04 25849evaluates to 1 or 0 for @emph{any} argument @expr{a}, so it can only
d7b8e6c6
EZ
25850be stored in a formula if the default simplifications are turned off
25851first with @kbd{m O} (or if it appears in an unevaluated context such
25852as a rewrite rule condition).
25853
5d67986c
RS
25854@ignore
25855@starindex
25856@end ignore
d7b8e6c6 25857@tindex variable
a4231b04
JB
25858The @samp{variable(a)} function is true if @expr{a} is a variable,
25859or false if not. If @expr{a} is a function call, this test is left
d7b8e6c6
EZ
25860in symbolic form. Built-in variables like @code{pi} and @code{inf}
25861are considered variables like any others by this test.
25862
5d67986c
RS
25863@ignore
25864@starindex
25865@end ignore
d7b8e6c6 25866@tindex nonvar
a4231b04 25867The @samp{nonvar(a)} function is true if @expr{a} is a non-variable.
d7b8e6c6
EZ
25868If its argument is a variable it is left unsimplified; it never
25869actually returns zero. However, since Calc's condition-testing
25870commands consider ``false'' anything not provably true, this is
25871often good enough.
25872
5d67986c
RS
25873@ignore
25874@starindex
25875@end ignore
d7b8e6c6 25876@tindex lin
5d67986c
RS
25877@ignore
25878@starindex
25879@end ignore
d7b8e6c6 25880@tindex linnt
5d67986c
RS
25881@ignore
25882@starindex
25883@end ignore
d7b8e6c6 25884@tindex islin
5d67986c
RS
25885@ignore
25886@starindex
25887@end ignore
d7b8e6c6
EZ
25888@tindex islinnt
25889@cindex Linearity testing
25890The functions @code{lin}, @code{linnt}, @code{islin}, and @code{islinnt}
25891check if an expression is ``linear,'' i.e., can be written in the form
a4231b04
JB
25892@expr{a + b x} for some constants @expr{a} and @expr{b}, and some
25893variable or subformula @expr{x}. The function @samp{islin(f,x)} checks
25894if formula @expr{f} is linear in @expr{x}, returning 1 if so. For
d7b8e6c6
EZ
25895example, @samp{islin(x,x)}, @samp{islin(-x,x)}, @samp{islin(3,x)}, and
25896@samp{islin(x y / 3 - 2, x)} all return 1. The @samp{lin(f,x)} function
25897is similar, except that instead of returning 1 it returns the vector
a4231b04
JB
25898@expr{[a, b, x]}. For the above examples, this vector would be
25899@expr{[0, 1, x]}, @expr{[0, -1, x]}, @expr{[3, 0, x]}, and
25900@expr{[-2, y/3, x]}, respectively. Both @code{lin} and @code{islin}
d7b8e6c6
EZ
25901generally remain unevaluated for expressions which are not linear,
25902e.g., @samp{lin(2 x^2, x)} and @samp{lin(sin(x), x)}. The second
25903argument can also be a formula; @samp{islin(2 + 3 sin(x), sin(x))}
25904returns true.
25905
25906The @code{linnt} and @code{islinnt} functions perform a similar check,
25907but require a ``non-trivial'' linear form, which means that the
a4231b04
JB
25908@expr{b} coefficient must be non-zero. For example, @samp{lin(2,x)}
25909returns @expr{[2, 0, x]} and @samp{lin(y,x)} returns @expr{[y, 0, x]},
d7b8e6c6
EZ
25910but @samp{linnt(2,x)} and @samp{linnt(y,x)} are left unevaluated
25911(in other words, these formulas are considered to be only ``trivially''
a4231b04 25912linear in @expr{x}).
d7b8e6c6
EZ
25913
25914All four linearity-testing functions allow you to omit the second
25915argument, in which case the input may be linear in any non-constant
a4231b04
JB
25916formula. Here, the @expr{a=0}, @expr{b=1} case is also considered
25917trivial, and only constant values for @expr{a} and @expr{b} are
25918recognized. Thus, @samp{lin(2 x y)} returns @expr{[0, 2, x y]},
25919@samp{lin(2 - x y)} returns @expr{[2, -1, x y]}, and @samp{lin(x y)}
25920returns @expr{[0, 1, x y]}. The @code{linnt} function would allow the
d7b8e6c6
EZ
25921first two cases but not the third. Also, neither @code{lin} nor
25922@code{linnt} accept plain constants as linear in the one-argument
25923case: @samp{islin(2,x)} is true, but @samp{islin(2)} is false.
25924
5d67986c
RS
25925@ignore
25926@starindex
25927@end ignore
d7b8e6c6 25928@tindex istrue
a4231b04
JB
25929The @samp{istrue(a)} function returns 1 if @expr{a} is a nonzero
25930number or provably nonzero formula, or 0 if @expr{a} is anything else.
d7b8e6c6
EZ
25931Calls to @code{istrue} can only be manipulated if @kbd{m O} mode is
25932used to make sure they are not evaluated prematurely. (Note that
25933declarations are used when deciding whether a formula is true;
25934@code{istrue} returns 1 when @code{dnonzero} would return 1, and
25935it returns 0 when @code{dnonzero} would return 0 or leave itself
25936in symbolic form.)
25937
25938@node Rewrite Rules, , Logical Operations, Algebra
25939@section Rewrite Rules
25940
25941@noindent
25942@cindex Rewrite rules
25943@cindex Transformations
25944@cindex Pattern matching
25945@kindex a r
25946@pindex calc-rewrite
25947@tindex rewrite
25948The @kbd{a r} (@code{calc-rewrite}) [@code{rewrite}] command makes
25949substitutions in a formula according to a specified pattern or patterns
25950known as @dfn{rewrite rules}. Whereas @kbd{a b} (@code{calc-substitute})
25951matches literally, so that substituting @samp{sin(x)} with @samp{cos(x)}
25952matches only the @code{sin} function applied to the variable @code{x},
25953rewrite rules match general kinds of formulas; rewriting using the rule
25954@samp{sin(x) := cos(x)} matches @code{sin} of any argument and replaces
25955it with @code{cos} of that same argument. The only significance of the
25956name @code{x} is that the same name is used on both sides of the rule.
25957
25958Rewrite rules rearrange formulas already in Calc's memory.
25959@xref{Syntax Tables}, to read about @dfn{syntax rules}, which are
25960similar to algebraic rewrite rules but operate when new algebraic
25961entries are being parsed, converting strings of characters into
25962Calc formulas.
25963
25964@menu
25965* Entering Rewrite Rules::
25966* Basic Rewrite Rules::
25967* Conditional Rewrite Rules::
25968* Algebraic Properties of Rewrite Rules::
25969* Other Features of Rewrite Rules::
25970* Composing Patterns in Rewrite Rules::
25971* Nested Formulas with Rewrite Rules::
25972* Multi-Phase Rewrite Rules::
25973* Selections with Rewrite Rules::
25974* Matching Commands::
25975* Automatic Rewrites::
25976* Debugging Rewrites::
25977* Examples of Rewrite Rules::
25978@end menu
25979
25980@node Entering Rewrite Rules, Basic Rewrite Rules, Rewrite Rules, Rewrite Rules
25981@subsection Entering Rewrite Rules
25982
25983@noindent
25984Rewrite rules normally use the ``assignment'' operator
25985@samp{@var{old} := @var{new}}.
25986This operator is equivalent to the function call @samp{assign(old, new)}.
25987The @code{assign} function is undefined by itself in Calc, so an
25988assignment formula such as a rewrite rule will be left alone by ordinary
25989Calc commands. But certain commands, like the rewrite system, interpret
a4231b04 25990assignments in special ways.
d7b8e6c6
EZ
25991
25992For example, the rule @samp{sin(x)^2 := 1-cos(x)^2} says to replace
25993every occurrence of the sine of something, squared, with one minus the
25994square of the cosine of that same thing. All by itself as a formula
25995on the stack it does nothing, but when given to the @kbd{a r} command
25996it turns that command into a sine-squared-to-cosine-squared converter.
25997
25998To specify a set of rules to be applied all at once, make a vector of
25999rules.
26000
26001When @kbd{a r} prompts you to enter the rewrite rules, you can answer
26002in several ways:
26003
26004@enumerate
26005@item
5d67986c 26006With a rule: @kbd{f(x) := g(x) @key{RET}}.
d7b8e6c6 26007@item
5d67986c 26008With a vector of rules: @kbd{[f1(x) := g1(x), f2(x) := g2(x)] @key{RET}}.
d7b8e6c6
EZ
26009(You can omit the enclosing square brackets if you wish.)
26010@item
26011With the name of a variable that contains the rule or rules vector:
5d67986c 26012@kbd{myrules @key{RET}}.
d7b8e6c6
EZ
26013@item
26014With any formula except a rule, a vector, or a variable name; this
26015will be interpreted as the @var{old} half of a rewrite rule,
26016and you will be prompted a second time for the @var{new} half:
26017@kbd{f(x) @key{RET} g(x) @key{RET}}.
26018@item
26019With a blank line, in which case the rule, rules vector, or variable
26020will be taken from the top of the stack (and the formula to be
26021rewritten will come from the second-to-top position).
26022@end enumerate
26023
26024If you enter the rules directly (as opposed to using rules stored
26025in a variable), those rules will be put into the Trail so that you
26026can retrieve them later. @xref{Trail Commands}.
26027
26028It is most convenient to store rules you use often in a variable and
26029invoke them by giving the variable name. The @kbd{s e}
26030(@code{calc-edit-variable}) command is an easy way to create or edit a
26031rule set stored in a variable. You may also wish to use @kbd{s p}
26032(@code{calc-permanent-variable}) to save your rules permanently;
a4231b04 26033@pxref{Operations on Variables}.
d7b8e6c6
EZ
26034
26035Rewrite rules are compiled into a special internal form for faster
26036matching. If you enter a rule set directly it must be recompiled
26037every time. If you store the rules in a variable and refer to them
26038through that variable, they will be compiled once and saved away
26039along with the variable for later reference. This is another good
26040reason to store your rules in a variable.
26041
26042Calc also accepts an obsolete notation for rules, as vectors
26043@samp{[@var{old}, @var{new}]}. But because it is easily confused with a
26044vector of two rules, the use of this notation is no longer recommended.
26045
26046@node Basic Rewrite Rules, Conditional Rewrite Rules, Entering Rewrite Rules, Rewrite Rules
26047@subsection Basic Rewrite Rules
26048
26049@noindent
a4231b04
JB
26050To match a particular formula @expr{x} with a particular rewrite rule
26051@samp{@var{old} := @var{new}}, Calc compares the structure of @expr{x} with
d7b8e6c6 26052the structure of @var{old}. Variables that appear in @var{old} are
a4231b04 26053treated as @dfn{meta-variables}; the corresponding positions in @expr{x}
d7b8e6c6
EZ
26054may contain any sub-formulas. For example, the pattern @samp{f(x,y)}
26055would match the expression @samp{f(12, a+1)} with the meta-variable
26056@samp{x} corresponding to 12 and with @samp{y} corresponding to
26057@samp{a+1}. However, this pattern would not match @samp{f(12)} or
26058@samp{g(12, a+1)}, since there is no assignment of the meta-variables
26059that will make the pattern match these expressions. Notice that if
26060the pattern is a single meta-variable, it will match any expression.
26061
26062If a given meta-variable appears more than once in @var{old}, the
a4231b04 26063corresponding sub-formulas of @expr{x} must be identical. Thus
d7b8e6c6
EZ
26064the pattern @samp{f(x,x)} would match @samp{f(12, 12)} and
26065@samp{f(a+1, a+1)} but not @samp{f(12, a+1)} or @samp{f(a+b, b+a)}.
26066(@xref{Conditional Rewrite Rules}, for a way to match the latter.)
26067
26068Things other than variables must match exactly between the pattern
26069and the target formula. To match a particular variable exactly, use
26070the pseudo-function @samp{quote(v)} in the pattern. For example, the
26071pattern @samp{x+quote(y)} matches @samp{x+y}, @samp{2+y}, or
26072@samp{sin(a)+y}.
26073
26074The special variable names @samp{e}, @samp{pi}, @samp{i}, @samp{phi},
26075@samp{gamma}, @samp{inf}, @samp{uinf}, and @samp{nan} always match
26076literally. Thus the pattern @samp{sin(d + e + f)} acts exactly like
26077@samp{sin(d + quote(e) + f)}.
26078
26079If the @var{old} pattern is found to match a given formula, that
26080formula is replaced by @var{new}, where any occurrences in @var{new}
26081of meta-variables from the pattern are replaced with the sub-formulas
26082that they matched. Thus, applying the rule @samp{f(x,y) := g(y+x,x)}
26083to @samp{f(12, a+1)} would produce @samp{g(a+13, 12)}.
26084
26085The normal @kbd{a r} command applies rewrite rules over and over
26086throughout the target formula until no further changes are possible
26087(up to a limit of 100 times). Use @kbd{C-u 1 a r} to make only one
26088change at a time.
26089
26090@node Conditional Rewrite Rules, Algebraic Properties of Rewrite Rules, Basic Rewrite Rules, Rewrite Rules
26091@subsection Conditional Rewrite Rules
26092
26093@noindent
26094A rewrite rule can also be @dfn{conditional}, written in the form
26095@samp{@var{old} := @var{new} :: @var{cond}}. (There is also the obsolete
26096form @samp{[@var{old}, @var{new}, @var{cond}]}.) If a @var{cond} part
26097is present in the
26098rule, this is an additional condition that must be satisfied before
26099the rule is accepted. Once @var{old} has been successfully matched
26100to the target expression, @var{cond} is evaluated (with all the
26101meta-variables substituted for the values they matched) and simplified
26102with @kbd{a s} (@code{calc-simplify}). If the result is a nonzero
26103number or any other object known to be nonzero (@pxref{Declarations}),
26104the rule is accepted. If the result is zero or if it is a symbolic
26105formula that is not known to be nonzero, the rule is rejected.
26106@xref{Logical Operations}, for a number of functions that return
a4231b04 261071 or 0 according to the results of various tests.
d7b8e6c6 26108
a4231b04 26109For example, the formula @samp{n > 0} simplifies to 1 or 0 if @expr{n}
d7b8e6c6 26110is replaced by a positive or nonpositive number, respectively (or if
a4231b04 26111@expr{n} has been declared to be positive or nonpositive). Thus,
d7b8e6c6
EZ
26112the rule @samp{f(x,y) := g(y+x,x) :: x+y > 0} would apply to
26113@samp{f(0, 4)} but not to @samp{f(-3, 2)} or @samp{f(12, a+1)}
a4231b04 26114(assuming no outstanding declarations for @expr{a}). In the case of
d7b8e6c6
EZ
26115@samp{f(-3, 2)}, the condition can be shown not to be satisfied; in
26116the case of @samp{f(12, a+1)}, the condition merely cannot be shown
26117to be satisfied, but that is enough to reject the rule.
26118
26119While Calc will use declarations to reason about variables in the
26120formula being rewritten, declarations do not apply to meta-variables.
26121For example, the rule @samp{f(a) := g(a+1)} will match for any values
26122of @samp{a}, such as complex numbers, vectors, or formulas, even if
26123@samp{a} has been declared to be real or scalar. If you want the
26124meta-variable @samp{a} to match only literal real numbers, use
26125@samp{f(a) := g(a+1) :: real(a)}. If you want @samp{a} to match only
26126reals and formulas which are provably real, use @samp{dreal(a)} as
26127the condition.
26128
26129The @samp{::} operator is a shorthand for the @code{condition}
26130function; @samp{@var{old} := @var{new} :: @var{cond}} is equivalent to
26131the formula @samp{condition(assign(@var{old}, @var{new}), @var{cond})}.
26132
26133If you have several conditions, you can use @samp{... :: c1 :: c2 :: c3}
26134or @samp{... :: c1 && c2 && c3}. The two are entirely equivalent.
26135
26136It is also possible to embed conditions inside the pattern:
26137@samp{f(x :: x>0, y) := g(y+x, x)}. This is purely a notational
26138convenience, though; where a condition appears in a rule has no
26139effect on when it is tested. The rewrite-rule compiler automatically
26140decides when it is best to test each condition while a rule is being
26141matched.
26142
26143Certain conditions are handled as special cases by the rewrite rule
a4231b04 26144system and are tested very efficiently: Where @expr{x} is any
d7b8e6c6 26145meta-variable, these conditions are @samp{integer(x)}, @samp{real(x)},
a4231b04 26146@samp{constant(x)}, @samp{negative(x)}, @samp{x >= y} where @expr{y}
d7b8e6c6
EZ
26147is either a constant or another meta-variable and @samp{>=} may be
26148replaced by any of the six relational operators, and @samp{x % a = b}
a4231b04 26149where @expr{a} and @expr{b} are constants. Other conditions, like
d7b8e6c6
EZ
26150@samp{x >= y+1} or @samp{dreal(x)}, will be less efficient to check
26151since Calc must bring the whole evaluator and simplifier into play.
26152
26153An interesting property of @samp{::} is that neither of its arguments
26154will be touched by Calc's default simplifications. This is important
26155because conditions often are expressions that cannot safely be
26156evaluated early. For example, the @code{typeof} function never
26157remains in symbolic form; entering @samp{typeof(a)} will put the
26158number 100 (the type code for variables like @samp{a}) on the stack.
26159But putting the condition @samp{... :: typeof(a) = 6} on the stack
26160is safe since @samp{::} prevents the @code{typeof} from being
26161evaluated until the condition is actually used by the rewrite system.
26162
26163Since @samp{::} protects its lefthand side, too, you can use a dummy
26164condition to protect a rule that must itself not evaluate early.
26165For example, it's not safe to put @samp{a(f,x) := apply(f, [x])} on
26166the stack because it will immediately evaluate to @samp{a(f,x) := f(x)},
26167where the meta-variable-ness of @code{f} on the righthand side has been
26168lost. But @samp{a(f,x) := apply(f, [x]) :: 1} is safe, and of course
26169the condition @samp{1} is always true (nonzero) so it has no effect on
26170the functioning of the rule. (The rewrite compiler will ensure that
26171it doesn't even impact the speed of matching the rule.)
26172
26173@node Algebraic Properties of Rewrite Rules, Other Features of Rewrite Rules, Conditional Rewrite Rules, Rewrite Rules
26174@subsection Algebraic Properties of Rewrite Rules
26175
26176@noindent
26177The rewrite mechanism understands the algebraic properties of functions
26178like @samp{+} and @samp{*}. In particular, pattern matching takes
26179the associativity and commutativity of the following functions into
26180account:
26181
26182@smallexample
26183+ - * = != && || and or xor vint vunion vxor gcd lcm max min beta
26184@end smallexample
26185
26186For example, the rewrite rule:
26187
26188@example
26189a x + b x := (a + b) x
26190@end example
26191
26192@noindent
26193will match formulas of the form,
26194
26195@example
26196a x + b x, x a + x b, a x + x b, x a + b x
26197@end example
26198
26199Rewrites also understand the relationship between the @samp{+} and @samp{-}
26200operators. The above rewrite rule will also match the formulas,
26201
26202@example
26203a x - b x, x a - x b, a x - x b, x a - b x
26204@end example
26205
26206@noindent
26207by matching @samp{b} in the pattern to @samp{-b} from the formula.
26208
26209Applied to a sum of many terms like @samp{r + a x + s + b x + t}, this
26210pattern will check all pairs of terms for possible matches. The rewrite
26211will take whichever suitable pair it discovers first.
26212
26213In general, a pattern using an associative operator like @samp{a + b}
5d67986c 26214will try @var{2 n} different ways to match a sum of @var{n} terms
d7b8e6c6
EZ
26215like @samp{x + y + z - w}. First, @samp{a} is matched against each
26216of @samp{x}, @samp{y}, @samp{z}, and @samp{-w} in turn, with @samp{b}
26217being matched to the remainders @samp{y + z - w}, @samp{x + z - w}, etc.
26218If none of these succeed, then @samp{b} is matched against each of the
26219four terms with @samp{a} matching the remainder. Half-and-half matches,
26220like @samp{(x + y) + (z - w)}, are not tried.
26221
26222Note that @samp{*} is not commutative when applied to matrices, but
26223rewrite rules pretend that it is. If you type @kbd{m v} to enable
07ce2eb3 26224Matrix mode (@pxref{Matrix Mode}), rewrite rules will match @samp{*}
d7b8e6c6
EZ
26225literally, ignoring its usual commutativity property. (In the
26226current implementation, the associativity also vanishes---it is as
26227if the pattern had been enclosed in a @code{plain} marker; see below.)
26228If you are applying rewrites to formulas with matrices, it's best to
07ce2eb3 26229enable Matrix mode first to prevent algebraically incorrect rewrites
d7b8e6c6
EZ
26230from occurring.
26231
26232The pattern @samp{-x} will actually match any expression. For example,
26233the rule
26234
26235@example
26236f(-x) := -f(x)
26237@end example
26238
26239@noindent
26240will rewrite @samp{f(a)} to @samp{-f(-a)}. To avoid this, either use
26241a @code{plain} marker as described below, or add a @samp{negative(x)}
26242condition. The @code{negative} function is true if its argument
26243``looks'' negative, for example, because it is a negative number or
26244because it is a formula like @samp{-x}. The new rule using this
26245condition is:
26246
26247@example
26248f(x) := -f(-x) :: negative(x) @r{or, equivalently,}
26249f(-x) := -f(x) :: negative(-x)
26250@end example
26251
26252In the same way, the pattern @samp{x - y} will match the sum @samp{a + b}
26253by matching @samp{y} to @samp{-b}.
26254
26255The pattern @samp{a b} will also match the formula @samp{x/y} if
26256@samp{y} is a number. Thus the rule @samp{a x + @w{b x} := (a+b) x}
26257will also convert @samp{a x + x / 2} to @samp{(a + 0.5) x} (or
26258@samp{(a + 1:2) x}, depending on the current fraction mode).
26259
26260Calc will @emph{not} take other liberties with @samp{*}, @samp{/}, and
26261@samp{^}. For example, the pattern @samp{f(a b)} will not match
26262@samp{f(x^2)}, and @samp{f(a + b)} will not match @samp{f(2 x)}, even
26263though conceivably these patterns could match with @samp{a = b = x}.
26264Nor will @samp{f(a b)} match @samp{f(x / y)} if @samp{y} is not a
26265constant, even though it could be considered to match with @samp{a = x}
26266and @samp{b = 1/y}. The reasons are partly for efficiency, and partly
26267because while few mathematical operations are substantively different
26268for addition and subtraction, often it is preferable to treat the cases
26269of multiplication, division, and integer powers separately.
26270
26271Even more subtle is the rule set
26272
26273@example
26274[ f(a) + f(b) := f(a + b), -f(a) := f(-a) ]
26275@end example
26276
26277@noindent
26278attempting to match @samp{f(x) - f(y)}. You might think that Calc
26279will view this subtraction as @samp{f(x) + (-f(y))} and then apply
26280the above two rules in turn, but actually this will not work because
26281Calc only does this when considering rules for @samp{+} (like the
26282first rule in this set). So it will see first that @samp{f(x) + (-f(y))}
26283does not match @samp{f(a) + f(b)} for any assignments of the
26284meta-variables, and then it will see that @samp{f(x) - f(y)} does
26285not match @samp{-f(a)} for any assignment of @samp{a}. Because Calc
26286tries only one rule at a time, it will not be able to rewrite
26287@samp{f(x) - f(y)} with this rule set. An explicit @samp{f(a) - f(b)}
26288rule will have to be added.
26289
26290Another thing patterns will @emph{not} do is break up complex numbers.
26291The pattern @samp{myconj(a + @w{b i)} := a - b i} will work for formulas
26292involving the special constant @samp{i} (such as @samp{3 - 4 i}), but
26293it will not match actual complex numbers like @samp{(3, -4)}. A version
26294of the above rule for complex numbers would be
26295
26296@example
26297myconj(a) := re(a) - im(a) (0,1) :: im(a) != 0
26298@end example
26299
26300@noindent
26301(Because the @code{re} and @code{im} functions understand the properties
26302of the special constant @samp{i}, this rule will also work for
26303@samp{3 - 4 i}. In fact, this particular rule would probably be better
26304without the @samp{im(a) != 0} condition, since if @samp{im(a) = 0} the
26305righthand side of the rule will still give the correct answer for the
26306conjugate of a real number.)
26307
26308It is also possible to specify optional arguments in patterns. The rule
26309
26310@example
26311opt(a) x + opt(b) (x^opt(c) + opt(d)) := f(a, b, c, d)
26312@end example
26313
26314@noindent
26315will match the formula
26316
26317@example
263185 (x^2 - 4) + 3 x
26319@end example
26320
26321@noindent
26322in a fairly straightforward manner, but it will also match reduced
26323formulas like
26324
26325@example
26326x + x^2, 2(x + 1) - x, x + x
26327@end example
26328
26329@noindent
26330producing, respectively,
26331
26332@example
26333f(1, 1, 2, 0), f(-1, 2, 1, 1), f(1, 1, 1, 0)
26334@end example
26335
26336(The latter two formulas can be entered only if default simplifications
26337have been turned off with @kbd{m O}.)
26338
26339The default value for a term of a sum is zero. The default value
26340for a part of a product, for a power, or for the denominator of a
26341quotient, is one. Also, @samp{-x} matches the pattern @samp{opt(a) b}
26342with @samp{a = -1}.
26343
26344In particular, the distributive-law rule can be refined to
26345
26346@example
26347opt(a) x + opt(b) x := (a + b) x
26348@end example
26349
26350@noindent
26351so that it will convert, e.g., @samp{a x - x}, to @samp{(a - 1) x}.
26352
26353The pattern @samp{opt(a) + opt(b) x} matches almost any formulas which
26354are linear in @samp{x}. You can also use the @code{lin} and @code{islin}
26355functions with rewrite conditions to test for this; @pxref{Logical
26356Operations}. These functions are not as convenient to use in rewrite
26357rules, but they recognize more kinds of formulas as linear:
a4231b04 26358@samp{x/z} is considered linear with @expr{b = 1/z} by @code{lin},
d7b8e6c6
EZ
26359but it will not match the above pattern because that pattern calls
26360for a multiplication, not a division.
26361
26362As another example, the obvious rule to replace @samp{sin(x)^2 + cos(x)^2}
26363by 1,
26364
26365@example
26366sin(x)^2 + cos(x)^2 := 1
26367@end example
26368
26369@noindent
26370misses many cases because the sine and cosine may both be multiplied by
26371an equal factor. Here's a more successful rule:
26372
26373@example
26374opt(a) sin(x)^2 + opt(a) cos(x)^2 := a
26375@end example
26376
26377Note that this rule will @emph{not} match @samp{sin(x)^2 + 6 cos(x)^2}
a4231b04 26378because one @expr{a} would have ``matched'' 1 while the other matched 6.
d7b8e6c6
EZ
26379
26380Calc automatically converts a rule like
26381
26382@example
26383f(x-1, x) := g(x)
26384@end example
26385
26386@noindent
26387into the form
26388
26389@example
26390f(temp, x) := g(x) :: temp = x-1
26391@end example
26392
26393@noindent
26394(where @code{temp} stands for a new, invented meta-variable that
26395doesn't actually have a name). This modified rule will successfully
26396match @samp{f(6, 7)}, binding @samp{temp} and @samp{x} to 6 and 7,
26397respectively, then verifying that they differ by one even though
26398@samp{6} does not superficially look like @samp{x-1}.
26399
26400However, Calc does not solve equations to interpret a rule. The
26401following rule,
26402
26403@example
26404f(x-1, x+1) := g(x)
26405@end example
26406
26407@noindent
26408will not work. That is, it will match @samp{f(a - 1 + b, a + 1 + b)}
26409but not @samp{f(6, 8)}. Calc always interprets at least one occurrence
26410of a variable by literal matching. If the variable appears ``isolated''
26411then Calc is smart enough to use it for literal matching. But in this
26412last example, Calc is forced to rewrite the rule to @samp{f(x-1, temp)
26413:= g(x) :: temp = x+1} where the @samp{x-1} term must correspond to an
26414actual ``something-minus-one'' in the target formula.
26415
26416A successful way to write this would be @samp{f(x, x+2) := g(x+1)}.
26417You could make this resemble the original form more closely by using
26418@code{let} notation, which is described in the next section:
26419
26420@example
26421f(xm1, x+1) := g(x) :: let(x := xm1+1)
26422@end example
26423
26424Calc does this rewriting or ``conditionalizing'' for any sub-pattern
26425which involves only the functions in the following list, operating
26426only on constants and meta-variables which have already been matched
26427elsewhere in the pattern. When matching a function call, Calc is
26428careful to match arguments which are plain variables before arguments
26429which are calls to any of the functions below, so that a pattern like
26430@samp{f(x-1, x)} can be conditionalized even though the isolated
26431@samp{x} comes after the @samp{x-1}.
26432
26433@smallexample
26434+ - * / \ % ^ abs sign round rounde roundu trunc floor ceil
26435max min re im conj arg
26436@end smallexample
26437
26438You can suppress all of the special treatments described in this
26439section by surrounding a function call with a @code{plain} marker.
26440This marker causes the function call which is its argument to be
26441matched literally, without regard to commutativity, associativity,
26442negation, or conditionalization. When you use @code{plain}, the
26443``deep structure'' of the formula being matched can show through.
26444For example,
26445
26446@example
26447plain(a - a b) := f(a, b)
26448@end example
26449
26450@noindent
26451will match only literal subtractions. However, the @code{plain}
26452marker does not affect its arguments' arguments. In this case,
26453commutativity and associativity is still considered while matching
26454the @w{@samp{a b}} sub-pattern, so the whole pattern will match
26455@samp{x - y x} as well as @samp{x - x y}. We could go still
26456further and use
26457
26458@example
26459plain(a - plain(a b)) := f(a, b)
26460@end example
26461
26462@noindent
26463which would do a completely strict match for the pattern.
26464
26465By contrast, the @code{quote} marker means that not only the
26466function name but also the arguments must be literally the same.
26467The above pattern will match @samp{x - x y} but
26468
26469@example
26470quote(a - a b) := f(a, b)
26471@end example
26472
26473@noindent
26474will match only the single formula @samp{a - a b}. Also,
26475
26476@example
26477quote(a - quote(a b)) := f(a, b)
26478@end example
26479
26480@noindent
26481will match only @samp{a - quote(a b)}---probably not the desired
26482effect!
26483
26484A certain amount of algebra is also done when substituting the
26485meta-variables on the righthand side of a rule. For example,
26486in the rule
26487
26488@example
26489a + f(b) := f(a + b)
26490@end example
26491
26492@noindent
26493matching @samp{f(x) - y} would produce @samp{f((-y) + x)} if
26494taken literally, but the rewrite mechanism will simplify the
26495righthand side to @samp{f(x - y)} automatically. (Of course,
26496the default simplifications would do this anyway, so this
26497special simplification is only noticeable if you have turned the
26498default simplifications off.) This rewriting is done only when
26499a meta-variable expands to a ``negative-looking'' expression.
26500If this simplification is not desirable, you can use a @code{plain}
26501marker on the righthand side:
26502
26503@example
26504a + f(b) := f(plain(a + b))
26505@end example
26506
26507@noindent
26508In this example, we are still allowing the pattern-matcher to
26509use all the algebra it can muster, but the righthand side will
26510always simplify to a literal addition like @samp{f((-y) + x)}.
26511
26512@node Other Features of Rewrite Rules, Composing Patterns in Rewrite Rules, Algebraic Properties of Rewrite Rules, Rewrite Rules
26513@subsection Other Features of Rewrite Rules
26514
26515@noindent
26516Certain ``function names'' serve as markers in rewrite rules.
26517Here is a complete list of these markers. First are listed the
26518markers that work inside a pattern; then come the markers that
26519work in the righthand side of a rule.
26520
5d67986c
RS
26521@ignore
26522@starindex
26523@end ignore
d7b8e6c6
EZ
26524@tindex import
26525One kind of marker, @samp{import(x)}, takes the place of a whole
a4231b04 26526rule. Here @expr{x} is the name of a variable containing another
d7b8e6c6
EZ
26527rule set; those rules are ``spliced into'' the rule set that
26528imports them. For example, if @samp{[f(a+b) := f(a) + f(b),
26529f(a b) := a f(b) :: real(a)]} is stored in variable @samp{linearF},
26530then the rule set @samp{[f(0) := 0, import(linearF)]} will apply
26531all three rules. It is possible to modify the imported rules
26532slightly: @samp{import(x, v1, x1, v2, x2, @dots{})} imports
a4231b04 26533the rule set @expr{x} with all occurrences of
8e04863e 26534@texline @math{v_1},
a4231b04
JB
26535@infoline @expr{v1},
26536as either a variable name or a function name, replaced with
8e04863e 26537@texline @math{x_1}
a4231b04
JB
26538@infoline @expr{x1}
26539and so on. (If
8e04863e 26540@texline @math{v_1}
a4231b04
JB
26541@infoline @expr{v1}
26542is used as a function name, then
8e04863e 26543@texline @math{x_1}
a4231b04 26544@infoline @expr{x1}
d7b8e6c6
EZ
26545must be either a function name itself or a @w{@samp{< >}} nameless
26546function; @pxref{Specifying Operators}.) For example, @samp{[g(0) := 0,
26547import(linearF, f, g)]} applies the linearity rules to the function
26548@samp{g} instead of @samp{f}. Imports can be nested, but the
26549import-with-renaming feature may fail to rename sub-imports properly.
26550
26551The special functions allowed in patterns are:
26552
26553@table @samp
26554@item quote(x)
5d67986c
RS
26555@ignore
26556@starindex
26557@end ignore
d7b8e6c6 26558@tindex quote
a4231b04 26559This pattern matches exactly @expr{x}; variable names in @expr{x} are
d7b8e6c6
EZ
26560not interpreted as meta-variables. The only flexibility is that
26561numbers are compared for numeric equality, so that the pattern
26562@samp{f(quote(12))} will match both @samp{f(12)} and @samp{f(12.0)}.
26563(Numbers are always treated this way by the rewrite mechanism:
26564The rule @samp{f(x,x) := g(x)} will match @samp{f(12, 12.0)}.
26565The rewrite may produce either @samp{g(12)} or @samp{g(12.0)}
26566as a result in this case.)
26567
26568@item plain(x)
5d67986c
RS
26569@ignore
26570@starindex
26571@end ignore
d7b8e6c6 26572@tindex plain
a4231b04
JB
26573Here @expr{x} must be a function call @samp{f(x1,x2,@dots{})}. This
26574pattern matches a call to function @expr{f} with the specified
d7b8e6c6 26575argument patterns. No special knowledge of the properties of the
a4231b04 26576function @expr{f} is used in this case; @samp{+} is not commutative or
d7b8e6c6
EZ
26577associative. Unlike @code{quote}, the arguments @samp{x1,x2,@dots{}}
26578are treated as patterns. If you wish them to be treated ``plainly''
26579as well, you must enclose them with more @code{plain} markers:
26580@samp{plain(plain(@w{-a}) + plain(b c))}.
26581
26582@item opt(x,def)
5d67986c
RS
26583@ignore
26584@starindex
26585@end ignore
d7b8e6c6 26586@tindex opt
a4231b04 26587Here @expr{x} must be a variable name. This must appear as an
d7b8e6c6
EZ
26588argument to a function or an element of a vector; it specifies that
26589the argument or element is optional.
26590As an argument to @samp{+}, @samp{-}, @samp{*}, @samp{&&}, or @samp{||},
26591or as the second argument to @samp{/} or @samp{^}, the value @var{def}
26592may be omitted. The pattern @samp{x + opt(y)} matches a sum by
a4231b04
JB
26593binding one summand to @expr{x} and the other to @expr{y}, and it
26594matches anything else by binding the whole expression to @expr{x} and
26595zero to @expr{y}. The other operators above work similarly.
d7b8e6c6 26596
28665d46 26597For general miscellaneous functions, the default value @code{def}
d7b8e6c6
EZ
26598must be specified. Optional arguments are dropped starting with
26599the rightmost one during matching. For example, the pattern
26600@samp{f(opt(a,0), b, opt(c,b))} will match @samp{f(b)}, @samp{f(a,b)},
a4231b04 26601or @samp{f(a,b,c)}. Default values of zero and @expr{b} are
d7b8e6c6 26602supplied in this example for the omitted arguments. Note that
a4231b04
JB
26603the literal variable @expr{b} will be the default in the latter
26604case, @emph{not} the value that matched the meta-variable @expr{b}.
d7b8e6c6
EZ
26605In other words, the default @var{def} is effectively quoted.
26606
26607@item condition(x,c)
5d67986c
RS
26608@ignore
26609@starindex
26610@end ignore
d7b8e6c6
EZ
26611@tindex condition
26612@tindex ::
a4231b04
JB
26613This matches the pattern @expr{x}, with the attached condition
26614@expr{c}. It is the same as @samp{x :: c}.
d7b8e6c6
EZ
26615
26616@item pand(x,y)
5d67986c
RS
26617@ignore
26618@starindex
26619@end ignore
d7b8e6c6
EZ
26620@tindex pand
26621@tindex &&&
a4231b04
JB
26622This matches anything that matches both pattern @expr{x} and
26623pattern @expr{y}. It is the same as @samp{x &&& y}.
d7b8e6c6
EZ
26624@pxref{Composing Patterns in Rewrite Rules}.
26625
26626@item por(x,y)
5d67986c
RS
26627@ignore
26628@starindex
26629@end ignore
d7b8e6c6
EZ
26630@tindex por
26631@tindex |||
a4231b04
JB
26632This matches anything that matches either pattern @expr{x} or
26633pattern @expr{y}. It is the same as @w{@samp{x ||| y}}.
d7b8e6c6
EZ
26634
26635@item pnot(x)
5d67986c
RS
26636@ignore
26637@starindex
26638@end ignore
d7b8e6c6
EZ
26639@tindex pnot
26640@tindex !!!
a4231b04 26641This matches anything that does not match pattern @expr{x}.
d7b8e6c6
EZ
26642It is the same as @samp{!!! x}.
26643
26644@item cons(h,t)
5d67986c
RS
26645@ignore
26646@mindex cons
26647@end ignore
d7b8e6c6
EZ
26648@tindex cons (rewrites)
26649This matches any vector of one or more elements. The first
a4231b04
JB
26650element is matched to @expr{h}; a vector of the remaining
26651elements is matched to @expr{t}. Note that vectors of fixed
d7b8e6c6
EZ
26652length can also be matched as actual vectors: The rule
26653@samp{cons(a,cons(b,[])) := cons(a+b,[])} is equivalent
26654to the rule @samp{[a,b] := [a+b]}.
26655
26656@item rcons(t,h)
5d67986c
RS
26657@ignore
26658@mindex rcons
26659@end ignore
d7b8e6c6
EZ
26660@tindex rcons (rewrites)
26661This is like @code{cons}, except that the @emph{last} element
a4231b04
JB
26662is matched to @expr{h}, with the remaining elements matched
26663to @expr{t}.
d7b8e6c6
EZ
26664
26665@item apply(f,args)
5d67986c
RS
26666@ignore
26667@mindex apply
26668@end ignore
d7b8e6c6
EZ
26669@tindex apply (rewrites)
26670This matches any function call. The name of the function, in
a4231b04 26671the form of a variable, is matched to @expr{f}. The arguments
d7b8e6c6
EZ
26672of the function, as a vector of zero or more objects, are
26673matched to @samp{args}. Constants, variables, and vectors
26674do @emph{not} match an @code{apply} pattern. For example,
26675@samp{apply(f,x)} matches any function call, @samp{apply(quote(f),x)}
26676matches any call to the function @samp{f}, @samp{apply(f,[a,b])}
26677matches any function call with exactly two arguments, and
26678@samp{apply(quote(f), cons(a,cons(b,x)))} matches any call
26679to the function @samp{f} with two or more arguments. Another
26680way to implement the latter, if the rest of the rule does not
26681need to refer to the first two arguments of @samp{f} by name,
26682would be @samp{apply(quote(f), x :: vlen(x) >= 2)}.
26683Here's a more interesting sample use of @code{apply}:
26684
26685@example
26686apply(f,[x+n]) := n + apply(f,[x])
26687 :: in(f, [floor,ceil,round,trunc]) :: integer(n)
26688@end example
26689
26690Note, however, that this will be slower to match than a rule
26691set with four separate rules. The reason is that Calc sorts
26692the rules of a rule set according to top-level function name;
26693if the top-level function is @code{apply}, Calc must try the
26694rule for every single formula and sub-formula. If the top-level
26695function in the pattern is, say, @code{floor}, then Calc invokes
26696the rule only for sub-formulas which are calls to @code{floor}.
26697
26698Formulas normally written with operators like @code{+} are still
26699considered function calls: @code{apply(f,x)} matches @samp{a+b}
26700with @samp{f = add}, @samp{x = [a,b]}.
26701
26702You must use @code{apply} for meta-variables with function names
26703on both sides of a rewrite rule: @samp{apply(f, [x]) := f(x+1)}
26704is @emph{not} correct, because it rewrites @samp{spam(6)} into
26705@samp{f(7)}. The righthand side should be @samp{apply(f, [x+1])}.
07ce2eb3
JB
26706Also note that you will have to use No-Simplify mode (@kbd{m O})
26707when entering this rule so that the @code{apply} isn't
d7b8e6c6
EZ
26708evaluated immediately to get the new rule @samp{f(x) := f(x+1)}.
26709Or, use @kbd{s e} to enter the rule without going through the stack,
26710or enter the rule as @samp{apply(f, [x]) := apply(f, [x+1]) @w{:: 1}}.
26711@xref{Conditional Rewrite Rules}.
26712
26713@item select(x)
5d67986c
RS
26714@ignore
26715@starindex
26716@end ignore
d7b8e6c6
EZ
26717@tindex select
26718This is used for applying rules to formulas with selections;
26719@pxref{Selections with Rewrite Rules}.
26720@end table
26721
26722Special functions for the righthand sides of rules are:
26723
26724@table @samp
26725@item quote(x)
26726The notation @samp{quote(x)} is changed to @samp{x} when the
26727righthand side is used. As far as the rewrite rule is concerned,
26728@code{quote} is invisible. However, @code{quote} has the special
26729property in Calc that its argument is not evaluated. Thus,
26730while it will not work to put the rule @samp{t(a) := typeof(a)}
26731on the stack because @samp{typeof(a)} is evaluated immediately
26732to produce @samp{t(a) := 100}, you can use @code{quote} to
26733protect the righthand side: @samp{t(a) := quote(typeof(a))}.
26734(@xref{Conditional Rewrite Rules}, for another trick for
26735protecting rules from evaluation.)
26736
26737@item plain(x)
26738Special properties of and simplifications for the function call
a4231b04 26739@expr{x} are not used. One interesting case where @code{plain}
d7b8e6c6
EZ
26740is useful is the rule, @samp{q(x) := quote(x)}, trying to expand a
26741shorthand notation for the @code{quote} function. This rule will
26742not work as shown; instead of replacing @samp{q(foo)} with
26743@samp{quote(foo)}, it will replace it with @samp{foo}! The correct
26744rule would be @samp{q(x) := plain(quote(x))}.
26745
26746@item cons(h,t)
a4231b04 26747Where @expr{t} is a vector, this is converted into an expanded
d7b8e6c6
EZ
26748vector during rewrite processing. Note that @code{cons} is a regular
26749Calc function which normally does this anyway; the only way @code{cons}
26750is treated specially by rewrites is that @code{cons} on the righthand
26751side of a rule will be evaluated even if default simplifications
26752have been turned off.
26753
26754@item rcons(t,h)
a4231b04
JB
26755Analogous to @code{cons} except putting @expr{h} at the @emph{end} of
26756the vector @expr{t}.
d7b8e6c6
EZ
26757
26758@item apply(f,args)
a4231b04 26759Where @expr{f} is a variable and @var{args} is a vector, this
d7b8e6c6
EZ
26760is converted to a function call. Once again, note that @code{apply}
26761is also a regular Calc function.
26762
26763@item eval(x)
5d67986c
RS
26764@ignore
26765@starindex
26766@end ignore
d7b8e6c6 26767@tindex eval
a4231b04 26768The formula @expr{x} is handled in the usual way, then the
d7b8e6c6
EZ
26769default simplifications are applied to it even if they have
26770been turned off normally. This allows you to treat any function
26771similarly to the way @code{cons} and @code{apply} are always
26772treated. However, there is a slight difference: @samp{cons(2+3, [])}
26773with default simplifications off will be converted to @samp{[2+3]},
26774whereas @samp{eval(cons(2+3, []))} will be converted to @samp{[5]}.
26775
26776@item evalsimp(x)
5d67986c
RS
26777@ignore
26778@starindex
26779@end ignore
d7b8e6c6 26780@tindex evalsimp
a4231b04 26781The formula @expr{x} has meta-variables substituted in the usual
d7b8e6c6
EZ
26782way, then algebraically simplified as if by the @kbd{a s} command.
26783
26784@item evalextsimp(x)
5d67986c
RS
26785@ignore
26786@starindex
26787@end ignore
d7b8e6c6 26788@tindex evalextsimp
a4231b04 26789The formula @expr{x} has meta-variables substituted in the normal
d7b8e6c6
EZ
26790way, then ``extendedly'' simplified as if by the @kbd{a e} command.
26791
26792@item select(x)
26793@xref{Selections with Rewrite Rules}.
26794@end table
26795
26796There are also some special functions you can use in conditions.
26797
26798@table @samp
26799@item let(v := x)
5d67986c
RS
26800@ignore
26801@starindex
26802@end ignore
d7b8e6c6 26803@tindex let
a4231b04 26804The expression @expr{x} is evaluated with meta-variables substituted.
d7b8e6c6 26805The @kbd{a s} command's simplifications are @emph{not} applied by
a4231b04 26806default, but @expr{x} can include calls to @code{evalsimp} or
d7b8e6c6
EZ
26807@code{evalextsimp} as described above to invoke higher levels
26808of simplification. The
a4231b04 26809result of @expr{x} is then bound to the meta-variable @expr{v}. As
d7b8e6c6
EZ
26810usual, if this meta-variable has already been matched to something
26811else the two values must be equal; if the meta-variable is new then
26812it is bound to the result of the expression. This variable can then
26813appear in later conditions, and on the righthand side of the rule.
a4231b04
JB
26814In fact, @expr{v} may be any pattern in which case the result of
26815evaluating @expr{x} is matched to that pattern, binding any
d7b8e6c6
EZ
26816meta-variables that appear in that pattern. Note that @code{let}
26817can only appear by itself as a condition, or as one term of an
26818@samp{&&} which is a whole condition: It cannot be inside
a4231b04 26819an @samp{||} term or otherwise buried.
d7b8e6c6
EZ
26820
26821The alternate, equivalent form @samp{let(v, x)} is also recognized.
26822Note that the use of @samp{:=} by @code{let}, while still being
26823assignment-like in character, is unrelated to the use of @samp{:=}
26824in the main part of a rewrite rule.
26825
26826As an example, @samp{f(a) := g(ia) :: let(ia := 1/a) :: constant(ia)}
26827replaces @samp{f(a)} with @samp{g} of the inverse of @samp{a}, if
26828that inverse exists and is constant. For example, if @samp{a} is a
26829singular matrix the operation @samp{1/a} is left unsimplified and
26830@samp{constant(ia)} fails, but if @samp{a} is an invertible matrix
26831then the rule succeeds. Without @code{let} there would be no way
26832to express this rule that didn't have to invert the matrix twice.
26833Note that, because the meta-variable @samp{ia} is otherwise unbound
26834in this rule, the @code{let} condition itself always ``succeeds''
26835because no matter what @samp{1/a} evaluates to, it can successfully
a4231b04 26836be bound to @code{ia}.
d7b8e6c6
EZ
26837
26838Here's another example, for integrating cosines of linear
26839terms: @samp{myint(cos(y),x) := sin(y)/b :: let([a,b,x] := lin(y,x))}.
26840The @code{lin} function returns a 3-vector if its argument is linear,
26841or leaves itself unevaluated if not. But an unevaluated @code{lin}
26842call will not match the 3-vector on the lefthand side of the @code{let},
26843so this @code{let} both verifies that @code{y} is linear, and binds
26844the coefficients @code{a} and @code{b} for use elsewhere in the rule.
26845(It would have been possible to use @samp{sin(a x + b)/b} for the
26846righthand side instead, but using @samp{sin(y)/b} avoids gratuitous
a4231b04 26847rearrangement of the argument of the sine.)
d7b8e6c6 26848
5d67986c
RS
26849@ignore
26850@starindex
26851@end ignore
d7b8e6c6
EZ
26852@tindex ierf
26853Similarly, here is a rule that implements an inverse-@code{erf}
26854function. It uses @code{root} to search for a solution. If
26855@code{root} succeeds, it will return a vector of two numbers
26856where the first number is the desired solution. If no solution
26857is found, @code{root} remains in symbolic form. So we use
26858@code{let} to check that the result was indeed a vector.
26859
26860@example
26861ierf(x) := y :: let([y,z] := root(erf(a) = x, a, .5))
26862@end example
26863
26864@item matches(v,p)
26865The meta-variable @var{v}, which must already have been matched
26866to something elsewhere in the rule, is compared against pattern
26867@var{p}. Since @code{matches} is a standard Calc function, it
26868can appear anywhere in a condition. But if it appears alone or
26869as a term of a top-level @samp{&&}, then you get the special
26870extra feature that meta-variables which are bound to things
26871inside @var{p} can be used elsewhere in the surrounding rewrite
26872rule.
26873
26874The only real difference between @samp{let(p := v)} and
26875@samp{matches(v, p)} is that the former evaluates @samp{v} using
26876the default simplifications, while the latter does not.
26877
26878@item remember
26879@vindex remember
26880This is actually a variable, not a function. If @code{remember}
26881appears as a condition in a rule, then when that rule succeeds
26882the original expression and rewritten expression are added to the
26883front of the rule set that contained the rule. If the rule set
26884was not stored in a variable, @code{remember} is ignored. The
26885lefthand side is enclosed in @code{quote} in the added rule if it
26886contains any variables.
26887
26888For example, the rule @samp{f(n) := n f(n-1) :: remember} applied
26889to @samp{f(7)} will add the rule @samp{f(7) := 7 f(6)} to the front
26890of the rule set. The rule set @code{EvalRules} works slightly
26891differently: There, the evaluation of @samp{f(6)} will complete before
26892the result is added to the rule set, in this case as @samp{f(7) := 5040}.
26893Thus @code{remember} is most useful inside @code{EvalRules}.
26894
26895It is up to you to ensure that the optimization performed by
26896@code{remember} is safe. For example, the rule @samp{foo(n) := n
26897:: evalv(eatfoo) > 0 :: remember} is a bad idea (@code{evalv} is
26898the function equivalent of the @kbd{=} command); if the variable
26899@code{eatfoo} ever contains 1, rules like @samp{foo(7) := 7} will
26900be added to the rule set and will continue to operate even if
26901@code{eatfoo} is later changed to 0.
26902
26903@item remember(c)
5d67986c
RS
26904@ignore
26905@starindex
26906@end ignore
d7b8e6c6 26907@tindex remember
a4231b04 26908Remember the match as described above, but only if condition @expr{c}
d7b8e6c6
EZ
26909is true. For example, @samp{remember(n % 4 = 0)} in the above factorial
26910rule remembers only every fourth result. Note that @samp{remember(1)}
26911is equivalent to @samp{remember}, and @samp{remember(0)} has no effect.
26912@end table
26913
26914@node Composing Patterns in Rewrite Rules, Nested Formulas with Rewrite Rules, Other Features of Rewrite Rules, Rewrite Rules
26915@subsection Composing Patterns in Rewrite Rules
26916
26917@noindent
26918There are three operators, @samp{&&&}, @samp{|||}, and @samp{!!!},
26919that combine rewrite patterns to make larger patterns. The
26920combinations are ``and,'' ``or,'' and ``not,'' respectively, and
26921these operators are the pattern equivalents of @samp{&&}, @samp{||}
26922and @samp{!} (which operate on zero-or-nonzero logical values).
26923
26924Note that @samp{&&&}, @samp{|||}, and @samp{!!!} are left in symbolic
26925form by all regular Calc features; they have special meaning only in
26926the context of rewrite rule patterns.
26927
26928The pattern @samp{@var{p1} &&& @var{p2}} matches anything that
26929matches both @var{p1} and @var{p2}. One especially useful case is
26930when one of @var{p1} or @var{p2} is a meta-variable. For example,
26931here is a rule that operates on error forms:
26932
26933@example
26934f(x &&& a +/- b, x) := g(x)
26935@end example
26936
26937This does the same thing, but is arguably simpler than, the rule
26938
26939@example
26940f(a +/- b, a +/- b) := g(a +/- b)
26941@end example
26942
5d67986c
RS
26943@ignore
26944@starindex
26945@end ignore
d7b8e6c6
EZ
26946@tindex ends
26947Here's another interesting example:
26948
26949@example
26950ends(cons(a, x) &&& rcons(y, b)) := [a, b]
26951@end example
26952
26953@noindent
26954which effectively clips out the middle of a vector leaving just
26955the first and last elements. This rule will change a one-element
26956vector @samp{[a]} to @samp{[a, a]}. The similar rule
26957
26958@example
26959ends(cons(a, rcons(y, b))) := [a, b]
26960@end example
26961
26962@noindent
26963would do the same thing except that it would fail to match a
26964one-element vector.
26965
26966@tex
26967\bigskip
26968@end tex
26969
26970The pattern @samp{@var{p1} ||| @var{p2}} matches anything that
26971matches either @var{p1} or @var{p2}. Calc first tries matching
26972against @var{p1}; if that fails, it goes on to try @var{p2}.
26973
5d67986c
RS
26974@ignore
26975@starindex
26976@end ignore
d7b8e6c6
EZ
26977@tindex curve
26978A simple example of @samp{|||} is
26979
26980@example
26981curve(inf ||| -inf) := 0
26982@end example
26983
26984@noindent
26985which converts both @samp{curve(inf)} and @samp{curve(-inf)} to zero.
26986
26987Here is a larger example:
26988
26989@example
26990log(a, b) ||| (ln(a) :: let(b := e)) := mylog(a, b)
26991@end example
26992
26993This matches both generalized and natural logarithms in a single rule.
26994Note that the @samp{::} term must be enclosed in parentheses because
26995that operator has lower precedence than @samp{|||} or @samp{:=}.
26996
26997(In practice this rule would probably include a third alternative,
26998omitted here for brevity, to take care of @code{log10}.)
26999
27000While Calc generally treats interior conditions exactly the same as
27001conditions on the outside of a rule, it does guarantee that if all the
27002variables in the condition are special names like @code{e}, or already
27003bound in the pattern to which the condition is attached (say, if
27004@samp{a} had appeared in this condition), then Calc will process this
27005condition right after matching the pattern to the left of the @samp{::}.
27006Thus, we know that @samp{b} will be bound to @samp{e} only if the
27007@code{ln} branch of the @samp{|||} was taken.
27008
27009Note that this rule was careful to bind the same set of meta-variables
27010on both sides of the @samp{|||}. Calc does not check this, but if
27011you bind a certain meta-variable only in one branch and then use that
27012meta-variable elsewhere in the rule, results are unpredictable:
27013
27014@example
27015f(a,b) ||| g(b) := h(a,b)
27016@end example
27017
27018Here if the pattern matches @samp{g(17)}, Calc makes no promises about
27019the value that will be substituted for @samp{a} on the righthand side.
27020
27021@tex
27022\bigskip
27023@end tex
27024
27025The pattern @samp{!!! @var{pat}} matches anything that does not
27026match @var{pat}. Any meta-variables that are bound while matching
27027@var{pat} remain unbound outside of @var{pat}.
27028
27029For example,
27030
27031@example
27032f(x &&& !!! a +/- b, !!![]) := g(x)
27033@end example
27034
27035@noindent
27036converts @code{f} whose first argument is anything @emph{except} an
27037error form, and whose second argument is not the empty vector, into
27038a similar call to @code{g} (but without the second argument).
27039
27040If we know that the second argument will be a vector (empty or not),
27041then an equivalent rule would be:
27042
27043@example
27044f(x, y) := g(x) :: typeof(x) != 7 :: vlen(y) > 0
27045@end example
27046
27047@noindent
27048where of course 7 is the @code{typeof} code for error forms.
27049Another final condition, that works for any kind of @samp{y},
27050would be @samp{!istrue(y == [])}. (The @code{istrue} function
27051returns an explicit 0 if its argument was left in symbolic form;
27052plain @samp{!(y == [])} or @samp{y != []} would not work to replace
27053@samp{!!![]} since these would be left unsimplified, and thus cause
27054the rule to fail, if @samp{y} was something like a variable name.)
27055
27056It is possible for a @samp{!!!} to refer to meta-variables bound
27057elsewhere in the pattern. For example,
27058
27059@example
27060f(a, !!!a) := g(a)
27061@end example
27062
27063@noindent
27064matches any call to @code{f} with different arguments, changing
27065this to @code{g} with only the first argument.
27066
27067If a function call is to be matched and one of the argument patterns
27068contains a @samp{!!!} somewhere inside it, that argument will be
27069matched last. Thus
27070
27071@example
27072f(!!!a, a) := g(a)
27073@end example
27074
27075@noindent
27076will be careful to bind @samp{a} to the second argument of @code{f}
27077before testing the first argument. If Calc had tried to match the
27078first argument of @code{f} first, the results would have been
28665d46 27079disastrous: since @code{a} was unbound so far, the pattern @samp{a}
d7b8e6c6
EZ
27080would have matched anything at all, and the pattern @samp{!!!a}
27081therefore would @emph{not} have matched anything at all!
27082
27083@node Nested Formulas with Rewrite Rules, Multi-Phase Rewrite Rules, Composing Patterns in Rewrite Rules, Rewrite Rules
27084@subsection Nested Formulas with Rewrite Rules
27085
27086@noindent
27087When @kbd{a r} (@code{calc-rewrite}) is used, it takes an expression from
27088the top of the stack and attempts to match any of the specified rules
27089to any part of the expression, starting with the whole expression
27090and then, if that fails, trying deeper and deeper sub-expressions.
27091For each part of the expression, the rules are tried in the order
27092they appear in the rules vector. The first rule to match the first
27093sub-expression wins; it replaces the matched sub-expression according
27094to the @var{new} part of the rule.
27095
27096Often, the rule set will match and change the formula several times.
27097The top-level formula is first matched and substituted repeatedly until
27098it no longer matches the pattern; then, sub-formulas are tried, and
27099so on. Once every part of the formula has gotten its chance, the
27100rewrite mechanism starts over again with the top-level formula
27101(in case a substitution of one of its arguments has caused it again
27102to match). This continues until no further matches can be made
27103anywhere in the formula.
27104
27105It is possible for a rule set to get into an infinite loop. The
27106most obvious case, replacing a formula with itself, is not a problem
27107because a rule is not considered to ``succeed'' unless the righthand
27108side actually comes out to something different than the original
27109formula or sub-formula that was matched. But if you accidentally
27110had both @samp{ln(a b) := ln(a) + ln(b)} and the reverse
27111@samp{ln(a) + ln(b) := ln(a b)} in your rule set, Calc would
27112run forever switching a formula back and forth between the two
27113forms.
27114
27115To avoid disaster, Calc normally stops after 100 changes have been
27116made to the formula. This will be enough for most multiple rewrites,
27117but it will keep an endless loop of rewrites from locking up the
27118computer forever. (On most systems, you can also type @kbd{C-g} to
27119halt any Emacs command prematurely.)
27120
27121To change this limit, give a positive numeric prefix argument.
27122In particular, @kbd{M-1 a r} applies only one rewrite at a time,
27123useful when you are first testing your rule (or just if repeated
27124rewriting is not what is called for by your application).
27125
5d67986c
RS
27126@ignore
27127@starindex
27128@end ignore
27129@ignore
27130@mindex iter@idots
27131@end ignore
d7b8e6c6
EZ
27132@tindex iterations
27133You can also put a ``function call'' @samp{iterations(@var{n})}
27134in place of a rule anywhere in your rules vector (but usually at
27135the top). Then, @var{n} will be used instead of 100 as the default
27136number of iterations for this rule set. You can use
27137@samp{iterations(inf)} if you want no iteration limit by default.
27138A prefix argument will override the @code{iterations} limit in the
27139rule set.
27140
27141@example
27142[ iterations(1),
27143 f(x) := f(x+1) ]
27144@end example
27145
27146More precisely, the limit controls the number of ``iterations,''
27147where each iteration is a successful matching of a rule pattern whose
27148righthand side, after substituting meta-variables and applying the
27149default simplifications, is different from the original sub-formula
27150that was matched.
27151
27152A prefix argument of zero sets the limit to infinity. Use with caution!
27153
27154Given a negative numeric prefix argument, @kbd{a r} will match and
27155substitute the top-level expression up to that many times, but
27156will not attempt to match the rules to any sub-expressions.
27157
27158In a formula, @code{rewrite(@var{expr}, @var{rules}, @var{n})}
27159does a rewriting operation. Here @var{expr} is the expression
27160being rewritten, @var{rules} is the rule, vector of rules, or
27161variable containing the rules, and @var{n} is the optional
27162iteration limit, which may be a positive integer, a negative
27163integer, or @samp{inf} or @samp{-inf}. If @var{n} is omitted
27164the @code{iterations} value from the rule set is used; if both
27165are omitted, 100 is used.
27166
27167@node Multi-Phase Rewrite Rules, Selections with Rewrite Rules, Nested Formulas with Rewrite Rules, Rewrite Rules
27168@subsection Multi-Phase Rewrite Rules
27169
27170@noindent
27171It is possible to separate a rewrite rule set into several @dfn{phases}.
27172During each phase, certain rules will be enabled while certain others
27173will be disabled. A @dfn{phase schedule} controls the order in which
27174phases occur during the rewriting process.
27175
5d67986c
RS
27176@ignore
27177@starindex
27178@end ignore
d7b8e6c6
EZ
27179@tindex phase
27180@vindex all
27181If a call to the marker function @code{phase} appears in the rules
27182vector in place of a rule, all rules following that point will be
27183members of the phase(s) identified in the arguments to @code{phase}.
27184Phases are given integer numbers. The markers @samp{phase()} and
27185@samp{phase(all)} both mean the following rules belong to all phases;
27186this is the default at the start of the rule set.
27187
27188If you do not explicitly schedule the phases, Calc sorts all phase
27189numbers that appear in the rule set and executes the phases in
27190ascending order. For example, the rule set
27191
d7b8e6c6 27192@example
5d67986c 27193@group
d7b8e6c6
EZ
27194[ f0(x) := g0(x),
27195 phase(1),
27196 f1(x) := g1(x),
27197 phase(2),
27198 f2(x) := g2(x),
27199 phase(3),
27200 f3(x) := g3(x),
27201 phase(1,2),
27202 f4(x) := g4(x) ]
d7b8e6c6 27203@end group
5d67986c 27204@end example
d7b8e6c6
EZ
27205
27206@noindent
27207has three phases, 1 through 3. Phase 1 consists of the @code{f0},
27208@code{f1}, and @code{f4} rules (in that order). Phase 2 consists of
27209@code{f0}, @code{f2}, and @code{f4}. Phase 3 consists of @code{f0}
27210and @code{f3}.
27211
27212When Calc rewrites a formula using this rule set, it first rewrites
27213the formula using only the phase 1 rules until no further changes are
27214possible. Then it switches to the phase 2 rule set and continues
27215until no further changes occur, then finally rewrites with phase 3.
27216When no more phase 3 rules apply, rewriting finishes. (This is
27217assuming @kbd{a r} with a large enough prefix argument to allow the
27218rewriting to run to completion; the sequence just described stops
27219early if the number of iterations specified in the prefix argument,
27220100 by default, is reached.)
27221
27222During each phase, Calc descends through the nested levels of the
27223formula as described previously. (@xref{Nested Formulas with Rewrite
27224Rules}.) Rewriting starts at the top of the formula, then works its
27225way down to the parts, then goes back to the top and works down again.
27226The phase 2 rules do not begin until no phase 1 rules apply anywhere
27227in the formula.
27228
5d67986c
RS
27229@ignore
27230@starindex
27231@end ignore
d7b8e6c6
EZ
27232@tindex schedule
27233A @code{schedule} marker appearing in the rule set (anywhere, but
27234conventionally at the top) changes the default schedule of phases.
27235In the simplest case, @code{schedule} has a sequence of phase numbers
27236for arguments; each phase number is invoked in turn until the
27237arguments to @code{schedule} are exhausted. Thus adding
27238@samp{schedule(3,2,1)} at the top of the above rule set would
27239reverse the order of the phases; @samp{schedule(1,2,3)} would have
27240no effect since this is the default schedule; and @samp{schedule(1,2,1,3)}
27241would give phase 1 a second chance after phase 2 has completed, before
27242moving on to phase 3.
27243
27244Any argument to @code{schedule} can instead be a vector of phase
27245numbers (or even of sub-vectors). Then the sub-sequence of phases
27246described by the vector are tried repeatedly until no change occurs
27247in any phase in the sequence. For example, @samp{schedule([1, 2], 3)}
27248tries phase 1, then phase 2, then, if either phase made any changes
27249to the formula, repeats these two phases until they can make no
27250further progress. Finally, it goes on to phase 3 for finishing
27251touches.
27252
27253Also, items in @code{schedule} can be variable names as well as
27254numbers. A variable name is interpreted as the name of a function
27255to call on the whole formula. For example, @samp{schedule(1, simplify)}
27256says to apply the phase-1 rules (presumably, all of them), then to
27257call @code{simplify} which is the function name equivalent of @kbd{a s}.
27258Likewise, @samp{schedule([1, simplify])} says to alternate between
27259phase 1 and @kbd{a s} until no further changes occur.
27260
27261Phases can be used purely to improve efficiency; if it is known that
27262a certain group of rules will apply only at the beginning of rewriting,
27263and a certain other group will apply only at the end, then rewriting
27264will be faster if these groups are identified as separate phases.
27265Once the phase 1 rules are done, Calc can put them aside and no longer
27266spend any time on them while it works on phase 2.
27267
27268There are also some problems that can only be solved with several
27269rewrite phases. For a real-world example of a multi-phase rule set,
27270examine the set @code{FitRules}, which is used by the curve-fitting
27271command to convert a model expression to linear form.
27272@xref{Curve Fitting Details}. This set is divided into four phases.
27273The first phase rewrites certain kinds of expressions to be more
27274easily linearizable, but less computationally efficient. After the
27275linear components have been picked out, the final phase includes the
27276opposite rewrites to put each component back into an efficient form.
27277If both sets of rules were included in one big phase, Calc could get
27278into an infinite loop going back and forth between the two forms.
27279
27280Elsewhere in @code{FitRules}, the components are first isolated,
27281then recombined where possible to reduce the complexity of the linear
27282fit, then finally packaged one component at a time into vectors.
27283If the packaging rules were allowed to begin before the recombining
27284rules were finished, some components might be put away into vectors
27285before they had a chance to recombine. By putting these rules in
27286two separate phases, this problem is neatly avoided.
27287
27288@node Selections with Rewrite Rules, Matching Commands, Multi-Phase Rewrite Rules, Rewrite Rules
27289@subsection Selections with Rewrite Rules
27290
27291@noindent
27292If a sub-formula of the current formula is selected (as by @kbd{j s};
27293@pxref{Selecting Subformulas}), the @kbd{a r} (@code{calc-rewrite})
27294command applies only to that sub-formula. Together with a negative
27295prefix argument, you can use this fact to apply a rewrite to one
27296specific part of a formula without affecting any other parts.
27297
27298@kindex j r
27299@pindex calc-rewrite-selection
27300The @kbd{j r} (@code{calc-rewrite-selection}) command allows more
27301sophisticated operations on selections. This command prompts for
27302the rules in the same way as @kbd{a r}, but it then applies those
27303rules to the whole formula in question even though a sub-formula
27304of it has been selected. However, the selected sub-formula will
27305first have been surrounded by a @samp{select( )} function call.
27306(Calc's evaluator does not understand the function name @code{select};
27307this is only a tag used by the @kbd{j r} command.)
27308
27309For example, suppose the formula on the stack is @samp{2 (a + b)^2}
27310and the sub-formula @samp{a + b} is selected. This formula will
27311be rewritten to @samp{2 select(a + b)^2} and then the rewrite
27312rules will be applied in the usual way. The rewrite rules can
27313include references to @code{select} to tell where in the pattern
27314the selected sub-formula should appear.
27315
27316If there is still exactly one @samp{select( )} function call in
27317the formula after rewriting is done, it indicates which part of
27318the formula should be selected afterwards. Otherwise, the
27319formula will be unselected.
27320
27321You can make @kbd{j r} act much like @kbd{a r} by enclosing both parts
27322of the rewrite rule with @samp{select()}. However, @kbd{j r}
27323allows you to use the current selection in more flexible ways.
27324Suppose you wished to make a rule which removed the exponent from
27325the selected term; the rule @samp{select(a)^x := select(a)} would
27326work. In the above example, it would rewrite @samp{2 select(a + b)^2}
27327to @samp{2 select(a + b)}. This would then be returned to the
27328stack as @samp{2 (a + b)} with the @samp{a + b} selected.
27329
27330The @kbd{j r} command uses one iteration by default, unlike
27331@kbd{a r} which defaults to 100 iterations. A numeric prefix
27332argument affects @kbd{j r} in the same way as @kbd{a r}.
27333@xref{Nested Formulas with Rewrite Rules}.
27334
27335As with other selection commands, @kbd{j r} operates on the stack
27336entry that contains the cursor. (If the cursor is on the top-of-stack
27337@samp{.} marker, it works as if the cursor were on the formula
27338at stack level 1.)
27339
27340If you don't specify a set of rules, the rules are taken from the
27341top of the stack, just as with @kbd{a r}. In this case, the
27342cursor must indicate stack entry 2 or above as the formula to be
27343rewritten (otherwise the same formula would be used as both the
27344target and the rewrite rules).
27345
27346If the indicated formula has no selection, the cursor position within
27347the formula temporarily selects a sub-formula for the purposes of this
27348command. If the cursor is not on any sub-formula (e.g., it is in
27349the line-number area to the left of the formula), the @samp{select( )}
27350markers are ignored by the rewrite mechanism and the rules are allowed
27351to apply anywhere in the formula.
27352
27353As a special feature, the normal @kbd{a r} command also ignores
27354@samp{select( )} calls in rewrite rules. For example, if you used the
27355above rule @samp{select(a)^x := select(a)} with @kbd{a r}, it would apply
27356the rule as if it were @samp{a^x := a}. Thus, you can write general
27357purpose rules with @samp{select( )} hints inside them so that they
27358will ``do the right thing'' in both @kbd{a r} and @kbd{j r},
27359both with and without selections.
27360
27361@node Matching Commands, Automatic Rewrites, Selections with Rewrite Rules, Rewrite Rules
27362@subsection Matching Commands
27363
27364@noindent
27365@kindex a m
27366@pindex calc-match
27367@tindex match
27368The @kbd{a m} (@code{calc-match}) [@code{match}] function takes a
27369vector of formulas and a rewrite-rule-style pattern, and produces
27370a vector of all formulas which match the pattern. The command
27371prompts you to enter the pattern; as for @kbd{a r}, you can enter
27372a single pattern (i.e., a formula with meta-variables), or a
27373vector of patterns, or a variable which contains patterns, or
27374you can give a blank response in which case the patterns are taken
27375from the top of the stack. The pattern set will be compiled once
27376and saved if it is stored in a variable. If there are several
27377patterns in the set, vector elements are kept if they match any
27378of the patterns.
27379
27380For example, @samp{match(a+b, [x, x+y, x-y, 7, x+y+z])}
27381will return @samp{[x+y, x-y, x+y+z]}.
27382
27383The @code{import} mechanism is not available for pattern sets.
27384
27385The @kbd{a m} command can also be used to extract all vector elements
27386which satisfy any condition: The pattern @samp{x :: x>0} will select
27387all the positive vector elements.
27388
27389@kindex I a m
27390@tindex matchnot
27391With the Inverse flag [@code{matchnot}], this command extracts all
27392vector elements which do @emph{not} match the given pattern.
27393
5d67986c
RS
27394@ignore
27395@starindex
27396@end ignore
d7b8e6c6
EZ
27397@tindex matches
27398There is also a function @samp{matches(@var{x}, @var{p})} which
27399evaluates to 1 if expression @var{x} matches pattern @var{p}, or
27400to 0 otherwise. This is sometimes useful for including into the
27401conditional clauses of other rewrite rules.
27402
5d67986c
RS
27403@ignore
27404@starindex
27405@end ignore
d7b8e6c6
EZ
27406@tindex vmatches
27407The function @code{vmatches} is just like @code{matches}, except
27408that if the match succeeds it returns a vector of assignments to
27409the meta-variables instead of the number 1. For example,
27410@samp{vmatches(f(1,2), f(a,b))} returns @samp{[a := 1, b := 2]}.
27411If the match fails, the function returns the number 0.
27412
27413@node Automatic Rewrites, Debugging Rewrites, Matching Commands, Rewrite Rules
27414@subsection Automatic Rewrites
27415
27416@noindent
27417@cindex @code{EvalRules} variable
27418@vindex EvalRules
27419It is possible to get Calc to apply a set of rewrite rules on all
27420results, effectively adding to the built-in set of default
27421simplifications. To do this, simply store your rule set in the
27422variable @code{EvalRules}. There is a convenient @kbd{s E} command
27423for editing @code{EvalRules}; @pxref{Operations on Variables}.
27424
27425For example, suppose you want @samp{sin(a + b)} to be expanded out
27426to @samp{sin(b) cos(a) + cos(b) sin(a)} wherever it appears, and
27427similarly for @samp{cos(a + b)}. The corresponding rewrite rule
27428set would be,
27429
d7b8e6c6 27430@smallexample
5d67986c 27431@group
d7b8e6c6
EZ
27432[ sin(a + b) := cos(a) sin(b) + sin(a) cos(b),
27433 cos(a + b) := cos(a) cos(b) - sin(a) sin(b) ]
d7b8e6c6 27434@end group
5d67986c 27435@end smallexample
d7b8e6c6
EZ
27436
27437To apply these manually, you could put them in a variable called
27438@code{trigexp} and then use @kbd{a r trigexp} every time you wanted
27439to expand trig functions. But if instead you store them in the
27440variable @code{EvalRules}, they will automatically be applied to all
27441sines and cosines of sums. Then, with @samp{2 x} and @samp{45} on
07ce2eb3 27442the stack, typing @kbd{+ S} will (assuming Degrees mode) result in
d7b8e6c6
EZ
27443@samp{0.7071 sin(2 x) + 0.7071 cos(2 x)} automatically.
27444
27445As each level of a formula is evaluated, the rules from
27446@code{EvalRules} are applied before the default simplifications.
27447Rewriting continues until no further @code{EvalRules} apply.
27448Note that this is different from the usual order of application of
27449rewrite rules: @code{EvalRules} works from the bottom up, simplifying
27450the arguments to a function before the function itself, while @kbd{a r}
27451applies rules from the top down.
27452
27453Because the @code{EvalRules} are tried first, you can use them to
27454override the normal behavior of any built-in Calc function.
27455
27456It is important not to write a rule that will get into an infinite
27457loop. For example, the rule set @samp{[f(0) := 1, f(n) := n f(n-1)]}
27458appears to be a good definition of a factorial function, but it is
27459unsafe. Imagine what happens if @samp{f(2.5)} is simplified. Calc
27460will continue to subtract 1 from this argument forever without reaching
27461zero. A safer second rule would be @samp{f(n) := n f(n-1) :: n>0}.
27462Another dangerous rule is @samp{g(x, y) := g(y, x)}. Rewriting
27463@samp{g(2, 4)}, this would bounce back and forth between that and
27464@samp{g(4, 2)} forever. If an infinite loop in @code{EvalRules}
27465occurs, Emacs will eventually stop with a ``Computation got stuck
27466or ran too long'' message.
27467
27468Another subtle difference between @code{EvalRules} and regular rewrites
27469concerns rules that rewrite a formula into an identical formula. For
a4231b04 27470example, @samp{f(n) := f(floor(n))} ``fails to match'' when @expr{n} is
d7b8e6c6
EZ
27471already an integer. But in @code{EvalRules} this case is detected only
27472if the righthand side literally becomes the original formula before any
27473further simplification. This means that @samp{f(n) := f(floor(n))} will
27474get into an infinite loop if it occurs in @code{EvalRules}. Calc will
27475replace @samp{f(6)} with @samp{f(floor(6))}, which is different from
27476@samp{f(6)}, so it will consider the rule to have matched and will
27477continue simplifying that formula; first the argument is simplified
27478to get @samp{f(6)}, then the rule matches again to get @samp{f(floor(6))}
27479again, ad infinitum. A much safer rule would check its argument first,
27480say, with @samp{f(n) := f(floor(n)) :: !dint(n)}.
27481
27482(What really happens is that the rewrite mechanism substitutes the
27483meta-variables in the righthand side of a rule, compares to see if the
27484result is the same as the original formula and fails if so, then uses
27485the default simplifications to simplify the result and compares again
27486(and again fails if the formula has simplified back to its original
27487form). The only special wrinkle for the @code{EvalRules} is that the
27488same rules will come back into play when the default simplifications
27489are used. What Calc wants to do is build @samp{f(floor(6))}, see that
27490this is different from the original formula, simplify to @samp{f(6)},
27491see that this is the same as the original formula, and thus halt the
27492rewriting. But while simplifying, @samp{f(6)} will again trigger
27493the same @code{EvalRules} rule and Calc will get into a loop inside
27494the rewrite mechanism itself.)
27495
27496The @code{phase}, @code{schedule}, and @code{iterations} markers do
27497not work in @code{EvalRules}. If the rule set is divided into phases,
27498only the phase 1 rules are applied, and the schedule is ignored.
27499The rules are always repeated as many times as possible.
27500
27501The @code{EvalRules} are applied to all function calls in a formula,
27502but not to numbers (and other number-like objects like error forms),
27503nor to vectors or individual variable names. (Though they will apply
27504to @emph{components} of vectors and error forms when appropriate.) You
27505might try to make a variable @code{phihat} which automatically expands
27506to its definition without the need to press @kbd{=} by writing the
27507rule @samp{quote(phihat) := (1-sqrt(5))/2}, but unfortunately this rule
27508will not work as part of @code{EvalRules}.
27509
27510Finally, another limitation is that Calc sometimes calls its built-in
27511functions directly rather than going through the default simplifications.
27512When it does this, @code{EvalRules} will not be able to override those
27513functions. For example, when you take the absolute value of the complex
a4231b04 27514number @expr{(2, 3)}, Calc computes @samp{sqrt(2*2 + 3*3)} by calling
d7b8e6c6
EZ
27515the multiplication, addition, and square root functions directly rather
27516than applying the default simplifications to this formula. So an
27517@code{EvalRules} rule that (perversely) rewrites @samp{sqrt(13) := 6}
07ce2eb3 27518would not apply. (However, if you put Calc into Symbolic mode so that
d7b8e6c6
EZ
27519@samp{sqrt(13)} will be left in symbolic form by the built-in square
27520root function, your rule will be able to apply. But if the complex
a4231b04 27521number were @expr{(3,4)}, so that @samp{sqrt(25)} must be calculated,
07ce2eb3 27522then Symbolic mode will not help because @samp{sqrt(25)} can be
d7b8e6c6
EZ
27523evaluated exactly to 5.)
27524
27525One subtle restriction that normally only manifests itself with
27526@code{EvalRules} is that while a given rewrite rule is in the process
27527of being checked, that same rule cannot be recursively applied. Calc
27528effectively removes the rule from its rule set while checking the rule,
27529then puts it back once the match succeeds or fails. (The technical
27530reason for this is that compiled pattern programs are not reentrant.)
27531For example, consider the rule @samp{foo(x) := x :: foo(x/2) > 0}
27532attempting to match @samp{foo(8)}. This rule will be inactive while
27533the condition @samp{foo(4) > 0} is checked, even though it might be
27534an integral part of evaluating that condition. Note that this is not
27535a problem for the more usual recursive type of rule, such as
27536@samp{foo(x) := foo(x/2)}, because there the rule has succeeded and
27537been reactivated by the time the righthand side is evaluated.
27538
27539If @code{EvalRules} has no stored value (its default state), or if
27540anything but a vector is stored in it, then it is ignored.
27541
27542Even though Calc's rewrite mechanism is designed to compare rewrite
27543rules to formulas as quickly as possible, storing rules in
27544@code{EvalRules} may make Calc run substantially slower. This is
27545particularly true of rules where the top-level call is a commonly used
27546function, or is not fixed. The rule @samp{f(n) := n f(n-1) :: n>0} will
27547only activate the rewrite mechanism for calls to the function @code{f},
27548but @samp{lg(n) + lg(m) := lg(n m)} will check every @samp{+} operator.
5d67986c
RS
27549
27550@smallexample
27551apply(f, [a*b]) := apply(f, [a]) + apply(f, [b]) :: in(f, [ln, log10])
27552@end smallexample
27553
27554@noindent
27555may seem more ``efficient'' than two separate rules for @code{ln} and
27556@code{log10}, but actually it is vastly less efficient because rules
27557with @code{apply} as the top-level pattern must be tested against
27558@emph{every} function call that is simplified.
d7b8e6c6
EZ
27559
27560@cindex @code{AlgSimpRules} variable
27561@vindex AlgSimpRules
27562Suppose you want @samp{sin(a + b)} to be expanded out not all the time,
27563but only when @kbd{a s} is used to simplify the formula. The variable
27564@code{AlgSimpRules} holds rules for this purpose. The @kbd{a s} command
27565will apply @code{EvalRules} and @code{AlgSimpRules} to the formula, as
27566well as all of its built-in simplifications.
27567
27568Most of the special limitations for @code{EvalRules} don't apply to
27569@code{AlgSimpRules}. Calc simply does an @kbd{a r AlgSimpRules}
27570command with an infinite repeat count as the first step of @kbd{a s}.
27571It then applies its own built-in simplifications throughout the
27572formula, and then repeats these two steps (along with applying the
27573default simplifications) until no further changes are possible.
27574
27575@cindex @code{ExtSimpRules} variable
27576@cindex @code{UnitSimpRules} variable
27577@vindex ExtSimpRules
27578@vindex UnitSimpRules
27579There are also @code{ExtSimpRules} and @code{UnitSimpRules} variables
27580that are used by @kbd{a e} and @kbd{u s}, respectively; these commands
27581also apply @code{EvalRules} and @code{AlgSimpRules}. The variable
27582@code{IntegSimpRules} contains simplification rules that are used
27583only during integration by @kbd{a i}.
27584
27585@node Debugging Rewrites, Examples of Rewrite Rules, Automatic Rewrites, Rewrite Rules
27586@subsection Debugging Rewrites
27587
27588@noindent
27589If a buffer named @samp{*Trace*} exists, the rewrite mechanism will
27590record some useful information there as it operates. The original
27591formula is written there, as is the result of each successful rewrite,
27592and the final result of the rewriting. All phase changes are also
27593noted.
27594
27595Calc always appends to @samp{*Trace*}. You must empty this buffer
27596yourself periodically if it is in danger of growing unwieldy.
27597
27598Note that the rewriting mechanism is substantially slower when the
27599@samp{*Trace*} buffer exists, even if the buffer is not visible on
27600the screen. Once you are done, you will probably want to kill this
27601buffer (with @kbd{C-x k *Trace* @key{RET}}). If you leave it in
27602existence and forget about it, all your future rewrite commands will
27603be needlessly slow.
27604
27605@node Examples of Rewrite Rules, , Debugging Rewrites, Rewrite Rules
27606@subsection Examples of Rewrite Rules
27607
27608@noindent
27609Returning to the example of substituting the pattern
27610@samp{sin(x)^2 + cos(x)^2} with 1, we saw that the rule
27611@samp{opt(a) sin(x)^2 + opt(a) cos(x)^2 := a} does a good job of
27612finding suitable cases. Another solution would be to use the rule
27613@samp{cos(x)^2 := 1 - sin(x)^2}, followed by algebraic simplification
27614if necessary. This rule will be the most effective way to do the job,
a4231b04 27615but at the expense of making some changes that you might not desire.
d7b8e6c6
EZ
27616
27617Another algebraic rewrite rule is @samp{exp(x+y) := exp(x) exp(y)}.
27618To make this work with the @w{@kbd{j r}} command so that it can be
27619easily targeted to a particular exponential in a large formula,
27620you might wish to write the rule as @samp{select(exp(x+y)) :=
27621select(exp(x) exp(y))}. The @samp{select} markers will be
27622ignored by the regular @kbd{a r} command
a4231b04 27623(@pxref{Selections with Rewrite Rules}).
d7b8e6c6
EZ
27624
27625A surprisingly useful rewrite rule is @samp{a/(b-c) := a*(b+c)/(b^2-c^2)}.
a4231b04 27626This will simplify the formula whenever @expr{b} and/or @expr{c} can
d7b8e6c6
EZ
27627be made simpler by squaring. For example, applying this rule to
27628@samp{2 / (sqrt(2) + 3)} yields @samp{6:7 - 2:7 sqrt(2)} (assuming
07ce2eb3 27629Symbolic mode has been enabled to keep the square root from being
28665d46 27630evaluated to a floating-point approximation). This rule is also
d7b8e6c6
EZ
27631useful when working with symbolic complex numbers, e.g.,
27632@samp{(a + b i) / (c + d i)}.
27633
27634As another example, we could define our own ``triangular numbers'' function
27635with the rules @samp{[tri(0) := 0, tri(n) := n + tri(n-1) :: n>0]}. Enter
27636this vector and store it in a variable: @kbd{@w{s t} trirules}. Now, given
27637a suitable formula like @samp{tri(5)} on the stack, type @samp{a r trirules}
27638to apply these rules repeatedly. After six applications, @kbd{a r} will
27639stop with 15 on the stack. Once these rules are debugged, it would probably
27640be most useful to add them to @code{EvalRules} so that Calc will evaluate
27641the new @code{tri} function automatically. We could then use @kbd{Z K} on
5d67986c 27642the keyboard macro @kbd{' tri($) @key{RET}} to make a command that applies
d7b8e6c6
EZ
27643@code{tri} to the value on the top of the stack. @xref{Programming}.
27644
27645@cindex Quaternions
a4231b04
JB
27646The following rule set, contributed by
27647@texline Fran\c cois
27648@infoline Francois
27649Pinard, implements @dfn{quaternions}, a generalization of the concept of
27650complex numbers. Quaternions have four components, and are here
27651represented by function calls @samp{quat(@var{w}, [@var{x}, @var{y},
27652@var{z}])} with ``real part'' @var{w} and the three ``imaginary'' parts
27653collected into a vector. Various arithmetical operations on quaternions
27654are supported. To use these rules, either add them to @code{EvalRules},
27655or create a command based on @kbd{a r} for simplifying quaternion
27656formulas. A convenient way to enter quaternions would be a command
27657defined by a keyboard macro containing: @kbd{' quat($$$$, [$$$, $$, $])
27658@key{RET}}.
d7b8e6c6
EZ
27659
27660@smallexample
27661[ quat(w, x, y, z) := quat(w, [x, y, z]),
27662 quat(w, [0, 0, 0]) := w,
27663 abs(quat(w, v)) := hypot(w, v),
27664 -quat(w, v) := quat(-w, -v),
27665 r + quat(w, v) := quat(r + w, v) :: real(r),
27666 r - quat(w, v) := quat(r - w, -v) :: real(r),
27667 quat(w1, v1) + quat(w2, v2) := quat(w1 + w2, v1 + v2),
27668 r * quat(w, v) := quat(r * w, r * v) :: real(r),
27669 plain(quat(w1, v1) * quat(w2, v2))
27670 := quat(w1 * w2 - v1 * v2, w1 * v2 + w2 * v1 + cross(v1, v2)),
27671 quat(w1, v1) / r := quat(w1 / r, v1 / r) :: real(r),
27672 z / quat(w, v) := z * quatinv(quat(w, v)),
27673 quatinv(quat(w, v)) := quat(w, -v) / (w^2 + v^2),
27674 quatsqr(quat(w, v)) := quat(w^2 - v^2, 2 * w * v),
27675 quat(w, v)^k := quatsqr(quat(w, v)^(k / 2))
27676 :: integer(k) :: k > 0 :: k % 2 = 0,
27677 quat(w, v)^k := quatsqr(quat(w, v)^((k - 1) / 2)) * quat(w, v)
27678 :: integer(k) :: k > 2,
27679 quat(w, v)^-k := quatinv(quat(w, v)^k) :: integer(k) :: k > 0 ]
27680@end smallexample
27681
27682Quaternions, like matrices, have non-commutative multiplication.
a4231b04
JB
27683In other words, @expr{q1 * q2 = q2 * q1} is not necessarily true if
27684@expr{q1} and @expr{q2} are @code{quat} forms. The @samp{quat*quat}
d7b8e6c6
EZ
27685rule above uses @code{plain} to prevent Calc from rearranging the
27686product. It may also be wise to add the line @samp{[quat(), matrix]}
27687to the @code{Decls} matrix, to ensure that Calc's other algebraic
27688operations will not rearrange a quaternion product. @xref{Declarations}.
27689
27690These rules also accept a four-argument @code{quat} form, converting
27691it to the preferred form in the first rule. If you would rather see
27692results in the four-argument form, just append the two items
27693@samp{phase(2), quat(w, [x, y, z]) := quat(w, x, y, z)} to the end
27694of the rule set. (But remember that multi-phase rule sets don't work
27695in @code{EvalRules}.)
27696
27697@node Units, Store and Recall, Algebra, Top
27698@chapter Operating on Units
27699
27700@noindent
27701One special interpretation of algebraic formulas is as numbers with units.
27702For example, the formula @samp{5 m / s^2} can be read ``five meters
27703per second squared.'' The commands in this chapter help you
27704manipulate units expressions in this form. Units-related commands
27705begin with the @kbd{u} prefix key.
27706
27707@menu
27708* Basic Operations on Units::
27709* The Units Table::
27710* Predefined Units::
27711* User-Defined Units::
27712@end menu
27713
27714@node Basic Operations on Units, The Units Table, Units, Units
27715@section Basic Operations on Units
27716
27717@noindent
27718A @dfn{units expression} is a formula which is basically a number
27719multiplied and/or divided by one or more @dfn{unit names}, which may
27720optionally be raised to integer powers. Actually, the value part need not
27721be a number; any product or quotient involving unit names is a units
27722expression. Many of the units commands will also accept any formula,
27723where the command applies to all units expressions which appear in the
27724formula.
27725
27726A unit name is a variable whose name appears in the @dfn{unit table},
27727or a variable whose name is a prefix character like @samp{k} (for ``kilo'')
27728or @samp{u} (for ``micro'') followed by a name in the unit table.
27729A substantial table of built-in units is provided with Calc;
27730@pxref{Predefined Units}. You can also define your own unit names;
a4231b04 27731@pxref{User-Defined Units}.
d7b8e6c6
EZ
27732
27733Note that if the value part of a units expression is exactly @samp{1},
27734it will be removed by the Calculator's automatic algebra routines: The
27735formula @samp{1 mm} is ``simplified'' to @samp{mm}. This is only a
27736display anomaly, however; @samp{mm} will work just fine as a
a4231b04 27737representation of one millimeter.
d7b8e6c6 27738
07ce2eb3 27739You may find that Algebraic mode (@pxref{Algebraic Entry}) makes working
d7b8e6c6
EZ
27740with units expressions easier. Otherwise, you will have to remember
27741to hit the apostrophe key every time you wish to enter units.
27742
27743@kindex u s
27744@pindex calc-simplify-units
5d67986c
RS
27745@ignore
27746@mindex usimpl@idots
27747@end ignore
d7b8e6c6
EZ
27748@tindex usimplify
27749The @kbd{u s} (@code{calc-simplify-units}) [@code{usimplify}] command
27750simplifies a units
27751expression. It uses @kbd{a s} (@code{calc-simplify}) to simplify the
27752expression first as a regular algebraic formula; it then looks for
27753features that can be further simplified by converting one object's units
27754to be compatible with another's. For example, @samp{5 m + 23 mm} will
27755simplify to @samp{5.023 m}. When different but compatible units are
27756added, the righthand term's units are converted to match those of the
27757lefthand term. @xref{Simplification Modes}, for a way to have this done
a4231b04 27758automatically at all times.
d7b8e6c6
EZ
27759
27760Units simplification also handles quotients of two units with the same
27761dimensionality, as in @w{@samp{2 in s/L cm}} to @samp{5.08 s/L}; fractional
27762powers of unit expressions, as in @samp{sqrt(9 mm^2)} to @samp{3 mm} and
27763@samp{sqrt(9 acre)} to a quantity in meters; and @code{floor},
27764@code{ceil}, @code{round}, @code{rounde}, @code{roundu}, @code{trunc},
27765@code{float}, @code{frac}, @code{abs}, and @code{clean}
27766applied to units expressions, in which case
27767the operation in question is applied only to the numeric part of the
27768expression. Finally, trigonometric functions of quantities with units
a4231b04 27769of angle are evaluated, regardless of the current angular mode.
d7b8e6c6
EZ
27770
27771@kindex u c
27772@pindex calc-convert-units
27773The @kbd{u c} (@code{calc-convert-units}) command converts a units
27774expression to new, compatible units. For example, given the units
27775expression @samp{55 mph}, typing @kbd{u c m/s @key{RET}} produces
27776@samp{24.5872 m/s}. If the units you request are inconsistent with
27777the original units, the number will be converted into your units
27778times whatever ``remainder'' units are left over. For example,
27779converting @samp{55 mph} into acres produces @samp{6.08e-3 acre / m s}.
27780(Recall that multiplication binds more strongly than division in Calc
27781formulas, so the units here are acres per meter-second.) Remainder
27782units are expressed in terms of ``fundamental'' units like @samp{m} and
27783@samp{s}, regardless of the input units.
27784
27785One special exception is that if you specify a single unit name, and
27786a compatible unit appears somewhere in the units expression, then
27787that compatible unit will be converted to the new unit and the
27788remaining units in the expression will be left alone. For example,
27789given the input @samp{980 cm/s^2}, the command @kbd{u c ms} will
27790change the @samp{s} to @samp{ms} to get @samp{9.8e-4 cm/ms^2}.
27791The ``remainder unit'' @samp{cm} is left alone rather than being
27792changed to the base unit @samp{m}.
27793
27794You can use explicit unit conversion instead of the @kbd{u s} command
27795to gain more control over the units of the result of an expression.
27796For example, given @samp{5 m + 23 mm}, you can type @kbd{u c m} or
27797@kbd{u c mm} to express the result in either meters or millimeters.
27798(For that matter, you could type @kbd{u c fath} to express the result
27799in fathoms, if you preferred!)
27800
27801In place of a specific set of units, you can also enter one of the
27802units system names @code{si}, @code{mks} (equivalent), or @code{cgs}.
27803For example, @kbd{u c si @key{RET}} converts the expression into
27804International System of Units (SI) base units. Also, @kbd{u c base}
27805converts to Calc's base units, which are the same as @code{si} units
27806except that @code{base} uses @samp{g} as the fundamental unit of mass
27807whereas @code{si} uses @samp{kg}.
27808
27809@cindex Composite units
27810The @kbd{u c} command also accepts @dfn{composite units}, which
27811are expressed as the sum of several compatible unit names. For
27812example, converting @samp{30.5 in} to units @samp{mi+ft+in} (miles,
27813feet, and inches) produces @samp{2 ft + 6.5 in}. Calc first
27814sorts the unit names into order of decreasing relative size.
27815It then accounts for as much of the input quantity as it can
27816using an integer number times the largest unit, then moves on
27817to the next smaller unit, and so on. Only the smallest unit
27818may have a non-integer amount attached in the result. A few
27819standard unit names exist for common combinations, such as
27820@code{mfi} for @samp{mi+ft+in}, and @code{tpo} for @samp{ton+lb+oz}.
27821Composite units are expanded as if by @kbd{a x}, so that
27822@samp{(ft+in)/hr} is first converted to @samp{ft/hr+in/hr}.
27823
27824If the value on the stack does not contain any units, @kbd{u c} will
27825prompt first for the old units which this value should be considered
27826to have, then for the new units. Assuming the old and new units you
27827give are consistent with each other, the result also will not contain
5d67986c 27828any units. For example, @kbd{@w{u c} cm @key{RET} in @key{RET}} converts the number
d7b8e6c6
EZ
278292 on the stack to 5.08.
27830
27831@kindex u b
27832@pindex calc-base-units
27833The @kbd{u b} (@code{calc-base-units}) command is shorthand for
27834@kbd{u c base}; it converts the units expression on the top of the
27835stack into @code{base} units. If @kbd{u s} does not simplify a
27836units expression as far as you would like, try @kbd{u b}.
27837
27838The @kbd{u c} and @kbd{u b} commands treat temperature units (like
27839@samp{degC} and @samp{K}) as relative temperatures. For example,
27840@kbd{u c} converts @samp{10 degC} to @samp{18 degF}: A change of 10
27841degrees Celsius corresponds to a change of 18 degrees Fahrenheit.
27842
27843@kindex u t
27844@pindex calc-convert-temperature
27845@cindex Temperature conversion
27846The @kbd{u t} (@code{calc-convert-temperature}) command converts
27847absolute temperatures. The value on the stack must be a simple units
27848expression with units of temperature only. This command would convert
27849@samp{10 degC} to @samp{50 degF}, the equivalent temperature on the
a4231b04 27850Fahrenheit scale.
d7b8e6c6
EZ
27851
27852@kindex u r
27853@pindex calc-remove-units
27854@kindex u x
27855@pindex calc-extract-units
27856The @kbd{u r} (@code{calc-remove-units}) command removes units from the
27857formula at the top of the stack. The @kbd{u x}
27858(@code{calc-extract-units}) command extracts only the units portion of a
27859formula. These commands essentially replace every term of the formula
27860that does or doesn't (respectively) look like a unit name by the
a4231b04 27861constant 1, then resimplify the formula.
d7b8e6c6
EZ
27862
27863@kindex u a
27864@pindex calc-autorange-units
27865The @kbd{u a} (@code{calc-autorange-units}) command turns on and off a
27866mode in which unit prefixes like @code{k} (``kilo'') are automatically
27867applied to keep the numeric part of a units expression in a reasonable
27868range. This mode affects @kbd{u s} and all units conversion commands
27869except @kbd{u b}. For example, with autoranging on, @samp{12345 Hz}
27870will be simplified to @samp{12.345 kHz}. Autoranging is useful for
27871some kinds of units (like @code{Hz} and @code{m}), but is probably
27872undesirable for non-metric units like @code{ft} and @code{tbsp}.
27873(Composite units are more appropriate for those; see above.)
27874
27875Autoranging always applies the prefix to the leftmost unit name.
27876Calc chooses the largest prefix that causes the number to be greater
27877than or equal to 1.0. Thus an increasing sequence of adjusted times
27878would be @samp{1 ms, 10 ms, 100 ms, 1 s, 10 s, 100 s, 1 ks}.
27879Generally the rule of thumb is that the number will be adjusted
27880to be in the interval @samp{[1 .. 1000)}, although there are several
27881exceptions to this rule. First, if the unit has a power then this
27882is not possible; @samp{0.1 s^2} simplifies to @samp{100000 ms^2}.
27883Second, the ``centi-'' prefix is allowed to form @code{cm} (centimeters),
27884but will not apply to other units. The ``deci-,'' ``deka-,'' and
27885``hecto-'' prefixes are never used. Thus the allowable interval is
27886@samp{[1 .. 10)} for millimeters and @samp{[1 .. 100)} for centimeters.
27887Finally, a prefix will not be added to a unit if the resulting name
27888is also the actual name of another unit; @samp{1e-15 t} would normally
27889be considered a ``femto-ton,'' but it is written as @samp{1000 at}
27890(1000 atto-tons) instead because @code{ft} would be confused with feet.
27891
27892@node The Units Table, Predefined Units, Basic Operations on Units, Units
27893@section The Units Table
27894
27895@noindent
27896@kindex u v
27897@pindex calc-enter-units-table
27898The @kbd{u v} (@code{calc-enter-units-table}) command displays the units table
27899in another buffer called @code{*Units Table*}. Each entry in this table
27900gives the unit name as it would appear in an expression, the definition
27901of the unit in terms of simpler units, and a full name or description of
27902the unit. Fundamental units are defined as themselves; these are the
27903units produced by the @kbd{u b} command. The fundamental units are
27904meters, seconds, grams, kelvins, amperes, candelas, moles, radians,
27905and steradians.
27906
27907The Units Table buffer also displays the Unit Prefix Table. Note that
27908two prefixes, ``kilo'' and ``hecto,'' accept either upper- or lower-case
27909prefix letters. @samp{Meg} is also accepted as a synonym for the @samp{M}
27910prefix. Whenever a unit name can be interpreted as either a built-in name
27911or a prefix followed by another built-in name, the former interpretation
27912wins. For example, @samp{2 pt} means two pints, not two pico-tons.
27913
27914The Units Table buffer, once created, is not rebuilt unless you define
27915new units. To force the buffer to be rebuilt, give any numeric prefix
27916argument to @kbd{u v}.
27917
27918@kindex u V
27919@pindex calc-view-units-table
27920The @kbd{u V} (@code{calc-view-units-table}) command is like @kbd{u v} except
27921that the cursor is not moved into the Units Table buffer. You can
27922type @kbd{u V} again to remove the Units Table from the display. To
27923return from the Units Table buffer after a @kbd{u v}, type @kbd{M-# c}
27924again or use the regular Emacs @w{@kbd{C-x o}} (@code{other-window})
27925command. You can also kill the buffer with @kbd{C-x k} if you wish;
27926the actual units table is safely stored inside the Calculator.
27927
27928@kindex u g
27929@pindex calc-get-unit-definition
27930The @kbd{u g} (@code{calc-get-unit-definition}) command retrieves a unit's
27931defining expression and pushes it onto the Calculator stack. For example,
27932@kbd{u g in} will produce the expression @samp{2.54 cm}. This is the
27933same definition for the unit that would appear in the Units Table buffer.
27934Note that this command works only for actual unit names; @kbd{u g km}
27935will report that no such unit exists, for example, because @code{km} is
27936really the unit @code{m} with a @code{k} (``kilo'') prefix. To see a
27937definition of a unit in terms of base units, it is easier to push the
27938unit name on the stack and then reduce it to base units with @kbd{u b}.
27939
27940@kindex u e
27941@pindex calc-explain-units
27942The @kbd{u e} (@code{calc-explain-units}) command displays an English
27943description of the units of the expression on the stack. For example,
27944for the expression @samp{62 km^2 g / s^2 mol K}, the description is
27945``Square-Kilometer Gram per (Second-squared Mole Degree-Kelvin).'' This
27946command uses the English descriptions that appear in the righthand
27947column of the Units Table.
27948
27949@node Predefined Units, User-Defined Units, The Units Table, Units
27950@section Predefined Units
27951
27952@noindent
27953Since the exact definitions of many kinds of units have evolved over the
27954years, and since certain countries sometimes have local differences in
27955their definitions, it is a good idea to examine Calc's definition of a
27956unit before depending on its exact value. For example, there are three
27957different units for gallons, corresponding to the US (@code{gal}),
27958Canadian (@code{galC}), and British (@code{galUK}) definitions. Also,
27959note that @code{oz} is a standard ounce of mass, @code{ozt} is a Troy
27960ounce, and @code{ozfl} is a fluid ounce.
27961
27962The temperature units corresponding to degrees Kelvin and Centigrade
27963(Celsius) are the same in this table, since most units commands treat
27964temperatures as being relative. The @code{calc-convert-temperature}
27965command has special rules for handling the different absolute magnitudes
27966of the various temperature scales.
27967
27968The unit of volume ``liters'' can be referred to by either the lower-case
27969@code{l} or the upper-case @code{L}.
27970
27971The unit @code{A} stands for Amperes; the name @code{Ang} is used
27972@tex
27973for \AA ngstroms.
27974@end tex
27975@ifinfo
27976for Angstroms.
27977@end ifinfo
27978
27979The unit @code{pt} stands for pints; the name @code{point} stands for
27980a typographical point, defined by @samp{72 point = 1 in}. There is
27981also @code{tpt}, which stands for a printer's point as defined by the
27982@TeX{} typesetting system: @samp{72.27 tpt = 1 in}.
27983
27984The unit @code{e} stands for the elementary (electron) unit of charge;
27985because algebra command could mistake this for the special constant
a4231b04 27986@expr{e}, Calc provides the alternate unit name @code{ech} which is
d7b8e6c6
EZ
27987preferable to @code{e}.
27988
27989The name @code{g} stands for one gram of mass; there is also @code{gf},
27990one gram of force. (Likewise for @kbd{lb}, pounds, and @kbd{lbf}.)
a4231b04 27991Meanwhile, one ``@expr{g}'' of acceleration is denoted @code{ga}.
d7b8e6c6
EZ
27992
27993The unit @code{ton} is a U.S. ton of @samp{2000 lb}, and @code{t} is
27994a metric ton of @samp{1000 kg}.
27995
27996The names @code{s} (or @code{sec}) and @code{min} refer to units of
27997time; @code{arcsec} and @code{arcmin} are units of angle.
27998
27999Some ``units'' are really physical constants; for example, @code{c}
28000represents the speed of light, and @code{h} represents Planck's
28001constant. You can use these just like other units: converting
28002@samp{.5 c} to @samp{m/s} expresses one-half the speed of light in
28003meters per second. You can also use this merely as a handy reference;
28004the @kbd{u g} command gets the definition of one of these constants
28005in its normal terms, and @kbd{u b} expresses the definition in base
28006units.
28007
28008Two units, @code{pi} and @code{fsc} (the fine structure constant,
8e04863e 28009approximately @mathit{1/137}) are dimensionless. The units simplification
d7b8e6c6
EZ
28010commands simply treat these names as equivalent to their corresponding
28011values. However you can, for example, use @kbd{u c} to convert a pure
28012number into multiples of the fine structure constant, or @kbd{u b} to
28013convert this back into a pure number. (When @kbd{u c} prompts for the
28014``old units,'' just enter a blank line to signify that the value
28015really is unitless.)
28016
28017@c Describe angular units, luminosity vs. steradians problem.
28018
28019@node User-Defined Units, , Predefined Units, Units
28020@section User-Defined Units
28021
28022@noindent
28023Calc provides ways to get quick access to your selected ``favorite''
28024units, as well as ways to define your own new units.
28025
28026@kindex u 0-9
28027@pindex calc-quick-units
28028@vindex Units
28029@cindex @code{Units} variable
28030@cindex Quick units
28031To select your favorite units, store a vector of unit names or
28032expressions in the Calc variable @code{Units}. The @kbd{u 1}
28033through @kbd{u 9} commands (@code{calc-quick-units}) provide access
28034to these units. If the value on the top of the stack is a plain
28035number (with no units attached), then @kbd{u 1} gives it the
28036specified units. (Basically, it multiplies the number by the
28037first item in the @code{Units} vector.) If the number on the
28038stack @emph{does} have units, then @kbd{u 1} converts that number
28039to the new units. For example, suppose the vector @samp{[in, ft]}
28040is stored in @code{Units}. Then @kbd{30 u 1} will create the
28041expression @samp{30 in}, and @kbd{u 2} will convert that expression
28042to @samp{2.5 ft}.
28043
28044The @kbd{u 0} command accesses the tenth element of @code{Units}.
28045Only ten quick units may be defined at a time. If the @code{Units}
28046variable has no stored value (the default), or if its value is not
28047a vector, then the quick-units commands will not function. The
28048@kbd{s U} command is a convenient way to edit the @code{Units}
28049variable; @pxref{Operations on Variables}.
28050
28051@kindex u d
28052@pindex calc-define-unit
28053@cindex User-defined units
28054The @kbd{u d} (@code{calc-define-unit}) command records the units
28055expression on the top of the stack as the definition for a new,
28056user-defined unit. For example, putting @samp{16.5 ft} on the stack and
28057typing @kbd{u d rod} defines the new unit @samp{rod} to be equivalent to
2805816.5 feet. The unit conversion and simplification commands will now
28059treat @code{rod} just like any other unit of length. You will also be
28060prompted for an optional English description of the unit, which will
28061appear in the Units Table.
28062
28063@kindex u u
28064@pindex calc-undefine-unit
28065The @kbd{u u} (@code{calc-undefine-unit}) command removes a user-defined
28066unit. It is not possible to remove one of the predefined units,
28067however.
28068
28069If you define a unit with an existing unit name, your new definition
28070will replace the original definition of that unit. If the unit was a
28071predefined unit, the old definition will not be replaced, only
28072``shadowed.'' The built-in definition will reappear if you later use
28073@kbd{u u} to remove the shadowing definition.
28074
28075To create a new fundamental unit, use either 1 or the unit name itself
28076as the defining expression. Otherwise the expression can involve any
28077other units that you like (except for composite units like @samp{mfi}).
28078You can create a new composite unit with a sum of other units as the
28079defining expression. The next unit operation like @kbd{u c} or @kbd{u v}
28080will rebuild the internal unit table incorporating your modifications.
28081Note that erroneous definitions (such as two units defined in terms of
28082each other) will not be detected until the unit table is next rebuilt;
28083@kbd{u v} is a convenient way to force this to happen.
28084
28085Temperature units are treated specially inside the Calculator; it is not
28086possible to create user-defined temperature units.
28087
28088@kindex u p
28089@pindex calc-permanent-units
3b846359 28090@cindex Calc init file, user-defined units
d7b8e6c6 28091The @kbd{u p} (@code{calc-permanent-units}) command stores the user-defined
3b846359
JB
28092units in your Calc init file (the file given by the variable
28093@code{calc-settings-file}, typically @file{~/.calc.el}), so that the
28094units will still be available in subsequent Emacs sessions. If there
28095was already a set of user-defined units in your Calc init file, it
28096is replaced by the new set. (@xref{General Mode Commands}, for a way to
28097tell Calc to use a different file for the Calc init file.)
d7b8e6c6
EZ
28098
28099@node Store and Recall, Graphics, Units, Top
28100@chapter Storing and Recalling
28101
28102@noindent
28103Calculator variables are really just Lisp variables that contain numbers
28104or formulas in a form that Calc can understand. The commands in this
28105section allow you to manipulate variables conveniently. Commands related
28106to variables use the @kbd{s} prefix key.
28107
28108@menu
28109* Storing Variables::
28110* Recalling Variables::
28111* Operations on Variables::
28112* Let Command::
28113* Evaluates-To Operator::
28114@end menu
28115
28116@node Storing Variables, Recalling Variables, Store and Recall, Store and Recall
28117@section Storing Variables
28118
28119@noindent
28120@kindex s s
28121@pindex calc-store
28122@cindex Storing variables
28123@cindex Quick variables
28124@vindex q0
28125@vindex q9
28126The @kbd{s s} (@code{calc-store}) command stores the value at the top of
28127the stack into a specified variable. It prompts you to enter the
28128name of the variable. If you press a single digit, the value is stored
4f38ed98
JB
28129immediately in one of the ``quick'' variables @code{q0} through
28130@code{q9}. Or you can enter any variable name.
d7b8e6c6
EZ
28131
28132@kindex s t
28133@pindex calc-store-into
28134The @kbd{s s} command leaves the stored value on the stack. There is
28135also an @kbd{s t} (@code{calc-store-into}) command, which removes a
28136value from the stack and stores it in a variable.
28137
28138If the top of stack value is an equation @samp{a = 7} or assignment
28139@samp{a := 7} with a variable on the lefthand side, then Calc will
28140assign that variable with that value by default, i.e., if you type
28141@kbd{s s @key{RET}} or @kbd{s t @key{RET}}. In this example, the
28142value 7 would be stored in the variable @samp{a}. (If you do type
28143a variable name at the prompt, the top-of-stack value is stored in
28144its entirety, even if it is an equation: @samp{s s b @key{RET}}
28145with @samp{a := 7} on the stack stores @samp{a := 7} in @code{b}.)
28146
28147In fact, the top of stack value can be a vector of equations or
28148assignments with different variables on their lefthand sides; the
28149default will be to store all the variables with their corresponding
28150righthand sides simultaneously.
28151
28152It is also possible to type an equation or assignment directly at
28153the prompt for the @kbd{s s} or @kbd{s t} command: @kbd{s s foo = 7}.
28154In this case the expression to the right of the @kbd{=} or @kbd{:=}
28155symbol is evaluated as if by the @kbd{=} command, and that value is
28156stored in the variable. No value is taken from the stack; @kbd{s s}
28157and @kbd{s t} are equivalent when used in this way.
28158
28159@kindex s 0-9
28160@kindex t 0-9
28161The prefix keys @kbd{s} and @kbd{t} may be followed immediately by a
28162digit; @kbd{s 9} is equivalent to @kbd{s s 9}, and @kbd{t 9} is
28163equivalent to @kbd{s t 9}. (The @kbd{t} prefix is otherwise used
28164for trail and time/date commands.)
28165
28166@kindex s +
28167@kindex s -
5d67986c
RS
28168@ignore
28169@mindex @idots
28170@end ignore
d7b8e6c6 28171@kindex s *
5d67986c
RS
28172@ignore
28173@mindex @null
28174@end ignore
d7b8e6c6 28175@kindex s /
5d67986c
RS
28176@ignore
28177@mindex @null
28178@end ignore
d7b8e6c6 28179@kindex s ^
5d67986c
RS
28180@ignore
28181@mindex @null
28182@end ignore
d7b8e6c6 28183@kindex s |
5d67986c
RS
28184@ignore
28185@mindex @null
28186@end ignore
d7b8e6c6 28187@kindex s n
5d67986c
RS
28188@ignore
28189@mindex @null
28190@end ignore
d7b8e6c6 28191@kindex s &
5d67986c
RS
28192@ignore
28193@mindex @null
28194@end ignore
d7b8e6c6 28195@kindex s [
5d67986c
RS
28196@ignore
28197@mindex @null
28198@end ignore
d7b8e6c6
EZ
28199@kindex s ]
28200@pindex calc-store-plus
28201@pindex calc-store-minus
28202@pindex calc-store-times
28203@pindex calc-store-div
28204@pindex calc-store-power
28205@pindex calc-store-concat
28206@pindex calc-store-neg
28207@pindex calc-store-inv
28208@pindex calc-store-decr
28209@pindex calc-store-incr
28210There are also several ``arithmetic store'' commands. For example,
28211@kbd{s +} removes a value from the stack and adds it to the specified
28212variable. The other arithmetic stores are @kbd{s -}, @kbd{s *}, @kbd{s /},
28213@kbd{s ^}, and @w{@kbd{s |}} (vector concatenation), plus @kbd{s n} and
28214@kbd{s &} which negate or invert the value in a variable, and @w{@kbd{s [}}
28215and @kbd{s ]} which decrease or increase a variable by one.
28216
28217All the arithmetic stores accept the Inverse prefix to reverse the
a4231b04
JB
28218order of the operands. If @expr{v} represents the contents of the
28219variable, and @expr{a} is the value drawn from the stack, then regular
28220@w{@kbd{s -}} assigns
8e04863e 28221@texline @math{v \coloneq v - a},
a4231b04
JB
28222@infoline @expr{v := v - a},
28223but @kbd{I s -} assigns
8e04863e 28224@texline @math{v \coloneq a - v}.
a4231b04
JB
28225@infoline @expr{v := a - v}.
28226While @kbd{I s *} might seem pointless, it is
d7b8e6c6
EZ
28227useful if matrix multiplication is involved. Actually, all the
28228arithmetic stores use formulas designed to behave usefully both
28229forwards and backwards:
28230
d7b8e6c6 28231@example
5d67986c 28232@group
d7b8e6c6
EZ
28233s + v := v + a v := a + v
28234s - v := v - a v := a - v
28235s * v := v * a v := a * v
28236s / v := v / a v := a / v
28237s ^ v := v ^ a v := a ^ v
28238s | v := v | a v := a | v
28239s n v := v / (-1) v := (-1) / v
28240s & v := v ^ (-1) v := (-1) ^ v
28241s [ v := v - 1 v := 1 - v
28242s ] v := v - (-1) v := (-1) - v
d7b8e6c6 28243@end group
5d67986c 28244@end example
d7b8e6c6
EZ
28245
28246In the last four cases, a numeric prefix argument will be used in
28247place of the number one. (For example, @kbd{M-2 s ]} increases
28248a variable by 2, and @kbd{M-2 I s ]} replaces a variable by
28249minus-two minus the variable.
28250
28251The first six arithmetic stores can also be typed @kbd{s t +}, @kbd{s t -},
28252etc. The commands @kbd{s s +}, @kbd{s s -}, and so on are analogous
a4231b04 28253arithmetic stores that don't remove the value @expr{a} from the stack.
d7b8e6c6
EZ
28254
28255All arithmetic stores report the new value of the variable in the
28256Trail for your information. They signal an error if the variable
28257previously had no stored value. If default simplifications have been
28258turned off, the arithmetic stores temporarily turn them on for numeric
28259arguments only (i.e., they temporarily do an @kbd{m N} command).
28260@xref{Simplification Modes}. Large vectors put in the trail by
28261these commands always use abbreviated (@kbd{t .}) mode.
28262
28263@kindex s m
28264@pindex calc-store-map
28265The @kbd{s m} command is a general way to adjust a variable's value
28266using any Calc function. It is a ``mapping'' command analogous to
28267@kbd{V M}, @kbd{V R}, etc. @xref{Reducing and Mapping}, to see
28268how to specify a function for a mapping command. Basically,
28269all you do is type the Calc command key that would invoke that
28270function normally. For example, @kbd{s m n} applies the @kbd{n}
28271key to negate the contents of the variable, so @kbd{s m n} is
28272equivalent to @kbd{s n}. Also, @kbd{s m Q} takes the square root
28273of the value stored in a variable, @kbd{s m v v} uses @kbd{v v} to
28274reverse the vector stored in the variable, and @kbd{s m H I S}
28275takes the hyperbolic arcsine of the variable contents.
28276
28277If the mapping function takes two or more arguments, the additional
28278arguments are taken from the stack; the old value of the variable
a4231b04
JB
28279is provided as the first argument. Thus @kbd{s m -} with @expr{a}
28280on the stack computes @expr{v - a}, just like @kbd{s -}. With the
d7b8e6c6
EZ
28281Inverse prefix, the variable's original value becomes the @emph{last}
28282argument instead of the first. Thus @kbd{I s m -} is also
28283equivalent to @kbd{I s -}.
28284
28285@kindex s x
28286@pindex calc-store-exchange
28287The @kbd{s x} (@code{calc-store-exchange}) command exchanges the value
28288of a variable with the value on the top of the stack. Naturally, the
28289variable must already have a stored value for this to work.
28290
28291You can type an equation or assignment at the @kbd{s x} prompt. The
28292command @kbd{s x a=6} takes no values from the stack; instead, it
28293pushes the old value of @samp{a} on the stack and stores @samp{a = 6}.
28294
28295@kindex s u
28296@pindex calc-unstore
28297@cindex Void variables
28298@cindex Un-storing variables
c7bb1c63
JB
28299Until you store something in them, most variables are ``void,'' that is,
28300they contain no value at all. If they appear in an algebraic formula
28301they will be left alone even if you press @kbd{=} (@code{calc-evaluate}).
d7b8e6c6 28302The @kbd{s u} (@code{calc-unstore}) command returns a variable to the
a4231b04 28303void state.
d7b8e6c6 28304
6188800e
JB
28305@kindex s c
28306@pindex calc-copy-variable
28307The @kbd{s c} (@code{calc-copy-variable}) command copies the stored
28308value of one variable to another. One way it differs from a simple
28309@kbd{s r} followed by an @kbd{s t} (aside from saving keystrokes) is
28310that the value never goes on the stack and thus is never rounded,
28311evaluated, or simplified in any way; it is not even rounded down to the
28312current precision.
28313
d7b8e6c6
EZ
28314The only variables with predefined values are the ``special constants''
28315@code{pi}, @code{e}, @code{i}, @code{phi}, and @code{gamma}. You are free
28316to unstore these variables or to store new values into them if you like,
28317although some of the algebraic-manipulation functions may assume these
28318variables represent their standard values. Calc displays a warning if
28319you change the value of one of these variables, or of one of the other
28320special variables @code{inf}, @code{uinf}, and @code{nan} (which are
28321normally void).
28322
6188800e
JB
28323Note that @code{pi} doesn't actually have 3.14159265359 stored in it,
28324but rather a special magic value that evaluates to @cpi{} at the current
28325precision. Likewise @code{e}, @code{i}, and @code{phi} evaluate
28326according to the current precision or polar mode. If you recall a value
28327from @code{pi} and store it back, this magic property will be lost. The
28328magic property is preserved, however, when a variable is copied with
28329@kbd{s c}.
28330
28331@kindex s k
28332@pindex calc-copy-special-constant
28333If one of the ``special constants'' is redefined (or undefined) so that
28334it no longer has its magic property, the property can be restored with
28335@kbd{s k} (@code{calc-copy-special-constant}). This command will prompt
28336for a special constant and a variable to store it in, and so a special
28337constant can be stored in any variable. Here, the special constant that
28338you enter doesn't depend on the value of the corresponding variable;
28339@code{pi} will represent 3.14159@dots{} regardless of what is currently
28340stored in the Calc variable @code{pi}. If one of the other special
28341variables, @code{inf}, @code{uinf} or @code{nan}, is given a value, its
28342original behavior can be restored by voiding it with @kbd{s u}.
d7b8e6c6
EZ
28343
28344@node Recalling Variables, Operations on Variables, Storing Variables, Store and Recall
28345@section Recalling Variables
28346
28347@noindent
28348@kindex s r
28349@pindex calc-recall
28350@cindex Recalling variables
28351The most straightforward way to extract the stored value from a variable
28352is to use the @kbd{s r} (@code{calc-recall}) command. This command prompts
28353for a variable name (similarly to @code{calc-store}), looks up the value
28354of the specified variable, and pushes that value onto the stack. It is
28355an error to try to recall a void variable.
28356
28357It is also possible to recall the value from a variable by evaluating a
28358formula containing that variable. For example, @kbd{' a @key{RET} =} is
28359the same as @kbd{s r a @key{RET}} except that if the variable is void, the
28360former will simply leave the formula @samp{a} on the stack whereas the
28361latter will produce an error message.
28362
28363@kindex r 0-9
28364The @kbd{r} prefix may be followed by a digit, so that @kbd{r 9} is
28365equivalent to @kbd{s r 9}. (The @kbd{r} prefix is otherwise unused
28366in the current version of Calc.)
28367
28368@node Operations on Variables, Let Command, Recalling Variables, Store and Recall
28369@section Other Operations on Variables
28370
28371@noindent
28372@kindex s e
28373@pindex calc-edit-variable
28374The @kbd{s e} (@code{calc-edit-variable}) command edits the stored
28375value of a variable without ever putting that value on the stack
28376or simplifying or evaluating the value. It prompts for the name of
28377the variable to edit. If the variable has no stored value, the
28378editing buffer will start out empty. If the editing buffer is
33108698 28379empty when you press @kbd{C-c C-c} to finish, the variable will
d7b8e6c6
EZ
28380be made void. @xref{Editing Stack Entries}, for a general
28381description of editing.
28382
28383The @kbd{s e} command is especially useful for creating and editing
28384rewrite rules which are stored in variables. Sometimes these rules
28385contain formulas which must not be evaluated until the rules are
28386actually used. (For example, they may refer to @samp{deriv(x,y)},
28387where @code{x} will someday become some expression involving @code{y};
28388if you let Calc evaluate the rule while you are defining it, Calc will
28389replace @samp{deriv(x,y)} with 0 because the formula @code{x} does
28390not itself refer to @code{y}.) By contrast, recalling the variable,
28391editing with @kbd{`}, and storing will evaluate the variable's value
28392as a side effect of putting the value on the stack.
28393
28394@kindex s A
28395@kindex s D
5d67986c
RS
28396@ignore
28397@mindex @idots
28398@end ignore
d7b8e6c6 28399@kindex s E
5d67986c
RS
28400@ignore
28401@mindex @null
28402@end ignore
d7b8e6c6 28403@kindex s F
5d67986c
RS
28404@ignore
28405@mindex @null
28406@end ignore
d7b8e6c6 28407@kindex s G
5d67986c
RS
28408@ignore
28409@mindex @null
28410@end ignore
d7b8e6c6 28411@kindex s H
5d67986c
RS
28412@ignore
28413@mindex @null
28414@end ignore
d7b8e6c6 28415@kindex s I
5d67986c
RS
28416@ignore
28417@mindex @null
28418@end ignore
d7b8e6c6 28419@kindex s L
5d67986c
RS
28420@ignore
28421@mindex @null
28422@end ignore
d7b8e6c6 28423@kindex s P
5d67986c
RS
28424@ignore
28425@mindex @null
28426@end ignore
d7b8e6c6 28427@kindex s R
5d67986c
RS
28428@ignore
28429@mindex @null
28430@end ignore
d7b8e6c6 28431@kindex s T
5d67986c
RS
28432@ignore
28433@mindex @null
28434@end ignore
d7b8e6c6 28435@kindex s U
5d67986c
RS
28436@ignore
28437@mindex @null
28438@end ignore
d7b8e6c6
EZ
28439@kindex s X
28440@pindex calc-store-AlgSimpRules
28441@pindex calc-store-Decls
28442@pindex calc-store-EvalRules
28443@pindex calc-store-FitRules
28444@pindex calc-store-GenCount
28445@pindex calc-store-Holidays
28446@pindex calc-store-IntegLimit
28447@pindex calc-store-LineStyles
28448@pindex calc-store-PointStyles
28449@pindex calc-store-PlotRejects
28450@pindex calc-store-TimeZone
28451@pindex calc-store-Units
28452@pindex calc-store-ExtSimpRules
28453There are several special-purpose variable-editing commands that
28454use the @kbd{s} prefix followed by a shifted letter:
28455
28456@table @kbd
28457@item s A
28458Edit @code{AlgSimpRules}. @xref{Algebraic Simplifications}.
28459@item s D
28460Edit @code{Decls}. @xref{Declarations}.
28461@item s E
28462Edit @code{EvalRules}. @xref{Default Simplifications}.
28463@item s F
28464Edit @code{FitRules}. @xref{Curve Fitting}.
28465@item s G
28466Edit @code{GenCount}. @xref{Solving Equations}.
28467@item s H
28468Edit @code{Holidays}. @xref{Business Days}.
28469@item s I
28470Edit @code{IntegLimit}. @xref{Calculus}.
28471@item s L
28472Edit @code{LineStyles}. @xref{Graphics}.
28473@item s P
28474Edit @code{PointStyles}. @xref{Graphics}.
28475@item s R
28476Edit @code{PlotRejects}. @xref{Graphics}.
28477@item s T
28478Edit @code{TimeZone}. @xref{Time Zones}.
28479@item s U
28480Edit @code{Units}. @xref{User-Defined Units}.
28481@item s X
28482Edit @code{ExtSimpRules}. @xref{Unsafe Simplifications}.
28483@end table
28484
28485These commands are just versions of @kbd{s e} that use fixed variable
28486names rather than prompting for the variable name.
28487
28488@kindex s p
28489@pindex calc-permanent-variable
28490@cindex Storing variables
28491@cindex Permanent variables
3b846359 28492@cindex Calc init file, variables
d7b8e6c6 28493The @kbd{s p} (@code{calc-permanent-variable}) command saves a
3b846359
JB
28494variable's value permanently in your Calc init file (the file given by
28495the variable @code{calc-settings-file}, typically @file{~/.calc.el}), so
28496that its value will still be available in future Emacs sessions. You
28497can re-execute @w{@kbd{s p}} later on to update the saved value, but the
28498only way to remove a saved variable is to edit your calc init file
d7b8e6c6 28499by hand. (@xref{General Mode Commands}, for a way to tell Calc to
3b846359 28500use a different file for the Calc init file.)
d7b8e6c6
EZ
28501
28502If you do not specify the name of a variable to save (i.e.,
4f38ed98 28503@kbd{s p @key{RET}}), all Calc variables with defined values
d7b8e6c6
EZ
28504are saved except for the special constants @code{pi}, @code{e},
28505@code{i}, @code{phi}, and @code{gamma}; the variables @code{TimeZone}
28506and @code{PlotRejects};
28507@code{FitRules}, @code{DistribRules}, and other built-in rewrite
28508rules; and @code{PlotData@var{n}} variables generated
28509by the graphics commands. (You can still save these variables by
a4231b04 28510explicitly naming them in an @kbd{s p} command.)
d7b8e6c6
EZ
28511
28512@kindex s i
28513@pindex calc-insert-variables
28514The @kbd{s i} (@code{calc-insert-variables}) command writes
4f38ed98
JB
28515the values of all Calc variables into a specified buffer.
28516The variables are written with the prefix @code{var-} in the form of
28517Lisp @code{setq} commands
d7b8e6c6 28518which store the values in string form. You can place these commands
3b846359 28519in your Calc init file (or @file{.emacs}) if you wish, though in this case it
d7b8e6c6
EZ
28520would be easier to use @kbd{s p @key{RET}}. (Note that @kbd{s i}
28521omits the same set of variables as @w{@kbd{s p @key{RET}}}; the difference
28522is that @kbd{s i} will store the variables in any buffer, and it also
28523stores in a more human-readable format.)
28524
28525@node Let Command, Evaluates-To Operator, Operations on Variables, Store and Recall
28526@section The Let Command
28527
28528@noindent
28529@kindex s l
28530@pindex calc-let
28531@cindex Variables, temporary assignment
28532@cindex Temporary assignment to variables
28533If you have an expression like @samp{a+b^2} on the stack and you wish to
a4231b04 28534compute its value where @expr{b=3}, you can simply store 3 in @expr{b} and
d7b8e6c6 28535then press @kbd{=} to reevaluate the formula. This has the side-effect
a4231b04 28536of leaving the stored value of 3 in @expr{b} for future operations.
d7b8e6c6
EZ
28537
28538The @kbd{s l} (@code{calc-let}) command evaluates a formula under a
28539@emph{temporary} assignment of a variable. It stores the value on the
28540top of the stack into the specified variable, then evaluates the
28541second-to-top stack entry, then restores the original value (or lack of one)
28542in the variable. Thus after @kbd{'@w{ }a+b^2 @key{RET} 3 s l b @key{RET}},
28543the stack will contain the formula @samp{a + 9}. The subsequent command
28544@kbd{@w{5 s l a} @key{RET}} will replace this formula with the number 14.
28545The variables @samp{a} and @samp{b} are not permanently affected in any way
28546by these commands.
28547
28548The value on the top of the stack may be an equation or assignment, or
28549a vector of equations or assignments, in which case the default will be
28550analogous to the case of @kbd{s t @key{RET}}. @xref{Storing Variables}.
28551
28552Also, you can answer the variable-name prompt with an equation or
5d67986c
RS
28553assignment: @kbd{s l b=3 @key{RET}} is the same as storing 3 on the stack
28554and typing @kbd{s l b @key{RET}}.
d7b8e6c6
EZ
28555
28556The @kbd{a b} (@code{calc-substitute}) command is another way to substitute
28557a variable with a value in a formula. It does an actual substitution
28558rather than temporarily assigning the variable and evaluating. For
a4231b04 28559example, letting @expr{n=2} in @samp{f(n pi)} with @kbd{a b} will
d7b8e6c6
EZ
28560produce @samp{f(2 pi)}, whereas @kbd{s l} would give @samp{f(6.28)}
28561since the evaluation step will also evaluate @code{pi}.
28562
28563@node Evaluates-To Operator, , Let Command, Store and Recall
28564@section The Evaluates-To Operator
28565
28566@noindent
28567@tindex evalto
28568@tindex =>
28569@cindex Evaluates-to operator
28570@cindex @samp{=>} operator
28571The special algebraic symbol @samp{=>} is known as the @dfn{evaluates-to
28572operator}. (It will show up as an @code{evalto} function call in
053bc283 28573other language modes like Pascal and La@TeX{}.) This is a binary
d7b8e6c6
EZ
28574operator, that is, it has a lefthand and a righthand argument,
28575although it can be entered with the righthand argument omitted.
28576
28577A formula like @samp{@var{a} => @var{b}} is evaluated by Calc as
28578follows: First, @var{a} is not simplified or modified in any
28579way. The previous value of argument @var{b} is thrown away; the
28580formula @var{a} is then copied and evaluated as if by the @kbd{=}
28581command according to all current modes and stored variable values,
28582and the result is installed as the new value of @var{b}.
28583
28584For example, suppose you enter the algebraic formula @samp{2 + 3 => 17}.
28585The number 17 is ignored, and the lefthand argument is left in its
28586unevaluated form; the result is the formula @samp{2 + 3 => 5}.
28587
28588@kindex s =
28589@pindex calc-evalto
28590You can enter an @samp{=>} formula either directly using algebraic
28591entry (in which case the righthand side may be omitted since it is
28592going to be replaced right away anyhow), or by using the @kbd{s =}
28593(@code{calc-evalto}) command, which takes @var{a} from the stack
28594and replaces it with @samp{@var{a} => @var{b}}.
28595
28596Calc keeps track of all @samp{=>} operators on the stack, and
28597recomputes them whenever anything changes that might affect their
28598values, i.e., a mode setting or variable value. This occurs only
28599if the @samp{=>} operator is at the top level of the formula, or
28600if it is part of a top-level vector. In other words, pushing
28601@samp{2 + (a => 17)} will change the 17 to the actual value of
28602@samp{a} when you enter the formula, but the result will not be
28603dynamically updated when @samp{a} is changed later because the
28604@samp{=>} operator is buried inside a sum. However, a vector
28605of @samp{=>} operators will be recomputed, since it is convenient
28606to push a vector like @samp{[a =>, b =>, c =>]} on the stack to
28607make a concise display of all the variables in your problem.
28608(Another way to do this would be to use @samp{[a, b, c] =>},
28609which provides a slightly different format of display. You
28610can use whichever you find easiest to read.)
28611
28612@kindex m C
28613@pindex calc-auto-recompute
28614The @kbd{m C} (@code{calc-auto-recompute}) command allows you to
28615turn this automatic recomputation on or off. If you turn
28616recomputation off, you must explicitly recompute an @samp{=>}
28617operator on the stack in one of the usual ways, such as by
28618pressing @kbd{=}. Turning recomputation off temporarily can save
28619a lot of time if you will be changing several modes or variables
28620before you look at the @samp{=>} entries again.
28621
28622Most commands are not especially useful with @samp{=>} operators
28623as arguments. For example, given @samp{x + 2 => 17}, it won't
28624work to type @kbd{1 +} to get @samp{x + 3 => 18}. If you want
28625to operate on the lefthand side of the @samp{=>} operator on
28626the top of the stack, type @kbd{j 1} (that's the digit ``one'')
28627to select the lefthand side, execute your commands, then type
28628@kbd{j u} to unselect.
28629
28630All current modes apply when an @samp{=>} operator is computed,
28631including the current simplification mode. Recall that the
28632formula @samp{x + y + x} is not handled by Calc's default
28633simplifications, but the @kbd{a s} command will reduce it to
28634the simpler form @samp{y + 2 x}. You can also type @kbd{m A}
07ce2eb3 28635to enable an Algebraic Simplification mode in which the
d7b8e6c6
EZ
28636equivalent of @kbd{a s} is used on all of Calc's results.
28637If you enter @samp{x + y + x =>} normally, the result will
28638be @samp{x + y + x => x + y + x}. If you change to
07ce2eb3 28639Algebraic Simplification mode, the result will be
d7b8e6c6
EZ
28640@samp{x + y + x => y + 2 x}. However, just pressing @kbd{a s}
28641once will have no effect on @samp{x + y + x => x + y + x},
28642because the righthand side depends only on the lefthand side
28643and the current mode settings, and the lefthand side is not
28644affected by commands like @kbd{a s}.
28645
28646The ``let'' command (@kbd{s l}) has an interesting interaction
28647with the @samp{=>} operator. The @kbd{s l} command evaluates the
28648second-to-top stack entry with the top stack entry supplying
28649a temporary value for a given variable. As you might expect,
28650if that stack entry is an @samp{=>} operator its righthand
28651side will temporarily show this value for the variable. In
28652fact, all @samp{=>}s on the stack will be updated if they refer
28653to that variable. But this change is temporary in the sense
28654that the next command that causes Calc to look at those stack
28655entries will make them revert to the old variable value.
28656
d7b8e6c6 28657@smallexample
5d67986c 28658@group
d7b8e6c6
EZ
286592: a => a 2: a => 17 2: a => a
286601: a + 1 => a + 1 1: a + 1 => 18 1: a + 1 => a + 1
28661 . . .
28662
5d67986c 28663 17 s l a @key{RET} p 8 @key{RET}
d7b8e6c6 28664@end group
5d67986c 28665@end smallexample
d7b8e6c6
EZ
28666
28667Here the @kbd{p 8} command changes the current precision,
28668thus causing the @samp{=>} forms to be recomputed after the
5d67986c 28669influence of the ``let'' is gone. The @kbd{d @key{SPC}} command
d7b8e6c6
EZ
28670(@code{calc-refresh}) is a handy way to force the @samp{=>}
28671operators on the stack to be recomputed without any other
28672side effects.
28673
28674@kindex s :
28675@pindex calc-assign
28676@tindex assign
28677@tindex :=
07ce2eb3 28678Embedded mode also uses @samp{=>} operators. In Embedded mode,
d7b8e6c6
EZ
28679the lefthand side of an @samp{=>} operator can refer to variables
28680assigned elsewhere in the file by @samp{:=} operators. The
28681assignment operator @samp{a := 17} does not actually do anything
07ce2eb3 28682by itself. But Embedded mode recognizes it and marks it as a sort
d7b8e6c6 28683of file-local definition of the variable. You can enter @samp{:=}
07ce2eb3 28684operators in Algebraic mode, or by using the @kbd{s :}
d7b8e6c6
EZ
28685(@code{calc-assign}) [@code{assign}] command which takes a variable
28686and value from the stack and replaces them with an assignment.
28687
8ed713c6 28688@xref{TeX and LaTeX Language Modes}, for the way @samp{=>} appears in
d7b8e6c6
EZ
28689@TeX{} language output. The @dfn{eqn} mode gives similar
28690treatment to @samp{=>}.
28691
28692@node Graphics, Kill and Yank, Store and Recall, Top
28693@chapter Graphics
28694
28695@noindent
28696The commands for graphing data begin with the @kbd{g} prefix key. Calc
28697uses GNUPLOT 2.0 or 3.0 to do graphics. These commands will only work
28698if GNUPLOT is available on your system. (While GNUPLOT sounds like
28699a relative of GNU Emacs, it is actually completely unrelated.
28700However, it is free software and can be obtained from the Free
28701Software Foundation's machine @samp{prep.ai.mit.edu}.)
28702
28703@vindex calc-gnuplot-name
28704If you have GNUPLOT installed on your system but Calc is unable to
28705find it, you may need to set the @code{calc-gnuplot-name} variable
3b846359 28706in your Calc init file or @file{.emacs}. You may also need to set some Lisp
d7b8e6c6
EZ
28707variables to show Calc how to run GNUPLOT on your system; these
28708are described under @kbd{g D} and @kbd{g O} below. If you are
28709using the X window system, Calc will configure GNUPLOT for you
28710automatically. If you have GNUPLOT 3.0 and you are not using X,
28711Calc will configure GNUPLOT to display graphs using simple character
28712graphics that will work on any terminal.
28713
28714@menu
28715* Basic Graphics::
28716* Three Dimensional Graphics::
28717* Managing Curves::
28718* Graphics Options::
28719* Devices::
28720@end menu
28721
28722@node Basic Graphics, Three Dimensional Graphics, Graphics, Graphics
28723@section Basic Graphics
28724
28725@noindent
28726@kindex g f
28727@pindex calc-graph-fast
28728The easiest graphics command is @kbd{g f} (@code{calc-graph-fast}).
28729This command takes two vectors of equal length from the stack.
28730The vector at the top of the stack represents the ``y'' values of
28731the various data points. The vector in the second-to-top position
28732represents the corresponding ``x'' values. This command runs
28733GNUPLOT (if it has not already been started by previous graphing
28734commands) and displays the set of data points. The points will
28735be connected by lines, and there will also be some kind of symbol
28736to indicate the points themselves.
28737
28738The ``x'' entry may instead be an interval form, in which case suitable
28739``x'' values are interpolated between the minimum and maximum values of
28740the interval (whether the interval is open or closed is ignored).
28741
28742The ``x'' entry may also be a number, in which case Calc uses the
a4231b04
JB
28743sequence of ``x'' values @expr{x}, @expr{x+1}, @expr{x+2}, etc.
28744(Generally the number 0 or 1 would be used for @expr{x} in this case.)
d7b8e6c6
EZ
28745
28746The ``y'' entry may be any formula instead of a vector. Calc effectively
28747uses @kbd{N} (@code{calc-eval-num}) to evaluate variables in the formula;
28748the result of this must be a formula in a single (unassigned) variable.
28749The formula is plotted with this variable taking on the various ``x''
28750values. Graphs of formulas by default use lines without symbols at the
28751computed data points. Note that if neither ``x'' nor ``y'' is a vector,
28752Calc guesses at a reasonable number of data points to use. See the
28753@kbd{g N} command below. (The ``x'' values must be either a vector
28754or an interval if ``y'' is a formula.)
28755
5d67986c
RS
28756@ignore
28757@starindex
28758@end ignore
d7b8e6c6
EZ
28759@tindex xy
28760If ``y'' is (or evaluates to) a formula of the form
28761@samp{xy(@var{x}, @var{y})} then the result is a
28762parametric plot. The two arguments of the fictitious @code{xy} function
28763are used as the ``x'' and ``y'' coordinates of the curve, respectively.
28764In this case the ``x'' vector or interval you specified is not directly
28765visible in the graph. For example, if ``x'' is the interval @samp{[0..360]}
28766and ``y'' is the formula @samp{xy(sin(t), cos(t))}, the resulting graph
a4231b04 28767will be a circle.
d7b8e6c6
EZ
28768
28769Also, ``x'' and ``y'' may each be variable names, in which case Calc
28770looks for suitable vectors, intervals, or formulas stored in those
28771variables.
28772
28773The ``x'' and ``y'' values for the data points (as pulled from the vectors,
28774calculated from the formulas, or interpolated from the intervals) should
28775be real numbers (integers, fractions, or floats). If either the ``x''
28776value or the ``y'' value of a given data point is not a real number, that
28777data point will be omitted from the graph. The points on either side
28778of the invalid point will @emph{not} be connected by a line.
28779
28780See the documentation for @kbd{g a} below for a description of the way
28781numeric prefix arguments affect @kbd{g f}.
28782
28783@cindex @code{PlotRejects} variable
28784@vindex PlotRejects
28785If you store an empty vector in the variable @code{PlotRejects}
28786(i.e., @kbd{[ ] s t PlotRejects}), Calc will append information to
28787this vector for every data point which was rejected because its
28788``x'' or ``y'' values were not real numbers. The result will be
28789a matrix where each row holds the curve number, data point number,
28790``x'' value, and ``y'' value for a rejected data point.
28791@xref{Evaluates-To Operator}, for a handy way to keep tabs on the
28792current value of @code{PlotRejects}. @xref{Operations on Variables},
28793for the @kbd{s R} command which is another easy way to examine
28794@code{PlotRejects}.
28795
28796@kindex g c
28797@pindex calc-graph-clear
28798To clear the graphics display, type @kbd{g c} (@code{calc-graph-clear}).
28799If the GNUPLOT output device is an X window, the window will go away.
28800Effects on other kinds of output devices will vary. You don't need
28801to use @kbd{g c} if you don't want to---if you give another @kbd{g f}
28802or @kbd{g p} command later on, it will reuse the existing graphics
28803window if there is one.
28804
28805@node Three Dimensional Graphics, Managing Curves, Basic Graphics, Graphics
28806@section Three-Dimensional Graphics
28807
28808@kindex g F
28809@pindex calc-graph-fast-3d
28810The @kbd{g F} (@code{calc-graph-fast-3d}) command makes a three-dimensional
28811graph. It works only if you have GNUPLOT 3.0 or later; with GNUPLOT 2.0,
28812you will see a GNUPLOT error message if you try this command.
28813
28814The @kbd{g F} command takes three values from the stack, called ``x'',
28815``y'', and ``z'', respectively. As was the case for 2D graphs, there
28816are several options for these values.
28817
28818In the first case, ``x'' and ``y'' are each vectors (not necessarily of
28819the same length); either or both may instead be interval forms. The
28820``z'' value must be a matrix with the same number of rows as elements
28821in ``x'', and the same number of columns as elements in ``y''. The
a4231b04 28822result is a surface plot where
8e04863e 28823@texline @math{z_{ij}}
a4231b04
JB
28824@infoline @expr{z_ij}
28825is the height of the point
28826at coordinate @expr{(x_i, y_j)} on the surface. The 3D graph will
d7b8e6c6
EZ
28827be displayed from a certain default viewpoint; you can change this
28828viewpoint by adding a @samp{set view} to the @samp{*Gnuplot Commands*}
28829buffer as described later. See the GNUPLOT 3.0 documentation for a
28830description of the @samp{set view} command.
28831
28832Each point in the matrix will be displayed as a dot in the graph,
28833and these points will be connected by a grid of lines (@dfn{isolines}).
28834
28835In the second case, ``x'', ``y'', and ``z'' are all vectors of equal
28836length. The resulting graph displays a 3D line instead of a surface,
28837where the coordinates of points along the line are successive triplets
28838of values from the input vectors.
28839
28840In the third case, ``x'' and ``y'' are vectors or interval forms, and
28841``z'' is any formula involving two variables (not counting variables
28842with assigned values). These variables are sorted into alphabetical
28843order; the first takes on values from ``x'' and the second takes on
28844values from ``y'' to form a matrix of results that are graphed as a
288453D surface.
28846
5d67986c
RS
28847@ignore
28848@starindex
28849@end ignore
d7b8e6c6
EZ
28850@tindex xyz
28851If the ``z'' formula evaluates to a call to the fictitious function
28852@samp{xyz(@var{x}, @var{y}, @var{z})}, then the result is a
28853``parametric surface.'' In this case, the axes of the graph are
28854taken from the @var{x} and @var{y} values in these calls, and the
28855``x'' and ``y'' values from the input vectors or intervals are used only
28856to specify the range of inputs to the formula. For example, plotting
28857@samp{[0..360], [0..180], xyz(sin(x)*sin(y), cos(x)*sin(y), cos(y))}
28858will draw a sphere. (Since the default resolution for 3D plots is
288595 steps in each of ``x'' and ``y'', this will draw a very crude
28860sphere. You could use the @kbd{g N} command, described below, to
28861increase this resolution, or specify the ``x'' and ``y'' values as
28862vectors with more than 5 elements.
28863
28864It is also possible to have a function in a regular @kbd{g f} plot
28865evaluate to an @code{xyz} call. Since @kbd{g f} plots a line, not
28866a surface, the result will be a 3D parametric line. For example,
28867@samp{[[0..720], xyz(sin(x), cos(x), x)]} will plot two turns of a
28868helix (a three-dimensional spiral).
28869
28870As for @kbd{g f}, each of ``x'', ``y'', and ``z'' may instead be
28871variables containing the relevant data.
28872
28873@node Managing Curves, Graphics Options, Three Dimensional Graphics, Graphics
28874@section Managing Curves
28875
28876@noindent
28877The @kbd{g f} command is really shorthand for the following commands:
28878@kbd{C-u g d g a g p}. Likewise, @w{@kbd{g F}} is shorthand for
28879@kbd{C-u g d g A g p}. You can gain more control over your graph
28880by using these commands directly.
28881
28882@kindex g a
28883@pindex calc-graph-add
28884The @kbd{g a} (@code{calc-graph-add}) command adds the ``curve''
28885represented by the two values on the top of the stack to the current
28886graph. You can have any number of curves in the same graph. When
28887you give the @kbd{g p} command, all the curves will be drawn superimposed
28888on the same axes.
28889
28890The @kbd{g a} command (and many others that affect the current graph)
28891will cause a special buffer, @samp{*Gnuplot Commands*}, to be displayed
28892in another window. This buffer is a template of the commands that will
28893be sent to GNUPLOT when it is time to draw the graph. The first
28894@kbd{g a} command adds a @code{plot} command to this buffer. Succeeding
28895@kbd{g a} commands add extra curves onto that @code{plot} command.
28896Other graph-related commands put other GNUPLOT commands into this
28897buffer. In normal usage you never need to work with this buffer
28898directly, but you can if you wish. The only constraint is that there
28899must be only one @code{plot} command, and it must be the last command
28900in the buffer. If you want to save and later restore a complete graph
28901configuration, you can use regular Emacs commands to save and restore
28902the contents of the @samp{*Gnuplot Commands*} buffer.
28903
28904@vindex PlotData1
28905@vindex PlotData2
28906If the values on the stack are not variable names, @kbd{g a} will invent
28907variable names for them (of the form @samp{PlotData@var{n}}) and store
28908the values in those variables. The ``x'' and ``y'' variables are what
28909go into the @code{plot} command in the template. If you add a curve
28910that uses a certain variable and then later change that variable, you
28911can replot the graph without having to delete and re-add the curve.
28912That's because the variable name, not the vector, interval or formula
28913itself, is what was added by @kbd{g a}.
28914
28915A numeric prefix argument on @kbd{g a} or @kbd{g f} changes the way
28916stack entries are interpreted as curves. With a positive prefix
a4231b04
JB
28917argument @expr{n}, the top @expr{n} stack entries are ``y'' values
28918for @expr{n} different curves which share a common ``x'' value in
28919the @expr{n+1}st stack entry. (Thus @kbd{g a} with no prefix
d7b8e6c6
EZ
28920argument is equivalent to @kbd{C-u 1 g a}.)
28921
28922A prefix of zero or plain @kbd{C-u} means to take two stack entries,
28923``x'' and ``y'' as usual, but to interpret ``y'' as a vector of
28924``y'' values for several curves that share a common ``x''.
28925
a4231b04
JB
28926A negative prefix argument tells Calc to read @expr{n} vectors from
28927the stack; each vector @expr{[x, y]} describes an independent curve.
d7b8e6c6
EZ
28928This is the only form of @kbd{g a} that creates several curves at once
28929that don't have common ``x'' values. (Of course, the range of ``x''
28930values covered by all the curves ought to be roughly the same if
28931they are to look nice on the same graph.)
28932
a4231b04 28933For example, to plot
8e04863e 28934@texline @math{\sin n x}
a4231b04
JB
28935@infoline @expr{sin(n x)}
28936for integers @expr{n}
d7b8e6c6 28937from 1 to 5, you could use @kbd{v x} to create a vector of integers
a4231b04 28938(@expr{n}), then @kbd{V M '} or @kbd{V M $} to map @samp{sin(n x)}
d7b8e6c6
EZ
28939across this vector. The resulting vector of formulas is suitable
28940for use as the ``y'' argument to a @kbd{C-u g a} or @kbd{C-u g f}
28941command.
28942
28943@kindex g A
28944@pindex calc-graph-add-3d
28945The @kbd{g A} (@code{calc-graph-add-3d}) command adds a 3D curve
2cbd16b9 28946to the graph. It is not valid to intermix 2D and 3D curves in a
d7b8e6c6 28947single graph. This command takes three arguments, ``x'', ``y'',
a4231b04
JB
28948and ``z'', from the stack. With a positive prefix @expr{n}, it
28949takes @expr{n+2} arguments (common ``x'' and ``y'', plus @expr{n}
d7b8e6c6
EZ
28950separate ``z''s). With a zero prefix, it takes three stack entries
28951but the ``z'' entry is a vector of curve values. With a negative
a4231b04 28952prefix @expr{-n}, it takes @expr{n} vectors of the form @expr{[x, y, z]}.
d7b8e6c6
EZ
28953The @kbd{g A} command works by adding a @code{splot} (surface-plot)
28954command to the @samp{*Gnuplot Commands*} buffer.
28955
28956(Although @kbd{g a} adds a 2D @code{plot} command to the
28957@samp{*Gnuplot Commands*} buffer, Calc changes this to @code{splot}
28958before sending it to GNUPLOT if it notices that the data points are
28959evaluating to @code{xyz} calls. It will not work to mix 2D and 3D
28960@kbd{g a} curves in a single graph, although Calc does not currently
28961check for this.)
28962
28963@kindex g d
28964@pindex calc-graph-delete
28965The @kbd{g d} (@code{calc-graph-delete}) command deletes the most
28966recently added curve from the graph. It has no effect if there are
28967no curves in the graph. With a numeric prefix argument of any kind,
28968it deletes all of the curves from the graph.
28969
28970@kindex g H
28971@pindex calc-graph-hide
28972The @kbd{g H} (@code{calc-graph-hide}) command ``hides'' or ``unhides''
28973the most recently added curve. A hidden curve will not appear in
28974the actual plot, but information about it such as its name and line and
28975point styles will be retained.
28976
28977@kindex g j
28978@pindex calc-graph-juggle
28979The @kbd{g j} (@code{calc-graph-juggle}) command moves the curve
28980at the end of the list (the ``most recently added curve'') to the
28981front of the list. The next-most-recent curve is thus exposed for
28982@w{@kbd{g d}} or similar commands to use. With @kbd{g j} you can work
28983with any curve in the graph even though curve-related commands only
28984affect the last curve in the list.
28985
28986@kindex g p
28987@pindex calc-graph-plot
28988The @kbd{g p} (@code{calc-graph-plot}) command uses GNUPLOT to draw
28989the graph described in the @samp{*Gnuplot Commands*} buffer. Any
28990GNUPLOT parameters which are not defined by commands in this buffer
28991are reset to their default values. The variables named in the @code{plot}
28992command are written to a temporary data file and the variable names
28993are then replaced by the file name in the template. The resulting
28994plotting commands are fed to the GNUPLOT program. See the documentation
28995for the GNUPLOT program for more specific information. All temporary
28996files are removed when Emacs or GNUPLOT exits.
28997
28998If you give a formula for ``y'', Calc will remember all the values that
28999it calculates for the formula so that later plots can reuse these values.
29000Calc throws out these saved values when you change any circumstances
29001that may affect the data, such as switching from Degrees to Radians
29002mode, or changing the value of a parameter in the formula. You can
29003force Calc to recompute the data from scratch by giving a negative
29004numeric prefix argument to @kbd{g p}.
29005
29006Calc uses a fairly rough step size when graphing formulas over intervals.
29007This is to ensure quick response. You can ``refine'' a plot by giving
29008a positive numeric prefix argument to @kbd{g p}. Calc goes through
29009the data points it has computed and saved from previous plots of the
29010function, and computes and inserts a new data point midway between
29011each of the existing points. You can refine a plot any number of times,
29012but beware that the amount of calculation involved doubles each time.
29013
29014Calc does not remember computed values for 3D graphs. This means the
29015numerix prefix argument, if any, to @kbd{g p} is effectively ignored if
29016the current graph is three-dimensional.
29017
29018@kindex g P
29019@pindex calc-graph-print
29020The @kbd{g P} (@code{calc-graph-print}) command is like @kbd{g p},
29021except that it sends the output to a printer instead of to the
29022screen. More precisely, @kbd{g p} looks for @samp{set terminal}
29023or @samp{set output} commands in the @samp{*Gnuplot Commands*} buffer;
29024lacking these it uses the default settings. However, @kbd{g P}
29025ignores @samp{set terminal} and @samp{set output} commands and
29026uses a different set of default values. All of these values are
29027controlled by the @kbd{g D} and @kbd{g O} commands discussed below.
29028Provided everything is set up properly, @kbd{g p} will plot to
29029the screen unless you have specified otherwise and @kbd{g P} will
29030always plot to the printer.
29031
29032@node Graphics Options, Devices, Managing Curves, Graphics
29033@section Graphics Options
29034
29035@noindent
29036@kindex g g
29037@pindex calc-graph-grid
29038The @kbd{g g} (@code{calc-graph-grid}) command turns the ``grid''
29039on and off. It is off by default; tick marks appear only at the
29040edges of the graph. With the grid turned on, dotted lines appear
29041across the graph at each tick mark. Note that this command only
29042changes the setting in @samp{*Gnuplot Commands*}; to see the effects
29043of the change you must give another @kbd{g p} command.
29044
29045@kindex g b
29046@pindex calc-graph-border
29047The @kbd{g b} (@code{calc-graph-border}) command turns the border
29048(the box that surrounds the graph) on and off. It is on by default.
29049This command will only work with GNUPLOT 3.0 and later versions.
29050
29051@kindex g k
29052@pindex calc-graph-key
29053The @kbd{g k} (@code{calc-graph-key}) command turns the ``key''
29054on and off. The key is a chart in the corner of the graph that
29055shows the correspondence between curves and line styles. It is
29056off by default, and is only really useful if you have several
29057curves on the same graph.
29058
29059@kindex g N
29060@pindex calc-graph-num-points
29061The @kbd{g N} (@code{calc-graph-num-points}) command allows you
29062to select the number of data points in the graph. This only affects
29063curves where neither ``x'' nor ``y'' is specified as a vector.
29064Enter a blank line to revert to the default value (initially 15).
29065With no prefix argument, this command affects only the current graph.
29066With a positive prefix argument this command changes or, if you enter
29067a blank line, displays the default number of points used for all
29068graphs created by @kbd{g a} that don't specify the resolution explicitly.
29069With a negative prefix argument, this command changes or displays
29070the default value (initially 5) used for 3D graphs created by @kbd{g A}.
a4231b04 29071Note that a 3D setting of 5 means that a total of @expr{5^2 = 25} points
d7b8e6c6
EZ
29072will be computed for the surface.
29073
29074Data values in the graph of a function are normally computed to a
29075precision of five digits, regardless of the current precision at the
29076time. This is usually more than adequate, but there are cases where
a4231b04 29077it will not be. For example, plotting @expr{1 + x} with @expr{x} in the
d7b8e6c6
EZ
29078interval @samp{[0 ..@: 1e-6]} will round all the data points down
29079to 1.0! Putting the command @samp{set precision @var{n}} in the
29080@samp{*Gnuplot Commands*} buffer will cause the data to be computed
29081at precision @var{n} instead of 5. Since this is such a rare case,
29082there is no keystroke-based command to set the precision.
29083
29084@kindex g h
29085@pindex calc-graph-header
29086The @kbd{g h} (@code{calc-graph-header}) command sets the title
29087for the graph. This will show up centered above the graph.
29088The default title is blank (no title).
29089
29090@kindex g n
29091@pindex calc-graph-name
29092The @kbd{g n} (@code{calc-graph-name}) command sets the title of an
29093individual curve. Like the other curve-manipulating commands, it
29094affects the most recently added curve, i.e., the last curve on the
29095list in the @samp{*Gnuplot Commands*} buffer. To set the title of
29096the other curves you must first juggle them to the end of the list
29097with @kbd{g j}, or edit the @samp{*Gnuplot Commands*} buffer by hand.
29098Curve titles appear in the key; if the key is turned off they are
29099not used.
29100
29101@kindex g t
29102@kindex g T
29103@pindex calc-graph-title-x
29104@pindex calc-graph-title-y
29105The @kbd{g t} (@code{calc-graph-title-x}) and @kbd{g T}
29106(@code{calc-graph-title-y}) commands set the titles on the ``x''
29107and ``y'' axes, respectively. These titles appear next to the
29108tick marks on the left and bottom edges of the graph, respectively.
29109Calc does not have commands to control the tick marks themselves,
29110but you can edit them into the @samp{*Gnuplot Commands*} buffer if
29111you wish. See the GNUPLOT documentation for details.
29112
29113@kindex g r
29114@kindex g R
29115@pindex calc-graph-range-x
29116@pindex calc-graph-range-y
29117The @kbd{g r} (@code{calc-graph-range-x}) and @kbd{g R}
29118(@code{calc-graph-range-y}) commands set the range of values on the
29119``x'' and ``y'' axes, respectively. You are prompted to enter a
29120suitable range. This should be either a pair of numbers of the
29121form, @samp{@var{min}:@var{max}}, or a blank line to revert to the
29122default behavior of setting the range based on the range of values
29123in the data, or @samp{$} to take the range from the top of the stack.
29124Ranges on the stack can be represented as either interval forms or
29125vectors: @samp{[@var{min} ..@: @var{max}]} or @samp{[@var{min}, @var{max}]}.
29126
29127@kindex g l
29128@kindex g L
29129@pindex calc-graph-log-x
29130@pindex calc-graph-log-y
29131The @kbd{g l} (@code{calc-graph-log-x}) and @kbd{g L} (@code{calc-graph-log-y})
29132commands allow you to set either or both of the axes of the graph to
29133be logarithmic instead of linear.
29134
29135@kindex g C-l
29136@kindex g C-r
29137@kindex g C-t
29138@pindex calc-graph-log-z
29139@pindex calc-graph-range-z
29140@pindex calc-graph-title-z
29141For 3D plots, @kbd{g C-t}, @kbd{g C-r}, and @kbd{g C-l} (those are
29142letters with the Control key held down) are the corresponding commands
29143for the ``z'' axis.
29144
29145@kindex g z
29146@kindex g Z
29147@pindex calc-graph-zero-x
29148@pindex calc-graph-zero-y
29149The @kbd{g z} (@code{calc-graph-zero-x}) and @kbd{g Z}
29150(@code{calc-graph-zero-y}) commands control whether a dotted line is
29151drawn to indicate the ``x'' and/or ``y'' zero axes. (These are the same
29152dotted lines that would be drawn there anyway if you used @kbd{g g} to
29153turn the ``grid'' feature on.) Zero-axis lines are on by default, and
29154may be turned off only in GNUPLOT 3.0 and later versions. They are
29155not available for 3D plots.
29156
29157@kindex g s
29158@pindex calc-graph-line-style
29159The @kbd{g s} (@code{calc-graph-line-style}) command turns the connecting
29160lines on or off for the most recently added curve, and optionally selects
29161the style of lines to be used for that curve. Plain @kbd{g s} simply
29162toggles the lines on and off. With a numeric prefix argument, @kbd{g s}
29163turns lines on and sets a particular line style. Line style numbers
29164start at one and their meanings vary depending on the output device.
29165GNUPLOT guarantees that there will be at least six different line styles
29166available for any device.
29167
29168@kindex g S
29169@pindex calc-graph-point-style
29170The @kbd{g S} (@code{calc-graph-point-style}) command similarly turns
29171the symbols at the data points on or off, or sets the point style.
29172If you turn both lines and points off, the data points will show as
29173tiny dots.
29174
29175@cindex @code{LineStyles} variable
29176@cindex @code{PointStyles} variable
29177@vindex LineStyles
29178@vindex PointStyles
29179Another way to specify curve styles is with the @code{LineStyles} and
29180@code{PointStyles} variables. These variables initially have no stored
29181values, but if you store a vector of integers in one of these variables,
29182the @kbd{g a} and @kbd{g f} commands will use those style numbers
29183instead of the defaults for new curves that are added to the graph.
29184An entry should be a positive integer for a specific style, or 0 to let
8e04863e 29185the style be chosen automatically, or @mathit{-1} to turn off lines or points
d7b8e6c6
EZ
29186altogether. If there are more curves than elements in the vector, the
29187last few curves will continue to have the default styles. Of course,
29188you can later use @kbd{g s} and @kbd{g S} to change any of these styles.
29189
5d67986c 29190For example, @kbd{'[2 -1 3] @key{RET} s t LineStyles} causes the first curve
d7b8e6c6
EZ
29191to have lines in style number 2, the second curve to have no connecting
29192lines, and the third curve to have lines in style 3. Point styles will
29193still be assigned automatically, but you could store another vector in
29194@code{PointStyles} to define them, too.
29195
29196@node Devices, , Graphics Options, Graphics
29197@section Graphical Devices
29198
29199@noindent
29200@kindex g D
29201@pindex calc-graph-device
29202The @kbd{g D} (@code{calc-graph-device}) command sets the device name
29203(or ``terminal name'' in GNUPLOT lingo) to be used by @kbd{g p} commands
29204on this graph. It does not affect the permanent default device name.
29205If you enter a blank name, the device name reverts to the default.
29206Enter @samp{?} to see a list of supported devices.
29207
29208With a positive numeric prefix argument, @kbd{g D} instead sets
29209the default device name, used by all plots in the future which do
29210not override it with a plain @kbd{g D} command. If you enter a
29211blank line this command shows you the current default. The special
29212name @code{default} signifies that Calc should choose @code{x11} if
29213the X window system is in use (as indicated by the presence of a
29214@code{DISPLAY} environment variable), or otherwise @code{dumb} under
29215GNUPLOT 3.0 and later, or @code{postscript} under GNUPLOT 2.0.
29216This is the initial default value.
29217
29218The @code{dumb} device is an interface to ``dumb terminals,'' i.e.,
29219terminals with no special graphics facilities. It writes a crude
29220picture of the graph composed of characters like @code{-} and @code{|}
29221to a buffer called @samp{*Gnuplot Trail*}, which Calc then displays.
29222The graph is made the same size as the Emacs screen, which on most
a4231b04 29223dumb terminals will be
8e04863e 29224@texline @math{80\times24}
a4231b04
JB
29225@infoline 80x24
29226characters. The graph is displayed in
33108698 29227an Emacs ``recursive edit''; type @kbd{q} or @kbd{C-c C-c} to exit
d7b8e6c6
EZ
29228the recursive edit and return to Calc. Note that the @code{dumb}
29229device is present only in GNUPLOT 3.0 and later versions.
29230
29231The word @code{dumb} may be followed by two numbers separated by
29232spaces. These are the desired width and height of the graph in
29233characters. Also, the device name @code{big} is like @code{dumb}
29234but creates a graph four times the width and height of the Emacs
29235screen. You will then have to scroll around to view the entire
29236graph. In the @samp{*Gnuplot Trail*} buffer, @key{SPC}, @key{DEL},
29237@kbd{<}, and @kbd{>} are defined to scroll by one screenful in each
29238of the four directions.
29239
29240With a negative numeric prefix argument, @kbd{g D} sets or displays
29241the device name used by @kbd{g P} (@code{calc-graph-print}). This
29242is initially @code{postscript}. If you don't have a PostScript
29243printer, you may decide once again to use @code{dumb} to create a
29244plot on any text-only printer.
29245
29246@kindex g O
29247@pindex calc-graph-output
29248The @kbd{g O} (@code{calc-graph-output}) command sets the name of
29249the output file used by GNUPLOT. For some devices, notably @code{x11},
29250there is no output file and this information is not used. Many other
29251``devices'' are really file formats like @code{postscript}; in these
29252cases the output in the desired format goes into the file you name
5d67986c 29253with @kbd{g O}. Type @kbd{g O stdout @key{RET}} to set GNUPLOT to write
d7b8e6c6
EZ
29254to its standard output stream, i.e., to @samp{*Gnuplot Trail*}.
29255This is the default setting.
29256
29257Another special output name is @code{tty}, which means that GNUPLOT
29258is going to write graphics commands directly to its standard output,
29259which you wish Emacs to pass through to your terminal. Tektronix
29260graphics terminals, among other devices, operate this way. Calc does
29261this by telling GNUPLOT to write to a temporary file, then running a
29262sub-shell executing the command @samp{cat tempfile >/dev/tty}. On
29263typical Unix systems, this will copy the temporary file directly to
29264the terminal, bypassing Emacs entirely. You will have to type @kbd{C-l}
29265to Emacs afterwards to refresh the screen.
29266
29267Once again, @kbd{g O} with a positive or negative prefix argument
29268sets the default or printer output file names, respectively. In each
29269case you can specify @code{auto}, which causes Calc to invent a temporary
29270file name for each @kbd{g p} (or @kbd{g P}) command. This temporary file
29271will be deleted once it has been displayed or printed. If the output file
29272name is not @code{auto}, the file is not automatically deleted.
29273
29274The default and printer devices and output files can be saved
29275permanently by the @kbd{m m} (@code{calc-save-modes}) command. The
29276default number of data points (see @kbd{g N}) and the X geometry
29277(see @kbd{g X}) are also saved. Other graph information is @emph{not}
29278saved; you can save a graph's configuration simply by saving the contents
29279of the @samp{*Gnuplot Commands*} buffer.
29280
29281@vindex calc-gnuplot-plot-command
29282@vindex calc-gnuplot-default-device
29283@vindex calc-gnuplot-default-output
29284@vindex calc-gnuplot-print-command
29285@vindex calc-gnuplot-print-device
29286@vindex calc-gnuplot-print-output
b154df16 29287You may wish to configure the default and
d7b8e6c6
EZ
29288printer devices and output files for the whole system. The relevant
29289Lisp variables are @code{calc-gnuplot-default-device} and @code{-output},
29290and @code{calc-gnuplot-print-device} and @code{-output}. The output
29291file names must be either strings as described above, or Lisp
29292expressions which are evaluated on the fly to get the output file names.
29293
29294Other important Lisp variables are @code{calc-gnuplot-plot-command} and
29295@code{calc-gnuplot-print-command}, which give the system commands to
29296display or print the output of GNUPLOT, respectively. These may be
29297@code{nil} if no command is necessary, or strings which can include
29298@samp{%s} to signify the name of the file to be displayed or printed.
29299Or, these variables may contain Lisp expressions which are evaluated
b154df16
JB
29300to display or print the output. These variables are customizable
29301(@pxref{Customizable Variables}).
d7b8e6c6
EZ
29302
29303@kindex g x
29304@pindex calc-graph-display
29305The @kbd{g x} (@code{calc-graph-display}) command lets you specify
29306on which X window system display your graphs should be drawn. Enter
29307a blank line to see the current display name. This command has no
29308effect unless the current device is @code{x11}.
29309
29310@kindex g X
29311@pindex calc-graph-geometry
29312The @kbd{g X} (@code{calc-graph-geometry}) command is a similar
29313command for specifying the position and size of the X window.
29314The normal value is @code{default}, which generally means your
29315window manager will let you place the window interactively.
29316Entering @samp{800x500+0+0} would create an 800-by-500 pixel
29317window in the upper-left corner of the screen.
29318
29319The buffer called @samp{*Gnuplot Trail*} holds a transcript of the
29320session with GNUPLOT. This shows the commands Calc has ``typed'' to
29321GNUPLOT and the responses it has received. Calc tries to notice when an
29322error message has appeared here and display the buffer for you when
29323this happens. You can check this buffer yourself if you suspect
29324something has gone wrong.
29325
29326@kindex g C
29327@pindex calc-graph-command
29328The @kbd{g C} (@code{calc-graph-command}) command prompts you to
29329enter any line of text, then simply sends that line to the current
29330GNUPLOT process. The @samp{*Gnuplot Trail*} buffer looks deceptively
29331like a Shell buffer but you can't type commands in it yourself.
29332Instead, you must use @kbd{g C} for this purpose.
29333
29334@kindex g v
29335@kindex g V
29336@pindex calc-graph-view-commands
29337@pindex calc-graph-view-trail
29338The @kbd{g v} (@code{calc-graph-view-commands}) and @kbd{g V}
29339(@code{calc-graph-view-trail}) commands display the @samp{*Gnuplot Commands*}
29340and @samp{*Gnuplot Trail*} buffers, respectively, in another window.
29341This happens automatically when Calc thinks there is something you
29342will want to see in either of these buffers. If you type @kbd{g v}
29343or @kbd{g V} when the relevant buffer is already displayed, the
29344buffer is hidden again.
29345
29346One reason to use @kbd{g v} is to add your own commands to the
29347@samp{*Gnuplot Commands*} buffer. Press @kbd{g v}, then use
29348@kbd{C-x o} to switch into that window. For example, GNUPLOT has
29349@samp{set label} and @samp{set arrow} commands that allow you to
29350annotate your plots. Since Calc doesn't understand these commands,
29351you have to add them to the @samp{*Gnuplot Commands*} buffer
29352yourself, then use @w{@kbd{g p}} to replot using these new commands. Note
29353that your commands must appear @emph{before} the @code{plot} command.
29354To get help on any GNUPLOT feature, type, e.g., @kbd{g C help set label}.
5d67986c 29355You may have to type @kbd{g C @key{RET}} a few times to clear the
d7b8e6c6
EZ
29356``press return for more'' or ``subtopic of @dots{}'' requests.
29357Note that Calc always sends commands (like @samp{set nolabel}) to
29358reset all plotting parameters to the defaults before each plot, so
29359to delete a label all you need to do is delete the @samp{set label}
29360line you added (or comment it out with @samp{#}) and then replot
29361with @kbd{g p}.
29362
29363@kindex g q
29364@pindex calc-graph-quit
29365You can use @kbd{g q} (@code{calc-graph-quit}) to kill the GNUPLOT
29366process that is running. The next graphing command you give will
29367start a fresh GNUPLOT process. The word @samp{Graph} appears in
29368the Calc window's mode line whenever a GNUPLOT process is currently
29369running. The GNUPLOT process is automatically killed when you
29370exit Emacs if you haven't killed it manually by then.
29371
29372@kindex g K
29373@pindex calc-graph-kill
29374The @kbd{g K} (@code{calc-graph-kill}) command is like @kbd{g q}
29375except that it also views the @samp{*Gnuplot Trail*} buffer so that
29376you can see the process being killed. This is better if you are
29377killing GNUPLOT because you think it has gotten stuck.
29378
29379@node Kill and Yank, Keypad Mode, Graphics, Top
29380@chapter Kill and Yank Functions
29381
29382@noindent
29383The commands in this chapter move information between the Calculator and
29384other Emacs editing buffers.
29385
07ce2eb3 29386In many cases Embedded mode is an easier and more natural way to
d7b8e6c6
EZ
29387work with Calc from a regular editing buffer. @xref{Embedded Mode}.
29388
29389@menu
29390* Killing From Stack::
29391* Yanking Into Stack::
29392* Grabbing From Buffers::
29393* Yanking Into Buffers::
29394* X Cut and Paste::
29395@end menu
29396
29397@node Killing From Stack, Yanking Into Stack, Kill and Yank, Kill and Yank
29398@section Killing from the Stack
29399
29400@noindent
29401@kindex C-k
29402@pindex calc-kill
29403@kindex M-k
29404@pindex calc-copy-as-kill
29405@kindex C-w
29406@pindex calc-kill-region
29407@kindex M-w
29408@pindex calc-copy-region-as-kill
29409@cindex Kill ring
29410@dfn{Kill} commands are Emacs commands that insert text into the
29411``kill ring,'' from which it can later be ``yanked'' by a @kbd{C-y}
29412command. Three common kill commands in normal Emacs are @kbd{C-k}, which
29413kills one line, @kbd{C-w}, which kills the region between mark and point,
29414and @kbd{M-w}, which puts the region into the kill ring without actually
29415deleting it. All of these commands work in the Calculator, too. Also,
29416@kbd{M-k} has been provided to complete the set; it puts the current line
29417into the kill ring without deleting anything.
29418
29419The kill commands are unusual in that they pay attention to the location
29420of the cursor in the Calculator buffer. If the cursor is on or below the
29421bottom line, the kill commands operate on the top of the stack. Otherwise,
29422they operate on whatever stack element the cursor is on. Calc's kill
29423commands always operate on whole stack entries. (They act the same as their
29424standard Emacs cousins except they ``round up'' the specified region to
29425encompass full lines.) The text is copied into the kill ring exactly as
29426it appears on the screen, including line numbers if they are enabled.
29427
29428A numeric prefix argument to @kbd{C-k} or @kbd{M-k} affects the number
a4231b04
JB
29429of lines killed. A positive argument kills the current line and @expr{n-1}
29430lines below it. A negative argument kills the @expr{-n} lines above the
d7b8e6c6
EZ
29431current line. Again this mirrors the behavior of the standard Emacs
29432@kbd{C-k} command. Although a whole line is always deleted, @kbd{C-k}
29433with no argument copies only the number itself into the kill ring, whereas
29434@kbd{C-k} with a prefix argument of 1 copies the number with its trailing
29435newline.
29436
29437@node Yanking Into Stack, Grabbing From Buffers, Killing From Stack, Kill and Yank
29438@section Yanking into the Stack
29439
29440@noindent
29441@kindex C-y
29442@pindex calc-yank
29443The @kbd{C-y} command yanks the most recently killed text back into the
29444Calculator. It pushes this value onto the top of the stack regardless of
29445the cursor position. In general it re-parses the killed text as a number
29446or formula (or a list of these separated by commas or newlines). However if
29447the thing being yanked is something that was just killed from the Calculator
29448itself, its full internal structure is yanked. For example, if you have
29449set the floating-point display mode to show only four significant digits,
29450then killing and re-yanking 3.14159 (which displays as 3.142) will yank the
29451full 3.14159, even though yanking it into any other buffer would yank the
29452number in its displayed form, 3.142. (Since the default display modes
29453show all objects to their full precision, this feature normally makes no
29454difference.)
29455
29456@node Grabbing From Buffers, Yanking Into Buffers, Yanking Into Stack, Kill and Yank
29457@section Grabbing from Other Buffers
29458
29459@noindent
29460@kindex M-# g
29461@pindex calc-grab-region
29462The @kbd{M-# g} (@code{calc-grab-region}) command takes the text between
29463point and mark in the current buffer and attempts to parse it as a
29464vector of values. Basically, it wraps the text in vector brackets
29465@samp{[ ]} unless the text already is enclosed in vector brackets,
29466then reads the text as if it were an algebraic entry. The contents
29467of the vector may be numbers, formulas, or any other Calc objects.
29468If the @kbd{M-# g} command works successfully, it does an automatic
29469@kbd{M-# c} to enter the Calculator buffer.
29470
29471A numeric prefix argument grabs the specified number of lines around
29472point, ignoring the mark. A positive prefix grabs from point to the
a4231b04 29473@expr{n}th following newline (so that @kbd{M-1 M-# g} grabs from point
d7b8e6c6 29474to the end of the current line); a negative prefix grabs from point
a4231b04 29475back to the @expr{n+1}st preceding newline. In these cases the text
d7b8e6c6
EZ
29476that is grabbed is exactly the same as the text that @kbd{C-k} would
29477delete given that prefix argument.
29478
29479A prefix of zero grabs the current line; point may be anywhere on the
29480line.
29481
29482A plain @kbd{C-u} prefix interprets the region between point and mark
29483as a single number or formula rather than a vector. For example,
29484@kbd{M-# g} on the text @samp{2 a b} produces the vector of three
29485values @samp{[2, a, b]}, but @kbd{C-u M-# g} on the same region
29486reads a formula which is a product of three things: @samp{2 a b}.
29487(The text @samp{a + b}, on the other hand, will be grabbed as a
29488vector of one element by plain @kbd{M-# g} because the interpretation
29489@samp{[a, +, b]} would be a syntax error.)
29490
29491If a different language has been specified (@pxref{Language Modes}),
29492the grabbed text will be interpreted according to that language.
29493
29494@kindex M-# r
29495@pindex calc-grab-rectangle
29496The @kbd{M-# r} (@code{calc-grab-rectangle}) command takes the text between
29497point and mark and attempts to parse it as a matrix. If point and mark
29498are both in the leftmost column, the lines in between are parsed in their
29499entirety. Otherwise, point and mark define the corners of a rectangle
29500whose contents are parsed.
29501
29502Each line of the grabbed area becomes a row of the matrix. The result
29503will actually be a vector of vectors, which Calc will treat as a matrix
29504only if every row contains the same number of values.
29505
29506If a line contains a portion surrounded by square brackets (or curly
29507braces), that portion is interpreted as a vector which becomes a row
29508of the matrix. Any text surrounding the bracketed portion on the line
29509is ignored.
29510
29511Otherwise, the entire line is interpreted as a row vector as if it
29512were surrounded by square brackets. Leading line numbers (in the
29513format used in the Calc stack buffer) are ignored. If you wish to
29514force this interpretation (even if the line contains bracketed
29515portions), give a negative numeric prefix argument to the
29516@kbd{M-# r} command.
29517
29518If you give a numeric prefix argument of zero or plain @kbd{C-u}, each
29519line is instead interpreted as a single formula which is converted into
29520a one-element vector. Thus the result of @kbd{C-u M-# r} will be a
29521one-column matrix. For example, suppose one line of the data is the
29522expression @samp{2 a}. A plain @w{@kbd{M-# r}} will interpret this as
29523@samp{[2 a]}, which in turn is read as a two-element vector that forms
29524one row of the matrix. But a @kbd{C-u M-# r} will interpret this row
29525as @samp{[2*a]}.
29526
29527If you give a positive numeric prefix argument @var{n}, then each line
29528will be split up into columns of width @var{n}; each column is parsed
29529separately as a matrix element. If a line contained
29530@w{@samp{2 +/- 3 4 +/- 5}}, then grabbing with a prefix argument of 8
a4231b04 29531would correctly split the line into two error forms.
d7b8e6c6
EZ
29532
29533@xref{Matrix Functions}, to see how to pull the matrix apart into its
a4231b04 29534constituent rows and columns. (If it is a
8e04863e 29535@texline @math{1\times1}
a4231b04
JB
29536@infoline 1x1
29537matrix, just hit @kbd{v u} (@code{calc-unpack}) twice.)
d7b8e6c6
EZ
29538
29539@kindex M-# :
29540@kindex M-# _
29541@pindex calc-grab-sum-across
29542@pindex calc-grab-sum-down
29543@cindex Summing rows and columns of data
29544The @kbd{M-# :} (@code{calc-grab-sum-down}) command is a handy way to
29545grab a rectangle of data and sum its columns. It is equivalent to
29546typing @kbd{M-# r}, followed by @kbd{V R : +} (the vector reduction
29547command that sums the columns of a matrix; @pxref{Reducing}). The
29548result of the command will be a vector of numbers, one for each column
29549in the input data. The @kbd{M-# _} (@code{calc-grab-sum-across}) command
29550similarly grabs a rectangle and sums its rows by executing @w{@kbd{V R _ +}}.
29551
29552As well as being more convenient, @kbd{M-# :} and @kbd{M-# _} are also
29553much faster because they don't actually place the grabbed vector on
29554the stack. In a @kbd{M-# r V R : +} sequence, formatting the vector
29555for display on the stack takes a large fraction of the total time
29556(unless you have planned ahead and used @kbd{v .} and @kbd{t .} modes).
29557
29558For example, suppose we have a column of numbers in a file which we
29559wish to sum. Go to one corner of the column and press @kbd{C-@@} to
29560set the mark; go to the other corner and type @kbd{M-# :}. Since there
29561is only one column, the result will be a vector of one number, the sum.
29562(You can type @kbd{v u} to unpack this vector into a plain number if
29563you want to do further arithmetic with it.)
29564
29565To compute the product of the column of numbers, we would have to do
29566it ``by hand'' since there's no special grab-and-multiply command.
29567Use @kbd{M-# r} to grab the column of numbers into the calculator in
29568the form of a column matrix. The statistics command @kbd{u *} is a
29569handy way to find the product of a vector or matrix of numbers.
29570@xref{Statistical Operations}. Another approach would be to use
29571an explicit column reduction command, @kbd{V R : *}.
29572
29573@node Yanking Into Buffers, X Cut and Paste, Grabbing From Buffers, Kill and Yank
29574@section Yanking into Other Buffers
29575
29576@noindent
29577@kindex y
29578@pindex calc-copy-to-buffer
29579The plain @kbd{y} (@code{calc-copy-to-buffer}) command inserts the number
29580at the top of the stack into the most recently used normal editing buffer.
29581(More specifically, this is the most recently used buffer which is displayed
29582in a window and whose name does not begin with @samp{*}. If there is no
29583such buffer, this is the most recently used buffer except for Calculator
29584and Calc Trail buffers.) The number is inserted exactly as it appears and
29585without a newline. (If line-numbering is enabled, the line number is
29586normally not included.) The number is @emph{not} removed from the stack.
29587
29588With a prefix argument, @kbd{y} inserts several numbers, one per line.
29589A positive argument inserts the specified number of values from the top
a4231b04 29590of the stack. A negative argument inserts the @expr{n}th value from the
d7b8e6c6
EZ
29591top of the stack. An argument of zero inserts the entire stack. Note
29592that @kbd{y} with an argument of 1 is slightly different from @kbd{y}
29593with no argument; the former always copies full lines, whereas the
29594latter strips off the trailing newline.
29595
29596With a lone @kbd{C-u} as a prefix argument, @kbd{y} @emph{replaces} the
29597region in the other buffer with the yanked text, then quits the
29598Calculator, leaving you in that buffer. A typical use would be to use
29599@kbd{M-# g} to read a region of data into the Calculator, operate on the
29600data to produce a new matrix, then type @kbd{C-u y} to replace the
29601original data with the new data. One might wish to alter the matrix
29602display style (@pxref{Vector and Matrix Formats}) or change the current
29603display language (@pxref{Language Modes}) before doing this. Also, note
29604that this command replaces a linear region of text (as grabbed by
a4231b04 29605@kbd{M-# g}), not a rectangle (as grabbed by @kbd{M-# r}).
d7b8e6c6
EZ
29606
29607If the editing buffer is in overwrite (as opposed to insert) mode,
29608and the @kbd{C-u} prefix was not used, then the yanked number will
29609overwrite the characters following point rather than being inserted
29610before those characters. The usual conventions of overwrite mode
29611are observed; for example, characters will be inserted at the end of
29612a line rather than overflowing onto the next line. Yanking a multi-line
29613object such as a matrix in overwrite mode overwrites the next @var{n}
29614lines in the buffer, lengthening or shortening each line as necessary.
29615Finally, if the thing being yanked is a simple integer or floating-point
29616number (like @samp{-1.2345e-3}) and the characters following point also
29617make up such a number, then Calc will replace that number with the new
29618number, lengthening or shortening as necessary. The concept of
29619``overwrite mode'' has thus been generalized from overwriting characters
29620to overwriting one complete number with another.
29621
29622@kindex M-# y
29623The @kbd{M-# y} key sequence is equivalent to @kbd{y} except that
29624it can be typed anywhere, not just in Calc. This provides an easy
29625way to guarantee that Calc knows which editing buffer you want to use!
29626
29627@node X Cut and Paste, , Yanking Into Buffers, Kill and Yank
29628@section X Cut and Paste
29629
29630@noindent
29631If you are using Emacs with the X window system, there is an easier
29632way to move small amounts of data into and out of the calculator:
29633Use the mouse-oriented cut and paste facilities of X.
29634
29635The default bindings for a three-button mouse cause the left button
29636to move the Emacs cursor to the given place, the right button to
29637select the text between the cursor and the clicked location, and
29638the middle button to yank the selection into the buffer at the
29639clicked location. So, if you have a Calc window and an editing
29640window on your Emacs screen, you can use left-click/right-click
29641to select a number, vector, or formula from one window, then
29642middle-click to paste that value into the other window. When you
29643paste text into the Calc window, Calc interprets it as an algebraic
29644entry. It doesn't matter where you click in the Calc window; the
29645new value is always pushed onto the top of the stack.
29646
29647The @code{xterm} program that is typically used for general-purpose
29648shell windows in X interprets the mouse buttons in the same way.
29649So you can use the mouse to move data between Calc and any other
29650Unix program. One nice feature of @code{xterm} is that a double
29651left-click selects one word, and a triple left-click selects a
29652whole line. So you can usually transfer a single number into Calc
29653just by double-clicking on it in the shell, then middle-clicking
29654in the Calc window.
29655
17c5c219 29656@node Keypad Mode, Embedded Mode, Kill and Yank, Top
07ce2eb3 29657@chapter Keypad Mode
d7b8e6c6
EZ
29658
29659@noindent
29660@kindex M-# k
29661@pindex calc-keypad
29662The @kbd{M-# k} (@code{calc-keypad}) command starts the Calculator
29663and displays a picture of a calculator-style keypad. If you are using
29664the X window system, you can click on any of the ``keys'' in the
29665keypad using the left mouse button to operate the calculator.
07ce2eb3 29666The original window remains the selected window; in Keypad mode
d7b8e6c6
EZ
29667you can type in your file while simultaneously performing
29668calculations with the mouse.
29669
29670@pindex full-calc-keypad
29671If you have used @kbd{M-# b} first, @kbd{M-# k} instead invokes
29672the @code{full-calc-keypad} command, which takes over the whole
29673Emacs screen and displays the keypad, the Calc stack, and the Calc
29674trail all at once. This mode would normally be used when running
29675Calc standalone (@pxref{Standalone Operation}).
29676
29677If you aren't using the X window system, you must switch into
29678the @samp{*Calc Keypad*} window, place the cursor on the desired
29679``key,'' and type @key{SPC} or @key{RET}. If you think this
29680is easier than using Calc normally, go right ahead.
29681
07ce2eb3 29682Calc commands are more or less the same in Keypad mode. Certain
d7b8e6c6
EZ
29683keypad keys differ slightly from the corresponding normal Calc
29684keystrokes; all such deviations are described below.
29685
07ce2eb3 29686Keypad mode includes many more commands than will fit on the keypad
d7b8e6c6
EZ
29687at once. Click the right mouse button [@code{calc-keypad-menu}]
29688to switch to the next menu. The bottom five rows of the keypad
29689stay the same; the top three rows change to a new set of commands.
29690To return to earlier menus, click the middle mouse button
29691[@code{calc-keypad-menu-back}] or simply advance through the menus
29692until you wrap around. Typing @key{TAB} inside the keypad window
29693is equivalent to clicking the right mouse button there.
29694
29695You can always click the @key{EXEC} button and type any normal
29696Calc key sequence. This is equivalent to switching into the
29697Calc buffer, typing the keys, then switching back to your
29698original buffer.
29699
29700@menu
29701* Keypad Main Menu::
29702* Keypad Functions Menu::
29703* Keypad Binary Menu::
29704* Keypad Vectors Menu::
29705* Keypad Modes Menu::
29706@end menu
29707
29708@node Keypad Main Menu, Keypad Functions Menu, Keypad Mode, Keypad Mode
29709@section Main Menu
29710
d7b8e6c6 29711@smallexample
5d67986c 29712@group
17c5c219 29713|----+-----Calc 2.1------+----1
d7b8e6c6
EZ
29714|FLR |CEIL|RND |TRNC|CLN2|FLT |
29715|----+----+----+----+----+----|
29716| LN |EXP | |ABS |IDIV|MOD |
29717|----+----+----+----+----+----|
29718|SIN |COS |TAN |SQRT|y^x |1/x |
29719|----+----+----+----+----+----|
29720| ENTER |+/- |EEX |UNDO| <- |
29721|-----+---+-+--+--+-+---++----|
29722| INV | 7 | 8 | 9 | / |
29723|-----+-----+-----+-----+-----|
29724| HYP | 4 | 5 | 6 | * |
29725|-----+-----+-----+-----+-----|
29726|EXEC | 1 | 2 | 3 | - |
29727|-----+-----+-----+-----+-----|
29728| OFF | 0 | . | PI | + |
29729|-----+-----+-----+-----+-----+
d7b8e6c6 29730@end group
5d67986c 29731@end smallexample
d7b8e6c6
EZ
29732
29733@noindent
07ce2eb3 29734This is the menu that appears the first time you start Keypad mode.
d7b8e6c6
EZ
29735It will show up in a vertical window on the right side of your screen.
29736Above this menu is the traditional Calc stack display. On a 24-line
29737screen you will be able to see the top three stack entries.
29738
29739The ten digit keys, decimal point, and @key{EEX} key are used for
29740entering numbers in the obvious way. @key{EEX} begins entry of an
29741exponent in scientific notation. Just as with regular Calc, the
29742number is pushed onto the stack as soon as you press @key{ENTER}
29743or any other function key.
29744
29745The @key{+/-} key corresponds to normal Calc's @kbd{n} key. During
29746numeric entry it changes the sign of the number or of the exponent.
29747At other times it changes the sign of the number on the top of the
29748stack.
29749
29750The @key{INV} and @key{HYP} keys modify other keys. As well as
07ce2eb3 29751having the effects described elsewhere in this manual, Keypad mode
d7b8e6c6
EZ
29752defines several other ``inverse'' operations. These are described
29753below and in the following sections.
29754
29755The @key{ENTER} key finishes the current numeric entry, or otherwise
29756duplicates the top entry on the stack.
29757
29758The @key{UNDO} key undoes the most recent Calc operation.
29759@kbd{INV UNDO} is the ``redo'' command, and @kbd{HYP UNDO} is
5d67986c 29760``last arguments'' (@kbd{M-@key{RET}}).
d7b8e6c6
EZ
29761
29762The @key{<-} key acts as a ``backspace'' during numeric entry.
29763At other times it removes the top stack entry. @kbd{INV <-}
29764clears the entire stack. @kbd{HYP <-} takes an integer from
29765the stack, then removes that many additional stack elements.
29766
29767The @key{EXEC} key prompts you to enter any keystroke sequence
29768that would normally work in Calc mode. This can include a
29769numeric prefix if you wish. It is also possible simply to
29770switch into the Calc window and type commands in it; there is
07ce2eb3 29771nothing ``magic'' about this window when Keypad mode is active.
d7b8e6c6
EZ
29772
29773The other keys in this display perform their obvious calculator
29774functions. @key{CLN2} rounds the top-of-stack by temporarily
29775reducing the precision by 2 digits. @key{FLT} converts an
29776integer or fraction on the top of the stack to floating-point.
29777
29778The @key{INV} and @key{HYP} keys combined with several of these keys
29779give you access to some common functions even if the appropriate menu
29780is not displayed. Obviously you don't need to learn these keys
29781unless you find yourself wasting time switching among the menus.
29782
29783@table @kbd
29784@item INV +/-
29785is the same as @key{1/x}.
29786@item INV +
29787is the same as @key{SQRT}.
29788@item INV -
29789is the same as @key{CONJ}.
29790@item INV *
29791is the same as @key{y^x}.
29792@item INV /
a4231b04 29793is the same as @key{INV y^x} (the @expr{x}th root of @expr{y}).
d7b8e6c6
EZ
29794@item HYP/INV 1
29795are the same as @key{SIN} / @kbd{INV SIN}.
29796@item HYP/INV 2
29797are the same as @key{COS} / @kbd{INV COS}.
29798@item HYP/INV 3
29799are the same as @key{TAN} / @kbd{INV TAN}.
29800@item INV/HYP 4
29801are the same as @key{LN} / @kbd{HYP LN}.
29802@item INV/HYP 5
29803are the same as @key{EXP} / @kbd{HYP EXP}.
29804@item INV 6
29805is the same as @key{ABS}.
29806@item INV 7
29807is the same as @key{RND} (@code{calc-round}).
29808@item INV 8
29809is the same as @key{CLN2}.
29810@item INV 9
29811is the same as @key{FLT} (@code{calc-float}).
29812@item INV 0
29813is the same as @key{IMAG}.
29814@item INV .
29815is the same as @key{PREC}.
29816@item INV ENTER
29817is the same as @key{SWAP}.
29818@item HYP ENTER
29819is the same as @key{RLL3}.
29820@item INV HYP ENTER
29821is the same as @key{OVER}.
29822@item HYP +/-
29823packs the top two stack entries as an error form.
29824@item HYP EEX
29825packs the top two stack entries as a modulo form.
29826@item INV EEX
29827creates an interval form; this removes an integer which is one
29828of 0 @samp{[]}, 1 @samp{[)}, 2 @samp{(]} or 3 @samp{()}, followed
29829by the two limits of the interval.
29830@end table
29831
29832The @kbd{OFF} key turns Calc off; typing @kbd{M-# k} or @kbd{M-# M-#}
29833again has the same effect. This is analogous to typing @kbd{q} or
29834hitting @kbd{M-# c} again in the normal calculator. If Calc is
29835running standalone (the @code{full-calc-keypad} command appeared in the
29836command line that started Emacs), then @kbd{OFF} is replaced with
29837@kbd{EXIT}; clicking on this actually exits Emacs itself.
29838
29839@node Keypad Functions Menu, Keypad Binary Menu, Keypad Main Menu, Keypad Mode
29840@section Functions Menu
29841
d7b8e6c6 29842@smallexample
5d67986c 29843@group
d7b8e6c6
EZ
29844|----+----+----+----+----+----2
29845|IGAM|BETA|IBET|ERF |BESJ|BESY|
29846|----+----+----+----+----+----|
29847|IMAG|CONJ| RE |ATN2|RAND|RAGN|
29848|----+----+----+----+----+----|
29849|GCD |FACT|DFCT|BNOM|PERM|NXTP|
29850|----+----+----+----+----+----|
d7b8e6c6 29851@end group
5d67986c 29852@end smallexample
d7b8e6c6
EZ
29853
29854@noindent
29855This menu provides various operations from the @kbd{f} and @kbd{k}
29856prefix keys.
29857
29858@key{IMAG} multiplies the number on the stack by the imaginary
a4231b04 29859number @expr{i = (0, 1)}.
d7b8e6c6
EZ
29860
29861@key{RE} extracts the real part a complex number. @kbd{INV RE}
29862extracts the imaginary part.
29863
29864@key{RAND} takes a number from the top of the stack and computes
29865a random number greater than or equal to zero but less than that
29866number. (@xref{Random Numbers}.) @key{RAGN} is the ``random
29867again'' command; it computes another random number using the
29868same limit as last time.
29869
29870@key{INV GCD} computes the LCM (least common multiple) function.
29871
a4231b04 29872@key{INV FACT} is the gamma function.
8e04863e 29873@texline @math{\Gamma(x) = (x-1)!}.
a4231b04 29874@infoline @expr{gamma(x) = (x-1)!}.
d7b8e6c6
EZ
29875
29876@key{PERM} is the number-of-permutations function, which is on the
29877@kbd{H k c} key in normal Calc.
29878
29879@key{NXTP} finds the next prime after a number. @kbd{INV NXTP}
29880finds the previous prime.
29881
29882@node Keypad Binary Menu, Keypad Vectors Menu, Keypad Functions Menu, Keypad Mode
29883@section Binary Menu
29884
d7b8e6c6 29885@smallexample
5d67986c 29886@group
d7b8e6c6
EZ
29887|----+----+----+----+----+----3
29888|AND | OR |XOR |NOT |LSH |RSH |
29889|----+----+----+----+----+----|
29890|DEC |HEX |OCT |BIN |WSIZ|ARSH|
29891|----+----+----+----+----+----|
29892| A | B | C | D | E | F |
29893|----+----+----+----+----+----|
d7b8e6c6 29894@end group
5d67986c 29895@end smallexample
d7b8e6c6
EZ
29896
29897@noindent
29898The keys in this menu perform operations on binary integers.
29899Note that both logical and arithmetic right-shifts are provided.
29900@key{INV LSH} rotates one bit to the left.
29901
29902The ``difference'' function (normally on @kbd{b d}) is on @key{INV AND}.
29903The ``clip'' function (normally on @w{@kbd{b c}}) is on @key{INV NOT}.
29904
29905The @key{DEC}, @key{HEX}, @key{OCT}, and @key{BIN} keys select the
29906current radix for display and entry of numbers: Decimal, hexadecimal,
29907octal, or binary. The six letter keys @key{A} through @key{F} are used
29908for entering hexadecimal numbers.
29909
29910The @key{WSIZ} key displays the current word size for binary operations
29911and allows you to enter a new word size. You can respond to the prompt
29912using either the keyboard or the digits and @key{ENTER} from the keypad.
29913The initial word size is 32 bits.
29914
29915@node Keypad Vectors Menu, Keypad Modes Menu, Keypad Binary Menu, Keypad Mode
29916@section Vectors Menu
29917
d7b8e6c6 29918@smallexample
5d67986c 29919@group
d7b8e6c6
EZ
29920|----+----+----+----+----+----4
29921|SUM |PROD|MAX |MAP*|MAP^|MAP$|
29922|----+----+----+----+----+----|
29923|MINV|MDET|MTRN|IDNT|CRSS|"x" |
29924|----+----+----+----+----+----|
29925|PACK|UNPK|INDX|BLD |LEN |... |
29926|----+----+----+----+----+----|
d7b8e6c6 29927@end group
5d67986c 29928@end smallexample
d7b8e6c6
EZ
29929
29930@noindent
29931The keys in this menu operate on vectors and matrices.
29932
29933@key{PACK} removes an integer @var{n} from the top of the stack;
29934the next @var{n} stack elements are removed and packed into a vector,
29935which is replaced onto the stack. Thus the sequence
29936@kbd{1 ENTER 3 ENTER 5 ENTER 3 PACK} enters the vector
29937@samp{[1, 3, 5]} onto the stack. To enter a matrix, build each row
29938on the stack as a vector, then use a final @key{PACK} to collect the
29939rows into a matrix.
29940
29941@key{UNPK} unpacks the vector on the stack, pushing each of its
29942components separately.
29943
29944@key{INDX} removes an integer @var{n}, then builds a vector of
29945integers from 1 to @var{n}. @kbd{INV INDX} takes three numbers
29946from the stack: The vector size @var{n}, the starting number,
29947and the increment. @kbd{BLD} takes an integer @var{n} and any
29948value @var{x} and builds a vector of @var{n} copies of @var{x}.
29949
29950@key{IDNT} removes an integer @var{n}, then builds an @var{n}-by-@var{n}
29951identity matrix.
29952
29953@key{LEN} replaces a vector by its length, an integer.
29954
29955@key{...} turns on or off ``abbreviated'' display mode for large vectors.
29956
29957@key{MINV}, @key{MDET}, @key{MTRN}, and @key{CROSS} are the matrix
29958inverse, determinant, and transpose, and vector cross product.
29959
29960@key{SUM} replaces a vector by the sum of its elements. It is
29961equivalent to @kbd{u +} in normal Calc (@pxref{Statistical Operations}).
29962@key{PROD} computes the product of the elements of a vector, and
29963@key{MAX} computes the maximum of all the elements of a vector.
29964
29965@key{INV SUM} computes the alternating sum of the first element
29966minus the second, plus the third, minus the fourth, and so on.
29967@key{INV MAX} computes the minimum of the vector elements.
29968
29969@key{HYP SUM} computes the mean of the vector elements.
29970@key{HYP PROD} computes the sample standard deviation.
29971@key{HYP MAX} computes the median.
29972
29973@key{MAP*} multiplies two vectors elementwise. It is equivalent
29974to the @kbd{V M *} command. @key{MAP^} computes powers elementwise.
29975The arguments must be vectors of equal length, or one must be a vector
29976and the other must be a plain number. For example, @kbd{2 MAP^} squares
29977all the elements of a vector.
29978
29979@key{MAP$} maps the formula on the top of the stack across the
29980vector in the second-to-top position. If the formula contains
29981several variables, Calc takes that many vectors starting at the
29982second-to-top position and matches them to the variables in
29983alphabetical order. The result is a vector of the same size as
29984the input vectors, whose elements are the formula evaluated with
29985the variables set to the various sets of numbers in those vectors.
29986For example, you could simulate @key{MAP^} using @key{MAP$} with
29987the formula @samp{x^y}.
29988
a4231b04
JB
29989The @kbd{"x"} key pushes the variable name @expr{x} onto the
29990stack. To build the formula @expr{x^2 + 6}, you would use the
d7b8e6c6
EZ
29991key sequence @kbd{"x" 2 y^x 6 +}. This formula would then be
29992suitable for use with the @key{MAP$} key described above.
29993With @key{INV}, @key{HYP}, or @key{INV} and @key{HYP}, the
a4231b04
JB
29994@kbd{"x"} key pushes the variable names @expr{y}, @expr{z}, and
29995@expr{t}, respectively.
d7b8e6c6
EZ
29996
29997@node Keypad Modes Menu, , Keypad Vectors Menu, Keypad Mode
29998@section Modes Menu
29999
d7b8e6c6 30000@smallexample
5d67986c 30001@group
d7b8e6c6
EZ
30002|----+----+----+----+----+----5
30003|FLT |FIX |SCI |ENG |GRP | |
30004|----+----+----+----+----+----|
30005|RAD |DEG |FRAC|POLR|SYMB|PREC|
30006|----+----+----+----+----+----|
30007|SWAP|RLL3|RLL4|OVER|STO |RCL |
30008|----+----+----+----+----+----|
d7b8e6c6 30009@end group
5d67986c 30010@end smallexample
d7b8e6c6
EZ
30011
30012@noindent
30013The keys in this menu manipulate modes, variables, and the stack.
30014
30015The @key{FLT}, @key{FIX}, @key{SCI}, and @key{ENG} keys select
30016floating-point, fixed-point, scientific, or engineering notation.
30017@key{FIX} displays two digits after the decimal by default; the
30018others display full precision. With the @key{INV} prefix, these
30019keys pop a number-of-digits argument from the stack.
30020
30021The @key{GRP} key turns grouping of digits with commas on or off.
30022@kbd{INV GRP} enables grouping to the right of the decimal point as
30023well as to the left.
30024
30025The @key{RAD} and @key{DEG} keys switch between radians and degrees
30026for trigonometric functions.
30027
30028The @key{FRAC} key turns Fraction mode on or off. This affects
30029whether commands like @kbd{/} with integer arguments produce
30030fractional or floating-point results.
30031
30032The @key{POLR} key turns Polar mode on or off, determining whether
30033polar or rectangular complex numbers are used by default.
30034
30035The @key{SYMB} key turns Symbolic mode on or off, in which
30036operations that would produce inexact floating-point results
30037are left unevaluated as algebraic formulas.
30038
30039The @key{PREC} key selects the current precision. Answer with
30040the keyboard or with the keypad digit and @key{ENTER} keys.
30041
30042The @key{SWAP} key exchanges the top two stack elements.
30043The @key{RLL3} key rotates the top three stack elements upwards.
30044The @key{RLL4} key rotates the top four stack elements upwards.
30045The @key{OVER} key duplicates the second-to-top stack element.
30046
30047The @key{STO} and @key{RCL} keys are analogous to @kbd{s t} and
30048@kbd{s r} in regular Calc. @xref{Store and Recall}. Click the
30049@key{STO} or @key{RCL} key, then one of the ten digits. (Named
07ce2eb3 30050variables are not available in Keypad mode.) You can also use,
d7b8e6c6
EZ
30051for example, @kbd{STO + 3} to add to register 3.
30052
30053@node Embedded Mode, Programming, Keypad Mode, Top
30054@chapter Embedded Mode
30055
30056@noindent
07ce2eb3 30057Embedded mode in Calc provides an alternative to copying numbers
d7b8e6c6 30058and formulas back and forth between editing buffers and the Calc
07ce2eb3 30059stack. In Embedded mode, your editing buffer becomes temporarily
d7b8e6c6
EZ
30060linked to the stack and this copying is taken care of automatically.
30061
30062@menu
30063* Basic Embedded Mode::
30064* More About Embedded Mode::
30065* Assignments in Embedded Mode::
30066* Mode Settings in Embedded Mode::
30067* Customizing Embedded Mode::
30068@end menu
30069
30070@node Basic Embedded Mode, More About Embedded Mode, Embedded Mode, Embedded Mode
30071@section Basic Embedded Mode
30072
30073@noindent
30074@kindex M-# e
30075@pindex calc-embedded
30076To enter Embedded mode, position the Emacs point (cursor) on a
30077formula in any buffer and press @kbd{M-# e} (@code{calc-embedded}).
30078Note that @kbd{M-# e} is not to be used in the Calc stack buffer
30079like most Calc commands, but rather in regular editing buffers that
30080are visiting your own files.
30081
1dddb589
JB
30082Calc will try to guess an appropriate language based on the major mode
30083of the editing buffer. (@xref{Language Modes}.) If the current buffer is
30084in @code{latex-mode}, for example, Calc will set its language to La@TeX{}.
30085Similarly, Calc will use @TeX{} language for @code{tex-mode},
30086@code{plain-tex-mode} and @code{context-mode}, C language for
30087@code{c-mode} and @code{c++-mode}, FORTRAN language for
30088@code{fortran-mode} and @code{f90-mode}, Pascal for @code{pascal-mode},
b154df16
JB
30089and eqn for @code{nroff-mode} (@pxref{Customizable Variables}).
30090These can be overridden with Calc's mode
1dddb589
JB
30091changing commands (@pxref{Mode Settings in Embedded Mode}). If no
30092suitable language is available, Calc will continue with its current language.
30093
d7b8e6c6
EZ
30094Calc normally scans backward and forward in the buffer for the
30095nearest opening and closing @dfn{formula delimiters}. The simplest
07ce2eb3 30096delimiters are blank lines. Other delimiters that Embedded mode
d7b8e6c6
EZ
30097understands are:
30098
30099@enumerate
30100@item
30101The @TeX{} and La@TeX{} math delimiters @samp{$ $}, @samp{$$ $$},
30102@samp{\[ \]}, and @samp{\( \)};
30103@item
8ed713c6 30104Lines beginning with @samp{\begin} and @samp{\end} (except matrix delimiters);
d7b8e6c6
EZ
30105@item
30106Lines beginning with @samp{@@} (Texinfo delimiters).
30107@item
30108Lines beginning with @samp{.EQ} and @samp{.EN} (@dfn{eqn} delimiters);
30109@item
30110Lines containing a single @samp{%} or @samp{.\"} symbol and nothing else.
30111@end enumerate
30112
30113@xref{Customizing Embedded Mode}, to see how to make Calc recognize
30114your own favorite delimiters. Delimiters like @samp{$ $} can appear
30115on their own separate lines or in-line with the formula.
30116
30117If you give a positive or negative numeric prefix argument, Calc
f16fc7f9
JB
30118instead uses the current point as one end of the formula, and includes
30119that many lines forward or backward (respectively, including the current
30120line). Explicit delimiters are not necessary in this case.
d7b8e6c6 30121
2be7b183
JB
30122With a prefix argument of zero, Calc uses the current region (delimited
30123by point and mark) instead of formula delimiters. With a prefix
30124argument of @kbd{C-u} only, Calc uses the current line as the formula.
d7b8e6c6
EZ
30125
30126@kindex M-# w
30127@pindex calc-embedded-word
2be7b183
JB
30128The @kbd{M-# w} (@code{calc-embedded-word}) command will start Embedded
30129mode on the current ``word''; in this case Calc will scan for the first
30130non-numeric character (i.e., the first character that is not a digit,
30131sign, decimal point, or upper- or lower-case @samp{e}) forward and
30132backward to delimit the formula.
d7b8e6c6
EZ
30133
30134When you enable Embedded mode for a formula, Calc reads the text
30135between the delimiters and tries to interpret it as a Calc formula.
1dddb589 30136Calc can generally identify @TeX{} formulas and
d7b8e6c6
EZ
30137Big-style formulas even if the language mode is wrong. If Calc
30138can't make sense of the formula, it beeps and refuses to enter
30139Embedded mode. But if the current language is wrong, Calc can
30140sometimes parse the formula successfully (but incorrectly);
30141for example, the C expression @samp{atan(a[1])} can be parsed
30142in Normal language mode, but the @code{atan} won't correspond to
30143the built-in @code{arctan} function, and the @samp{a[1]} will be
30144interpreted as @samp{a} times the vector @samp{[1]}!
30145
30146If you press @kbd{M-# e} or @kbd{M-# w} to activate an embedded
30147formula which is blank, say with the cursor on the space between
30148the two delimiters @samp{$ $}, Calc will immediately prompt for
30149an algebraic entry.
30150
30151Only one formula in one buffer can be enabled at a time. If you
30152move to another area of the current buffer and give Calc commands,
30153Calc turns Embedded mode off for the old formula and then tries
30154to restart Embedded mode at the new position. Other buffers are
30155not affected by Embedded mode.
30156
30157When Embedded mode begins, Calc pushes the current formula onto
30158the stack. No Calc stack window is created; however, Calc copies
30159the top-of-stack position into the original buffer at all times.
30160You can create a Calc window by hand with @kbd{M-# o} if you
30161find you need to see the entire stack.
30162
30163For example, typing @kbd{M-# e} while somewhere in the formula
30164@samp{n>2} in the following line enables Embedded mode on that
30165inequality:
30166
30167@example
30168We define $F_n = F_(n-1)+F_(n-2)$ for all $n>2$.
30169@end example
30170
30171@noindent
a4231b04 30172The formula @expr{n>2} will be pushed onto the Calc stack, and
d7b8e6c6
EZ
30173the top of stack will be copied back into the editing buffer.
30174This means that spaces will appear around the @samp{>} symbol
30175to match Calc's usual display style:
30176
30177@example
30178We define $F_n = F_(n-1)+F_(n-2)$ for all $n > 2$.
30179@end example
30180
30181@noindent
30182No spaces have appeared around the @samp{+} sign because it's
30183in a different formula, one which we have not yet touched with
30184Embedded mode.
30185
30186Now that Embedded mode is enabled, keys you type in this buffer
30187are interpreted as Calc commands. At this point we might use
30188the ``commute'' command @kbd{j C} to reverse the inequality.
30189This is a selection-based command for which we first need to
30190move the cursor onto the operator (@samp{>} in this case) that
30191needs to be commuted.
30192
30193@example
30194We define $F_n = F_(n-1)+F_(n-2)$ for all $2 < n$.
30195@end example
30196
30197The @kbd{M-# o} command is a useful way to open a Calc window
30198without actually selecting that window. Giving this command
30199verifies that @samp{2 < n} is also on the Calc stack. Typing
5d67986c 30200@kbd{17 @key{RET}} would produce:
d7b8e6c6
EZ
30201
30202@example
30203We define $F_n = F_(n-1)+F_(n-2)$ for all $17$.
30204@end example
30205
30206@noindent
30207with @samp{2 < n} and @samp{17} on the stack; typing @key{TAB}
30208at this point will exchange the two stack values and restore
30209@samp{2 < n} to the embedded formula. Even though you can't
30210normally see the stack in Embedded mode, it is still there and
30211it still operates in the same way. But, as with old-fashioned
30212RPN calculators, you can only see the value at the top of the
30213stack at any given time (unless you use @kbd{M-# o}).
30214
30215Typing @kbd{M-# e} again turns Embedded mode off. The Calc
30216window reveals that the formula @w{@samp{2 < n}} is automatically
30217removed from the stack, but the @samp{17} is not. Entering
30218Embedded mode always pushes one thing onto the stack, and
30219leaving Embedded mode always removes one thing. Anything else
30220that happens on the stack is entirely your business as far as
30221Embedded mode is concerned.
30222
30223If you press @kbd{M-# e} in the wrong place by accident, it is
30224possible that Calc will be able to parse the nearby text as a
30225formula and will mangle that text in an attempt to redisplay it
30226``properly'' in the current language mode. If this happens,
30227press @kbd{M-# e} again to exit Embedded mode, then give the
30228regular Emacs ``undo'' command (@kbd{C-_} or @kbd{C-x u}) to put
30229the text back the way it was before Calc edited it. Note that Calc's
30230own Undo command (typed before you turn Embedded mode back off)
30231will not do you any good, because as far as Calc is concerned
30232you haven't done anything with this formula yet.
30233
30234@node More About Embedded Mode, Assignments in Embedded Mode, Basic Embedded Mode, Embedded Mode
30235@section More About Embedded Mode
30236
30237@noindent
30238When Embedded mode ``activates'' a formula, i.e., when it examines
30239the formula for the first time since the buffer was created or
30240loaded, Calc tries to sense the language in which the formula was
053bc283
JB
30241written. If the formula contains any La@TeX{}-like @samp{\} sequences,
30242it is parsed (i.e., read) in La@TeX{} mode. If the formula appears to
d7b8e6c6
EZ
30243be written in multi-line Big mode, it is parsed in Big mode. Otherwise,
30244it is parsed according to the current language mode.
30245
30246Note that Calc does not change the current language mode according
1dddb589 30247the formula it reads in. Even though it can read a La@TeX{} formula when
053bc283 30248not in La@TeX{} mode, it will immediately rewrite this formula using
1dddb589 30249whatever language mode is in effect.
d7b8e6c6
EZ
30250
30251@tex
30252\bigskip
30253@end tex
30254
30255@kindex d p
30256@pindex calc-show-plain
30257Calc's parser is unable to read certain kinds of formulas. For
30258example, with @kbd{v ]} (@code{calc-matrix-brackets}) you can
30259specify matrix display styles which the parser is unable to
30260recognize as matrices. The @kbd{d p} (@code{calc-show-plain})
30261command turns on a mode in which a ``plain'' version of a
30262formula is placed in front of the fully-formatted version.
30263When Calc reads a formula that has such a plain version in
30264front, it reads the plain version and ignores the formatted
30265version.
30266
30267Plain formulas are preceded and followed by @samp{%%%} signs
30268by default. This notation has the advantage that the @samp{%}
053bc283
JB
30269character begins a comment in @TeX{} and La@TeX{}, so if your formula is
30270embedded in a @TeX{} or La@TeX{} document its plain version will be
d7b8e6c6
EZ
30271invisible in the final printed copy. @xref{Customizing
30272Embedded Mode}, to see how to change the ``plain'' formula
30273delimiters, say to something that @dfn{eqn} or some other
30274formatter will treat as a comment.
30275
30276There are several notations which Calc's parser for ``big''
30277formatted formulas can't yet recognize. In particular, it can't
30278read the large symbols for @code{sum}, @code{prod}, and @code{integ},
30279and it can't handle @samp{=>} with the righthand argument omitted.
30280Also, Calc won't recognize special formats you have defined with
30281the @kbd{Z C} command (@pxref{User-Defined Compositions}). In
30282these cases it is important to use ``plain'' mode to make sure
30283Calc will be able to read your formula later.
30284
30285Another example where ``plain'' mode is important is if you have
30286specified a float mode with few digits of precision. Normally
30287any digits that are computed but not displayed will simply be
30288lost when you save and re-load your embedded buffer, but ``plain''
30289mode allows you to make sure that the complete number is present
30290in the file as well as the rounded-down number.
30291
30292@tex
30293\bigskip
30294@end tex
30295
30296Embedded buffers remember active formulas for as long as they
30297exist in Emacs memory. Suppose you have an embedded formula
a4231b04 30298which is @cpi{} to the normal 12 decimal places, and then
d7b8e6c6
EZ
30299type @w{@kbd{C-u 5 d n}} to display only five decimal places.
30300If you then type @kbd{d n}, all 12 places reappear because the
30301full number is still there on the Calc stack. More surprisingly,
30302even if you exit Embedded mode and later re-enter it for that
30303formula, typing @kbd{d n} will restore all 12 places because
30304each buffer remembers all its active formulas. However, if you
30305save the buffer in a file and reload it in a new Emacs session,
30306all non-displayed digits will have been lost unless you used
30307``plain'' mode.
30308
30309@tex
30310\bigskip
30311@end tex
30312
30313In some applications of Embedded mode, you will want to have a
30314sequence of copies of a formula that show its evolution as you
30315work on it. For example, you might want to have a sequence
30316like this in your file (elaborating here on the example from
30317the ``Getting Started'' chapter):
30318
30319@smallexample
30320The derivative of
30321
30322 ln(ln(x))
30323
30324is
30325
30326 @r{(the derivative of }ln(ln(x))@r{)}
30327
30328whose value at x = 2 is
30329
30330 @r{(the value)}
30331
30332and at x = 3 is
30333
30334 @r{(the value)}
30335@end smallexample
30336
30337@kindex M-# d
30338@pindex calc-embedded-duplicate
30339The @kbd{M-# d} (@code{calc-embedded-duplicate}) command is a
30340handy way to make sequences like this. If you type @kbd{M-# d},
30341the formula under the cursor (which may or may not have Embedded
30342mode enabled for it at the time) is copied immediately below and
30343Embedded mode is then enabled for that copy.
30344
30345For this example, you would start with just
30346
30347@smallexample
30348The derivative of
30349
30350 ln(ln(x))
30351@end smallexample
30352
30353@noindent
30354and press @kbd{M-# d} with the cursor on this formula. The result
30355is
30356
30357@smallexample
30358The derivative of
30359
30360 ln(ln(x))
30361
30362
30363 ln(ln(x))
30364@end smallexample
30365
30366@noindent
30367with the second copy of the formula enabled in Embedded mode.
5d67986c 30368You can now press @kbd{a d x @key{RET}} to take the derivative, and
d7b8e6c6 30369@kbd{M-# d M-# d} to make two more copies of the derivative.
5d67986c 30370To complete the computations, type @kbd{3 s l x @key{RET}} to evaluate
d7b8e6c6 30371the last formula, then move up to the second-to-last formula
5d67986c 30372and type @kbd{2 s l x @key{RET}}.
d7b8e6c6
EZ
30373
30374Finally, you would want to press @kbd{M-# e} to exit Embedded
30375mode, then go up and insert the necessary text in between the
30376various formulas and numbers.
30377
30378@tex
30379\bigskip
30380@end tex
30381
30382@kindex M-# f
30383@kindex M-# '
30384@pindex calc-embedded-new-formula
30385The @kbd{M-# f} (@code{calc-embedded-new-formula}) command
30386creates a new embedded formula at the current point. It inserts
30387some default delimiters, which are usually just blank lines,
30388and then does an algebraic entry to get the formula (which is
30389then enabled for Embedded mode). This is just shorthand for
30390typing the delimiters yourself, positioning the cursor between
30391the new delimiters, and pressing @kbd{M-# e}. The key sequence
30392@kbd{M-# '} is equivalent to @kbd{M-# f}.
30393
30394@kindex M-# n
30395@kindex M-# p
30396@pindex calc-embedded-next
30397@pindex calc-embedded-previous
30398The @kbd{M-# n} (@code{calc-embedded-next}) and @kbd{M-# p}
30399(@code{calc-embedded-previous}) commands move the cursor to the
30400next or previous active embedded formula in the buffer. They
30401can take positive or negative prefix arguments to move by several
30402formulas. Note that these commands do not actually examine the
30403text of the buffer looking for formulas; they only see formulas
30404which have previously been activated in Embedded mode. In fact,
30405@kbd{M-# n} and @kbd{M-# p} are a useful way to tell which
30406embedded formulas are currently active. Also, note that these
30407commands do not enable Embedded mode on the next or previous
30408formula, they just move the cursor. (By the way, @kbd{M-# n} is
30409not as awkward to type as it may seem, because @kbd{M-#} ignores
30410Shift and Meta on the second keystroke: @kbd{M-# M-N} can be typed
30411by holding down Shift and Meta and alternately typing two keys.)
30412
30413@kindex M-# `
30414@pindex calc-embedded-edit
30415The @kbd{M-# `} (@code{calc-embedded-edit}) command edits the
30416embedded formula at the current point as if by @kbd{`} (@code{calc-edit}).
30417Embedded mode does not have to be enabled for this to work. Press
33108698 30418@kbd{C-c C-c} to finish the edit, or @kbd{C-x k} to cancel.
d7b8e6c6
EZ
30419
30420@node Assignments in Embedded Mode, Mode Settings in Embedded Mode, More About Embedded Mode, Embedded Mode
30421@section Assignments in Embedded Mode
30422
30423@noindent
30424The @samp{:=} (assignment) and @samp{=>} (``evaluates-to'') operators
30425are especially useful in Embedded mode. They allow you to make
30426a definition in one formula, then refer to that definition in
30427other formulas embedded in the same buffer.
30428
30429An embedded formula which is an assignment to a variable, as in
30430
30431@example
30432foo := 5
30433@end example
30434
30435@noindent
a4231b04 30436records @expr{5} as the stored value of @code{foo} for the
d7b8e6c6 30437purposes of Embedded mode operations in the current buffer. It
a4231b04 30438does @emph{not} actually store @expr{5} as the ``global'' value
d7b8e6c6
EZ
30439of @code{foo}, however. Regular Calc operations, and Embedded
30440formulas in other buffers, will not see this assignment.
30441
30442One way to use this assigned value is simply to create an
30443Embedded formula elsewhere that refers to @code{foo}, and to press
30444@kbd{=} in that formula. However, this permanently replaces the
30445@code{foo} in the formula with its current value. More interesting
30446is to use @samp{=>} elsewhere:
30447
30448@example
30449foo + 7 => 12
30450@end example
30451
30452@xref{Evaluates-To Operator}, for a general discussion of @samp{=>}.
30453
30454If you move back and change the assignment to @code{foo}, any
30455@samp{=>} formulas which refer to it are automatically updated.
30456
30457@example
30458foo := 17
30459
30460foo + 7 => 24
30461@end example
30462
30463The obvious question then is, @emph{how} can one easily change the
30464assignment to @code{foo}? If you simply select the formula in
30465Embedded mode and type 17, the assignment itself will be replaced
30466by the 17. The effect on the other formula will be that the
30467variable @code{foo} becomes unassigned:
30468
30469@example
3047017
30471
30472foo + 7 => foo + 7
30473@end example
30474
30475The right thing to do is first to use a selection command (@kbd{j 2}
30476will do the trick) to select the righthand side of the assignment.
5d67986c 30477Then, @kbd{17 @key{TAB} @key{DEL}} will swap the 17 into place (@pxref{Selecting
d7b8e6c6
EZ
30478Subformulas}, to see how this works).
30479
30480@kindex M-# j
30481@pindex calc-embedded-select
30482The @kbd{M-# j} (@code{calc-embedded-select}) command provides an
28665d46 30483easy way to operate on assignments. It is just like @kbd{M-# e},
d7b8e6c6
EZ
30484except that if the enabled formula is an assignment, it uses
30485@kbd{j 2} to select the righthand side. If the enabled formula
30486is an evaluates-to, it uses @kbd{j 1} to select the lefthand side.
30487A formula can also be a combination of both:
30488
30489@example
30490bar := foo + 3 => 20
30491@end example
30492
30493@noindent
30494in which case @kbd{M-# j} will select the middle part (@samp{foo + 3}).
30495
30496The formula is automatically deselected when you leave Embedded
30497mode.
30498
30499@kindex M-# u
30500@kindex M-# =
909bd0ca 30501@pindex calc-embedded-update-formula
d7b8e6c6
EZ
30502Another way to change the assignment to @code{foo} would simply be
30503to edit the number using regular Emacs editing rather than Embedded
30504mode. Then, we have to find a way to get Embedded mode to notice
30505the change. The @kbd{M-# u} or @kbd{M-# =}
30506(@code{calc-embedded-update-formula}) command is a convenient way
a4231b04 30507to do this.
d7b8e6c6
EZ
30508
30509@example
30510foo := 6
30511
30512foo + 7 => 13
30513@end example
30514
30515Pressing @kbd{M-# u} is much like pressing @kbd{M-# e = M-# e}, that
30516is, temporarily enabling Embedded mode for the formula under the
30517cursor and then evaluating it with @kbd{=}. But @kbd{M-# u} does
30518not actually use @kbd{M-# e}, and in fact another formula somewhere
30519else can be enabled in Embedded mode while you use @kbd{M-# u} and
30520that formula will not be disturbed.
30521
30522With a numeric prefix argument, @kbd{M-# u} updates all active
30523@samp{=>} formulas in the buffer. Formulas which have not yet
30524been activated in Embedded mode, and formulas which do not have
30525@samp{=>} as their top-level operator, are not affected by this.
30526(This is useful only if you have used @kbd{m C}; see below.)
30527
30528With a plain @kbd{C-u} prefix, @kbd{C-u M-# u} updates only in the
30529region between mark and point rather than in the whole buffer.
30530
30531@kbd{M-# u} is also a handy way to activate a formula, such as an
30532@samp{=>} formula that has freshly been typed in or loaded from a
30533file.
30534
30535@kindex M-# a
30536@pindex calc-embedded-activate
30537The @kbd{M-# a} (@code{calc-embedded-activate}) command scans
30538through the current buffer and activates all embedded formulas
30539that contain @samp{:=} or @samp{=>} symbols. This does not mean
30540that Embedded mode is actually turned on, but only that the
30541formulas' positions are registered with Embedded mode so that
30542the @samp{=>} values can be properly updated as assignments are
30543changed.
30544
30545It is a good idea to type @kbd{M-# a} right after loading a file
30546that uses embedded @samp{=>} operators. Emacs includes a nifty
30547``buffer-local variables'' feature that you can use to do this
30548automatically. The idea is to place near the end of your file
30549a few lines that look like this:
30550
30551@example
30552--- Local Variables: ---
30553--- eval:(calc-embedded-activate) ---
30554--- End: ---
30555@end example
30556
30557@noindent
30558where the leading and trailing @samp{---} can be replaced by
30559any suitable strings (which must be the same on all three lines)
053bc283 30560or omitted altogether; in a @TeX{} or La@TeX{} file, @samp{%} would be a good
d7b8e6c6
EZ
30561leading string and no trailing string would be necessary. In a
30562C program, @samp{/*} and @samp{*/} would be good leading and
30563trailing strings.
30564
30565When Emacs loads a file into memory, it checks for a Local Variables
30566section like this one at the end of the file. If it finds this
30567section, it does the specified things (in this case, running
30568@kbd{M-# a} automatically) before editing of the file begins.
30569The Local Variables section must be within 3000 characters of the
30570end of the file for Emacs to find it, and it must be in the last
30571page of the file if the file has any page separators.
30572@xref{File Variables, , Local Variables in Files, emacs, the
30573Emacs manual}.
30574
30575Note that @kbd{M-# a} does not update the formulas it finds.
30576To do this, type, say, @kbd{M-1 M-# u} after @w{@kbd{M-# a}}.
30577Generally this should not be a problem, though, because the
30578formulas will have been up-to-date already when the file was
30579saved.
30580
30581Normally, @kbd{M-# a} activates all the formulas it finds, but
30582any previous active formulas remain active as well. With a
30583positive numeric prefix argument, @kbd{M-# a} first deactivates
30584all current active formulas, then actives the ones it finds in
30585its scan of the buffer. With a negative prefix argument,
30586@kbd{M-# a} simply deactivates all formulas.
30587
30588Embedded mode has two symbols, @samp{Active} and @samp{~Active},
30589which it puts next to the major mode name in a buffer's mode line.
30590It puts @samp{Active} if it has reason to believe that all
30591formulas in the buffer are active, because you have typed @kbd{M-# a}
30592and Calc has not since had to deactivate any formulas (which can
30593happen if Calc goes to update an @samp{=>} formula somewhere because
30594a variable changed, and finds that the formula is no longer there
30595due to some kind of editing outside of Embedded mode). Calc puts
30596@samp{~Active} in the mode line if some, but probably not all,
30597formulas in the buffer are active. This happens if you activate
30598a few formulas one at a time but never use @kbd{M-# a}, or if you
30599used @kbd{M-# a} but then Calc had to deactivate a formula
30600because it lost track of it. If neither of these symbols appears
30601in the mode line, no embedded formulas are active in the buffer
30602(e.g., before Embedded mode has been used, or after a @kbd{M-- M-# a}).
30603
30604Embedded formulas can refer to assignments both before and after them
30605in the buffer. If there are several assignments to a variable, the
30606nearest preceding assignment is used if there is one, otherwise the
30607following assignment is used.
30608
30609@example
30610x => 1
30611
30612x := 1
30613
30614x => 1
30615
30616x := 2
30617
30618x => 2
30619@end example
30620
30621As well as simple variables, you can also assign to subscript
30622expressions of the form @samp{@var{var}_@var{number}} (as in
30623@code{x_0}), or @samp{@var{var}_@var{var}} (as in @code{x_max}).
30624Assignments to other kinds of objects can be represented by Calc,
30625but the automatic linkage between assignments and references works
30626only for plain variables and these two kinds of subscript expressions.
30627
30628If there are no assignments to a given variable, the global
30629stored value for the variable is used (@pxref{Storing Variables}),
30630or, if no value is stored, the variable is left in symbolic form.
30631Note that global stored values will be lost when the file is saved
30632and loaded in a later Emacs session, unless you have used the
30633@kbd{s p} (@code{calc-permanent-variable}) command to save them;
30634@pxref{Operations on Variables}.
30635
30636The @kbd{m C} (@code{calc-auto-recompute}) command turns automatic
30637recomputation of @samp{=>} forms on and off. If you turn automatic
30638recomputation off, you will have to use @kbd{M-# u} to update these
30639formulas manually after an assignment has been changed. If you
30640plan to change several assignments at once, it may be more efficient
30641to type @kbd{m C}, change all the assignments, then use @kbd{M-1 M-# u}
30642to update the entire buffer afterwards. The @kbd{m C} command also
30643controls @samp{=>} formulas on the stack; @pxref{Evaluates-To
30644Operator}. When you turn automatic recomputation back on, the
30645stack will be updated but the Embedded buffer will not; you must
30646use @kbd{M-# u} to update the buffer by hand.
30647
30648@node Mode Settings in Embedded Mode, Customizing Embedded Mode, Assignments in Embedded Mode, Embedded Mode
30649@section Mode Settings in Embedded Mode
30650
746539f6
JB
30651@kindex m e
30652@pindex calc-embedded-preserve-modes
d7b8e6c6 30653@noindent
1dddb589 30654The mode settings can be changed while Calc is in embedded mode, but
746539f6
JB
30655by default they will revert to their original values when embedded mode
30656is ended. However, the modes saved when the mode-recording mode is
30657@code{Save} (see below) and the modes in effect when the @kbd{m e}
30658(@code{calc-embedded-preserve-modes}) command is given
30659will be preserved when embedded mode is ended.
1dddb589 30660
07ce2eb3 30661Embedded mode has a rather complicated mechanism for handling mode
d7b8e6c6
EZ
30662settings in Embedded formulas. It is possible to put annotations
30663in the file that specify mode settings either global to the entire
30664file or local to a particular formula or formulas. In the latter
30665case, different modes can be specified for use when a formula
07ce2eb3 30666is the enabled Embedded mode formula.
d7b8e6c6 30667
07ce2eb3
JB
30668When you give any mode-setting command, like @kbd{m f} (for Fraction
30669mode) or @kbd{d s} (for scientific notation), Embedded mode adds
d7b8e6c6
EZ
30670a line like the following one to the file just before the opening
30671delimiter of the formula.
30672
30673@example
30674% [calc-mode: fractions: t]
30675% [calc-mode: float-format: (sci 0)]
30676@end example
30677
30678When Calc interprets an embedded formula, it scans the text before
30679the formula for mode-setting annotations like these and sets the
30680Calc buffer to match these modes. Modes not explicitly described
30681in the file are not changed. Calc scans all the way to the top of
30682the file, or up to a line of the form
30683
30684@example
30685% [calc-defaults]
30686@end example
30687
30688@noindent
30689which you can insert at strategic places in the file if this backward
30690scan is getting too slow, or just to provide a barrier between one
30691``zone'' of mode settings and another.
30692
30693If the file contains several annotations for the same mode, the
30694closest one before the formula is used. Annotations after the
30695formula are never used (except for global annotations, described
30696below).
30697
30698The scan does not look for the leading @samp{% }, only for the
30699square brackets and the text they enclose. You can edit the mode
30700annotations to a style that works better in context if you wish.
30701@xref{Customizing Embedded Mode}, to see how to change the style
30702that Calc uses when it generates the annotations. You can write
30703mode annotations into the file yourself if you know the syntax;
30704the easiest way to find the syntax for a given mode is to let
30705Calc write the annotation for it once and see what it does.
30706
30707If you give a mode-changing command for a mode that already has
30708a suitable annotation just above the current formula, Calc will
30709modify that annotation rather than generating a new, conflicting
30710one.
30711
30712Mode annotations have three parts, separated by colons. (Spaces
30713after the colons are optional.) The first identifies the kind
30714of mode setting, the second is a name for the mode itself, and
30715the third is the value in the form of a Lisp symbol, number,
30716or list. Annotations with unrecognizable text in the first or
30717second parts are ignored. The third part is not checked to make
2cbd16b9 30718sure the value is of a valid type or range; if you write an
d7b8e6c6
EZ
30719annotation by hand, be sure to give a proper value or results
30720will be unpredictable. Mode-setting annotations are case-sensitive.
30721
07ce2eb3 30722While Embedded mode is enabled, the word @code{Local} appears in
d7b8e6c6
EZ
30723the mode line. This is to show that mode setting commands generate
30724annotations that are ``local'' to the current formula or set of
30725formulas. The @kbd{m R} (@code{calc-mode-record-mode}) command
30726causes Calc to generate different kinds of annotations. Pressing
30727@kbd{m R} repeatedly cycles through the possible modes.
30728
30729@code{LocEdit} and @code{LocPerm} modes generate annotations
30730that look like this, respectively:
30731
30732@example
30733% [calc-edit-mode: float-format: (sci 0)]
30734% [calc-perm-mode: float-format: (sci 5)]
30735@end example
30736
30737The first kind of annotation will be used only while a formula
07ce2eb3 30738is enabled in Embedded mode. The second kind will be used only
d7b8e6c6
EZ
30739when the formula is @emph{not} enabled. (Whether the formula
30740is ``active'' or not, i.e., whether Calc has seen this formula
30741yet, is not relevant here.)
30742
30743@code{Global} mode generates an annotation like this at the end
30744of the file:
30745
30746@example
30747% [calc-global-mode: fractions t]
30748@end example
30749
30750Global mode annotations affect all formulas throughout the file,
30751and may appear anywhere in the file. This allows you to tuck your
30752mode annotations somewhere out of the way, say, on a new page of
30753the file, as long as those mode settings are suitable for all
30754formulas in the file.
30755
30756Enabling a formula with @kbd{M-# e} causes a fresh scan for local
30757mode annotations; you will have to use this after adding annotations
30758above a formula by hand to get the formula to notice them. Updating
30759a formula with @kbd{M-# u} will also re-scan the local modes, but
30760global modes are only re-scanned by @kbd{M-# a}.
30761
30762Another way that modes can get out of date is if you add a local
30763mode annotation to a formula that has another formula after it.
30764In this example, we have used the @kbd{d s} command while the
30765first of the two embedded formulas is active. But the second
30766formula has not changed its style to match, even though by the
30767rules of reading annotations the @samp{(sci 0)} applies to it, too.
30768
30769@example
30770% [calc-mode: float-format: (sci 0)]
307711.23e2
30772
30773456.
30774@end example
30775
30776We would have to go down to the other formula and press @kbd{M-# u}
30777on it in order to get it to notice the new annotation.
30778
35626cba
JB
30779Two more mode-recording modes selectable by @kbd{m R} are available
30780which are also available outside of Embedded mode.
30781(@pxref{General Mode Commands}.) They are @code{Save}, in which mode
30782settings are recorded permanently in your Calc init file (the file given
30783by the variable @code{calc-settings-file}, typically @file{~/.calc.el})
d7b8e6c6
EZ
30784rather than by annotating the current document, and no-recording
30785mode (where there is no symbol like @code{Save} or @code{Local} in
30786the mode line), in which mode-changing commands do not leave any
30787annotations at all.
30788
07ce2eb3 30789When Embedded mode is not enabled, mode-recording modes except
d7b8e6c6
EZ
30790for @code{Save} have no effect.
30791
30792@node Customizing Embedded Mode, , Mode Settings in Embedded Mode, Embedded Mode
30793@section Customizing Embedded Mode
30794
30795@noindent
07ce2eb3 30796You can modify Embedded mode's behavior by setting various Lisp
b154df16
JB
30797variables described here. These variables are customizable
30798(@pxref{Customizable Variables}), or you can use @kbd{M-x set-variable}
30799or @kbd{M-x edit-options} to adjust a variable on the fly.
30800(Another possibility would
d7b8e6c6
EZ
30801be to use a file-local variable annotation at the end of the
30802file; @pxref{File Variables, , Local Variables in Files, emacs, the
30803Emacs manual}.)
30804
30805While none of these variables will be buffer-local by default, you
07ce2eb3 30806can make any of them local to any Embedded mode buffer. (Their
d7b8e6c6
EZ
30807values in the @samp{*Calculator*} buffer are never used.)
30808
30809@vindex calc-embedded-open-formula
30810The @code{calc-embedded-open-formula} variable holds a regular
30811expression for the opening delimiter of a formula. @xref{Regexp Search,
30812, Regular Expression Search, emacs, the Emacs manual}, to see
30813how regular expressions work. Basically, a regular expression is a
30814pattern that Calc can search for. A regular expression that considers
30815blank lines, @samp{$}, and @samp{$$} to be opening delimiters is
30816@code{"\\`\\|^\n\\|\\$\\$?"}. Just in case the meaning of this
30817regular expression is not completely plain, let's go through it
30818in detail.
30819
30820The surrounding @samp{" "} marks quote the text between them as a
30821Lisp string. If you left them off, @code{set-variable} or
30822@code{edit-options} would try to read the regular expression as a
30823Lisp program.
30824
30825The most obvious property of this regular expression is that it
30826contains indecently many backslashes. There are actually two levels
30827of backslash usage going on here. First, when Lisp reads a quoted
30828string, all pairs of characters beginning with a backslash are
30829interpreted as special characters. Here, @code{\n} changes to a
30830new-line character, and @code{\\} changes to a single backslash.
30831So the actual regular expression seen by Calc is
30832@samp{\`\|^ @r{(newline)} \|\$\$?}.
30833
30834Regular expressions also consider pairs beginning with backslash
30835to have special meanings. Sometimes the backslash is used to quote
30836a character that otherwise would have a special meaning in a regular
30837expression, like @samp{$}, which normally means ``end-of-line,''
30838or @samp{?}, which means that the preceding item is optional. So
30839@samp{\$\$?} matches either one or two dollar signs.
30840
30841The other codes in this regular expression are @samp{^}, which matches
30842``beginning-of-line,'' @samp{\|}, which means ``or,'' and @samp{\`},
30843which matches ``beginning-of-buffer.'' So the whole pattern means
30844that a formula begins at the beginning of the buffer, or on a newline
30845that occurs at the beginning of a line (i.e., a blank line), or at
30846one or two dollar signs.
30847
30848The default value of @code{calc-embedded-open-formula} looks just
30849like this example, with several more alternatives added on to
30850recognize various other common kinds of delimiters.
30851
30852By the way, the reason to use @samp{^\n} rather than @samp{^$}
30853or @samp{\n\n}, which also would appear to match blank lines,
30854is that the former expression actually ``consumes'' only one
30855newline character as @emph{part of} the delimiter, whereas the
30856latter expressions consume zero or two newlines, respectively.
30857The former choice gives the most natural behavior when Calc
30858must operate on a whole formula including its delimiters.
30859
30860See the Emacs manual for complete details on regular expressions.
30861But just for your convenience, here is a list of all characters
30862which must be quoted with backslash (like @samp{\$}) to avoid
30863some special interpretation: @samp{. * + ? [ ] ^ $ \}. (Note
30864the backslash in this list; for example, to match @samp{\[} you
30865must use @code{"\\\\\\["}. An exercise for the reader is to
30866account for each of these six backslashes!)
30867
30868@vindex calc-embedded-close-formula
30869The @code{calc-embedded-close-formula} variable holds a regular
30870expression for the closing delimiter of a formula. A closing
30871regular expression to match the above example would be
30872@code{"\\'\\|\n$\\|\\$\\$?"}. This is almost the same as the
30873other one, except it now uses @samp{\'} (``end-of-buffer'') and
30874@samp{\n$} (newline occurring at end of line, yet another way
30875of describing a blank line that is more appropriate for this
30876case).
30877
30878@vindex calc-embedded-open-word
30879@vindex calc-embedded-close-word
30880The @code{calc-embedded-open-word} and @code{calc-embedded-close-word}
30881variables are similar expressions used when you type @kbd{M-# w}
30882instead of @kbd{M-# e} to enable Embedded mode.
30883
30884@vindex calc-embedded-open-plain
30885The @code{calc-embedded-open-plain} variable is a string which
30886begins a ``plain'' formula written in front of the formatted
30887formula when @kbd{d p} mode is turned on. Note that this is an
30888actual string, not a regular expression, because Calc must be able
30889to write this string into a buffer as well as to recognize it.
30890The default string is @code{"%%% "} (note the trailing space).
30891
30892@vindex calc-embedded-close-plain
30893The @code{calc-embedded-close-plain} variable is a string which
30894ends a ``plain'' formula. The default is @code{" %%%\n"}. Without
07ce2eb3 30895the trailing newline here, the first line of a Big mode formula
d7b8e6c6
EZ
30896that followed might be shifted over with respect to the other lines.
30897
30898@vindex calc-embedded-open-new-formula
30899The @code{calc-embedded-open-new-formula} variable is a string
30900which is inserted at the front of a new formula when you type
30901@kbd{M-# f}. Its default value is @code{"\n\n"}. If this
30902string begins with a newline character and the @kbd{M-# f} is
30903typed at the beginning of a line, @kbd{M-# f} will skip this
30904first newline to avoid introducing unnecessary blank lines in
30905the file.
30906
30907@vindex calc-embedded-close-new-formula
30908The @code{calc-embedded-close-new-formula} variable is the corresponding
30909string which is inserted at the end of a new formula. Its default
30910value is also @code{"\n\n"}. The final newline is omitted by
30911@w{@kbd{M-# f}} if typed at the end of a line. (It follows that if
30912@kbd{M-# f} is typed on a blank line, both a leading opening
30913newline and a trailing closing newline are omitted.)
30914
30915@vindex calc-embedded-announce-formula
30916The @code{calc-embedded-announce-formula} variable is a regular
30917expression which is sure to be followed by an embedded formula.
30918The @kbd{M-# a} command searches for this pattern as well as for
30919@samp{=>} and @samp{:=} operators. Note that @kbd{M-# a} will
30920not activate just anything surrounded by formula delimiters; after
30921all, blank lines are considered formula delimiters by default!
30922But if your language includes a delimiter which can only occur
30923actually in front of a formula, you can take advantage of it here.
30924The default pattern is @code{"%Embed\n\\(% .*\n\\)*"}, which
30925checks for @samp{%Embed} followed by any number of lines beginning
30926with @samp{%} and a space. This last is important to make Calc
30927consider mode annotations part of the pattern, so that the formula's
30928opening delimiter really is sure to follow the pattern.
30929
30930@vindex calc-embedded-open-mode
30931The @code{calc-embedded-open-mode} variable is a string (not a
30932regular expression) which should precede a mode annotation.
30933Calc never scans for this string; Calc always looks for the
30934annotation itself. But this is the string that is inserted before
30935the opening bracket when Calc adds an annotation on its own.
30936The default is @code{"% "}.
30937
30938@vindex calc-embedded-close-mode
30939The @code{calc-embedded-close-mode} variable is a string which
30940follows a mode annotation written by Calc. Its default value
30941is simply a newline, @code{"\n"}. If you change this, it is a
30942good idea still to end with a newline so that mode annotations
30943will appear on lines by themselves.
30944
b154df16 30945@node Programming, Customizable Variables, Embedded Mode, Top
d7b8e6c6
EZ
30946@chapter Programming
30947
30948@noindent
30949There are several ways to ``program'' the Emacs Calculator, depending
30950on the nature of the problem you need to solve.
30951
30952@enumerate
30953@item
30954@dfn{Keyboard macros} allow you to record a sequence of keystrokes
30955and play them back at a later time. This is just the standard Emacs
30956keyboard macro mechanism, dressed up with a few more features such
30957as loops and conditionals.
30958
30959@item
30960@dfn{Algebraic definitions} allow you to use any formula to define a
30961new function. This function can then be used in algebraic formulas or
30962as an interactive command.
30963
30964@item
30965@dfn{Rewrite rules} are discussed in the section on algebra commands.
30966@xref{Rewrite Rules}. If you put your rewrite rules in the variable
30967@code{EvalRules}, they will be applied automatically to all Calc
30968results in just the same way as an internal ``rule'' is applied to
30969evaluate @samp{sqrt(9)} to 3 and so on. @xref{Automatic Rewrites}.
30970
30971@item
30972@dfn{Lisp} is the programming language that Calc (and most of Emacs)
30973is written in. If the above techniques aren't powerful enough, you
30974can write Lisp functions to do anything that built-in Calc commands
30975can do. Lisp code is also somewhat faster than keyboard macros or
30976rewrite rules.
30977@end enumerate
30978
30979@kindex z
30980Programming features are available through the @kbd{z} and @kbd{Z}
30981prefix keys. New commands that you define are two-key sequences
30982beginning with @kbd{z}. Commands for managing these definitions
30983use the shift-@kbd{Z} prefix. (The @kbd{Z T} (@code{calc-timing})
30984command is described elsewhere; @pxref{Troubleshooting Commands}.
30985The @kbd{Z C} (@code{calc-user-define-composition}) command is also
30986described elsewhere; @pxref{User-Defined Compositions}.)
30987
30988@menu
30989* Creating User Keys::
30990* Keyboard Macros::
30991* Invocation Macros::
30992* Algebraic Definitions::
30993* Lisp Definitions::
30994@end menu
30995
30996@node Creating User Keys, Keyboard Macros, Programming, Programming
30997@section Creating User Keys
30998
30999@noindent
31000@kindex Z D
31001@pindex calc-user-define
31002Any Calculator command may be bound to a key using the @kbd{Z D}
31003(@code{calc-user-define}) command. Actually, it is bound to a two-key
31004sequence beginning with the lower-case @kbd{z} prefix.
31005
31006The @kbd{Z D} command first prompts for the key to define. For example,
31007press @kbd{Z D a} to define the new key sequence @kbd{z a}. You are then
31008prompted for the name of the Calculator command that this key should
31009run. For example, the @code{calc-sincos} command is not normally
31010available on a key. Typing @kbd{Z D s sincos @key{RET}} programs the
31011@kbd{z s} key sequence to run @code{calc-sincos}. This definition will remain
31012in effect for the rest of this Emacs session, or until you redefine
31013@kbd{z s} to be something else.
31014
31015You can actually bind any Emacs command to a @kbd{z} key sequence by
31016backspacing over the @samp{calc-} when you are prompted for the command name.
31017
31018As with any other prefix key, you can type @kbd{z ?} to see a list of
31019all the two-key sequences you have defined that start with @kbd{z}.
31020Initially, no @kbd{z} sequences (except @kbd{z ?} itself) are defined.
31021
31022User keys are typically letters, but may in fact be any key.
31023(@key{META}-keys are not permitted, nor are a terminal's special
31024function keys which generate multi-character sequences when pressed.)
31025You can define different commands on the shifted and unshifted versions
31026of a letter if you wish.
31027
31028@kindex Z U
31029@pindex calc-user-undefine
31030The @kbd{Z U} (@code{calc-user-undefine}) command unbinds a user key.
31031For example, the key sequence @kbd{Z U s} will undefine the @code{sincos}
31032key we defined above.
31033
31034@kindex Z P
31035@pindex calc-user-define-permanent
31036@cindex Storing user definitions
31037@cindex Permanent user definitions
3b846359 31038@cindex Calc init file, user-defined commands
d7b8e6c6
EZ
31039The @kbd{Z P} (@code{calc-user-define-permanent}) command makes a key
31040binding permanent so that it will remain in effect even in future Emacs
31041sessions. (It does this by adding a suitable bit of Lisp code into
3b846359
JB
31042your Calc init file; that is, the file given by the variable
31043@code{calc-settings-file}, typically @file{~/.calc.el}.) For example,
31044@kbd{Z P s} would register our @code{sincos} command permanently. If
31045you later wish to unregister this command you must edit your Calc init
31046file by hand. (@xref{General Mode Commands}, for a way to tell Calc to
31047use a different file for the Calc init file.)
d7b8e6c6
EZ
31048
31049The @kbd{Z P} command also saves the user definition, if any, for the
31050command bound to the key. After @kbd{Z F} and @kbd{Z C}, a given user
31051key could invoke a command, which in turn calls an algebraic function,
31052which might have one or more special display formats. A single @kbd{Z P}
31053command will save all of these definitions.
a2db4c6b
JB
31054To save an algebraic function, type @kbd{'} (the apostrophe)
31055when prompted for a key, and type the function name. To save a command
31056without its key binding, type @kbd{M-x} and enter a function name. (The
31057@samp{calc-} prefix will automatically be inserted for you.)
31058(If the command you give implies a function, the function will be saved,
31059and if the function has any display formats, those will be saved, but
31060not the other way around: Saving a function will not save any commands
31061or key bindings associated with the function.)
d7b8e6c6
EZ
31062
31063@kindex Z E
31064@pindex calc-user-define-edit
31065@cindex Editing user definitions
31066The @kbd{Z E} (@code{calc-user-define-edit}) command edits the definition
31067of a user key. This works for keys that have been defined by either
31068keyboard macros or formulas; further details are contained in the relevant
31069following sections.
31070
31071@node Keyboard Macros, Invocation Macros, Creating User Keys, Programming
31072@section Programming with Keyboard Macros
31073
31074@noindent
31075@kindex X
31076@cindex Programming with keyboard macros
31077@cindex Keyboard macros
31078The easiest way to ``program'' the Emacs Calculator is to use standard
31079keyboard macros. Press @w{@kbd{C-x (}} to begin recording a macro. From
31080this point on, keystrokes you type will be saved away as well as
31081performing their usual functions. Press @kbd{C-x )} to end recording.
31082Press shift-@kbd{X} (or the standard Emacs key sequence @kbd{C-x e}) to
31083execute your keyboard macro by replaying the recorded keystrokes.
31084@xref{Keyboard Macros, , , emacs, the Emacs Manual}, for further
a4231b04 31085information.
d7b8e6c6
EZ
31086
31087When you use @kbd{X} to invoke a keyboard macro, the entire macro is
31088treated as a single command by the undo and trail features. The stack
31089display buffer is not updated during macro execution, but is instead
31090fixed up once the macro completes. Thus, commands defined with keyboard
31091macros are convenient and efficient. The @kbd{C-x e} command, on the
31092other hand, invokes the keyboard macro with no special treatment: Each
31093command in the macro will record its own undo information and trail entry,
31094and update the stack buffer accordingly. If your macro uses features
31095outside of Calc's control to operate on the contents of the Calc stack
31096buffer, or if it includes Undo, Redo, or last-arguments commands, you
31097must use @kbd{C-x e} to make sure the buffer and undo list are up-to-date
31098at all times. You could also consider using @kbd{K} (@code{calc-keep-args})
31099instead of @kbd{M-@key{RET}} (@code{calc-last-args}).
31100
31101Calc extends the standard Emacs keyboard macros in several ways.
31102Keyboard macros can be used to create user-defined commands. Keyboard
31103macros can include conditional and iteration structures, somewhat
31104analogous to those provided by a traditional programmable calculator.
31105
31106@menu
31107* Naming Keyboard Macros::
31108* Conditionals in Macros::
31109* Loops in Macros::
31110* Local Values in Macros::
31111* Queries in Macros::
31112@end menu
31113
31114@node Naming Keyboard Macros, Conditionals in Macros, Keyboard Macros, Keyboard Macros
31115@subsection Naming Keyboard Macros
31116
31117@noindent
31118@kindex Z K
31119@pindex calc-user-define-kbd-macro
31120Once you have defined a keyboard macro, you can bind it to a @kbd{z}
31121key sequence with the @kbd{Z K} (@code{calc-user-define-kbd-macro}) command.
31122This command prompts first for a key, then for a command name. For
31123example, if you type @kbd{C-x ( n @key{TAB} n @key{TAB} C-x )} you will
31124define a keyboard macro which negates the top two numbers on the stack
31125(@key{TAB} swaps the top two stack elements). Now you can type
31126@kbd{Z K n @key{RET}} to define this keyboard macro onto the @kbd{z n} key
31127sequence. The default command name (if you answer the second prompt with
31128just the @key{RET} key as in this example) will be something like
31129@samp{calc-User-n}. The keyboard macro will now be available as both
31130@kbd{z n} and @kbd{M-x calc-User-n}. You can backspace and enter a more
a4231b04 31131descriptive command name if you wish.
d7b8e6c6
EZ
31132
31133Macros defined by @kbd{Z K} act like single commands; they are executed
31134in the same way as by the @kbd{X} key. If you wish to define the macro
31135as a standard no-frills Emacs macro (to be executed as if by @kbd{C-x e}),
31136give a negative prefix argument to @kbd{Z K}.
31137
31138Once you have bound your keyboard macro to a key, you can use
31139@kbd{Z P} to register it permanently with Emacs. @xref{Creating User Keys}.
31140
31141@cindex Keyboard macros, editing
31142The @kbd{Z E} (@code{calc-user-define-edit}) command on a key that has
74857f83
JB
31143been defined by a keyboard macro tries to use the @code{edmacro} package
31144edit the macro. Type @kbd{C-c C-c} to finish editing and update
33108698
JB
31145the definition stored on the key, or, to cancel the edit, kill the
31146buffer with @kbd{C-x k}.
74857f83
JB
31147The special characters @code{RET}, @code{LFD}, @code{TAB}, @code{SPC},
31148@code{DEL}, and @code{NUL} must be entered as these three character
31149sequences, written in all uppercase, as must the prefixes @code{C-} and
31150@code{M-}. Spaces and line breaks are ignored. Other characters are
d7b8e6c6
EZ
31151copied verbatim into the keyboard macro. Basically, the notation is the
31152same as is used in all of this manual's examples, except that the manual
74857f83
JB
31153takes some liberties with spaces: When we say @kbd{' [1 2 3] @key{RET}},
31154we take it for granted that it is clear we really mean
31155@kbd{' [1 @key{SPC} 2 @key{SPC} 3] @key{RET}}.
d7b8e6c6
EZ
31156
31157@kindex M-# m
31158@pindex read-kbd-macro
31159The @kbd{M-# m} (@code{read-kbd-macro}) command reads an Emacs ``region''
31160of spelled-out keystrokes and defines it as the current keyboard macro.
31161It is a convenient way to define a keyboard macro that has been stored
31162in a file, or to define a macro without executing it at the same time.
d7b8e6c6
EZ
31163
31164@node Conditionals in Macros, Loops in Macros, Naming Keyboard Macros, Keyboard Macros
31165@subsection Conditionals in Keyboard Macros
31166
31167@noindent
31168@kindex Z [
31169@kindex Z ]
31170@pindex calc-kbd-if
31171@pindex calc-kbd-else
31172@pindex calc-kbd-else-if
31173@pindex calc-kbd-end-if
31174@cindex Conditional structures
31175The @kbd{Z [} (@code{calc-kbd-if}) and @kbd{Z ]} (@code{calc-kbd-end-if})
31176commands allow you to put simple tests in a keyboard macro. When Calc
31177sees the @kbd{Z [}, it pops an object from the stack and, if the object is
31178a non-zero value, continues executing keystrokes. But if the object is
31179zero, or if it is not provably nonzero, Calc skips ahead to the matching
31180@kbd{Z ]} keystroke. @xref{Logical Operations}, for a set of commands for
31181performing tests which conveniently produce 1 for true and 0 for false.
31182
31183For example, @kbd{@key{RET} 0 a < Z [ n Z ]} implements an absolute-value
31184function in the form of a keyboard macro. This macro duplicates the
31185number on the top of the stack, pushes zero and compares using @kbd{a <}
31186(@code{calc-less-than}), then, if the number was less than zero,
31187executes @kbd{n} (@code{calc-change-sign}). Otherwise, the change-sign
31188command is skipped.
31189
31190To program this macro, type @kbd{C-x (}, type the above sequence of
31191keystrokes, then type @kbd{C-x )}. Note that the keystrokes will be
31192executed while you are making the definition as well as when you later
31193re-execute the macro by typing @kbd{X}. Thus you should make sure a
31194suitable number is on the stack before defining the macro so that you
31195don't get a stack-underflow error during the definition process.
31196
31197Conditionals can be nested arbitrarily. However, there should be exactly
31198one @kbd{Z ]} for each @kbd{Z [} in a keyboard macro.
31199
31200@kindex Z :
31201The @kbd{Z :} (@code{calc-kbd-else}) command allows you to choose between
31202two keystroke sequences. The general format is @kbd{@var{cond} Z [
31203@var{then-part} Z : @var{else-part} Z ]}. If @var{cond} is true
31204(i.e., if the top of stack contains a non-zero number after @var{cond}
31205has been executed), the @var{then-part} will be executed and the
31206@var{else-part} will be skipped. Otherwise, the @var{then-part} will
31207be skipped and the @var{else-part} will be executed.
31208
31209@kindex Z |
31210The @kbd{Z |} (@code{calc-kbd-else-if}) command allows you to choose
31211between any number of alternatives. For example,
31212@kbd{@var{cond1} Z [ @var{part1} Z : @var{cond2} Z | @var{part2} Z :
31213@var{part3} Z ]} will execute @var{part1} if @var{cond1} is true,
31214otherwise it will execute @var{part2} if @var{cond2} is true, otherwise
31215it will execute @var{part3}.
31216
31217More precisely, @kbd{Z [} pops a number and conditionally skips to the
31218next matching @kbd{Z :} or @kbd{Z ]} key. @w{@kbd{Z ]}} has no effect when
31219actually executed. @kbd{Z :} skips to the next matching @kbd{Z ]}.
31220@kbd{Z |} pops a number and conditionally skips to the next matching
31221@kbd{Z :} or @kbd{Z ]}; thus, @kbd{Z [} and @kbd{Z |} are functionally
31222equivalent except that @kbd{Z [} participates in nesting but @kbd{Z |}
31223does not.
31224
31225Calc's conditional and looping constructs work by scanning the
31226keyboard macro for occurrences of character sequences like @samp{Z:}
31227and @samp{Z]}. One side-effect of this is that if you use these
31228constructs you must be careful that these character pairs do not
31229occur by accident in other parts of the macros. Since Calc rarely
31230uses shift-@kbd{Z} for any purpose except as a prefix character, this
31231is not likely to be a problem. Another side-effect is that it will
31232not work to define your own custom key bindings for these commands.
31233Only the standard shift-@kbd{Z} bindings will work correctly.
31234
31235@kindex Z C-g
31236If Calc gets stuck while skipping characters during the definition of a
31237macro, type @kbd{Z C-g} to cancel the definition. (Typing plain @kbd{C-g}
31238actually adds a @kbd{C-g} keystroke to the macro.)
31239
31240@node Loops in Macros, Local Values in Macros, Conditionals in Macros, Keyboard Macros
31241@subsection Loops in Keyboard Macros
31242
31243@noindent
31244@kindex Z <
31245@kindex Z >
31246@pindex calc-kbd-repeat
31247@pindex calc-kbd-end-repeat
31248@cindex Looping structures
31249@cindex Iterative structures
31250The @kbd{Z <} (@code{calc-kbd-repeat}) and @kbd{Z >}
31251(@code{calc-kbd-end-repeat}) commands pop a number from the stack,
31252which must be an integer, then repeat the keystrokes between the brackets
31253the specified number of times. If the integer is zero or negative, the
31254body is skipped altogether. For example, @kbd{1 @key{TAB} Z < 2 * Z >}
31255computes two to a nonnegative integer power. First, we push 1 on the
31256stack and then swap the integer argument back to the top. The @kbd{Z <}
31257pops that argument leaving the 1 back on top of the stack. Then, we
a4231b04 31258repeat a multiply-by-two step however many times.
d7b8e6c6
EZ
31259
31260Once again, the keyboard macro is executed as it is being entered.
31261In this case it is especially important to set up reasonable initial
31262conditions before making the definition: Suppose the integer 1000 just
31263happened to be sitting on the stack before we typed the above definition!
31264Another approach is to enter a harmless dummy definition for the macro,
31265then go back and edit in the real one with a @kbd{Z E} command. Yet
31266another approach is to type the macro as written-out keystroke names
31267in a buffer, then use @kbd{M-# m} (@code{read-kbd-macro}) to read the
31268macro.
31269
31270@kindex Z /
31271@pindex calc-break
31272The @kbd{Z /} (@code{calc-kbd-break}) command allows you to break out
31273of a keyboard macro loop prematurely. It pops an object from the stack;
31274if that object is true (a non-zero number), control jumps out of the
31275innermost enclosing @kbd{Z <} @dots{} @kbd{Z >} loop and continues
31276after the @kbd{Z >}. If the object is false, the @kbd{Z /} has no
31277effect. Thus @kbd{@var{cond} Z /} is similar to @samp{if (@var{cond}) break;}
a4231b04 31278in the C language.
d7b8e6c6
EZ
31279
31280@kindex Z (
31281@kindex Z )
31282@pindex calc-kbd-for
31283@pindex calc-kbd-end-for
31284The @kbd{Z (} (@code{calc-kbd-for}) and @kbd{Z )} (@code{calc-kbd-end-for})
31285commands are similar to @kbd{Z <} and @kbd{Z >}, except that they make the
31286value of the counter available inside the loop. The general layout is
31287@kbd{@var{init} @var{final} Z ( @var{body} @var{step} Z )}. The @kbd{Z (}
31288command pops initial and final values from the stack. It then creates
31289a temporary internal counter and initializes it with the value @var{init}.
31290The @kbd{Z (} command then repeatedly pushes the counter value onto the
31291stack and executes @var{body} and @var{step}, adding @var{step} to the
a4231b04 31292counter each time until the loop finishes.
d7b8e6c6
EZ
31293
31294@cindex Summations (by keyboard macros)
31295By default, the loop finishes when the counter becomes greater than (or
31296less than) @var{final}, assuming @var{initial} is less than (greater
31297than) @var{final}. If @var{initial} is equal to @var{final}, the body
31298executes exactly once. The body of the loop always executes at least
31299once. For example, @kbd{0 1 10 Z ( 2 ^ + 1 Z )} computes the sum of the
31300squares of the integers from 1 to 10, in steps of 1.
31301
31302If you give a numeric prefix argument of 1 to @kbd{Z (}, the loop is
31303forced to use upward-counting conventions. In this case, if @var{initial}
31304is greater than @var{final} the body will not be executed at all.
31305Note that @var{step} may still be negative in this loop; the prefix
31306argument merely constrains the loop-finished test. Likewise, a prefix
8e04863e 31307argument of @mathit{-1} forces downward-counting conventions.
d7b8e6c6
EZ
31308
31309@kindex Z @{
31310@kindex Z @}
31311@pindex calc-kbd-loop
31312@pindex calc-kbd-end-loop
31313The @kbd{Z @{} (@code{calc-kbd-loop}) and @kbd{Z @}}
31314(@code{calc-kbd-end-loop}) commands are similar to @kbd{Z <} and
31315@kbd{Z >}, except that they do not pop a count from the stack---they
31316effectively create an infinite loop. Every @kbd{Z @{} @dots{} @kbd{Z @}}
31317loop ought to include at least one @kbd{Z /} to make sure the loop
31318doesn't run forever. (If any error message occurs which causes Emacs
31319to beep, the keyboard macro will also be halted; this is a standard
31320feature of Emacs. You can also generally press @kbd{C-g} to halt a
31321running keyboard macro, although not all versions of Unix support
31322this feature.)
31323
31324The conditional and looping constructs are not actually tied to
31325keyboard macros, but they are most often used in that context.
31326For example, the keystrokes @kbd{10 Z < 23 @key{RET} Z >} push
31327ten copies of 23 onto the stack. This can be typed ``live'' just
31328as easily as in a macro definition.
31329
31330@xref{Conditionals in Macros}, for some additional notes about
31331conditional and looping commands.
31332
31333@node Local Values in Macros, Queries in Macros, Loops in Macros, Keyboard Macros
31334@subsection Local Values in Macros
31335
31336@noindent
31337@cindex Local variables
31338@cindex Restoring saved modes
31339Keyboard macros sometimes want to operate under known conditions
31340without affecting surrounding conditions. For example, a keyboard
07ce2eb3 31341macro may wish to turn on Fraction mode, or set a particular
d7b8e6c6
EZ
31342precision, independent of the user's normal setting for those
31343modes.
31344
31345@kindex Z `
31346@kindex Z '
31347@pindex calc-kbd-push
31348@pindex calc-kbd-pop
31349Macros also sometimes need to use local variables. Assignments to
31350local variables inside the macro should not affect any variables
31351outside the macro. The @kbd{Z `} (@code{calc-kbd-push}) and @kbd{Z '}
31352(@code{calc-kbd-pop}) commands give you both of these capabilities.
31353
31354When you type @kbd{Z `} (with a backquote or accent grave character),
31355the values of various mode settings are saved away. The ten ``quick''
31356variables @code{q0} through @code{q9} are also saved. When
31357you type @w{@kbd{Z '}} (with an apostrophe), these values are restored.
31358Pairs of @kbd{Z `} and @kbd{Z '} commands may be nested.
31359
31360If a keyboard macro halts due to an error in between a @kbd{Z `} and
31361a @kbd{Z '}, the saved values will be restored correctly even though
31362the macro never reaches the @kbd{Z '} command. Thus you can use
31363@kbd{Z `} and @kbd{Z '} without having to worry about what happens
31364in exceptional conditions.
31365
31366If you type @kbd{Z `} ``live'' (not in a keyboard macro), Calc puts
31367you into a ``recursive edit.'' You can tell you are in a recursive
31368edit because there will be extra square brackets in the mode line,
31369as in @samp{[(Calculator)]}. These brackets will go away when you
31370type the matching @kbd{Z '} command. The modes and quick variables
31371will be saved and restored in just the same way as if actual keyboard
31372macros were involved.
31373
31374The modes saved by @kbd{Z `} and @kbd{Z '} are the current precision
31375and binary word size, the angular mode (Deg, Rad, or HMS), the
31376simplification mode, Algebraic mode, Symbolic mode, Infinite mode,
31377Matrix or Scalar mode, Fraction mode, and the current complex mode
31378(Polar or Rectangular). The ten ``quick'' variables' values (or lack
31379thereof) are also saved.
31380
31381Most mode-setting commands act as toggles, but with a numeric prefix
31382they force the mode either on (positive prefix) or off (negative
31383or zero prefix). Since you don't know what the environment might
31384be when you invoke your macro, it's best to use prefix arguments
31385for all mode-setting commands inside the macro.
31386
31387In fact, @kbd{C-u Z `} is like @kbd{Z `} except that it sets the modes
31388listed above to their default values. As usual, the matching @kbd{Z '}
31389will restore the modes to their settings from before the @kbd{C-u Z `}.
07ce2eb3 31390Also, @w{@kbd{Z `}} with a negative prefix argument resets the algebraic mode
d7b8e6c6
EZ
31391to its default (off) but leaves the other modes the same as they were
31392outside the construct.
31393
31394The contents of the stack and trail, values of non-quick variables, and
31395other settings such as the language mode and the various display modes,
31396are @emph{not} affected by @kbd{Z `} and @kbd{Z '}.
31397
31398@node Queries in Macros, , Local Values in Macros, Keyboard Macros
31399@subsection Queries in Keyboard Macros
31400
faa3b6fc
JB
31401@c @noindent
31402@c @kindex Z =
31403@c @pindex calc-kbd-report
31404@c The @kbd{Z =} (@code{calc-kbd-report}) command displays an informative
31405@c message including the value on the top of the stack. You are prompted
31406@c to enter a string. That string, along with the top-of-stack value,
31407@c is displayed unless @kbd{m w} (@code{calc-working}) has been used
31408@c to turn such messages off.
d7b8e6c6 31409
faa3b6fc 31410@noindent
d7b8e6c6
EZ
31411@kindex Z #
31412@pindex calc-kbd-query
faa3b6fc
JB
31413The @kbd{Z #} (@code{calc-kbd-query}) command prompts for an algebraic
31414entry which takes its input from the keyboard, even during macro
31415execution. All the normal conventions of algebraic input, including the
31416use of @kbd{$} characters, are supported. The prompt message itself is
31417taken from the top of the stack, and so must be entered (as a string)
31418before the @kbd{Z #} command. (Recall, as a string it can be entered by
31419pressing the @kbd{"} key and will appear as a vector when it is put on
31420the stack. The prompt message is only put on the stack to provide a
31421prompt for the @kbd{Z #} command; it will not play any role in any
31422subsequent calculations.) This command allows your keyboard macros to
31423accept numbers or formulas as interactive input.
31424
31425As an example,
e9d3dbea 31426@kbd{2 @key{RET} "Power: " @key{RET} Z # 3 @key{RET} ^} will prompt for
faa3b6fc
JB
31427input with ``Power: '' in the minibuffer, then return 2 to the provided
31428power. (The response to the prompt that's given, 3 in this example,
31429will not be part of the macro.)
d7b8e6c6 31430
baf2630d 31431@xref{Keyboard Macro Query, , , emacs, the Emacs Manual}, for a description of
d7b8e6c6
EZ
31432@kbd{C-x q} (@code{kbd-macro-query}), the standard Emacs way to accept
31433keyboard input during a keyboard macro. In particular, you can use
31434@kbd{C-x q} to enter a recursive edit, which allows the user to perform
31435any Calculator operations interactively before pressing @kbd{C-M-c} to
31436return control to the keyboard macro.
31437
31438@node Invocation Macros, Algebraic Definitions, Keyboard Macros, Programming
31439@section Invocation Macros
31440
31441@kindex M-# z
31442@kindex Z I
31443@pindex calc-user-invocation
31444@pindex calc-user-define-invocation
31445Calc provides one special keyboard macro, called up by @kbd{M-# z}
31446(@code{calc-user-invocation}), that is intended to allow you to define
31447your own special way of starting Calc. To define this ``invocation
31448macro,'' create the macro in the usual way with @kbd{C-x (} and
31449@kbd{C-x )}, then type @kbd{Z I} (@code{calc-user-define-invocation}).
31450There is only one invocation macro, so you don't need to type any
31451additional letters after @kbd{Z I}. From now on, you can type
31452@kbd{M-# z} at any time to execute your invocation macro.
31453
31454For example, suppose you find yourself often grabbing rectangles of
31455numbers into Calc and multiplying their columns. You can do this
31456by typing @kbd{M-# r} to grab, and @kbd{V R : *} to multiply columns.
31457To make this into an invocation macro, just type @kbd{C-x ( M-# r
31458V R : * C-x )}, then @kbd{Z I}. Then, to multiply a rectangle of data,
31459just mark the data in its buffer in the usual way and type @kbd{M-# z}.
31460
31461Invocation macros are treated like regular Emacs keyboard macros;
31462all the special features described above for @kbd{Z K}-style macros
31463do not apply. @kbd{M-# z} is just like @kbd{C-x e}, except that it
31464uses the macro that was last stored by @kbd{Z I}. (In fact, the
31465macro does not even have to have anything to do with Calc!)
31466
31467The @kbd{m m} command saves the last invocation macro defined by
31468@kbd{Z I} along with all the other Calc mode settings.
31469@xref{General Mode Commands}.
31470
31471@node Algebraic Definitions, Lisp Definitions, Invocation Macros, Programming
31472@section Programming with Formulas
31473
31474@noindent
31475@kindex Z F
31476@pindex calc-user-define-formula
31477@cindex Programming with algebraic formulas
31478Another way to create a new Calculator command uses algebraic formulas.
31479The @kbd{Z F} (@code{calc-user-define-formula}) command stores the
31480formula at the top of the stack as the definition for a key. This
31481command prompts for five things: The key, the command name, the function
31482name, the argument list, and the behavior of the command when given
31483non-numeric arguments.
31484
31485For example, suppose we type @kbd{' a+2b @key{RET}} to push the formula
31486@samp{a + 2*b} onto the stack. We now type @kbd{Z F m} to define this
31487formula on the @kbd{z m} key sequence. The next prompt is for a command
31488name, beginning with @samp{calc-}, which should be the long (@kbd{M-x}) form
31489for the new command. If you simply press @key{RET}, a default name like
31490@code{calc-User-m} will be constructed. In our example, suppose we enter
31491@kbd{spam @key{RET}} to define the new command as @code{calc-spam}.
31492
31493If you want to give the formula a long-style name only, you can press
31494@key{SPC} or @key{RET} when asked which single key to use. For example
31495@kbd{Z F @key{RET} spam @key{RET}} defines the new command as
31496@kbd{M-x calc-spam}, with no keyboard equivalent.
31497
a2db4c6b
JB
31498The third prompt is for an algebraic function name. The default is to
31499use the same name as the command name but without the @samp{calc-}
31500prefix. (If this is of the form @samp{User-m}, the hyphen is removed so
31501it won't be taken for a minus sign in algebraic formulas.)
31502This is the name you will use if you want to enter your
d7b8e6c6
EZ
31503new function in an algebraic formula. Suppose we enter @kbd{yow @key{RET}}.
31504Then the new function can be invoked by pushing two numbers on the
31505stack and typing @kbd{z m} or @kbd{x spam}, or by entering the algebraic
a4231b04 31506formula @samp{yow(x,y)}.
d7b8e6c6
EZ
31507
31508The fourth prompt is for the function's argument list. This is used to
31509associate values on the stack with the variables that appear in the formula.
31510The default is a list of all variables which appear in the formula, sorted
31511into alphabetical order. In our case, the default would be @samp{(a b)}.
31512This means that, when the user types @kbd{z m}, the Calculator will remove
31513two numbers from the stack, substitute these numbers for @samp{a} and
31514@samp{b} (respectively) in the formula, then simplify the formula and
31515push the result on the stack. In other words, @kbd{10 @key{RET} 100 z m}
31516would replace the 10 and 100 on the stack with the number 210, which is
a4231b04
JB
31517@expr{a + 2 b} with @expr{a=10} and @expr{b=100}. Likewise, the formula
31518@samp{yow(10, 100)} will be evaluated by substituting @expr{a=10} and
31519@expr{b=100} in the definition.
d7b8e6c6
EZ
31520
31521You can rearrange the order of the names before pressing @key{RET} to
31522control which stack positions go to which variables in the formula. If
31523you remove a variable from the argument list, that variable will be left
31524in symbolic form by the command. Thus using an argument list of @samp{(b)}
31525for our function would cause @kbd{10 z m} to replace the 10 on the stack
31526with the formula @samp{a + 20}. If we had used an argument list of
31527@samp{(b a)}, the result with inputs 10 and 100 would have been 120.
31528
31529You can also put a nameless function on the stack instead of just a
31530formula, as in @samp{<a, b : a + 2 b>}. @xref{Specifying Operators}.
31531In this example, the command will be defined by the formula @samp{a + 2 b}
31532using the argument list @samp{(a b)}.
31533
31534The final prompt is a y-or-n question concerning what to do if symbolic
31535arguments are given to your function. If you answer @kbd{y}, then
31536executing @kbd{z m} (using the original argument list @samp{(a b)}) with
a4231b04 31537arguments @expr{10} and @expr{x} will leave the function in symbolic
d7b8e6c6
EZ
31538form, i.e., @samp{yow(10,x)}. On the other hand, if you answer @kbd{n},
31539then the formula will always be expanded, even for non-constant
31540arguments: @samp{10 + 2 x}. If you never plan to feed algebraic
31541formulas to your new function, it doesn't matter how you answer this
a4231b04 31542question.
d7b8e6c6
EZ
31543
31544If you answered @kbd{y} to this question you can still cause a function
31545call to be expanded by typing @kbd{a "} (@code{calc-expand-formula}).
31546Also, Calc will expand the function if necessary when you take a
31547derivative or integral or solve an equation involving the function.
31548
31549@kindex Z G
31550@pindex calc-get-user-defn
31551Once you have defined a formula on a key, you can retrieve this formula
31552with the @kbd{Z G} (@code{calc-user-define-get-defn}) command. Press a
31553key, and this command pushes the formula that was used to define that
31554key onto the stack. Actually, it pushes a nameless function that
31555specifies both the argument list and the defining formula. You will get
31556an error message if the key is undefined, or if the key was not defined
a4231b04 31557by a @kbd{Z F} command.
d7b8e6c6
EZ
31558
31559The @kbd{Z E} (@code{calc-user-define-edit}) command on a key that has
31560been defined by a formula uses a variant of the @code{calc-edit} command
33108698
JB
31561to edit the defining formula. Press @kbd{C-c C-c} to finish editing and
31562store the new formula back in the definition, or kill the buffer with
31563@kbd{C-x k} to
d7b8e6c6
EZ
31564cancel the edit. (The argument list and other properties of the
31565definition are unchanged; to adjust the argument list, you can use
31566@kbd{Z G} to grab the function onto the stack, edit with @kbd{`}, and
31567then re-execute the @kbd{Z F} command.)
31568
31569As usual, the @kbd{Z P} command records your definition permanently.
31570In this case it will permanently record all three of the relevant
31571definitions: the key, the command, and the function.
31572
31573You may find it useful to turn off the default simplifications with
31574@kbd{m O} (@code{calc-no-simplify-mode}) when entering a formula to be
31575used as a function definition. For example, the formula @samp{deriv(a^2,v)}
31576which might be used to define a new function @samp{dsqr(a,v)} will be
31577``simplified'' to 0 immediately upon entry since @code{deriv} considers
a4231b04 31578@expr{a} to be constant with respect to @expr{v}. Turning off
d7b8e6c6
EZ
31579default simplifications cures this problem: The definition will be stored
31580in symbolic form without ever activating the @code{deriv} function. Press
31581@kbd{m D} to turn the default simplifications back on afterwards.
31582
31583@node Lisp Definitions, , Algebraic Definitions, Programming
31584@section Programming with Lisp
31585
31586@noindent
31587The Calculator can be programmed quite extensively in Lisp. All you
31588do is write a normal Lisp function definition, but with @code{defmath}
31589in place of @code{defun}. This has the same form as @code{defun}, but it
31590automagically replaces calls to standard Lisp functions like @code{+} and
31591@code{zerop} with calls to the corresponding functions in Calc's own library.
31592Thus you can write natural-looking Lisp code which operates on all of the
31593standard Calculator data types. You can then use @kbd{Z D} if you wish to
31594bind your new command to a @kbd{z}-prefix key sequence. The @kbd{Z E} command
31595will not edit a Lisp-based definition.
31596
31597Emacs Lisp is described in the GNU Emacs Lisp Reference Manual. This section
31598assumes a familiarity with Lisp programming concepts; if you do not know
31599Lisp, you may find keyboard macros or rewrite rules to be an easier way
31600to program the Calculator.
31601
31602This section first discusses ways to write commands, functions, or
31603small programs to be executed inside of Calc. Then it discusses how
31604your own separate programs are able to call Calc from the outside.
31605Finally, there is a list of internal Calc functions and data structures
31606for the true Lisp enthusiast.
31607
31608@menu
31609* Defining Functions::
31610* Defining Simple Commands::
31611* Defining Stack Commands::
31612* Argument Qualifiers::
31613* Example Definitions::
31614
31615* Calling Calc from Your Programs::
31616* Internals::
31617@end menu
31618
31619@node Defining Functions, Defining Simple Commands, Lisp Definitions, Lisp Definitions
31620@subsection Defining New Functions
31621
31622@noindent
31623@findex defmath
31624The @code{defmath} function (actually a Lisp macro) is like @code{defun}
31625except that code in the body of the definition can make use of the full
31626range of Calculator data types. The prefix @samp{calcFunc-} is added
31627to the specified name to get the actual Lisp function name. As a simple
31628example,
31629
31630@example
31631(defmath myfact (n)
31632 (if (> n 0)
31633 (* n (myfact (1- n)))
31634 1))
31635@end example
31636
31637@noindent
31638This actually expands to the code,
31639
31640@example
31641(defun calcFunc-myfact (n)
31642 (if (math-posp n)
31643 (math-mul n (calcFunc-myfact (math-add n -1)))
31644 1))
31645@end example
31646
31647@noindent
31648This function can be used in algebraic expressions, e.g., @samp{myfact(5)}.
31649
31650The @samp{myfact} function as it is defined above has the bug that an
31651expression @samp{myfact(a+b)} will be simplified to 1 because the
31652formula @samp{a+b} is not considered to be @code{posp}. A robust
31653factorial function would be written along the following lines:
31654
31655@smallexample
31656(defmath myfact (n)
31657 (if (> n 0)
31658 (* n (myfact (1- n)))
31659 (if (= n 0)
31660 1
31661 nil))) ; this could be simplified as: (and (= n 0) 1)
31662@end smallexample
31663
31664If a function returns @code{nil}, it is left unsimplified by the Calculator
31665(except that its arguments will be simplified). Thus, @samp{myfact(a+1+2)}
31666will be simplified to @samp{myfact(a+3)} but no further. Beware that every
31667time the Calculator reexamines this formula it will attempt to resimplify
31668it, so your function ought to detect the returning-@code{nil} case as
31669efficiently as possible.
31670
31671The following standard Lisp functions are treated by @code{defmath}:
31672@code{+}, @code{-}, @code{*}, @code{/}, @code{%}, @code{^} or
31673@code{expt}, @code{=}, @code{<}, @code{>}, @code{<=}, @code{>=},
31674@code{/=}, @code{1+}, @code{1-}, @code{logand}, @code{logior}, @code{logxor},
31675@code{logandc2}, @code{lognot}. Also, @code{~=} is an abbreviation for
a4231b04 31676@code{math-nearly-equal}, which is useful in implementing Taylor series.
d7b8e6c6
EZ
31677
31678For other functions @var{func}, if a function by the name
31679@samp{calcFunc-@var{func}} exists it is used, otherwise if a function by the
31680name @samp{math-@var{func}} exists it is used, otherwise if @var{func} itself
31681is defined as a function it is used, otherwise @samp{calcFunc-@var{func}} is
31682used on the assumption that this is a to-be-defined math function. Also, if
31683the function name is quoted as in @samp{('integerp a)} the function name is
a4231b04 31684always used exactly as written (but not quoted).
d7b8e6c6
EZ
31685
31686Variable names have @samp{var-} prepended to them unless they appear in
31687the function's argument list or in an enclosing @code{let}, @code{let*},
31688@code{for}, or @code{foreach} form,
31689or their names already contain a @samp{-} character. Thus a reference to
a4231b04 31690@samp{foo} is the same as a reference to @samp{var-foo}.
d7b8e6c6
EZ
31691
31692A few other Lisp extensions are available in @code{defmath} definitions:
31693
31694@itemize @bullet
31695@item
31696The @code{elt} function accepts any number of index variables.
31697Note that Calc vectors are stored as Lisp lists whose first
31698element is the symbol @code{vec}; thus, @samp{(elt v 2)} yields
31699the second element of vector @code{v}, and @samp{(elt m i j)}
31700yields one element of a Calc matrix.
31701
31702@item
31703The @code{setq} function has been extended to act like the Common
31704Lisp @code{setf} function. (The name @code{setf} is recognized as
31705a synonym of @code{setq}.) Specifically, the first argument of
31706@code{setq} can be an @code{nth}, @code{elt}, @code{car}, or @code{cdr} form,
31707in which case the effect is to store into the specified
a4231b04 31708element of a list. Thus, @samp{(setq (elt m i j) x)} stores @expr{x}
d7b8e6c6
EZ
31709into one element of a matrix.
31710
31711@item
31712A @code{for} looping construct is available. For example,
31713@samp{(for ((i 0 10)) body)} executes @code{body} once for each
a4231b04
JB
31714binding of @expr{i} from zero to 10. This is like a @code{let}
31715form in that @expr{i} is temporarily bound to the loop count
d7b8e6c6
EZ
31716without disturbing its value outside the @code{for} construct.
31717Nested loops, as in @samp{(for ((i 0 10) (j 0 (1- i) 2)) body)},
a4231b04
JB
31718are also available. For each value of @expr{i} from zero to 10,
31719@expr{j} counts from 0 to @expr{i-1} in steps of two. Note that
d7b8e6c6
EZ
31720@code{for} has the same general outline as @code{let*}, except
31721that each element of the header is a list of three or four
31722things, not just two.
31723
31724@item
31725The @code{foreach} construct loops over elements of a list.
31726For example, @samp{(foreach ((x (cdr v))) body)} executes
a4231b04
JB
31727@code{body} with @expr{x} bound to each element of Calc vector
31728@expr{v} in turn. The purpose of @code{cdr} here is to skip over
d7b8e6c6
EZ
31729the initial @code{vec} symbol in the vector.
31730
31731@item
31732The @code{break} function breaks out of the innermost enclosing
31733@code{while}, @code{for}, or @code{foreach} loop. If given a
31734value, as in @samp{(break x)}, this value is returned by the
31735loop. (Lisp loops otherwise always return @code{nil}.)
31736
31737@item
31738The @code{return} function prematurely returns from the enclosing
a4231b04 31739function. For example, @samp{(return (+ x y))} returns @expr{x+y}
d7b8e6c6
EZ
31740as the value of a function. You can use @code{return} anywhere
31741inside the body of the function.
31742@end itemize
31743
31744Non-integer numbers (and extremely large integers) cannot be included
31745directly into a @code{defmath} definition. This is because the Lisp
31746reader will fail to parse them long before @code{defmath} ever gets control.
31747Instead, use the notation, @samp{:"3.1415"}. In fact, any algebraic
31748formula can go between the quotes. For example,
31749
31750@smallexample
31751(defmath sqexp (x) ; sqexp(x) == sqrt(exp(x)) == exp(x*0.5)
31752 (and (numberp x)
31753 (exp :"x * 0.5")))
31754@end smallexample
31755
31756expands to
31757
31758@smallexample
31759(defun calcFunc-sqexp (x)
31760 (and (math-numberp x)
31761 (calcFunc-exp (math-mul x '(float 5 -1)))))
31762@end smallexample
31763
31764Note the use of @code{numberp} as a guard to ensure that the argument is
31765a number first, returning @code{nil} if not. The exponential function
31766could itself have been included in the expression, if we had preferred:
31767@samp{:"exp(x * 0.5)"}. As another example, the multiplication-and-recursion
31768step of @code{myfact} could have been written
31769
31770@example
31771:"n * myfact(n-1)"
31772@end example
31773
3b846359
JB
31774A good place to put your @code{defmath} commands is your Calc init file
31775(the file given by @code{calc-settings-file}, typically
31776@file{~/.calc.el}), which will not be loaded until Calc starts.
d7b8e6c6
EZ
31777If a file named @file{.emacs} exists in your home directory, Emacs reads
31778and executes the Lisp forms in this file as it starts up. While it may
3b846359 31779seem reasonable to put your favorite @code{defmath} commands there,
d7b8e6c6
EZ
31780this has the unfortunate side-effect that parts of the Calculator must be
31781loaded in to process the @code{defmath} commands whether or not you will
3b846359
JB
31782actually use the Calculator! If you want to put the @code{defmath}
31783commands there (for example, if you redefine @code{calc-settings-file}
31784to be @file{.emacs}), a better effect can be had by writing
d7b8e6c6
EZ
31785
31786@example
31787(put 'calc-define 'thing '(progn
31788 (defmath ... )
31789 (defmath ... )
31790))
31791@end example
31792
31793@noindent
31794@vindex calc-define
31795The @code{put} function adds a @dfn{property} to a symbol. Each Lisp
31796symbol has a list of properties associated with it. Here we add a
31797property with a name of @code{thing} and a @samp{(progn ...)} form as
31798its value. When Calc starts up, and at the start of every Calc command,
31799the property list for the symbol @code{calc-define} is checked and the
31800values of any properties found are evaluated as Lisp forms. The
31801properties are removed as they are evaluated. The property names
31802(like @code{thing}) are not used; you should choose something like the
31803name of your project so as not to conflict with other properties.
31804
31805The net effect is that you can put the above code in your @file{.emacs}
31806file and it will not be executed until Calc is loaded. Or, you can put
31807that same code in another file which you load by hand either before or
31808after Calc itself is loaded.
31809
31810The properties of @code{calc-define} are evaluated in the same order
31811that they were added. They can assume that the Calc modules @file{calc.el},
31812@file{calc-ext.el}, and @file{calc-macs.el} have been fully loaded, and
31813that the @samp{*Calculator*} buffer will be the current buffer.
31814
31815If your @code{calc-define} property only defines algebraic functions,
31816you can be sure that it will have been evaluated before Calc tries to
31817call your function, even if the file defining the property is loaded
31818after Calc is loaded. But if the property defines commands or key
31819sequences, it may not be evaluated soon enough. (Suppose it defines the
31820new command @code{tweak-calc}; the user can load your file, then type
31821@kbd{M-x tweak-calc} before Calc has had chance to do anything.) To
31822protect against this situation, you can put
31823
31824@example
31825(run-hooks 'calc-check-defines)
31826@end example
31827
31828@findex calc-check-defines
31829@noindent
31830at the end of your file. The @code{calc-check-defines} function is what
31831looks for and evaluates properties on @code{calc-define}; @code{run-hooks}
31832has the advantage that it is quietly ignored if @code{calc-check-defines}
31833is not yet defined because Calc has not yet been loaded.
31834
31835Examples of things that ought to be enclosed in a @code{calc-define}
31836property are @code{defmath} calls, @code{define-key} calls that modify
31837the Calc key map, and any calls that redefine things defined inside Calc.
31838Ordinary @code{defun}s need not be enclosed with @code{calc-define}.
31839
31840@node Defining Simple Commands, Defining Stack Commands, Defining Functions, Lisp Definitions
31841@subsection Defining New Simple Commands
31842
31843@noindent
31844@findex interactive
31845If a @code{defmath} form contains an @code{interactive} clause, it defines
31846a Calculator command. Actually such a @code{defmath} results in @emph{two}
31847function definitions: One, a @samp{calcFunc-} function as was just described,
31848with the @code{interactive} clause removed. Two, a @samp{calc-} function
31849with a suitable @code{interactive} clause and some sort of wrapper to make
31850the command work in the Calc environment.
31851
31852In the simple case, the @code{interactive} clause has the same form as
31853for normal Emacs Lisp commands:
31854
31855@smallexample
31856(defmath increase-precision (delta)
31857 "Increase precision by DELTA." ; This is the "documentation string"
31858 (interactive "p") ; Register this as a M-x-able command
31859 (setq calc-internal-prec (+ calc-internal-prec delta)))
31860@end smallexample
31861
31862This expands to the pair of definitions,
31863
31864@smallexample
31865(defun calc-increase-precision (delta)
31866 "Increase precision by DELTA."
31867 (interactive "p")
31868 (calc-wrapper
31869 (setq calc-internal-prec (math-add calc-internal-prec delta))))
31870
31871(defun calcFunc-increase-precision (delta)
31872 "Increase precision by DELTA."
31873 (setq calc-internal-prec (math-add calc-internal-prec delta)))
31874@end smallexample
31875
31876@noindent
31877where in this case the latter function would never really be used! Note
31878that since the Calculator stores small integers as plain Lisp integers,
31879the @code{math-add} function will work just as well as the native
31880@code{+} even when the intent is to operate on native Lisp integers.
31881
31882@findex calc-wrapper
31883The @samp{calc-wrapper} call invokes a macro which surrounds the body of
31884the function with code that looks roughly like this:
31885
31886@smallexample
31887(let ((calc-command-flags nil))
31888 (unwind-protect
31889 (save-excursion
31890 (calc-select-buffer)
31891 @emph{body of function}
31892 @emph{renumber stack}
31893 @emph{clear} Working @emph{message})
31894 @emph{realign cursor and window}
31895 @emph{clear Inverse, Hyperbolic, and Keep Args flags}
31896 @emph{update Emacs mode line}))
31897@end smallexample
31898
31899@findex calc-select-buffer
31900The @code{calc-select-buffer} function selects the @samp{*Calculator*}
31901buffer if necessary, say, because the command was invoked from inside
31902the @samp{*Calc Trail*} window.
31903
31904@findex calc-set-command-flag
5d67986c
RS
31905You can call, for example, @code{(calc-set-command-flag 'no-align)} to
31906set the above-mentioned command flags. Calc routines recognize the
31907following command flags:
d7b8e6c6
EZ
31908
31909@table @code
31910@item renum-stack
31911Stack line numbers @samp{1:}, @samp{2:}, and so on must be renumbered
31912after this command completes. This is set by routines like
31913@code{calc-push}.
31914
31915@item clear-message
31916Calc should call @samp{(message "")} if this command completes normally
31917(to clear a ``Working@dots{}'' message out of the echo area).
31918
31919@item no-align
31920Do not move the cursor back to the @samp{.} top-of-stack marker.
31921
31922@item position-point
31923Use the variables @code{calc-position-point-line} and
31924@code{calc-position-point-column} to position the cursor after
31925this command finishes.
31926
31927@item keep-flags
31928Do not clear @code{calc-inverse-flag}, @code{calc-hyperbolic-flag},
31929and @code{calc-keep-args-flag} at the end of this command.
31930
31931@item do-edit
31932Switch to buffer @samp{*Calc Edit*} after this command.
31933
31934@item hold-trail
31935Do not move trail pointer to end of trail when something is recorded
31936there.
31937@end table
31938
31939@kindex Y
31940@kindex Y ?
31941@vindex calc-Y-help-msgs
31942Calc reserves a special prefix key, shift-@kbd{Y}, for user-written
31943extensions to Calc. There are no built-in commands that work with
31944this prefix key; you must call @code{define-key} from Lisp (probably
31945from inside a @code{calc-define} property) to add to it. Initially only
31946@kbd{Y ?} is defined; it takes help messages from a list of strings
31947(initially @code{nil}) in the variable @code{calc-Y-help-msgs}. All
31948other undefined keys except for @kbd{Y} are reserved for use by
31949future versions of Calc.
31950
31951If you are writing a Calc enhancement which you expect to give to
31952others, it is best to minimize the number of @kbd{Y}-key sequences
31953you use. In fact, if you have more than one key sequence you should
31954consider defining three-key sequences with a @kbd{Y}, then a key that
31955stands for your package, then a third key for the particular command
31956within your package.
31957
31958Users may wish to install several Calc enhancements, and it is possible
31959that several enhancements will choose to use the same key. In the
31960example below, a variable @code{inc-prec-base-key} has been defined
31961to contain the key that identifies the @code{inc-prec} package. Its
31962value is initially @code{"P"}, but a user can change this variable
31963if necessary without having to modify the file.
31964
31965Here is a complete file, @file{inc-prec.el}, which makes a @kbd{Y P I}
31966command that increases the precision, and a @kbd{Y P D} command that
31967decreases the precision.
31968
31969@smallexample
31970;;; Increase and decrease Calc precision. Dave Gillespie, 5/31/91.
31971;;; (Include copyright or copyleft stuff here.)
31972
31973(defvar inc-prec-base-key "P"
31974 "Base key for inc-prec.el commands.")
31975
31976(put 'calc-define 'inc-prec '(progn
31977
31978(define-key calc-mode-map (format "Y%sI" inc-prec-base-key)
31979 'increase-precision)
31980(define-key calc-mode-map (format "Y%sD" inc-prec-base-key)
31981 'decrease-precision)
31982
31983(setq calc-Y-help-msgs
31984 (cons (format "%s + Inc-prec, Dec-prec" inc-prec-base-key)
31985 calc-Y-help-msgs))
31986
31987(defmath increase-precision (delta)
31988 "Increase precision by DELTA."
31989 (interactive "p")
31990 (setq calc-internal-prec (+ calc-internal-prec delta)))
31991
31992(defmath decrease-precision (delta)
31993 "Decrease precision by DELTA."
31994 (interactive "p")
31995 (setq calc-internal-prec (- calc-internal-prec delta)))
31996
31997)) ; end of calc-define property
31998
31999(run-hooks 'calc-check-defines)
32000@end smallexample
32001
32002@node Defining Stack Commands, Argument Qualifiers, Defining Simple Commands, Lisp Definitions
32003@subsection Defining New Stack-Based Commands
32004
32005@noindent
32006To define a new computational command which takes and/or leaves arguments
32007on the stack, a special form of @code{interactive} clause is used.
32008
32009@example
32010(interactive @var{num} @var{tag})
32011@end example
32012
32013@noindent
32014where @var{num} is an integer, and @var{tag} is a string. The effect is
32015to pop @var{num} values off the stack, resimplify them by calling
32016@code{calc-normalize}, and hand them to your function according to the
32017function's argument list. Your function may include @code{&optional} and
32018@code{&rest} parameters, so long as calling the function with @var{num}
2cbd16b9 32019parameters is valid.
d7b8e6c6
EZ
32020
32021Your function must return either a number or a formula in a form
32022acceptable to Calc, or a list of such numbers or formulas. These value(s)
32023are pushed onto the stack when the function completes. They are also
32024recorded in the Calc Trail buffer on a line beginning with @var{tag},
32025a string of (normally) four characters or less. If you omit @var{tag}
32026or use @code{nil} as a tag, the result is not recorded in the trail.
32027
32028As an example, the definition
32029
32030@smallexample
32031(defmath myfact (n)
32032 "Compute the factorial of the integer at the top of the stack."
32033 (interactive 1 "fact")
32034 (if (> n 0)
32035 (* n (myfact (1- n)))
32036 (and (= n 0) 1)))
32037@end smallexample
32038
32039@noindent
32040is a version of the factorial function shown previously which can be used
32041as a command as well as an algebraic function. It expands to
32042
32043@smallexample
32044(defun calc-myfact ()
32045 "Compute the factorial of the integer at the top of the stack."
32046 (interactive)
32047 (calc-slow-wrapper
32048 (calc-enter-result 1 "fact"
32049 (cons 'calcFunc-myfact (calc-top-list-n 1)))))
32050
32051(defun calcFunc-myfact (n)
32052 "Compute the factorial of the integer at the top of the stack."
32053 (if (math-posp n)
32054 (math-mul n (calcFunc-myfact (math-add n -1)))
32055 (and (math-zerop n) 1)))
32056@end smallexample
32057
32058@findex calc-slow-wrapper
32059The @code{calc-slow-wrapper} function is a version of @code{calc-wrapper}
32060that automatically puts up a @samp{Working...} message before the
32061computation begins. (This message can be turned off by the user
32062with an @kbd{m w} (@code{calc-working}) command.)
32063
32064@findex calc-top-list-n
32065The @code{calc-top-list-n} function returns a list of the specified number
32066of values from the top of the stack. It resimplifies each value by
32067calling @code{calc-normalize}. If its argument is zero it returns an
32068empty list. It does not actually remove these values from the stack.
32069
32070@findex calc-enter-result
32071The @code{calc-enter-result} function takes an integer @var{num} and string
32072@var{tag} as described above, plus a third argument which is either a
32073Calculator data object or a list of such objects. These objects are
32074resimplified and pushed onto the stack after popping the specified number
32075of values from the stack. If @var{tag} is non-@code{nil}, the values
32076being pushed are also recorded in the trail.
32077
32078Note that if @code{calcFunc-myfact} returns @code{nil} this represents
32079``leave the function in symbolic form.'' To return an actual empty list,
32080in the sense that @code{calc-enter-result} will push zero elements back
32081onto the stack, you should return the special value @samp{'(nil)}, a list
32082containing the single symbol @code{nil}.
32083
32084The @code{interactive} declaration can actually contain a limited
32085Emacs-style code string as well which comes just before @var{num} and
32086@var{tag}. Currently the only Emacs code supported is @samp{"p"}, as in
32087
32088@example
32089(defmath foo (a b &optional c)
32090 (interactive "p" 2 "foo")
32091 @var{body})
32092@end example
32093
32094In this example, the command @code{calc-foo} will evaluate the expression
32095@samp{foo(a,b)} if executed with no argument, or @samp{foo(a,b,n)} if
a4231b04 32096executed with a numeric prefix argument of @expr{n}.
d7b8e6c6
EZ
32097
32098The other code string allowed is @samp{"m"} (unrelated to the usual @samp{"m"}
32099code as used with @code{defun}). It uses the numeric prefix argument as the
32100number of objects to remove from the stack and pass to the function.
32101In this case, the integer @var{num} serves as a default number of
32102arguments to be used when no prefix is supplied.
32103
32104@node Argument Qualifiers, Example Definitions, Defining Stack Commands, Lisp Definitions
32105@subsection Argument Qualifiers
32106
32107@noindent
32108Anywhere a parameter name can appear in the parameter list you can also use
32109an @dfn{argument qualifier}. Thus the general form of a definition is:
32110
32111@example
32112(defmath @var{name} (@var{param} @var{param...}
32113 &optional @var{param} @var{param...}
32114 &rest @var{param})
32115 @var{body})
32116@end example
32117
32118@noindent
32119where each @var{param} is either a symbol or a list of the form
32120
32121@example
32122(@var{qual} @var{param})
32123@end example
32124
32125The following qualifiers are recognized:
32126
32127@table @samp
32128@item complete
32129@findex complete
32130The argument must not be an incomplete vector, interval, or complex number.
32131(This is rarely needed since the Calculator itself will never call your
32132function with an incomplete argument. But there is nothing stopping your
a4231b04 32133own Lisp code from calling your function with an incomplete argument.)
d7b8e6c6
EZ
32134
32135@item integer
32136@findex integer
32137The argument must be an integer. If it is an integer-valued float
32138it will be accepted but converted to integer form. Non-integers and
32139formulas are rejected.
32140
32141@item natnum
32142@findex natnum
32143Like @samp{integer}, but the argument must be non-negative.
32144
32145@item fixnum
32146@findex fixnum
32147Like @samp{integer}, but the argument must fit into a native Lisp integer,
32148which on most systems means less than 2^23 in absolute value. The
32149argument is converted into Lisp-integer form if necessary.
32150
32151@item float
32152@findex float
32153The argument is converted to floating-point format if it is a number or
32154vector. If it is a formula it is left alone. (The argument is never
32155actually rejected by this qualifier.)
32156
32157@item @var{pred}
32158The argument must satisfy predicate @var{pred}, which is one of the
32159standard Calculator predicates. @xref{Predicates}.
32160
32161@item not-@var{pred}
32162The argument must @emph{not} satisfy predicate @var{pred}.
32163@end table
32164
32165For example,
32166
32167@example
32168(defmath foo (a (constp (not-matrixp b)) &optional (float c)
32169 &rest (integer d))
32170 @var{body})
32171@end example
32172
32173@noindent
32174expands to
32175
32176@example
32177(defun calcFunc-foo (a b &optional c &rest d)
32178 (and (math-matrixp b)
32179 (math-reject-arg b 'not-matrixp))
32180 (or (math-constp b)
32181 (math-reject-arg b 'constp))
32182 (and c (setq c (math-check-float c)))
32183 (setq d (mapcar 'math-check-integer d))
32184 @var{body})
32185@end example
32186
32187@noindent
32188which performs the necessary checks and conversions before executing the
32189body of the function.
32190
32191@node Example Definitions, Calling Calc from Your Programs, Argument Qualifiers, Lisp Definitions
32192@subsection Example Definitions
32193
32194@noindent
32195This section includes some Lisp programming examples on a larger scale.
32196These programs make use of some of the Calculator's internal functions;
32197@pxref{Internals}.
32198
32199@menu
32200* Bit Counting Example::
32201* Sine Example::
32202@end menu
32203
32204@node Bit Counting Example, Sine Example, Example Definitions, Example Definitions
32205@subsubsection Bit-Counting
32206
32207@noindent
5d67986c
RS
32208@ignore
32209@starindex
32210@end ignore
d7b8e6c6
EZ
32211@tindex bcount
32212Calc does not include a built-in function for counting the number of
32213``one'' bits in a binary integer. It's easy to invent one using @kbd{b u}
32214to convert the integer to a set, and @kbd{V #} to count the elements of
32215that set; let's write a function that counts the bits without having to
32216create an intermediate set.
32217
32218@smallexample
32219(defmath bcount ((natnum n))
32220 (interactive 1 "bcnt")
32221 (let ((count 0))
32222 (while (> n 0)
32223 (if (oddp n)
32224 (setq count (1+ count)))
32225 (setq n (lsh n -1)))
32226 count))
32227@end smallexample
32228
32229@noindent
32230When this is expanded by @code{defmath}, it will become the following
32231Emacs Lisp function:
32232
32233@smallexample
32234(defun calcFunc-bcount (n)
32235 (setq n (math-check-natnum n))
32236 (let ((count 0))
32237 (while (math-posp n)
32238 (if (math-oddp n)
32239 (setq count (math-add count 1)))
32240 (setq n (calcFunc-lsh n -1)))
32241 count))
32242@end smallexample
32243
32244If the input numbers are large, this function involves a fair amount
32245of arithmetic. A binary right shift is essentially a division by two;
32246recall that Calc stores integers in decimal form so bit shifts must
32247involve actual division.
32248
32249To gain a bit more efficiency, we could divide the integer into
5d67986c 32250@var{n}-bit chunks, each of which can be handled quickly because
d7b8e6c6
EZ
32251they fit into Lisp integers. It turns out that Calc's arithmetic
32252routines are especially fast when dividing by an integer less than
5d67986c 322531000, so we can set @var{n = 9} bits and use repeated division by 512:
d7b8e6c6
EZ
32254
32255@smallexample
32256(defmath bcount ((natnum n))
32257 (interactive 1 "bcnt")
32258 (let ((count 0))
32259 (while (not (fixnump n))
32260 (let ((qr (idivmod n 512)))
32261 (setq count (+ count (bcount-fixnum (cdr qr)))
32262 n (car qr))))
32263 (+ count (bcount-fixnum n))))
32264
32265(defun bcount-fixnum (n)
32266 (let ((count 0))
32267 (while (> n 0)
32268 (setq count (+ count (logand n 1))
32269 n (lsh n -1)))
32270 count))
32271@end smallexample
32272
32273@noindent
32274Note that the second function uses @code{defun}, not @code{defmath}.
32275Because this function deals only with native Lisp integers (``fixnums''),
32276it can use the actual Emacs @code{+} and related functions rather
32277than the slower but more general Calc equivalents which @code{defmath}
32278uses.
32279
32280The @code{idivmod} function does an integer division, returning both
32281the quotient and the remainder at once. Again, note that while it
32282might seem that @samp{(logand n 511)} and @samp{(lsh n -9)} are
32283more efficient ways to split off the bottom nine bits of @code{n},
32284actually they are less efficient because each operation is really
32285a division by 512 in disguise; @code{idivmod} allows us to do the
32286same thing with a single division by 512.
32287
32288@node Sine Example, , Bit Counting Example, Example Definitions
32289@subsubsection The Sine Function
32290
32291@noindent
5d67986c
RS
32292@ignore
32293@starindex
32294@end ignore
d7b8e6c6
EZ
32295@tindex mysin
32296A somewhat limited sine function could be defined as follows, using the
a4231b04 32297well-known Taylor series expansion for
8e04863e 32298@texline @math{\sin x}:
a4231b04 32299@infoline @samp{sin(x)}:
d7b8e6c6
EZ
32300
32301@smallexample
32302(defmath mysin ((float (anglep x)))
32303 (interactive 1 "mysn")
32304 (setq x (to-radians x)) ; Convert from current angular mode.
32305 (let ((sum x) ; Initial term of Taylor expansion of sin.
32306 newsum
32307 (nfact 1) ; "nfact" equals "n" factorial at all times.
32308 (xnegsqr :"-(x^2)")) ; "xnegsqr" equals -x^2.
32309 (for ((n 3 100 2)) ; Upper limit of 100 is a good precaution.
32310 (working "mysin" sum) ; Display "Working" message, if enabled.
32311 (setq nfact (* nfact (1- n) n)
32312 x (* x xnegsqr)
32313 newsum (+ sum (/ x nfact)))
32314 (if (~= newsum sum) ; If newsum is "nearly equal to" sum,
32315 (break)) ; then we are done.
32316 (setq sum newsum))
32317 sum))
32318@end smallexample
32319
32320The actual @code{sin} function in Calc works by first reducing the problem
a4231b04 32321to a sine or cosine of a nonnegative number less than @cpiover{4}. This
d7b8e6c6
EZ
32322ensures that the Taylor series will converge quickly. Also, the calculation
32323is carried out with two extra digits of precision to guard against cumulative
32324round-off in @samp{sum}. Finally, complex arguments are allowed and handled
32325by a separate algorithm.
32326
32327@smallexample
32328(defmath mysin ((float (scalarp x)))
32329 (interactive 1 "mysn")
32330 (setq x (to-radians x)) ; Convert from current angular mode.
32331 (with-extra-prec 2 ; Evaluate with extra precision.
32332 (cond ((complexp x)
32333 (mysin-complex x))
32334 ((< x 0)
32335 (- (mysin-raw (- x))) ; Always call mysin-raw with x >= 0.
32336 (t (mysin-raw x))))))
32337
32338(defmath mysin-raw (x)
32339 (cond ((>= x 7)
32340 (mysin-raw (% x (two-pi)))) ; Now x < 7.
32341 ((> x (pi-over-2))
32342 (- (mysin-raw (- x (pi))))) ; Now -pi/2 <= x <= pi/2.
32343 ((> x (pi-over-4))
32344 (mycos-raw (- x (pi-over-2)))) ; Now -pi/2 <= x <= pi/4.
32345 ((< x (- (pi-over-4)))
32346 (- (mycos-raw (+ x (pi-over-2))))) ; Now -pi/4 <= x <= pi/4,
32347 (t (mysin-series x)))) ; so the series will be efficient.
32348@end smallexample
32349
32350@noindent
32351where @code{mysin-complex} is an appropriate function to handle complex
32352numbers, @code{mysin-series} is the routine to compute the sine Taylor
32353series as before, and @code{mycos-raw} is a function analogous to
32354@code{mysin-raw} for cosines.
32355
a4231b04 32356The strategy is to ensure that @expr{x} is nonnegative before calling
d7b8e6c6 32357@code{mysin-raw}. This function then recursively reduces its argument
a4231b04 32358to a suitable range, namely, plus-or-minus @cpiover{4}. Note that each
d7b8e6c6 32359test, and particularly the first comparison against 7, is designed so
28665d46 32360that small roundoff errors cannot produce an infinite loop. (Suppose
d7b8e6c6
EZ
32361we compared with @samp{(two-pi)} instead; if due to roundoff problems
32362the modulo operator ever returned @samp{(two-pi)} exactly, an infinite
32363recursion could result!) We use modulo only for arguments that will
32364clearly get reduced, knowing that the next rule will catch any reductions
32365that this rule misses.
32366
32367If a program is being written for general use, it is important to code
32368it carefully as shown in this second example. For quick-and-dirty programs,
32369when you know that your own use of the sine function will never encounter
32370a large argument, a simpler program like the first one shown is fine.
32371
32372@node Calling Calc from Your Programs, Internals, Example Definitions, Lisp Definitions
32373@subsection Calling Calc from Your Lisp Programs
32374
32375@noindent
32376A later section (@pxref{Internals}) gives a full description of
32377Calc's internal Lisp functions. It's not hard to call Calc from
32378inside your programs, but the number of these functions can be daunting.
32379So Calc provides one special ``programmer-friendly'' function called
32380@code{calc-eval} that can be made to do just about everything you
32381need. It's not as fast as the low-level Calc functions, but it's
32382much simpler to use!
32383
32384It may seem that @code{calc-eval} itself has a daunting number of
32385options, but they all stem from one simple operation.
32386
32387In its simplest manifestation, @samp{(calc-eval "1+2")} parses the
32388string @code{"1+2"} as if it were a Calc algebraic entry and returns
32389the result formatted as a string: @code{"3"}.
32390
32391Since @code{calc-eval} is on the list of recommended @code{autoload}
32392functions, you don't need to make any special preparations to load
32393Calc before calling @code{calc-eval} the first time. Calc will be
32394loaded and initialized for you.
32395
32396All the Calc modes that are currently in effect will be used when
32397evaluating the expression and formatting the result.
32398
32399@ifinfo
32400@example
32401
32402@end example
32403@end ifinfo
32404@subsubsection Additional Arguments to @code{calc-eval}
32405
32406@noindent
32407If the input string parses to a list of expressions, Calc returns
32408the results separated by @code{", "}. You can specify a different
32409separator by giving a second string argument to @code{calc-eval}:
32410@samp{(calc-eval "1+2,3+4" ";")} returns @code{"3;7"}.
32411
32412The ``separator'' can also be any of several Lisp symbols which
32413request other behaviors from @code{calc-eval}. These are discussed
32414one by one below.
32415
32416You can give additional arguments to be substituted for
32417@samp{$}, @samp{$$}, and so on in the main expression. For
32418example, @samp{(calc-eval "$/$$" nil "7" "1+1")} evaluates the
32419expression @code{"7/(1+1)"} to yield the result @code{"3.5"}
32420(assuming Fraction mode is not in effect). Note the @code{nil}
32421used as a placeholder for the item-separator argument.
32422
32423@ifinfo
32424@example
32425
32426@end example
32427@end ifinfo
32428@subsubsection Error Handling
32429
32430@noindent
32431If @code{calc-eval} encounters an error, it returns a list containing
32432the character position of the error, plus a suitable message as a
32433string. Note that @samp{1 / 0} is @emph{not} an error by Calc's
32434standards; it simply returns the string @code{"1 / 0"} which is the
32435division left in symbolic form. But @samp{(calc-eval "1/")} will
32436return the list @samp{(2 "Expected a number")}.
32437
32438If you bind the variable @code{calc-eval-error} to @code{t}
32439using a @code{let} form surrounding the call to @code{calc-eval},
32440errors instead call the Emacs @code{error} function which aborts
32441to the Emacs command loop with a beep and an error message.
32442
32443If you bind this variable to the symbol @code{string}, error messages
32444are returned as strings instead of lists. The character position is
32445ignored.
32446
32447As a courtesy to other Lisp code which may be using Calc, be sure
32448to bind @code{calc-eval-error} using @code{let} rather than changing
32449it permanently with @code{setq}.
32450
32451@ifinfo
32452@example
32453
32454@end example
32455@end ifinfo
32456@subsubsection Numbers Only
32457
32458@noindent
32459Sometimes it is preferable to treat @samp{1 / 0} as an error
32460rather than returning a symbolic result. If you pass the symbol
32461@code{num} as the second argument to @code{calc-eval}, results
32462that are not constants are treated as errors. The error message
32463reported is the first @code{calc-why} message if there is one,
32464or otherwise ``Number expected.''
32465
32466A result is ``constant'' if it is a number, vector, or other
32467object that does not include variables or function calls. If it
32468is a vector, the components must themselves be constants.
32469
32470@ifinfo
32471@example
32472
32473@end example
32474@end ifinfo
32475@subsubsection Default Modes
32476
32477@noindent
32478If the first argument to @code{calc-eval} is a list whose first
32479element is a formula string, then @code{calc-eval} sets all the
32480various Calc modes to their default values while the formula is
32481evaluated and formatted. For example, the precision is set to 12
07ce2eb3 32482digits, digit grouping is turned off, and the Normal language
d7b8e6c6
EZ
32483mode is used.
32484
32485This same principle applies to the other options discussed below.
32486If the first argument would normally be @var{x}, then it can also
32487be the list @samp{(@var{x})} to use the default mode settings.
32488
32489If there are other elements in the list, they are taken as
32490variable-name/value pairs which override the default mode
32491settings. Look at the documentation at the front of the
32492@file{calc.el} file to find the names of the Lisp variables for
32493the various modes. The mode settings are restored to their
32494original values when @code{calc-eval} is done.
32495
32496For example, @samp{(calc-eval '("$+$$" calc-internal-prec 8) 'num a b)}
32497computes the sum of two numbers, requiring a numeric result, and
32498using default mode settings except that the precision is 8 instead
32499of the default of 12.
32500
32501It's usually best to use this form of @code{calc-eval} unless your
32502program actually considers the interaction with Calc's mode settings
32503to be a feature. This will avoid all sorts of potential ``gotchas'';
32504consider what happens with @samp{(calc-eval "sqrt(2)" 'num)}
07ce2eb3 32505when the user has left Calc in Symbolic mode or No-Simplify mode.
d7b8e6c6
EZ
32506
32507As another example, @samp{(equal (calc-eval '("$<$$") nil a b) "1")}
a4231b04
JB
32508checks if the number in string @expr{a} is less than the one in
32509string @expr{b}. Without using a list, the integer 1 might
d7b8e6c6
EZ
32510come out in a variety of formats which would be hard to test for
32511conveniently: @code{"1"}, @code{"8#1"}, @code{"00001"}. (But
32512see ``Predicates'' mode, below.)
32513
32514@ifinfo
32515@example
32516
32517@end example
32518@end ifinfo
32519@subsubsection Raw Numbers
32520
32521@noindent
32522Normally all input and output for @code{calc-eval} is done with strings.
32523You can do arithmetic with, say, @samp{(calc-eval "$+$$" nil a b)}
32524in place of @samp{(+ a b)}, but this is very inefficient since the
32525numbers must be converted to and from string format as they are passed
32526from one @code{calc-eval} to the next.
32527
32528If the separator is the symbol @code{raw}, the result will be returned
32529as a raw Calc data structure rather than a string. You can read about
32530how these objects look in the following sections, but usually you can
32531treat them as ``black box'' objects with no important internal
32532structure.
32533
32534There is also a @code{rawnum} symbol, which is a combination of
28665d46 32535@code{raw} (returning a raw Calc object) and @code{num} (signaling
d7b8e6c6
EZ
32536an error if that object is not a constant).
32537
32538You can pass a raw Calc object to @code{calc-eval} in place of a
32539string, either as the formula itself or as one of the @samp{$}
32540arguments. Thus @samp{(calc-eval "$+$$" 'raw a b)} is an
32541addition function that operates on raw Calc objects. Of course
32542in this case it would be easier to call the low-level @code{math-add}
32543function in Calc, if you can remember its name.
32544
32545In particular, note that a plain Lisp integer is acceptable to Calc
32546as a raw object. (All Lisp integers are accepted on input, but
32547integers of more than six decimal digits are converted to ``big-integer''
32548form for output. @xref{Data Type Formats}.)
32549
32550When it comes time to display the object, just use @samp{(calc-eval a)}
32551to format it as a string.
32552
32553It is an error if the input expression evaluates to a list of
32554values. The separator symbol @code{list} is like @code{raw}
32555except that it returns a list of one or more raw Calc objects.
32556
32557Note that a Lisp string is not a valid Calc object, nor is a list
32558containing a string. Thus you can still safely distinguish all the
32559various kinds of error returns discussed above.
32560
32561@ifinfo
32562@example
32563
32564@end example
32565@end ifinfo
32566@subsubsection Predicates
32567
32568@noindent
32569If the separator symbol is @code{pred}, the result of the formula is
32570treated as a true/false value; @code{calc-eval} returns @code{t} or
32571@code{nil}, respectively. A value is considered ``true'' if it is a
32572non-zero number, or false if it is zero or if it is not a number.
32573
32574For example, @samp{(calc-eval "$<$$" 'pred a b)} tests whether
32575one value is less than another.
32576
32577As usual, it is also possible for @code{calc-eval} to return one of
32578the error indicators described above. Lisp will interpret such an
32579indicator as ``true'' if you don't check for it explicitly. If you
32580wish to have an error register as ``false'', use something like
32581@samp{(eq (calc-eval ...) t)}.
32582
32583@ifinfo
32584@example
32585
32586@end example
32587@end ifinfo
32588@subsubsection Variable Values
32589
32590@noindent
32591Variables in the formula passed to @code{calc-eval} are not normally
32592replaced by their values. If you wish this, you can use the
32593@code{evalv} function (@pxref{Algebraic Manipulation}). For example,
32594if 4 is stored in Calc variable @code{a} (i.e., in Lisp variable
32595@code{var-a}), then @samp{(calc-eval "a+pi")} will return the
32596formula @code{"a + pi"}, but @samp{(calc-eval "evalv(a+pi)")}
32597will return @code{"7.14159265359"}.
32598
32599To store in a Calc variable, just use @code{setq} to store in the
32600corresponding Lisp variable. (This is obtained by prepending
32601@samp{var-} to the Calc variable name.) Calc routines will
32602understand either string or raw form values stored in variables,
32603although raw data objects are much more efficient. For example,
32604to increment the Calc variable @code{a}:
32605
32606@example
32607(setq var-a (calc-eval "evalv(a+1)" 'raw))
32608@end example
32609
32610@ifinfo
32611@example
32612
32613@end example
32614@end ifinfo
32615@subsubsection Stack Access
32616
32617@noindent
32618If the separator symbol is @code{push}, the formula argument is
32619evaluated (with possible @samp{$} expansions, as usual). The
32620result is pushed onto the Calc stack. The return value is @code{nil}
32621(unless there is an error from evaluating the formula, in which
32622case the return value depends on @code{calc-eval-error} in the
32623usual way).
32624
32625If the separator symbol is @code{pop}, the first argument to
32626@code{calc-eval} must be an integer instead of a string. That
32627many values are popped from the stack and thrown away. A negative
32628argument deletes the entry at that stack level. The return value
32629is the number of elements remaining in the stack after popping;
32630@samp{(calc-eval 0 'pop)} is a good way to measure the size of
32631the stack.
32632
32633If the separator symbol is @code{top}, the first argument to
32634@code{calc-eval} must again be an integer. The value at that
32635stack level is formatted as a string and returned. Thus
32636@samp{(calc-eval 1 'top)} returns the top-of-stack value. If the
32637integer is out of range, @code{nil} is returned.
32638
32639The separator symbol @code{rawtop} is just like @code{top} except
32640that the stack entry is returned as a raw Calc object instead of
32641as a string.
32642
32643In all of these cases the first argument can be made a list in
32644order to force the default mode settings, as described above.
32645Thus @samp{(calc-eval '(2 calc-number-radix 16) 'top)} returns the
32646second-to-top stack entry, formatted as a string using the default
32647instead of current display modes, except that the radix is
32648hexadecimal instead of decimal.
32649
32650It is, of course, polite to put the Calc stack back the way you
32651found it when you are done, unless the user of your program is
32652actually expecting it to affect the stack.
32653
32654Note that you do not actually have to switch into the @samp{*Calculator*}
32655buffer in order to use @code{calc-eval}; it temporarily switches into
32656the stack buffer if necessary.
32657
32658@ifinfo
32659@example
32660
32661@end example
32662@end ifinfo
32663@subsubsection Keyboard Macros
32664
32665@noindent
32666If the separator symbol is @code{macro}, the first argument must be a
32667string of characters which Calc can execute as a sequence of keystrokes.
32668This switches into the Calc buffer for the duration of the macro.
32669For example, @samp{(calc-eval "vx5\rVR+" 'macro)} pushes the
32670vector @samp{[1,2,3,4,5]} on the stack and then replaces it
32671with the sum of those numbers. Note that @samp{\r} is the Lisp
32672notation for the carriage-return, @key{RET}, character.
32673
32674If your keyboard macro wishes to pop the stack, @samp{\C-d} is
32675safer than @samp{\177} (the @key{DEL} character) because some
32676installations may have switched the meanings of @key{DEL} and
32677@kbd{C-h}. Calc always interprets @kbd{C-d} as a synonym for
32678``pop-stack'' regardless of key mapping.
32679
32680If you provide a third argument to @code{calc-eval}, evaluation
32681of the keyboard macro will leave a record in the Trail using
32682that argument as a tag string. Normally the Trail is unaffected.
32683
32684The return value in this case is always @code{nil}.
32685
32686@ifinfo
32687@example
32688
32689@end example
32690@end ifinfo
32691@subsubsection Lisp Evaluation
32692
32693@noindent
32694Finally, if the separator symbol is @code{eval}, then the Lisp
32695@code{eval} function is called on the first argument, which must
32696be a Lisp expression rather than a Calc formula. Remember to
32697quote the expression so that it is not evaluated until inside
32698@code{calc-eval}.
32699
32700The difference from plain @code{eval} is that @code{calc-eval}
32701switches to the Calc buffer before evaluating the expression.
32702For example, @samp{(calc-eval '(setq calc-internal-prec 17) 'eval)}
32703will correctly affect the buffer-local Calc precision variable.
32704
32705An alternative would be @samp{(calc-eval '(calc-precision 17) 'eval)}.
32706This is evaluating a call to the function that is normally invoked
32707by the @kbd{p} key, giving it 17 as its ``numeric prefix argument.''
32708Note that this function will leave a message in the echo area as
32709a side effect. Also, all Calc functions switch to the Calc buffer
32710automatically if not invoked from there, so the above call is
32711also equivalent to @samp{(calc-precision 17)} by itself.
32712In all cases, Calc uses @code{save-excursion} to switch back to
32713your original buffer when it is done.
32714
32715As usual the first argument can be a list that begins with a Lisp
32716expression to use default instead of current mode settings.
32717
32718The result of @code{calc-eval} in this usage is just the result
32719returned by the evaluated Lisp expression.
32720
32721@ifinfo
32722@example
32723
32724@end example
32725@end ifinfo
32726@subsubsection Example
32727
32728@noindent
32729@findex convert-temp
32730Here is a sample Emacs command that uses @code{calc-eval}. Suppose
32731you have a document with lots of references to temperatures on the
32732Fahrenheit scale, say ``98.6 F'', and you wish to convert these
32733references to Centigrade. The following command does this conversion.
32734Place the Emacs cursor right after the letter ``F'' and invoke the
32735command to change ``98.6 F'' to ``37 C''. Or, if the temperature is
32736already in Centigrade form, the command changes it back to Fahrenheit.
32737
32738@example
32739(defun convert-temp ()
32740 (interactive)
32741 (save-excursion
32742 (re-search-backward "[^-.0-9]\\([-.0-9]+\\) *\\([FC]\\)")
32743 (let* ((top1 (match-beginning 1))
32744 (bot1 (match-end 1))
32745 (number (buffer-substring top1 bot1))
32746 (top2 (match-beginning 2))
32747 (bot2 (match-end 2))
32748 (type (buffer-substring top2 bot2)))
32749 (if (equal type "F")
32750 (setq type "C"
32751 number (calc-eval "($ - 32)*5/9" nil number))
32752 (setq type "F"
32753 number (calc-eval "$*9/5 + 32" nil number)))
32754 (goto-char top2)
32755 (delete-region top2 bot2)
32756 (insert-before-markers type)
32757 (goto-char top1)
32758 (delete-region top1 bot1)
32759 (if (string-match "\\.$" number) ; change "37." to "37"
32760 (setq number (substring number 0 -1)))
32761 (insert number))))
32762@end example
32763
32764Note the use of @code{insert-before-markers} when changing between
32765``F'' and ``C'', so that the character winds up before the cursor
32766instead of after it.
32767
32768@node Internals, , Calling Calc from Your Programs, Lisp Definitions
32769@subsection Calculator Internals
32770
32771@noindent
32772This section describes the Lisp functions defined by the Calculator that
32773may be of use to user-written Calculator programs (as described in the
32774rest of this chapter). These functions are shown by their names as they
32775conventionally appear in @code{defmath}. Their full Lisp names are
32776generally gotten by prepending @samp{calcFunc-} or @samp{math-} to their
32777apparent names. (Names that begin with @samp{calc-} are already in
32778their full Lisp form.) You can use the actual full names instead if you
32779prefer them, or if you are calling these functions from regular Lisp.
32780
32781The functions described here are scattered throughout the various
32782Calc component files. Note that @file{calc.el} includes @code{autoload}s
32783for only a few component files; when Calc wants to call an advanced
32784function it calls @samp{(calc-extensions)} first; this function
32785autoloads @file{calc-ext.el}, which in turn autoloads all the functions
32786in the remaining component files.
32787
32788Because @code{defmath} itself uses the extensions, user-written code
32789generally always executes with the extensions already loaded, so
32790normally you can use any Calc function and be confident that it will
32791be autoloaded for you when necessary. If you are doing something
32792special, check carefully to make sure each function you are using is
32793from @file{calc.el} or its components, and call @samp{(calc-extensions)}
32794before using any function based in @file{calc-ext.el} if you can't
32795prove this file will already be loaded.
32796
32797@menu
32798* Data Type Formats::
32799* Interactive Lisp Functions::
32800* Stack Lisp Functions::
32801* Predicates::
32802* Computational Lisp Functions::
32803* Vector Lisp Functions::
32804* Symbolic Lisp Functions::
32805* Formatting Lisp Functions::
32806* Hooks::
32807@end menu
32808
32809@node Data Type Formats, Interactive Lisp Functions, Internals, Internals
32810@subsubsection Data Type Formats
32811
32812@noindent
32813Integers are stored in either of two ways, depending on their magnitude.
32814Integers less than one million in absolute value are stored as standard
32815Lisp integers. This is the only storage format for Calc data objects
32816which is not a Lisp list.
32817
32818Large integers are stored as lists of the form @samp{(bigpos @var{d0}
32819@var{d1} @var{d2} @dots{})} for positive integers 1000000 or more, or
32820@samp{(bigneg @var{d0} @var{d1} @var{d2} @dots{})} for negative integers
8e04863e 32821@mathit{-1000000} or less. Each @var{d} is a base-1000 ``digit,'' a Lisp integer
d7b8e6c6
EZ
32822from 0 to 999. The least significant digit is @var{d0}; the last digit,
32823@var{dn}, which is always nonzero, is the most significant digit. For
8e04863e 32824example, the integer @mathit{-12345678} is stored as @samp{(bigneg 678 345 12)}.
d7b8e6c6
EZ
32825
32826The distinction between small and large integers is entirely hidden from
32827the user. In @code{defmath} definitions, the Lisp predicate @code{integerp}
32828returns true for either kind of integer, and in general both big and small
32829integers are accepted anywhere the word ``integer'' is used in this manual.
32830If the distinction must be made, native Lisp integers are called @dfn{fixnums}
32831and large integers are called @dfn{bignums}.
32832
32833Fractions are stored as a list of the form, @samp{(frac @var{n} @var{d})}
32834where @var{n} is an integer (big or small) numerator, @var{d} is an
32835integer denominator greater than one, and @var{n} and @var{d} are relatively
32836prime. Note that fractions where @var{d} is one are automatically converted
32837to plain integers by all math routines; fractions where @var{d} is negative
32838are normalized by negating the numerator and denominator.
32839
32840Floating-point numbers are stored in the form, @samp{(float @var{mant}
32841@var{exp})}, where @var{mant} (the ``mantissa'') is an integer less than
32842@samp{10^@var{p}} in absolute value (@var{p} represents the current
32843precision), and @var{exp} (the ``exponent'') is a fixnum. The value of
32844the float is @samp{@var{mant} * 10^@var{exp}}. For example, the number
8e04863e 32845@mathit{-3.14} is stored as @samp{(float -314 -2) = -314*10^-2}. Other constraints
d7b8e6c6
EZ
32846are that the number 0.0 is always stored as @samp{(float 0 0)}, and,
32847except for the 0.0 case, the rightmost base-10 digit of @var{mant} is
32848always nonzero. (If the rightmost digit is zero, the number is
a4231b04 32849rearranged by dividing @var{mant} by ten and incrementing @var{exp}.)
d7b8e6c6
EZ
32850
32851Rectangular complex numbers are stored in the form @samp{(cplx @var{re}
32852@var{im})}, where @var{re} and @var{im} are each real numbers, either
32853integers, fractions, or floats. The value is @samp{@var{re} + @var{im}i}.
32854The @var{im} part is nonzero; complex numbers with zero imaginary
a4231b04 32855components are converted to real numbers automatically.
d7b8e6c6
EZ
32856
32857Polar complex numbers are stored in the form @samp{(polar @var{r}
32858@var{theta})}, where @var{r} is a positive real value and @var{theta}
32859is a real value or HMS form representing an angle. This angle is
32860usually normalized to lie in the interval @samp{(-180 ..@: 180)} degrees,
32861or @samp{(-pi ..@: pi)} radians, according to the current angular mode.
32862If the angle is 0 the value is converted to a real number automatically.
32863(If the angle is 180 degrees, the value is usually also converted to a
a4231b04 32864negative real number.)
d7b8e6c6
EZ
32865
32866Hours-minutes-seconds forms are stored as @samp{(hms @var{h} @var{m}
32867@var{s})}, where @var{h} is an integer or an integer-valued float (i.e.,
32868a float with @samp{@var{exp} >= 0}), @var{m} is an integer or integer-valued
32869float in the range @w{@samp{[0 ..@: 60)}}, and @var{s} is any real number
a4231b04 32870in the range @samp{[0 ..@: 60)}.
d7b8e6c6
EZ
32871
32872Date forms are stored as @samp{(date @var{n})}, where @var{n} is
32873a real number that counts days since midnight on the morning of
32874January 1, 1 AD. If @var{n} is an integer, this is a pure date
32875form. If @var{n} is a fraction or float, this is a date/time form.
32876
32877Modulo forms are stored as @samp{(mod @var{n} @var{m})}, where @var{m} is a
32878positive real number or HMS form, and @var{n} is a real number or HMS
32879form in the range @samp{[0 ..@: @var{m})}.
32880
32881Error forms are stored as @samp{(sdev @var{x} @var{sigma})}, where @var{x}
32882is the mean value and @var{sigma} is the standard deviation. Each
32883component is either a number, an HMS form, or a symbolic object
32884(a variable or function call). If @var{sigma} is zero, the value is
32885converted to a plain real number. If @var{sigma} is negative or
32886complex, it is automatically normalized to be a positive real.
32887
32888Interval forms are stored as @samp{(intv @var{mask} @var{lo} @var{hi})},
32889where @var{mask} is one of the integers 0, 1, 2, or 3, and @var{lo} and
32890@var{hi} are real numbers, HMS forms, or symbolic objects. The @var{mask}
32891is a binary integer where 1 represents the fact that the interval is
32892closed on the high end, and 2 represents the fact that it is closed on
32893the low end. (Thus 3 represents a fully closed interval.) The interval
32894@w{@samp{(intv 3 @var{x} @var{x})}} is converted to the plain number @var{x};
32895intervals @samp{(intv @var{mask} @var{x} @var{x})} for any other @var{mask}
32896represent empty intervals. If @var{hi} is less than @var{lo}, the interval
32897is converted to a standard empty interval by replacing @var{hi} with @var{lo}.
32898
32899Vectors are stored as @samp{(vec @var{v1} @var{v2} @dots{})}, where @var{v1}
32900is the first element of the vector, @var{v2} is the second, and so on.
32901An empty vector is stored as @samp{(vec)}. A matrix is simply a vector
32902where all @var{v}'s are themselves vectors of equal lengths. Note that
32903Calc vectors are unrelated to the Emacs Lisp ``vector'' type, which is
32904generally unused by Calc data structures.
32905
32906Variables are stored as @samp{(var @var{name} @var{sym})}, where
32907@var{name} is a Lisp symbol whose print name is used as the visible name
32908of the variable, and @var{sym} is a Lisp symbol in which the variable's
32909value is actually stored. Thus, @samp{(var pi var-pi)} represents the
32910special constant @samp{pi}. Almost always, the form is @samp{(var
32911@var{v} var-@var{v})}. If the variable name was entered with @code{#}
32912signs (which are converted to hyphens internally), the form is
32913@samp{(var @var{u} @var{v})}, where @var{u} is a symbol whose name
32914contains @code{#} characters, and @var{v} is a symbol that contains
32915@code{-} characters instead. The value of a variable is the Calc
32916object stored in its @var{sym} symbol's value cell. If the symbol's
32917value cell is void or if it contains @code{nil}, the variable has no
32918value. Special constants have the form @samp{(special-const
32919@var{value})} stored in their value cell, where @var{value} is a formula
32920which is evaluated when the constant's value is requested. Variables
32921which represent units are not stored in any special way; they are units
32922only because their names appear in the units table. If the value
32923cell contains a string, it is parsed to get the variable's value when
a4231b04 32924the variable is used.
d7b8e6c6
EZ
32925
32926A Lisp list with any other symbol as the first element is a function call.
32927The symbols @code{+}, @code{-}, @code{*}, @code{/}, @code{%}, @code{^},
32928and @code{|} represent special binary operators; these lists are always
32929of the form @samp{(@var{op} @var{lhs} @var{rhs})} where @var{lhs} is the
32930sub-formula on the lefthand side and @var{rhs} is the sub-formula on the
32931right. The symbol @code{neg} represents unary negation; this list is always
32932of the form @samp{(neg @var{arg})}. Any other symbol @var{func} represents a
32933function that would be displayed in function-call notation; the symbol
32934@var{func} is in general always of the form @samp{calcFunc-@var{name}}.
32935The function cell of the symbol @var{func} should contain a Lisp function
32936for evaluating a call to @var{func}. This function is passed the remaining
32937elements of the list (themselves already evaluated) as arguments; such
32938functions should return @code{nil} or call @code{reject-arg} to signify
32939that they should be left in symbolic form, or they should return a Calc
32940object which represents their value, or a list of such objects if they
32941wish to return multiple values. (The latter case is allowed only for
32942functions which are the outer-level call in an expression whose value is
32943about to be pushed on the stack; this feature is considered obsolete
a4231b04 32944and is not used by any built-in Calc functions.)
d7b8e6c6
EZ
32945
32946@node Interactive Lisp Functions, Stack Lisp Functions, Data Type Formats, Internals
32947@subsubsection Interactive Functions
32948
32949@noindent
32950The functions described here are used in implementing interactive Calc
32951commands. Note that this list is not exhaustive! If there is an
32952existing command that behaves similarly to the one you want to define,
32953you may find helpful tricks by checking the source code for that command.
32954
32955@defun calc-set-command-flag flag
32956Set the command flag @var{flag}. This is generally a Lisp symbol, but
32957may in fact be anything. The effect is to add @var{flag} to the list
32958stored in the variable @code{calc-command-flags}, unless it is already
32959there. @xref{Defining Simple Commands}.
32960@end defun
32961
32962@defun calc-clear-command-flag flag
32963If @var{flag} appears among the list of currently-set command flags,
32964remove it from that list.
32965@end defun
32966
32967@defun calc-record-undo rec
32968Add the ``undo record'' @var{rec} to the list of steps to take if the
32969current operation should need to be undone. Stack push and pop functions
32970automatically call @code{calc-record-undo}, so the kinds of undo records
32971you might need to create take the form @samp{(set @var{sym} @var{value})},
32972which says that the Lisp variable @var{sym} was changed and had previously
32973contained @var{value}; @samp{(store @var{var} @var{value})} which says that
32974the Calc variable @var{var} (a string which is the name of the symbol that
32975contains the variable's value) was stored and its previous value was
32976@var{value} (either a Calc data object, or @code{nil} if the variable was
32977previously void); or @samp{(eval @var{undo} @var{redo} @var{args} @dots{})},
32978which means that to undo requires calling the function @samp{(@var{undo}
32979@var{args} @dots{})} and, if the undo is later redone, calling
a4231b04 32980@samp{(@var{redo} @var{args} @dots{})}.
d7b8e6c6
EZ
32981@end defun
32982
32983@defun calc-record-why msg args
32984Record the error or warning message @var{msg}, which is normally a string.
32985This message will be replayed if the user types @kbd{w} (@code{calc-why});
32986if the message string begins with a @samp{*}, it is considered important
32987enough to display even if the user doesn't type @kbd{w}. If one or more
32988@var{args} are present, the displayed message will be of the form,
32989@samp{@var{msg}: @var{arg1}, @var{arg2}, @dots{}}, where the arguments are
32990formatted on the assumption that they are either strings or Calc objects of
32991some sort. If @var{msg} is a symbol, it is the name of a Calc predicate
32992(such as @code{integerp} or @code{numvecp}) which the arguments did not
32993satisfy; it is expanded to a suitable string such as ``Expected an
32994integer.'' The @code{reject-arg} function calls @code{calc-record-why}
a4231b04 32995automatically; @pxref{Predicates}.
d7b8e6c6
EZ
32996@end defun
32997
32998@defun calc-is-inverse
32999This predicate returns true if the current command is inverse,
33000i.e., if the Inverse (@kbd{I} key) flag was set.
33001@end defun
33002
33003@defun calc-is-hyperbolic
33004This predicate is the analogous function for the @kbd{H} key.
33005@end defun
33006
33007@node Stack Lisp Functions, Predicates, Interactive Lisp Functions, Internals
33008@subsubsection Stack-Oriented Functions
33009
33010@noindent
33011The functions described here perform various operations on the Calc
33012stack and trail. They are to be used in interactive Calc commands.
33013
33014@defun calc-push-list vals n
33015Push the Calc objects in list @var{vals} onto the stack at stack level
33016@var{n}. If @var{n} is omitted it defaults to 1, so that the elements
33017are pushed at the top of the stack. If @var{n} is greater than 1, the
33018elements will be inserted into the stack so that the last element will
33019end up at level @var{n}, the next-to-last at level @var{n}+1, etc.
33020The elements of @var{vals} are assumed to be valid Calc objects, and
33021are not evaluated, rounded, or renormalized in any way. If @var{vals}
a4231b04 33022is an empty list, nothing happens.
d7b8e6c6
EZ
33023
33024The stack elements are pushed without any sub-formula selections.
33025You can give an optional third argument to this function, which must
33026be a list the same size as @var{vals} of selections. Each selection
33027must be @code{eq} to some sub-formula of the corresponding formula
33028in @var{vals}, or @code{nil} if that formula should have no selection.
33029@end defun
33030
33031@defun calc-top-list n m
33032Return a list of the @var{n} objects starting at level @var{m} of the
33033stack. If @var{m} is omitted it defaults to 1, so that the elements are
33034taken from the top of the stack. If @var{n} is omitted, it also
33035defaults to 1, so that the top stack element (in the form of a
33036one-element list) is returned. If @var{m} is greater than 1, the
33037@var{m}th stack element will be at the end of the list, the @var{m}+1st
33038element will be next-to-last, etc. If @var{n} or @var{m} are out of
33039range, the command is aborted with a suitable error message. If @var{n}
33040is zero, the function returns an empty list. The stack elements are not
a4231b04 33041evaluated, rounded, or renormalized.
d7b8e6c6
EZ
33042
33043If any stack elements contain selections, and selections have not
33044been disabled by the @kbd{j e} (@code{calc-enable-selections}) command,
33045this function returns the selected portions rather than the entire
33046stack elements. It can be given a third ``selection-mode'' argument
33047which selects other behaviors. If it is the symbol @code{t}, then
33048a selection in any of the requested stack elements produces an
ce7c7522 33049``invalid operation on selections'' error. If it is the symbol @code{full},
d7b8e6c6
EZ
33050the whole stack entry is always returned regardless of selections.
33051If it is the symbol @code{sel}, the selected portion is always returned,
33052or @code{nil} if there is no selection. (This mode ignores the @kbd{j e}
33053command.) If the symbol is @code{entry}, the complete stack entry in
33054list form is returned; the first element of this list will be the whole
33055formula, and the third element will be the selection (or @code{nil}).
33056@end defun
33057
33058@defun calc-pop-stack n m
33059Remove the specified elements from the stack. The parameters @var{n}
33060and @var{m} are defined the same as for @code{calc-top-list}. The return
33061value of @code{calc-pop-stack} is uninteresting.
33062
33063If there are any selected sub-formulas among the popped elements, and
33064@kbd{j e} has not been used to disable selections, this produces an
33065error without changing the stack. If you supply an optional third
33066argument of @code{t}, the stack elements are popped even if they
33067contain selections.
33068@end defun
33069
33070@defun calc-record-list vals tag
33071This function records one or more results in the trail. The @var{vals}
33072are a list of strings or Calc objects. The @var{tag} is the four-character
33073tag string to identify the values. If @var{tag} is omitted, a blank tag
33074will be used.
33075@end defun
33076
33077@defun calc-normalize n
33078This function takes a Calc object and ``normalizes'' it. At the very
33079least this involves re-rounding floating-point values according to the
33080current precision and other similar jobs. Also, unless the user has
07ce2eb3 33081selected No-Simplify mode (@pxref{Simplification Modes}), this involves
d7b8e6c6
EZ
33082actually evaluating a formula object by executing the function calls
33083it contains, and possibly also doing algebraic simplification, etc.
33084@end defun
33085
33086@defun calc-top-list-n n m
33087This function is identical to @code{calc-top-list}, except that it calls
33088@code{calc-normalize} on the values that it takes from the stack. They
33089are also passed through @code{check-complete}, so that incomplete
33090objects will be rejected with an error message. All computational
33091commands should use this in preference to @code{calc-top-list}; the only
33092standard Calc commands that operate on the stack without normalizing
33093are stack management commands like @code{calc-enter} and @code{calc-roll-up}.
33094This function accepts the same optional selection-mode argument as
33095@code{calc-top-list}.
33096@end defun
33097
33098@defun calc-top-n m
33099This function is a convenient form of @code{calc-top-list-n} in which only
33100a single element of the stack is taken and returned, rather than a list
33101of elements. This also accepts an optional selection-mode argument.
33102@end defun
33103
33104@defun calc-enter-result n tag vals
33105This function is a convenient interface to most of the above functions.
33106The @var{vals} argument should be either a single Calc object, or a list
33107of Calc objects; the object or objects are normalized, and the top @var{n}
33108stack entries are replaced by the normalized objects. If @var{tag} is
33109non-@code{nil}, the normalized objects are also recorded in the trail.
33110A typical stack-based computational command would take the form,
33111
33112@smallexample
33113(calc-enter-result @var{n} @var{tag} (cons 'calcFunc-@var{func}
33114 (calc-top-list-n @var{n})))
33115@end smallexample
33116
33117If any of the @var{n} stack elements replaced contain sub-formula
33118selections, and selections have not been disabled by @kbd{j e},
33119this function takes one of two courses of action. If @var{n} is
33120equal to the number of elements in @var{vals}, then each element of
33121@var{vals} is spliced into the corresponding selection; this is what
33122happens when you use the @key{TAB} key, or when you use a unary
33123arithmetic operation like @code{sqrt}. If @var{vals} has only one
33124element but @var{n} is greater than one, there must be only one
33125selection among the top @var{n} stack elements; the element from
33126@var{vals} is spliced into that selection. This is what happens when
33127you use a binary arithmetic operation like @kbd{+}. Any other
33128combination of @var{n} and @var{vals} is an error when selections
33129are present.
33130@end defun
33131
33132@defun calc-unary-op tag func arg
33133This function implements a unary operator that allows a numeric prefix
33134argument to apply the operator over many stack entries. If the prefix
33135argument @var{arg} is @code{nil}, this uses @code{calc-enter-result}
33136as outlined above. Otherwise, it maps the function over several stack
a4231b04 33137elements; @pxref{Prefix Arguments}. For example,
d7b8e6c6
EZ
33138
33139@smallexample
33140(defun calc-zeta (arg)
33141 (interactive "P")
33142 (calc-unary-op "zeta" 'calcFunc-zeta arg))
33143@end smallexample
33144@end defun
33145
33146@defun calc-binary-op tag func arg ident unary
33147This function implements a binary operator, analogously to
33148@code{calc-unary-op}. The optional @var{ident} and @var{unary}
33149arguments specify the behavior when the prefix argument is zero or
33150one, respectively. If the prefix is zero, the value @var{ident}
33151is pushed onto the stack, if specified, otherwise an error message
33152is displayed. If the prefix is one, the unary function @var{unary}
33153is applied to the top stack element, or, if @var{unary} is not
33154specified, nothing happens. When the argument is two or more,
33155the binary function @var{func} is reduced across the top @var{arg}
33156stack elements; when the argument is negative, the function is
8e04863e 33157mapped between the next-to-top @mathit{-@var{arg}} stack elements and the
a4231b04 33158top element.
d7b8e6c6
EZ
33159@end defun
33160
33161@defun calc-stack-size
33162Return the number of elements on the stack as an integer. This count
33163does not include elements that have been temporarily hidden by stack
33164truncation; @pxref{Truncating the Stack}.
33165@end defun
33166
33167@defun calc-cursor-stack-index n
33168Move the point to the @var{n}th stack entry. If @var{n} is zero, this
33169will be the @samp{.} line. If @var{n} is from 1 to the current stack size,
33170this will be the beginning of the first line of that stack entry's display.
33171If line numbers are enabled, this will move to the first character of the
a4231b04 33172line number, not the stack entry itself.
d7b8e6c6
EZ
33173@end defun
33174
33175@defun calc-substack-height n
33176Return the number of lines between the beginning of the @var{n}th stack
33177entry and the bottom of the buffer. If @var{n} is zero, this
33178will be one (assuming no stack truncation). If all stack entries are
33179one line long (i.e., no matrices are displayed), the return value will
33180be equal @var{n}+1 as long as @var{n} is in range. (Note that in Big
33181mode, the return value includes the blank lines that separate stack
a4231b04 33182entries.)
d7b8e6c6
EZ
33183@end defun
33184
33185@defun calc-refresh
33186Erase the @code{*Calculator*} buffer and reformat its contents from memory.
33187This must be called after changing any parameter, such as the current
33188display radix, which might change the appearance of existing stack
33189entries. (During a keyboard macro invoked by the @kbd{X} key, refreshing
33190is suppressed, but a flag is set so that the entire stack will be refreshed
a4231b04 33191rather than just the top few elements when the macro finishes.)
d7b8e6c6
EZ
33192@end defun
33193
33194@node Predicates, Computational Lisp Functions, Stack Lisp Functions, Internals
33195@subsubsection Predicates
33196
33197@noindent
33198The functions described here are predicates, that is, they return a
33199true/false value where @code{nil} means false and anything else means
33200true. These predicates are expanded by @code{defmath}, for example,
33201from @code{zerop} to @code{math-zerop}. In many cases they correspond
33202to native Lisp functions by the same name, but are extended to cover
33203the full range of Calc data types.
33204
33205@defun zerop x
33206Returns true if @var{x} is numerically zero, in any of the Calc data
33207types. (Note that for some types, such as error forms and intervals,
33208it never makes sense to return true.) In @code{defmath}, the expression
33209@samp{(= x 0)} will automatically be converted to @samp{(math-zerop x)},
33210and @samp{(/= x 0)} will be converted to @samp{(not (math-zerop x))}.
33211@end defun
33212
33213@defun negp x
33214Returns true if @var{x} is negative. This accepts negative real numbers
33215of various types, negative HMS and date forms, and intervals in which
33216all included values are negative. In @code{defmath}, the expression
33217@samp{(< x 0)} will automatically be converted to @samp{(math-negp x)},
33218and @samp{(>= x 0)} will be converted to @samp{(not (math-negp x))}.
33219@end defun
33220
33221@defun posp x
33222Returns true if @var{x} is positive (and non-zero). For complex
33223numbers, none of these three predicates will return true.
33224@end defun
33225
33226@defun looks-negp x
33227Returns true if @var{x} is ``negative-looking.'' This returns true if
33228@var{x} is a negative number, or a formula with a leading minus sign
33229such as @samp{-a/b}. In other words, this is an object which can be
33230made simpler by calling @code{(- @var{x})}.
33231@end defun
33232
33233@defun integerp x
33234Returns true if @var{x} is an integer of any size.
33235@end defun
33236
33237@defun fixnump x
33238Returns true if @var{x} is a native Lisp integer.
33239@end defun
33240
33241@defun natnump x
33242Returns true if @var{x} is a nonnegative integer of any size.
33243@end defun
33244
33245@defun fixnatnump x
33246Returns true if @var{x} is a nonnegative Lisp integer.
33247@end defun
33248
33249@defun num-integerp x
33250Returns true if @var{x} is numerically an integer, i.e., either a
33251true integer or a float with no significant digits to the right of
33252the decimal point.
33253@end defun
33254
33255@defun messy-integerp x
33256Returns true if @var{x} is numerically, but not literally, an integer.
33257A value is @code{num-integerp} if it is @code{integerp} or
33258@code{messy-integerp} (but it is never both at once).
33259@end defun
33260
33261@defun num-natnump x
33262Returns true if @var{x} is numerically a nonnegative integer.
33263@end defun
33264
33265@defun evenp x
33266Returns true if @var{x} is an even integer.
33267@end defun
33268
33269@defun looks-evenp x
33270Returns true if @var{x} is an even integer, or a formula with a leading
33271multiplicative coefficient which is an even integer.
33272@end defun
33273
33274@defun oddp x
33275Returns true if @var{x} is an odd integer.
33276@end defun
33277
33278@defun ratp x
33279Returns true if @var{x} is a rational number, i.e., an integer or a
33280fraction.
33281@end defun
33282
33283@defun realp x
33284Returns true if @var{x} is a real number, i.e., an integer, fraction,
33285or floating-point number.
33286@end defun
33287
33288@defun anglep x
33289Returns true if @var{x} is a real number or HMS form.
33290@end defun
33291
33292@defun floatp x
33293Returns true if @var{x} is a float, or a complex number, error form,
33294interval, date form, or modulo form in which at least one component
33295is a float.
33296@end defun
33297
33298@defun complexp x
33299Returns true if @var{x} is a rectangular or polar complex number
33300(but not a real number).
33301@end defun
33302
33303@defun rect-complexp x
33304Returns true if @var{x} is a rectangular complex number.
33305@end defun
33306
33307@defun polar-complexp x
33308Returns true if @var{x} is a polar complex number.
33309@end defun
33310
33311@defun numberp x
33312Returns true if @var{x} is a real number or a complex number.
33313@end defun
33314
33315@defun scalarp x
33316Returns true if @var{x} is a real or complex number or an HMS form.
33317@end defun
33318
33319@defun vectorp x
33320Returns true if @var{x} is a vector (this simply checks if its argument
33321is a list whose first element is the symbol @code{vec}).
33322@end defun
33323
33324@defun numvecp x
33325Returns true if @var{x} is a number or vector.
33326@end defun
33327
33328@defun matrixp x
33329Returns true if @var{x} is a matrix, i.e., a vector of one or more vectors,
33330all of the same size.
33331@end defun
33332
33333@defun square-matrixp x
33334Returns true if @var{x} is a square matrix.
33335@end defun
33336
33337@defun objectp x
33338Returns true if @var{x} is any numeric Calc object, including real and
33339complex numbers, HMS forms, date forms, error forms, intervals, and
33340modulo forms. (Note that error forms and intervals may include formulas
33341as their components; see @code{constp} below.)
33342@end defun
33343
33344@defun objvecp x
33345Returns true if @var{x} is an object or a vector. This also accepts
33346incomplete objects, but it rejects variables and formulas (except as
33347mentioned above for @code{objectp}).
33348@end defun
33349
33350@defun primp x
33351Returns true if @var{x} is a ``primitive'' or ``atomic'' Calc object,
33352i.e., one whose components cannot be regarded as sub-formulas. This
33353includes variables, and all @code{objectp} types except error forms
33354and intervals.
33355@end defun
33356
33357@defun constp x
33358Returns true if @var{x} is constant, i.e., a real or complex number,
33359HMS form, date form, or error form, interval, or vector all of whose
33360components are @code{constp}.
33361@end defun
33362
33363@defun lessp x y
33364Returns true if @var{x} is numerically less than @var{y}. Returns false
33365if @var{x} is greater than or equal to @var{y}, or if the order is
33366undefined or cannot be determined. Generally speaking, this works
33367by checking whether @samp{@var{x} - @var{y}} is @code{negp}. In
33368@code{defmath}, the expression @samp{(< x y)} will automatically be
33369converted to @samp{(lessp x y)}; expressions involving @code{>}, @code{<=},
a4231b04 33370and @code{>=} are similarly converted in terms of @code{lessp}.
d7b8e6c6
EZ
33371@end defun
33372
33373@defun beforep x y
33374Returns true if @var{x} comes before @var{y} in a canonical ordering
33375of Calc objects. If @var{x} and @var{y} are both real numbers, this
33376will be the same as @code{lessp}. But whereas @code{lessp} considers
33377other types of objects to be unordered, @code{beforep} puts any two
33378objects into a definite, consistent order. The @code{beforep}
33379function is used by the @kbd{V S} vector-sorting command, and also
33380by @kbd{a s} to put the terms of a product into canonical order:
33381This allows @samp{x y + y x} to be simplified easily to @samp{2 x y}.
33382@end defun
33383
33384@defun equal x y
33385This is the standard Lisp @code{equal} predicate; it returns true if
33386@var{x} and @var{y} are structurally identical. This is the usual way
33387to compare numbers for equality, but note that @code{equal} will treat
333880 and 0.0 as different.
33389@end defun
33390
33391@defun math-equal x y
33392Returns true if @var{x} and @var{y} are numerically equal, either because
33393they are @code{equal}, or because their difference is @code{zerop}. In
33394@code{defmath}, the expression @samp{(= x y)} will automatically be
33395converted to @samp{(math-equal x y)}.
33396@end defun
33397
33398@defun equal-int x n
33399Returns true if @var{x} and @var{n} are numerically equal, where @var{n}
33400is a fixnum which is not a multiple of 10. This will automatically be
33401used by @code{defmath} in place of the more general @code{math-equal}
a4231b04 33402whenever possible.
d7b8e6c6
EZ
33403@end defun
33404
33405@defun nearly-equal x y
33406Returns true if @var{x} and @var{y}, as floating-point numbers, are
33407equal except possibly in the last decimal place. For example,
33408314.159 and 314.166 are considered nearly equal if the current
33409precision is 6 (since they differ by 7 units), but not if the current
33410precision is 7 (since they differ by 70 units). Most functions which
33411use series expansions use @code{with-extra-prec} to evaluate the
33412series with 2 extra digits of precision, then use @code{nearly-equal}
33413to decide when the series has converged; this guards against cumulative
33414error in the series evaluation without doing extra work which would be
33415lost when the result is rounded back down to the current precision.
33416In @code{defmath}, this can be written @samp{(~= @var{x} @var{y})}.
33417The @var{x} and @var{y} can be numbers of any kind, including complex.
33418@end defun
33419
33420@defun nearly-zerop x y
33421Returns true if @var{x} is nearly zero, compared to @var{y}. This
33422checks whether @var{x} plus @var{y} would by be @code{nearly-equal}
33423to @var{y} itself, to within the current precision, in other words,
33424if adding @var{x} to @var{y} would have a negligible effect on @var{y}
33425due to roundoff error. @var{X} may be a real or complex number, but
33426@var{y} must be real.
33427@end defun
33428
33429@defun is-true x
33430Return true if the formula @var{x} represents a true value in
33431Calc, not Lisp, terms. It tests if @var{x} is a non-zero number
33432or a provably non-zero formula.
33433@end defun
33434
33435@defun reject-arg val pred
33436Abort the current function evaluation due to unacceptable argument values.
33437This calls @samp{(calc-record-why @var{pred} @var{val})}, then signals a
33438Lisp error which @code{normalize} will trap. The net effect is that the
a4231b04 33439function call which led here will be left in symbolic form.
d7b8e6c6
EZ
33440@end defun
33441
33442@defun inexact-value
07ce2eb3 33443If Symbolic mode is enabled, this will signal an error that causes
d7b8e6c6 33444@code{normalize} to leave the formula in symbolic form, with the message
07ce2eb3
JB
33445``Inexact result.'' (This function has no effect when not in Symbolic mode.)
33446Note that if your function calls @samp{(sin 5)} in Symbolic mode, the
d7b8e6c6
EZ
33447@code{sin} function will call @code{inexact-value}, which will cause your
33448function to be left unsimplified. You may instead wish to call
07ce2eb3 33449@samp{(normalize (list 'calcFunc-sin 5))}, which in Symbolic mode will
a4231b04 33450return the formula @samp{sin(5)} to your function.
d7b8e6c6
EZ
33451@end defun
33452
33453@defun overflow
33454This signals an error that will be reported as a floating-point overflow.
33455@end defun
33456
33457@defun underflow
33458This signals a floating-point underflow.
33459@end defun
33460
33461@node Computational Lisp Functions, Vector Lisp Functions, Predicates, Internals
33462@subsubsection Computational Functions
33463
33464@noindent
33465The functions described here do the actual computational work of the
33466Calculator. In addition to these, note that any function described in
33467the main body of this manual may be called from Lisp; for example, if
33468the documentation refers to the @code{calc-sqrt} [@code{sqrt}] command,
33469this means @code{calc-sqrt} is an interactive stack-based square-root
33470command and @code{sqrt} (which @code{defmath} expands to @code{calcFunc-sqrt})
a4231b04 33471is the actual Lisp function for taking square roots.
d7b8e6c6
EZ
33472
33473The functions @code{math-add}, @code{math-sub}, @code{math-mul},
33474@code{math-div}, @code{math-mod}, and @code{math-neg} are not included
33475in this list, since @code{defmath} allows you to write native Lisp
33476@code{+}, @code{-}, @code{*}, @code{/}, @code{%}, and unary @code{-},
a4231b04 33477respectively, instead.
d7b8e6c6
EZ
33478
33479@defun normalize val
33480(Full form: @code{math-normalize}.)
33481Reduce the value @var{val} to standard form. For example, if @var{val}
33482is a fixnum, it will be converted to a bignum if it is too large, and
33483if @var{val} is a bignum it will be normalized by clipping off trailing
33484(i.e., most-significant) zero digits and converting to a fixnum if it is
33485small. All the various data types are similarly converted to their standard
33486forms. Variables are left alone, but function calls are actually evaluated
33487in formulas. For example, normalizing @samp{(+ 2 (calcFunc-abs -4))} will
a4231b04 33488return 6.
d7b8e6c6
EZ
33489
33490If a function call fails, because the function is void or has the wrong
33491number of parameters, or because it returns @code{nil} or calls
33492@code{reject-arg} or @code{inexact-result}, @code{normalize} returns
a4231b04 33493the formula still in symbolic form.
d7b8e6c6 33494
07ce2eb3 33495If the current simplification mode is ``none'' or ``numeric arguments
d7b8e6c6 33496only,'' @code{normalize} will act appropriately. However, the more
07ce2eb3 33497powerful simplification modes (like Algebraic Simplification) are
d7b8e6c6
EZ
33498not handled by @code{normalize}. They are handled by @code{calc-normalize},
33499which calls @code{normalize} and possibly some other routines, such
33500as @code{simplify} or @code{simplify-units}. Programs generally will
33501never call @code{calc-normalize} except when popping or pushing values
a4231b04 33502on the stack.
d7b8e6c6
EZ
33503@end defun
33504
33505@defun evaluate-expr expr
33506Replace all variables in @var{expr} that have values with their values,
33507then use @code{normalize} to simplify the result. This is what happens
a4231b04 33508when you press the @kbd{=} key interactively.
d7b8e6c6
EZ
33509@end defun
33510
33511@defmac with-extra-prec n body
33512Evaluate the Lisp forms in @var{body} with precision increased by @var{n}
33513digits. This is a macro which expands to
33514
33515@smallexample
33516(math-normalize
33517 (let ((calc-internal-prec (+ calc-internal-prec @var{n})))
33518 @var{body}))
33519@end smallexample
33520
33521The surrounding call to @code{math-normalize} causes a floating-point
33522result to be rounded down to the original precision afterwards. This
33523is important because some arithmetic operations assume a number's
33524mantissa contains no more digits than the current precision allows.
33525@end defmac
33526
33527@defun make-frac n d
33528Build a fraction @samp{@var{n}:@var{d}}. This is equivalent to calling
33529@samp{(normalize (list 'frac @var{n} @var{d}))}, but more efficient.
33530@end defun
33531
33532@defun make-float mant exp
33533Build a floating-point value out of @var{mant} and @var{exp}, both
33534of which are arbitrary integers. This function will return a
33535properly normalized float value, or signal an overflow or underflow
33536if @var{exp} is out of range.
33537@end defun
33538
33539@defun make-sdev x sigma
33540Build an error form out of @var{x} and the absolute value of @var{sigma}.
33541If @var{sigma} is zero, the result is the number @var{x} directly.
33542If @var{sigma} is negative or complex, its absolute value is used.
33543If @var{x} or @var{sigma} is not a valid type of object for use in
33544error forms, this calls @code{reject-arg}.
33545@end defun
33546
33547@defun make-intv mask lo hi
33548Build an interval form out of @var{mask} (which is assumed to be an
33549integer from 0 to 3), and the limits @var{lo} and @var{hi}. If
33550@var{lo} is greater than @var{hi}, an empty interval form is returned.
33551This calls @code{reject-arg} if @var{lo} or @var{hi} is unsuitable.
33552@end defun
33553
33554@defun sort-intv mask lo hi
33555Build an interval form, similar to @code{make-intv}, except that if
33556@var{lo} is less than @var{hi} they are simply exchanged, and the
33557bits of @var{mask} are swapped accordingly.
33558@end defun
33559
33560@defun make-mod n m
33561Build a modulo form out of @var{n} and the modulus @var{m}. Since modulo
33562forms do not allow formulas as their components, if @var{n} or @var{m}
33563is not a real number or HMS form the result will be a formula which
33564is a call to @code{makemod}, the algebraic version of this function.
33565@end defun
33566
33567@defun float x
33568Convert @var{x} to floating-point form. Integers and fractions are
33569converted to numerically equivalent floats; components of complex
33570numbers, vectors, HMS forms, date forms, error forms, intervals, and
33571modulo forms are recursively floated. If the argument is a variable
33572or formula, this calls @code{reject-arg}.
33573@end defun
33574
33575@defun compare x y
8e04863e 33576Compare the numbers @var{x} and @var{y}, and return @mathit{-1} if
d7b8e6c6
EZ
33577@samp{(lessp @var{x} @var{y})}, 1 if @samp{(lessp @var{y} @var{x})},
335780 if @samp{(math-equal @var{x} @var{y})}, or 2 if the order is
a4231b04 33579undefined or cannot be determined.
d7b8e6c6
EZ
33580@end defun
33581
33582@defun numdigs n
33583Return the number of digits of integer @var{n}, effectively
33584@samp{ceil(log10(@var{n}))}, but much more efficient. Zero is
33585considered to have zero digits.
33586@end defun
33587
33588@defun scale-int x n
8e04863e 33589Shift integer @var{x} left @var{n} decimal digits, or right @mathit{-@var{n}}
d7b8e6c6
EZ
33590digits with truncation toward zero.
33591@end defun
33592
33593@defun scale-rounding x n
33594Like @code{scale-int}, except that a right shift rounds to the nearest
33595integer rather than truncating.
33596@end defun
33597
33598@defun fixnum n
33599Return the integer @var{n} as a fixnum, i.e., a native Lisp integer.
33600If @var{n} is outside the permissible range for Lisp integers (usually
3360124 binary bits) the result is undefined.
33602@end defun
33603
33604@defun sqr x
33605Compute the square of @var{x}; short for @samp{(* @var{x} @var{x})}.
33606@end defun
33607
33608@defun quotient x y
33609Divide integer @var{x} by integer @var{y}; return an integer quotient
33610and discard the remainder. If @var{x} or @var{y} is negative, the
33611direction of rounding is undefined.
33612@end defun
33613
33614@defun idiv x y
33615Perform an integer division; if @var{x} and @var{y} are both nonnegative
33616integers, this uses the @code{quotient} function, otherwise it computes
33617@samp{floor(@var{x}/@var{y})}. Thus the result is well-defined but
33618slower than for @code{quotient}.
33619@end defun
33620
33621@defun imod x y
33622Divide integer @var{x} by integer @var{y}; return the integer remainder
33623and discard the quotient. Like @code{quotient}, this works only for
33624integer arguments and is not well-defined for negative arguments.
33625For a more well-defined result, use @samp{(% @var{x} @var{y})}.
33626@end defun
33627
33628@defun idivmod x y
33629Divide integer @var{x} by integer @var{y}; return a cons cell whose
33630@code{car} is @samp{(quotient @var{x} @var{y})} and whose @code{cdr}
a4231b04 33631is @samp{(imod @var{x} @var{y})}.
d7b8e6c6
EZ
33632@end defun
33633
33634@defun pow x y
33635Compute @var{x} to the power @var{y}. In @code{defmath} code, this can
33636also be written @samp{(^ @var{x} @var{y})} or
a4231b04 33637@w{@samp{(expt @var{x} @var{y})}}.
d7b8e6c6
EZ
33638@end defun
33639
33640@defun abs-approx x
33641Compute a fast approximation to the absolute value of @var{x}. For
33642example, for a rectangular complex number the result is the sum of
33643the absolute values of the components.
33644@end defun
33645
651e237b
JB
33646@findex e
33647@findex gamma-const
33648@findex ln-2
33649@findex ln-10
33650@findex phi
d7b8e6c6
EZ
33651@findex pi-over-2
33652@findex pi-over-4
33653@findex pi-over-180
33654@findex sqrt-two-pi
33655@findex sqrt-e
651e237b 33656@findex two-pi
d7b8e6c6
EZ
33657@defun pi
33658The function @samp{(pi)} computes @samp{pi} to the current precision.
33659Other related constant-generating functions are @code{two-pi},
33660@code{pi-over-2}, @code{pi-over-4}, @code{pi-over-180}, @code{sqrt-two-pi},
651e237b
JB
33661@code{e}, @code{sqrt-e}, @code{ln-2}, @code{ln-10}, @code{phi} and
33662@code{gamma-const}. Each function returns a floating-point value in the
33663current precision, and each uses caching so that all calls after the
33664first are essentially free.
d7b8e6c6
EZ
33665@end defun
33666
33667@defmac math-defcache @var{func} @var{initial} @var{form}
33668This macro, usually used as a top-level call like @code{defun} or
33669@code{defvar}, defines a new cached constant analogous to @code{pi}, etc.
33670It defines a function @code{func} which returns the requested value;
33671if @var{initial} is non-@code{nil} it must be a @samp{(float @dots{})}
33672form which serves as an initial value for the cache. If @var{func}
33673is called when the cache is empty or does not have enough digits to
33674satisfy the current precision, the Lisp expression @var{form} is evaluated
33675with the current precision increased by four, and the result minus its
33676two least significant digits is stored in the cache. For example,
33677calling @samp{(pi)} with a precision of 30 computes @samp{pi} to 34
33678digits, rounds it down to 32 digits for future use, then rounds it
a4231b04 33679again to 30 digits for use in the present request.
d7b8e6c6
EZ
33680@end defmac
33681
33682@findex half-circle
33683@findex quarter-circle
33684@defun full-circle symb
33685If the current angular mode is Degrees or HMS, this function returns the
33686integer 360. In Radians mode, this function returns either the
33687corresponding value in radians to the current precision, or the formula
07ce2eb3 33688@samp{2*pi}, depending on the Symbolic mode. There are also similar
d7b8e6c6
EZ
33689function @code{half-circle} and @code{quarter-circle}.
33690@end defun
33691
33692@defun power-of-2 n
33693Compute two to the integer power @var{n}, as a (potentially very large)
33694integer. Powers of two are cached, so only the first call for a
33695particular @var{n} is expensive.
33696@end defun
33697
33698@defun integer-log2 n
33699Compute the base-2 logarithm of @var{n}, which must be an integer which
33700is a power of two. If @var{n} is not a power of two, this function will
33701return @code{nil}.
33702@end defun
33703
33704@defun div-mod a b m
33705Divide @var{a} by @var{b}, modulo @var{m}. This returns @code{nil} if
a4231b04 33706there is no solution, or if any of the arguments are not integers.
d7b8e6c6
EZ
33707@end defun
33708
33709@defun pow-mod a b m
33710Compute @var{a} to the power @var{b}, modulo @var{m}. If @var{a},
33711@var{b}, and @var{m} are integers, this uses an especially efficient
33712algorithm. Otherwise, it simply computes @samp{(% (^ a b) m)}.
33713@end defun
33714
33715@defun isqrt n
33716Compute the integer square root of @var{n}. This is the square root
33717of @var{n} rounded down toward zero, i.e., @samp{floor(sqrt(@var{n}))}.
33718If @var{n} is itself an integer, the computation is especially efficient.
33719@end defun
33720
33721@defun to-hms a ang
33722Convert the argument @var{a} into an HMS form. If @var{ang} is specified,
33723it is the angular mode in which to interpret @var{a}, either @code{deg}
33724or @code{rad}. Otherwise, the current angular mode is used. If @var{a}
33725is already an HMS form it is returned as-is.
33726@end defun
33727
33728@defun from-hms a ang
33729Convert the HMS form @var{a} into a real number. If @var{ang} is specified,
33730it is the angular mode in which to express the result, otherwise the
33731current angular mode is used. If @var{a} is already a real number, it
33732is returned as-is.
33733@end defun
33734
33735@defun to-radians a
33736Convert the number or HMS form @var{a} to radians from the current
33737angular mode.
33738@end defun
33739
33740@defun from-radians a
33741Convert the number @var{a} from radians to the current angular mode.
33742If @var{a} is a formula, this returns the formula @samp{deg(@var{a})}.
33743@end defun
33744
33745@defun to-radians-2 a
07ce2eb3 33746Like @code{to-radians}, except that in Symbolic mode a degrees to
d7b8e6c6
EZ
33747radians conversion yields a formula like @samp{@var{a}*pi/180}.
33748@end defun
33749
33750@defun from-radians-2 a
07ce2eb3 33751Like @code{from-radians}, except that in Symbolic mode a radians to
d7b8e6c6
EZ
33752degrees conversion yields a formula like @samp{@var{a}*180/pi}.
33753@end defun
33754
33755@defun random-digit
33756Produce a random base-1000 digit in the range 0 to 999.
33757@end defun
33758
33759@defun random-digits n
33760Produce a random @var{n}-digit integer; this will be an integer
33761in the interval @samp{[0, 10^@var{n})}.
33762@end defun
33763
33764@defun random-float
33765Produce a random float in the interval @samp{[0, 1)}.
33766@end defun
33767
33768@defun prime-test n iters
33769Determine whether the integer @var{n} is prime. Return a list which has
33770one of these forms: @samp{(nil @var{f})} means the number is non-prime
33771because it was found to be divisible by @var{f}; @samp{(nil)} means it
33772was found to be non-prime by table look-up (so no factors are known);
33773@samp{(nil unknown)} means it is definitely non-prime but no factors
33774are known because @var{n} was large enough that Fermat's probabilistic
33775test had to be used; @samp{(t)} means the number is definitely prime;
33776and @samp{(maybe @var{i} @var{p})} means that Fermat's test, after @var{i}
33777iterations, is @var{p} percent sure that the number is prime. The
33778@var{iters} parameter is the number of Fermat iterations to use, in the
33779case that this is necessary. If @code{prime-test} returns ``maybe,''
33780you can call it again with the same @var{n} to get a greater certainty;
a4231b04 33781@code{prime-test} remembers where it left off.
d7b8e6c6
EZ
33782@end defun
33783
33784@defun to-simple-fraction f
33785If @var{f} is a floating-point number which can be represented exactly
33786as a small rational number. return that number, else return @var{f}.
33787For example, 0.75 would be converted to 3:4. This function is very
33788fast.
33789@end defun
33790
33791@defun to-fraction f tol
33792Find a rational approximation to floating-point number @var{f} to within
33793a specified tolerance @var{tol}; this corresponds to the algebraic
33794function @code{frac}, and can be rather slow.
33795@end defun
33796
33797@defun quarter-integer n
33798If @var{n} is an integer or integer-valued float, this function
33799returns zero. If @var{n} is a half-integer (i.e., an integer plus
8e04863e 33800@mathit{1:2} or 0.5), it returns 2. If @var{n} is a quarter-integer,
d7b8e6c6
EZ
33801it returns 1 or 3. If @var{n} is anything else, this function
33802returns @code{nil}.
33803@end defun
33804
33805@node Vector Lisp Functions, Symbolic Lisp Functions, Computational Lisp Functions, Internals
33806@subsubsection Vector Functions
33807
33808@noindent
33809The functions described here perform various operations on vectors and
33810matrices.
33811
33812@defun math-concat x y
33813Do a vector concatenation; this operation is written @samp{@var{x} | @var{y}}
33814in a symbolic formula. @xref{Building Vectors}.
33815@end defun
33816
33817@defun vec-length v
33818Return the length of vector @var{v}. If @var{v} is not a vector, the
33819result is zero. If @var{v} is a matrix, this returns the number of
33820rows in the matrix.
33821@end defun
33822
33823@defun mat-dimens m
33824Determine the dimensions of vector or matrix @var{m}. If @var{m} is not
33825a vector, the result is an empty list. If @var{m} is a plain vector
33826but not a matrix, the result is a one-element list containing the length
33827of the vector. If @var{m} is a matrix with @var{r} rows and @var{c} columns,
33828the result is the list @samp{(@var{r} @var{c})}. Higher-order tensors
33829produce lists of more than two dimensions. Note that the object
33830@samp{[[1, 2, 3], [4, 5]]} is a vector of vectors not all the same size,
33831and is treated by this and other Calc routines as a plain vector of two
a4231b04 33832elements.
d7b8e6c6
EZ
33833@end defun
33834
33835@defun dimension-error
33836Abort the current function with a message of ``Dimension error.''
33837The Calculator will leave the function being evaluated in symbolic
33838form; this is really just a special case of @code{reject-arg}.
33839@end defun
33840
33841@defun build-vector args
5d67986c 33842Return a Calc vector with @var{args} as elements.
d7b8e6c6
EZ
33843For example, @samp{(build-vector 1 2 3)} returns the Calc vector
33844@samp{[1, 2, 3]}, stored internally as the list @samp{(vec 1 2 3)}.
33845@end defun
33846
33847@defun make-vec obj dims
33848Return a Calc vector or matrix all of whose elements are equal to
33849@var{obj}. For example, @samp{(make-vec 27 3 4)} returns a 3x4 matrix
33850filled with 27's.
33851@end defun
33852
33853@defun row-matrix v
33854If @var{v} is a plain vector, convert it into a row matrix, i.e.,
33855a matrix whose single row is @var{v}. If @var{v} is already a matrix,
33856leave it alone.
33857@end defun
33858
33859@defun col-matrix v
33860If @var{v} is a plain vector, convert it into a column matrix, i.e., a
33861matrix with each element of @var{v} as a separate row. If @var{v} is
33862already a matrix, leave it alone.
33863@end defun
33864
33865@defun map-vec f v
33866Map the Lisp function @var{f} over the Calc vector @var{v}. For example,
33867@samp{(map-vec 'math-floor v)} returns a vector of the floored components
33868of vector @var{v}.
33869@end defun
33870
33871@defun map-vec-2 f a b
33872Map the Lisp function @var{f} over the two vectors @var{a} and @var{b}.
33873If @var{a} and @var{b} are vectors of equal length, the result is a
33874vector of the results of calling @samp{(@var{f} @var{ai} @var{bi})}
33875for each pair of elements @var{ai} and @var{bi}. If either @var{a} or
33876@var{b} is a scalar, it is matched with each value of the other vector.
33877For example, @samp{(map-vec-2 'math-add v 1)} returns the vector @var{v}
33878with each element increased by one. Note that using @samp{'+} would not
33879work here, since @code{defmath} does not expand function names everywhere,
a4231b04 33880just where they are in the function position of a Lisp expression.
d7b8e6c6
EZ
33881@end defun
33882
33883@defun reduce-vec f v
33884Reduce the function @var{f} over the vector @var{v}. For example, if
33885@var{v} is @samp{[10, 20, 30, 40]}, this calls @samp{(f (f (f 10 20) 30) 40)}.
33886If @var{v} is a matrix, this reduces over the rows of @var{v}.
33887@end defun
33888
33889@defun reduce-cols f m
33890Reduce the function @var{f} over the columns of matrix @var{m}. For
33891example, if @var{m} is @samp{[[1, 2], [3, 4], [5, 6]]}, the result
33892is a vector of the two elements @samp{(f (f 1 3) 5)} and @samp{(f (f 2 4) 6)}.
33893@end defun
33894
33895@defun mat-row m n
33896Return the @var{n}th row of matrix @var{m}. This is equivalent to
33897@samp{(elt m n)}. For a slower but safer version, use @code{mrow}.
33898(@xref{Extracting Elements}.)
33899@end defun
33900
33901@defun mat-col m n
33902Return the @var{n}th column of matrix @var{m}, in the form of a vector.
33903The arguments are not checked for correctness.
33904@end defun
33905
33906@defun mat-less-row m n
33907Return a copy of matrix @var{m} with its @var{n}th row deleted. The
33908number @var{n} must be in range from 1 to the number of rows in @var{m}.
33909@end defun
33910
33911@defun mat-less-col m n
33912Return a copy of matrix @var{m} with its @var{n}th column deleted.
33913@end defun
33914
33915@defun transpose m
33916Return the transpose of matrix @var{m}.
33917@end defun
33918
33919@defun flatten-vector v
33920Flatten nested vector @var{v} into a vector of scalars. For example,
33921if @var{v} is @samp{[[1, 2, 3], [4, 5]]} the result is @samp{[1, 2, 3, 4, 5]}.
33922@end defun
33923
33924@defun copy-matrix m
33925If @var{m} is a matrix, return a copy of @var{m}. This maps
33926@code{copy-sequence} over the rows of @var{m}; in Lisp terms, each
33927element of the result matrix will be @code{eq} to the corresponding
33928element of @var{m}, but none of the @code{cons} cells that make up
33929the structure of the matrix will be @code{eq}. If @var{m} is a plain
a4231b04 33930vector, this is the same as @code{copy-sequence}.
d7b8e6c6
EZ
33931@end defun
33932
33933@defun swap-rows m r1 r2
33934Exchange rows @var{r1} and @var{r2} of matrix @var{m} in-place. In
33935other words, unlike most of the other functions described here, this
33936function changes @var{m} itself rather than building up a new result
33937matrix. The return value is @var{m}, i.e., @samp{(eq (swap-rows m 1 2) m)}
33938is true, with the side effect of exchanging the first two rows of
a4231b04 33939@var{m}.
d7b8e6c6
EZ
33940@end defun
33941
33942@node Symbolic Lisp Functions, Formatting Lisp Functions, Vector Lisp Functions, Internals
33943@subsubsection Symbolic Functions
33944
33945@noindent
33946The functions described here operate on symbolic formulas in the
33947Calculator.
33948
33949@defun calc-prepare-selection num
33950Prepare a stack entry for selection operations. If @var{num} is
33951omitted, the stack entry containing the cursor is used; otherwise,
33952it is the number of the stack entry to use. This function stores
33953useful information about the current stack entry into a set of
33954variables. @code{calc-selection-cache-num} contains the number of
33955the stack entry involved (equal to @var{num} if you specified it);
33956@code{calc-selection-cache-entry} contains the stack entry as a
33957list (such as @code{calc-top-list} would return with @code{entry}
33958as the selection mode); and @code{calc-selection-cache-comp} contains
33959a special ``tagged'' composition (@pxref{Formatting Lisp Functions})
33960which allows Calc to relate cursor positions in the buffer with
33961their corresponding sub-formulas.
33962
33963A slight complication arises in the selection mechanism because
33964formulas may contain small integers. For example, in the vector
33965@samp{[1, 2, 1]} the first and last elements are @code{eq} to each
33966other; selections are recorded as the actual Lisp object that
33967appears somewhere in the tree of the whole formula, but storing
33968@code{1} would falsely select both @code{1}'s in the vector. So
33969@code{calc-prepare-selection} also checks the stack entry and
33970replaces any plain integers with ``complex number'' lists of the form
33971@samp{(cplx @var{n} 0)}. This list will be displayed the same as a
33972plain @var{n} and the change will be completely invisible to the
33973user, but it will guarantee that no two sub-formulas of the stack
33974entry will be @code{eq} to each other. Next time the stack entry
33975is involved in a computation, @code{calc-normalize} will replace
33976these lists with plain numbers again, again invisibly to the user.
33977@end defun
33978
33979@defun calc-encase-atoms x
33980This modifies the formula @var{x} to ensure that each part of the
33981formula is a unique atom, using the @samp{(cplx @var{n} 0)} trick
33982described above. This function may use @code{setcar} to modify
33983the formula in-place.
33984@end defun
33985
33986@defun calc-find-selected-part
33987Find the smallest sub-formula of the current formula that contains
33988the cursor. This assumes @code{calc-prepare-selection} has been
33989called already. If the cursor is not actually on any part of the
33990formula, this returns @code{nil}.
33991@end defun
33992
33993@defun calc-change-current-selection selection
33994Change the currently prepared stack element's selection to
33995@var{selection}, which should be @code{eq} to some sub-formula
33996of the stack element, or @code{nil} to unselect the formula.
33997The stack element's appearance in the Calc buffer is adjusted
33998to reflect the new selection.
33999@end defun
34000
34001@defun calc-find-nth-part expr n
34002Return the @var{n}th sub-formula of @var{expr}. This function is used
34003by the selection commands, and (unless @kbd{j b} has been used) treats
34004sums and products as flat many-element formulas. Thus if @var{expr}
34005is @samp{((a + b) - c) + d}, calling @code{calc-find-nth-part} with
34006@var{n} equal to four will return @samp{d}.
34007@end defun
34008
34009@defun calc-find-parent-formula expr part
34010Return the sub-formula of @var{expr} which immediately contains
34011@var{part}. If @var{expr} is @samp{a*b + (c+1)*d} and @var{part}
34012is @code{eq} to the @samp{c+1} term of @var{expr}, then this function
34013will return @samp{(c+1)*d}. If @var{part} turns out not to be a
34014sub-formula of @var{expr}, the function returns @code{nil}. If
34015@var{part} is @code{eq} to @var{expr}, the function returns @code{t}.
34016This function does not take associativity into account.
34017@end defun
34018
34019@defun calc-find-assoc-parent-formula expr part
34020This is the same as @code{calc-find-parent-formula}, except that
34021(unless @kbd{j b} has been used) it continues widening the selection
34022to contain a complete level of the formula. Given @samp{a} from
34023@samp{((a + b) - c) + d}, @code{calc-find-parent-formula} will
34024return @samp{a + b} but @code{calc-find-assoc-parent-formula} will
34025return the whole expression.
34026@end defun
34027
34028@defun calc-grow-assoc-formula expr part
34029This expands sub-formula @var{part} of @var{expr} to encompass a
34030complete level of the formula. If @var{part} and its immediate
34031parent are not compatible associative operators, or if @kbd{j b}
34032has been used, this simply returns @var{part}.
34033@end defun
34034
34035@defun calc-find-sub-formula expr part
34036This finds the immediate sub-formula of @var{expr} which contains
34037@var{part}. It returns an index @var{n} such that
34038@samp{(calc-find-nth-part @var{expr} @var{n})} would return @var{part}.
34039If @var{part} is not a sub-formula of @var{expr}, it returns @code{nil}.
34040If @var{part} is @code{eq} to @var{expr}, it returns @code{t}. This
34041function does not take associativity into account.
34042@end defun
34043
34044@defun calc-replace-sub-formula expr old new
34045This function returns a copy of formula @var{expr}, with the
34046sub-formula that is @code{eq} to @var{old} replaced by @var{new}.
34047@end defun
34048
34049@defun simplify expr
34050Simplify the expression @var{expr} by applying various algebraic rules.
34051This is what the @w{@kbd{a s}} (@code{calc-simplify}) command uses. This
34052always returns a copy of the expression; the structure @var{expr} points
34053to remains unchanged in memory.
34054
34055More precisely, here is what @code{simplify} does: The expression is
34056first normalized and evaluated by calling @code{normalize}. If any
34057@code{AlgSimpRules} have been defined, they are then applied. Then
34058the expression is traversed in a depth-first, bottom-up fashion; at
34059each level, any simplifications that can be made are made until no
34060further changes are possible. Once the entire formula has been
34061traversed in this way, it is compared with the original formula (from
34062before the call to @code{normalize}) and, if it has changed,
34063the entire procedure is repeated (starting with @code{normalize})
34064until no further changes occur. Usually only two iterations are
34065needed:@: one to simplify the formula, and another to verify that no
34066further simplifications were possible.
34067@end defun
34068
34069@defun simplify-extended expr
34070Simplify the expression @var{expr}, with additional rules enabled that
34071help do a more thorough job, while not being entirely ``safe'' in all
34072circumstances. (For example, this mode will simplify @samp{sqrt(x^2)}
34073to @samp{x}, which is only valid when @var{x} is positive.) This is
34074implemented by temporarily binding the variable @code{math-living-dangerously}
34075to @code{t} (using a @code{let} form) and calling @code{simplify}.
34076Dangerous simplification rules are written to check this variable
a4231b04 34077before taking any action.
d7b8e6c6
EZ
34078@end defun
34079
34080@defun simplify-units expr
34081Simplify the expression @var{expr}, treating variable names as units
34082whenever possible. This works by binding the variable
34083@code{math-simplifying-units} to @code{t} while calling @code{simplify}.
34084@end defun
34085
34086@defmac math-defsimplify funcs body
34087Register a new simplification rule; this is normally called as a top-level
34088form, like @code{defun} or @code{defmath}. If @var{funcs} is a symbol
34089(like @code{+} or @code{calcFunc-sqrt}), this simplification rule is
34090applied to the formulas which are calls to the specified function. Or,
34091@var{funcs} can be a list of such symbols; the rule applies to all
34092functions on the list. The @var{body} is written like the body of a
34093function with a single argument called @code{expr}. The body will be
34094executed with @code{expr} bound to a formula which is a call to one of
34095the functions @var{funcs}. If the function body returns @code{nil}, or
34096if it returns a result @code{equal} to the original @code{expr}, it is
34097ignored and Calc goes on to try the next simplification rule that applies.
34098If the function body returns something different, that new formula is
a4231b04 34099substituted for @var{expr} in the original formula.
d7b8e6c6
EZ
34100
34101At each point in the formula, rules are tried in the order of the
34102original calls to @code{math-defsimplify}; the search stops after the
34103first rule that makes a change. Thus later rules for that same
34104function will not have a chance to trigger until the next iteration
34105of the main @code{simplify} loop.
34106
34107Note that, since @code{defmath} is not being used here, @var{body} must
34108be written in true Lisp code without the conveniences that @code{defmath}
34109provides. If you prefer, you can have @var{body} simply call another
34110function (defined with @code{defmath}) which does the real work.
34111
34112The arguments of a function call will already have been simplified
34113before any rules for the call itself are invoked. Since a new argument
34114list is consed up when this happens, this means that the rule's body is
34115allowed to rearrange the function's arguments destructively if that is
34116convenient. Here is a typical example of a simplification rule:
34117
34118@smallexample
34119(math-defsimplify calcFunc-arcsinh
34120 (or (and (math-looks-negp (nth 1 expr))
34121 (math-neg (list 'calcFunc-arcsinh
34122 (math-neg (nth 1 expr)))))
34123 (and (eq (car-safe (nth 1 expr)) 'calcFunc-sinh)
34124 (or math-living-dangerously
34125 (math-known-realp (nth 1 (nth 1 expr))))
34126 (nth 1 (nth 1 expr)))))
34127@end smallexample
34128
34129This is really a pair of rules written with one @code{math-defsimplify}
34130for convenience; the first replaces @samp{arcsinh(-x)} with
34131@samp{-arcsinh(x)}, and the second, which is safe only for real @samp{x},
a4231b04 34132replaces @samp{arcsinh(sinh(x))} with @samp{x}.
d7b8e6c6
EZ
34133@end defmac
34134
34135@defun common-constant-factor expr
34136Check @var{expr} to see if it is a sum of terms all multiplied by the
34137same rational value. If so, return this value. If not, return @code{nil}.
34138For example, if called on @samp{6x + 9y + 12z}, it would return 3, since
341393 is a common factor of all the terms.
34140@end defun
34141
34142@defun cancel-common-factor expr factor
34143Assuming @var{expr} is a sum with @var{factor} as a common factor,
34144divide each term of the sum by @var{factor}. This is done by
34145destructively modifying parts of @var{expr}, on the assumption that
34146it is being used by a simplification rule (where such things are
34147allowed; see above). For example, consider this built-in rule for
34148square roots:
34149
34150@smallexample
34151(math-defsimplify calcFunc-sqrt
34152 (let ((fac (math-common-constant-factor (nth 1 expr))))
34153 (and fac (not (eq fac 1))
34154 (math-mul (math-normalize (list 'calcFunc-sqrt fac))
34155 (math-normalize
34156 (list 'calcFunc-sqrt
34157 (math-cancel-common-factor
34158 (nth 1 expr) fac)))))))
34159@end smallexample
34160@end defun
34161
34162@defun frac-gcd a b
34163Compute a ``rational GCD'' of @var{a} and @var{b}, which must both be
34164rational numbers. This is the fraction composed of the GCD of the
34165numerators of @var{a} and @var{b}, over the GCD of the denominators.
34166It is used by @code{common-constant-factor}. Note that the standard
a4231b04 34167@code{gcd} function uses the LCM to combine the denominators.
d7b8e6c6
EZ
34168@end defun
34169
34170@defun map-tree func expr many
34171Try applying Lisp function @var{func} to various sub-expressions of
34172@var{expr}. Initially, call @var{func} with @var{expr} itself as an
34173argument. If this returns an expression which is not @code{equal} to
34174@var{expr}, apply @var{func} again until eventually it does return
34175@var{expr} with no changes. Then, if @var{expr} is a function call,
34176recursively apply @var{func} to each of the arguments. This keeps going
34177until no changes occur anywhere in the expression; this final expression
34178is returned by @code{map-tree}. Note that, unlike simplification rules,
34179@var{func} functions may @emph{not} make destructive changes to
34180@var{expr}. If a third argument @var{many} is provided, it is an
34181integer which says how many times @var{func} may be applied; the
a4231b04 34182default, as described above, is infinitely many times.
d7b8e6c6
EZ
34183@end defun
34184
34185@defun compile-rewrites rules
34186Compile the rewrite rule set specified by @var{rules}, which should
34187be a formula that is either a vector or a variable name. If the latter,
34188the compiled rules are saved so that later @code{compile-rules} calls
34189for that same variable can return immediately. If there are problems
34190with the rules, this function calls @code{error} with a suitable
34191message.
34192@end defun
34193
34194@defun apply-rewrites expr crules heads
34195Apply the compiled rewrite rule set @var{crules} to the expression
34196@var{expr}. This will make only one rewrite and only checks at the
34197top level of the expression. The result @code{nil} if no rules
34198matched, or if the only rules that matched did not actually change
34199the expression. The @var{heads} argument is optional; if is given,
34200it should be a list of all function names that (may) appear in
34201@var{expr}. The rewrite compiler tags each rule with the
34202rarest-looking function name in the rule; if you specify @var{heads},
34203@code{apply-rewrites} can use this information to narrow its search
34204down to just a few rules in the rule set.
34205@end defun
34206
34207@defun rewrite-heads expr
34208Compute a @var{heads} list for @var{expr} suitable for use with
34209@code{apply-rewrites}, as discussed above.
34210@end defun
34211
34212@defun rewrite expr rules many
34213This is an all-in-one rewrite function. It compiles the rule set
34214specified by @var{rules}, then uses @code{map-tree} to apply the
34215rules throughout @var{expr} up to @var{many} (default infinity)
34216times.
34217@end defun
34218
34219@defun match-patterns pat vec not-flag
34220Given a Calc vector @var{vec} and an uncompiled pattern set or
34221pattern set variable @var{pat}, this function returns a new vector
34222of all elements of @var{vec} which do (or don't, if @var{not-flag} is
34223non-@code{nil}) match any of the patterns in @var{pat}.
34224@end defun
34225
34226@defun deriv expr var value symb
34227Compute the derivative of @var{expr} with respect to variable @var{var}
34228(which may actually be any sub-expression). If @var{value} is specified,
34229the derivative is evaluated at the value of @var{var}; otherwise, the
34230derivative is left in terms of @var{var}. If the expression contains
34231functions for which no derivative formula is known, new derivative
34232functions are invented by adding primes to the names; @pxref{Calculus}.
34233However, if @var{symb} is non-@code{nil}, the presence of undifferentiable
34234functions in @var{expr} instead cancels the whole differentiation, and
34235@code{deriv} returns @code{nil} instead.
34236
34237Derivatives of an @var{n}-argument function can be defined by
34238adding a @code{math-derivative-@var{n}} property to the property list
34239of the symbol for the function's derivative, which will be the
34240function name followed by an apostrophe. The value of the property
34241should be a Lisp function; it is called with the same arguments as the
34242original function call that is being differentiated. It should return
34243a formula for the derivative. For example, the derivative of @code{ln}
34244is defined by
34245
34246@smallexample
34247(put 'calcFunc-ln\' 'math-derivative-1
34248 (function (lambda (u) (math-div 1 u))))
34249@end smallexample
34250
34251The two-argument @code{log} function has two derivatives,
34252@smallexample
34253(put 'calcFunc-log\' 'math-derivative-2 ; d(log(x,b)) / dx
34254 (function (lambda (x b) ... )))
34255(put 'calcFunc-log\'2 'math-derivative-2 ; d(log(x,b)) / db
34256 (function (lambda (x b) ... )))
34257@end smallexample
34258@end defun
34259
34260@defun tderiv expr var value symb
34261Compute the total derivative of @var{expr}. This is the same as
34262@code{deriv}, except that variables other than @var{var} are not
34263assumed to be constant with respect to @var{var}.
34264@end defun
34265
34266@defun integ expr var low high
34267Compute the integral of @var{expr} with respect to @var{var}.
34268@xref{Calculus}, for further details.
34269@end defun
34270
34271@defmac math-defintegral funcs body
34272Define a rule for integrating a function or functions of one argument;
34273this macro is very similar in format to @code{math-defsimplify}.
34274The main difference is that here @var{body} is the body of a function
34275with a single argument @code{u} which is bound to the argument to the
34276function being integrated, not the function call itself. Also, the
34277variable of integration is available as @code{math-integ-var}. If
34278evaluation of the integral requires doing further integrals, the body
34279should call @samp{(math-integral @var{x})} to find the integral of
34280@var{x} with respect to @code{math-integ-var}; this function returns
34281@code{nil} if the integral could not be done. Some examples:
34282
34283@smallexample
34284(math-defintegral calcFunc-conj
34285 (let ((int (math-integral u)))
34286 (and int
34287 (list 'calcFunc-conj int))))
34288
34289(math-defintegral calcFunc-cos
34290 (and (equal u math-integ-var)
34291 (math-from-radians-2 (list 'calcFunc-sin u))))
34292@end smallexample
34293
34294In the @code{cos} example, we define only the integral of @samp{cos(x) dx},
34295relying on the general integration-by-substitution facility to handle
34296cosines of more complicated arguments. An integration rule should return
34297@code{nil} if it can't do the integral; if several rules are defined for
34298the same function, they are tried in order until one returns a non-@code{nil}
a4231b04 34299result.
d7b8e6c6
EZ
34300@end defmac
34301
34302@defmac math-defintegral-2 funcs body
34303Define a rule for integrating a function or functions of two arguments.
34304This is exactly analogous to @code{math-defintegral}, except that @var{body}
34305is written as the body of a function with two arguments, @var{u} and
a4231b04 34306@var{v}.
d7b8e6c6
EZ
34307@end defmac
34308
34309@defun solve-for lhs rhs var full
34310Attempt to solve the equation @samp{@var{lhs} = @var{rhs}} by isolating
34311the variable @var{var} on the lefthand side; return the resulting righthand
34312side, or @code{nil} if the equation cannot be solved. The variable
34313@var{var} must appear at least once in @var{lhs} or @var{rhs}. Note that
34314the return value is a formula which does not contain @var{var}; this is
34315different from the user-level @code{solve} and @code{finv} functions,
34316which return a rearranged equation or a functional inverse, respectively.
34317If @var{full} is non-@code{nil}, a full solution including dummy signs
34318and dummy integers will be produced. User-defined inverses are provided
a4231b04 34319as properties in a manner similar to derivatives:
d7b8e6c6
EZ
34320
34321@smallexample
34322(put 'calcFunc-ln 'math-inverse
34323 (function (lambda (x) (list 'calcFunc-exp x))))
34324@end smallexample
34325
34326This function can call @samp{(math-solve-get-sign @var{x})} to create
34327a new arbitrary sign variable, returning @var{x} times that sign, and
34328@samp{(math-solve-get-int @var{x})} to create a new arbitrary integer
34329variable multiplied by @var{x}. These functions simply return @var{x}
34330if the caller requested a non-``full'' solution.
34331@end defun
34332
34333@defun solve-eqn expr var full
34334This version of @code{solve-for} takes an expression which will
34335typically be an equation or inequality. (If it is not, it will be
34336interpreted as the equation @samp{@var{expr} = 0}.) It returns an
34337equation or inequality, or @code{nil} if no solution could be found.
34338@end defun
34339
34340@defun solve-system exprs vars full
34341This function solves a system of equations. Generally, @var{exprs}
34342and @var{vars} will be vectors of equal length.
34343@xref{Solving Systems of Equations}, for other options.
34344@end defun
34345
34346@defun expr-contains expr var
34347Returns a non-@code{nil} value if @var{var} occurs as a subexpression
34348of @var{expr}.
34349
34350This function might seem at first to be identical to
34351@code{calc-find-sub-formula}. The key difference is that
34352@code{expr-contains} uses @code{equal} to test for matches, whereas
34353@code{calc-find-sub-formula} uses @code{eq}. In the formula
34354@samp{f(a, a)}, the two @samp{a}s will be @code{equal} but not
a4231b04 34355@code{eq} to each other.
d7b8e6c6
EZ
34356@end defun
34357
34358@defun expr-contains-count expr var
34359Returns the number of occurrences of @var{var} as a subexpression
a4231b04 34360of @var{expr}, or @code{nil} if there are no occurrences.
d7b8e6c6
EZ
34361@end defun
34362
34363@defun expr-depends expr var
34364Returns true if @var{expr} refers to any variable the occurs in @var{var}.
34365In other words, it checks if @var{expr} and @var{var} have any variables
34366in common.
34367@end defun
34368
34369@defun expr-contains-vars expr
34370Return true if @var{expr} contains any variables, or @code{nil} if @var{expr}
34371contains only constants and functions with constant arguments.
34372@end defun
34373
34374@defun expr-subst expr old new
34375Returns a copy of @var{expr}, with all occurrences of @var{old} replaced
34376by @var{new}. This treats @code{lambda} forms specially with respect
34377to the dummy argument variables, so that the effect is always to return
a4231b04 34378@var{expr} evaluated at @var{old} = @var{new}.
d7b8e6c6
EZ
34379@end defun
34380
34381@defun multi-subst expr old new
34382This is like @code{expr-subst}, except that @var{old} and @var{new}
34383are lists of expressions to be substituted simultaneously. If one
34384list is shorter than the other, trailing elements of the longer list
34385are ignored.
34386@end defun
34387
34388@defun expr-weight expr
34389Returns the ``weight'' of @var{expr}, basically a count of the total
34390number of objects and function calls that appear in @var{expr}. For
34391``primitive'' objects, this will be one.
34392@end defun
34393
34394@defun expr-height expr
34395Returns the ``height'' of @var{expr}, which is the deepest level to
34396which function calls are nested. (Note that @samp{@var{a} + @var{b}}
a4231b04 34397counts as a function call.) For primitive objects, this returns zero.
d7b8e6c6
EZ
34398@end defun
34399
34400@defun polynomial-p expr var
34401Check if @var{expr} is a polynomial in variable (or sub-expression)
34402@var{var}. If so, return the degree of the polynomial, that is, the
34403highest power of @var{var} that appears in @var{expr}. For example,
34404for @samp{(x^2 + 3)^3 + 4} this would return 6. This function returns
34405@code{nil} unless @var{expr}, when expanded out by @kbd{a x}
34406(@code{calc-expand}), would consist of a sum of terms in which @var{var}
34407appears only raised to nonnegative integer powers. Note that if
34408@var{var} does not occur in @var{expr}, then @var{expr} is considered
a4231b04 34409a polynomial of degree 0.
d7b8e6c6
EZ
34410@end defun
34411
34412@defun is-polynomial expr var degree loose
34413Check if @var{expr} is a polynomial in variable or sub-expression
34414@var{var}, and, if so, return a list representation of the polynomial
34415where the elements of the list are coefficients of successive powers of
34416@var{var}: @samp{@var{a} + @var{b} x + @var{c} x^3} would produce the
34417list @samp{(@var{a} @var{b} 0 @var{c})}, and @samp{(x + 1)^2} would
34418produce the list @samp{(1 2 1)}. The highest element of the list will
34419be non-zero, with the special exception that if @var{expr} is the
34420constant zero, the returned value will be @samp{(0)}. Return @code{nil}
34421if @var{expr} is not a polynomial in @var{var}. If @var{degree} is
34422specified, this will not consider polynomials of degree higher than that
34423value. This is a good precaution because otherwise an input of
34424@samp{(x+1)^1000} will cause a huge coefficient list to be built. If
34425@var{loose} is non-@code{nil}, then a looser definition of a polynomial
34426is used in which coefficients are no longer required not to depend on
34427@var{var}, but are only required not to take the form of polynomials
34428themselves. For example, @samp{sin(x) x^2 + cos(x)} is a loose
34429polynomial with coefficients @samp{((calcFunc-cos x) 0 (calcFunc-sin
34430x))}. The result will never be @code{nil} in loose mode, since any
a4231b04 34431expression can be interpreted as a ``constant'' loose polynomial.
d7b8e6c6
EZ
34432@end defun
34433
34434@defun polynomial-base expr pred
34435Check if @var{expr} is a polynomial in any variable that occurs in it;
34436if so, return that variable. (If @var{expr} is a multivariate polynomial,
34437this chooses one variable arbitrarily.) If @var{pred} is specified, it should
34438be a Lisp function which is called as @samp{(@var{pred} @var{subexpr})},
34439and which should return true if @code{mpb-top-expr} (a global name for
34440the original @var{expr}) is a suitable polynomial in @var{subexpr}.
34441The default predicate uses @samp{(polynomial-p mpb-top-expr @var{subexpr})};
34442you can use @var{pred} to specify additional conditions. Or, you could
34443have @var{pred} build up a list of every suitable @var{subexpr} that
a4231b04 34444is found.
d7b8e6c6
EZ
34445@end defun
34446
34447@defun poly-simplify poly
34448Simplify polynomial coefficient list @var{poly} by (destructively)
34449clipping off trailing zeros.
34450@end defun
34451
34452@defun poly-mix a ac b bc
34453Mix two polynomial lists @var{a} and @var{b} (in the form returned by
34454@code{is-polynomial}) in a linear combination with coefficient expressions
34455@var{ac} and @var{bc}. The result is a (not necessarily simplified)
a4231b04 34456polynomial list representing @samp{@var{ac} @var{a} + @var{bc} @var{b}}.
d7b8e6c6
EZ
34457@end defun
34458
34459@defun poly-mul a b
34460Multiply two polynomial coefficient lists @var{a} and @var{b}. The
34461result will be in simplified form if the inputs were simplified.
34462@end defun
34463
34464@defun build-polynomial-expr poly var
34465Construct a Calc formula which represents the polynomial coefficient
34466list @var{poly} applied to variable @var{var}. The @kbd{a c}
34467(@code{calc-collect}) command uses @code{is-polynomial} to turn an
34468expression into a coefficient list, then @code{build-polynomial-expr}
a4231b04 34469to turn the list back into an expression in regular form.
d7b8e6c6
EZ
34470@end defun
34471
34472@defun check-unit-name var
34473Check if @var{var} is a variable which can be interpreted as a unit
34474name. If so, return the units table entry for that unit. This
34475will be a list whose first element is the unit name (not counting
34476prefix characters) as a symbol and whose second element is the
34477Calc expression which defines the unit. (Refer to the Calc sources
34478for details on the remaining elements of this list.) If @var{var}
34479is not a variable or is not a unit name, return @code{nil}.
34480@end defun
34481
34482@defun units-in-expr-p expr sub-exprs
34483Return true if @var{expr} contains any variables which can be
34484interpreted as units. If @var{sub-exprs} is @code{t}, the entire
34485expression is searched. If @var{sub-exprs} is @code{nil}, this
a4231b04 34486checks whether @var{expr} is directly a units expression.
d7b8e6c6
EZ
34487@end defun
34488
34489@defun single-units-in-expr-p expr
34490Check whether @var{expr} contains exactly one units variable. If so,
34491return the units table entry for the variable. If @var{expr} does
34492not contain any units, return @code{nil}. If @var{expr} contains
34493two or more units, return the symbol @code{wrong}.
34494@end defun
34495
34496@defun to-standard-units expr which
34497Convert units expression @var{expr} to base units. If @var{which}
34498is @code{nil}, use Calc's native base units. Otherwise, @var{which}
34499can specify a units system, which is a list of two-element lists,
34500where the first element is a Calc base symbol name and the second
a4231b04 34501is an expression to substitute for it.
d7b8e6c6
EZ
34502@end defun
34503
34504@defun remove-units expr
34505Return a copy of @var{expr} with all units variables replaced by ones.
34506This expression is generally normalized before use.
34507@end defun
34508
34509@defun extract-units expr
34510Return a copy of @var{expr} with everything but units variables replaced
34511by ones.
34512@end defun
34513
34514@node Formatting Lisp Functions, Hooks, Symbolic Lisp Functions, Internals
34515@subsubsection I/O and Formatting Functions
34516
34517@noindent
34518The functions described here are responsible for parsing and formatting
34519Calc numbers and formulas.
34520
34521@defun calc-eval str sep arg1 arg2 @dots{}
34522This is the simplest interface to the Calculator from another Lisp program.
34523@xref{Calling Calc from Your Programs}.
34524@end defun
34525
34526@defun read-number str
34527If string @var{str} contains a valid Calc number, either integer,
34528fraction, float, or HMS form, this function parses and returns that
34529number. Otherwise, it returns @code{nil}.
34530@end defun
34531
34532@defun read-expr str
34533Read an algebraic expression from string @var{str}. If @var{str} does
34534not have the form of a valid expression, return a list of the form
34535@samp{(error @var{pos} @var{msg})} where @var{pos} is an integer index
34536into @var{str} of the general location of the error, and @var{msg} is
a4231b04 34537a string describing the problem.
d7b8e6c6
EZ
34538@end defun
34539
34540@defun read-exprs str
34541Read a list of expressions separated by commas, and return it as a
34542Lisp list. If an error occurs in any expressions, an error list as
34543shown above is returned instead.
34544@end defun
34545
34546@defun calc-do-alg-entry initial prompt no-norm
34547Read an algebraic formula or formulas using the minibuffer. All
34548conventions of regular algebraic entry are observed. The return value
34549is a list of Calc formulas; there will be more than one if the user
34550entered a list of values separated by commas. The result is @code{nil}
34551if the user presses Return with a blank line. If @var{initial} is
34552given, it is a string which the minibuffer will initially contain.
34553If @var{prompt} is given, it is the prompt string to use; the default
34554is ``Algebraic:''. If @var{no-norm} is @code{t}, the formulas will
34555be returned exactly as parsed; otherwise, they will be passed through
a4231b04 34556@code{calc-normalize} first.
d7b8e6c6
EZ
34557
34558To support the use of @kbd{$} characters in the algebraic entry, use
34559@code{let} to bind @code{calc-dollar-values} to a list of the values
34560to be substituted for @kbd{$}, @kbd{$$}, and so on, and bind
34561@code{calc-dollar-used} to 0. Upon return, @code{calc-dollar-used}
34562will have been changed to the highest number of consecutive @kbd{$}s
a4231b04 34563that actually appeared in the input.
d7b8e6c6
EZ
34564@end defun
34565
34566@defun format-number a
34567Convert the real or complex number or HMS form @var{a} to string form.
34568@end defun
34569
34570@defun format-flat-expr a prec
34571Convert the arbitrary Calc number or formula @var{a} to string form,
34572in the style used by the trail buffer and the @code{calc-edit} command.
34573This is a simple format designed
34574mostly to guarantee the string is of a form that can be re-parsed by
34575@code{read-expr}. Most formatting modes, such as digit grouping,
34576complex number format, and point character, are ignored to ensure the
34577result will be re-readable. The @var{prec} parameter is normally 0; if
34578you pass a large integer like 1000 instead, the expression will be
a4231b04 34579surrounded by parentheses unless it is a plain number or variable name.
d7b8e6c6
EZ
34580@end defun
34581
34582@defun format-nice-expr a width
34583This is like @code{format-flat-expr} (with @var{prec} equal to 0),
34584except that newlines will be inserted to keep lines down to the
34585specified @var{width}, and vectors that look like matrices or rewrite
34586rules are written in a pseudo-matrix format. The @code{calc-edit}
34587command uses this when only one stack entry is being edited.
34588@end defun
34589
34590@defun format-value a width
34591Convert the Calc number or formula @var{a} to string form, using the
269b7745 34592format seen in the stack buffer. Beware the string returned may
d7b8e6c6
EZ
34593not be re-readable by @code{read-expr}, for example, because of digit
34594grouping. Multi-line objects like matrices produce strings that
34595contain newline characters to separate the lines. The @var{w}
34596parameter, if given, is the target window size for which to format
34597the expressions. If @var{w} is omitted, the width of the Calculator
a4231b04 34598window is used.
d7b8e6c6
EZ
34599@end defun
34600
34601@defun compose-expr a prec
34602Format the Calc number or formula @var{a} according to the current
34603language mode, returning a ``composition.'' To learn about the
34604structure of compositions, see the comments in the Calc source code.
34605You can specify the format of a given type of function call by putting
34606a @code{math-compose-@var{lang}} property on the function's symbol,
34607whose value is a Lisp function that takes @var{a} and @var{prec} as
34608arguments and returns a composition. Here @var{lang} is a language
34609mode name, one of @code{normal}, @code{big}, @code{c}, @code{pascal},
34610@code{fortran}, @code{tex}, @code{eqn}, @code{math}, or @code{maple}.
34611In Big mode, Calc actually tries @code{math-compose-big} first, then
34612tries @code{math-compose-normal}. If this property does not exist,
34613or if the function returns @code{nil}, the function is written in the
34614normal function-call notation for that language.
34615@end defun
34616
34617@defun composition-to-string c w
34618Convert a composition structure returned by @code{compose-expr} into
34619a string. Multi-line compositions convert to strings containing
34620newline characters. The target window size is given by @var{w}.
34621The @code{format-value} function basically calls @code{compose-expr}
34622followed by @code{composition-to-string}.
34623@end defun
34624
34625@defun comp-width c
34626Compute the width in characters of composition @var{c}.
34627@end defun
34628
34629@defun comp-height c
34630Compute the height in lines of composition @var{c}.
34631@end defun
34632
34633@defun comp-ascent c
34634Compute the portion of the height of composition @var{c} which is on or
34635above the baseline. For a one-line composition, this will be one.
34636@end defun
34637
34638@defun comp-descent c
34639Compute the portion of the height of composition @var{c} which is below
34640the baseline. For a one-line composition, this will be zero.
34641@end defun
34642
34643@defun comp-first-char c
34644If composition @var{c} is a ``flat'' composition, return the first
34645(leftmost) character of the composition as an integer. Otherwise,
a4231b04 34646return @code{nil}.
d7b8e6c6
EZ
34647@end defun
34648
34649@defun comp-last-char c
34650If composition @var{c} is a ``flat'' composition, return the last
34651(rightmost) character, otherwise return @code{nil}.
34652@end defun
34653
34654@comment @node Lisp Variables, Hooks, Formatting Lisp Functions, Internals
34655@comment @subsubsection Lisp Variables
177c0ea7 34656@comment
d7b8e6c6
EZ
34657@comment @noindent
34658@comment (This section is currently unfinished.)
34659
34660@node Hooks, , Formatting Lisp Functions, Internals
34661@subsubsection Hooks
34662
34663@noindent
34664Hooks are variables which contain Lisp functions (or lists of functions)
34665which are called at various times. Calc defines a number of hooks
34666that help you to customize it in various ways. Calc uses the Lisp
34667function @code{run-hooks} to invoke the hooks shown below. Several
34668other customization-related variables are also described here.
34669
34670@defvar calc-load-hook
34671This hook is called at the end of @file{calc.el}, after the file has
34672been loaded, before any functions in it have been called, but after
34673@code{calc-mode-map} and similar variables have been set up.
34674@end defvar
34675
34676@defvar calc-ext-load-hook
34677This hook is called at the end of @file{calc-ext.el}.
34678@end defvar
34679
34680@defvar calc-start-hook
34681This hook is called as the last step in a @kbd{M-x calc} command.
34682At this point, the Calc buffer has been created and initialized if
34683necessary, the Calc window and trail window have been created,
34684and the ``Welcome to Calc'' message has been displayed.
34685@end defvar
34686
34687@defvar calc-mode-hook
34688This hook is called when the Calc buffer is being created. Usually
34689this will only happen once per Emacs session. The hook is called
34690after Emacs has switched to the new buffer, the mode-settings file
34691has been read if necessary, and all other buffer-local variables
34692have been set up. After this hook returns, Calc will perform a
34693@code{calc-refresh} operation, set up the mode line display, then
34694evaluate any deferred @code{calc-define} properties that have not
34695been evaluated yet.
34696@end defvar
34697
34698@defvar calc-trail-mode-hook
34699This hook is called when the Calc Trail buffer is being created.
34700It is called as the very last step of setting up the Trail buffer.
34701Like @code{calc-mode-hook}, this will normally happen only once
34702per Emacs session.
34703@end defvar
34704
34705@defvar calc-end-hook
34706This hook is called by @code{calc-quit}, generally because the user
34707presses @kbd{q} or @kbd{M-# c} while in Calc. The Calc buffer will
34708be the current buffer. The hook is called as the very first
34709step, before the Calc window is destroyed.
34710@end defvar
34711
34712@defvar calc-window-hook
651e237b 34713If this hook is non-@code{nil}, it is called to create the Calc window.
d7b8e6c6
EZ
34714Upon return, this new Calc window should be the current window.
34715(The Calc buffer will already be the current buffer when the
34716hook is called.) If the hook is not defined, Calc will
34717generally use @code{split-window}, @code{set-window-buffer},
34718and @code{select-window} to create the Calc window.
34719@end defvar
34720
34721@defvar calc-trail-window-hook
651e237b
JB
34722If this hook is non-@code{nil}, it is called to create the Calc Trail
34723window. The variable @code{calc-trail-buffer} will contain the buffer
34724which the window should use. Unlike @code{calc-window-hook}, this hook
34725must @emph{not} switch into the new window.
d7b8e6c6
EZ
34726@end defvar
34727
34728@defvar calc-edit-mode-hook
34729This hook is called by @code{calc-edit} (and the other ``edit''
34730commands) when the temporary editing buffer is being created.
34731The buffer will have been selected and set up to be in
34732@code{calc-edit-mode}, but will not yet have been filled with
34733text. (In fact it may still have leftover text from a previous
34734@code{calc-edit} command.)
34735@end defvar
34736
34737@defvar calc-mode-save-hook
34738This hook is called by the @code{calc-save-modes} command,
34739after Calc's own mode features have been inserted into the
3b846359 34740Calc init file and just before the ``End of mode settings''
d7b8e6c6
EZ
34741message is inserted.
34742@end defvar
34743
34744@defvar calc-reset-hook
34745This hook is called after @kbd{M-# 0} (@code{calc-reset}) has
34746reset all modes. The Calc buffer will be the current buffer.
34747@end defvar
34748
34749@defvar calc-other-modes
34750This variable contains a list of strings. The strings are
34751concatenated at the end of the modes portion of the Calc
34752mode line (after standard modes such as ``Deg'', ``Inv'' and
34753``Hyp''). Each string should be a short, single word followed
34754by a space. The variable is @code{nil} by default.
34755@end defvar
34756
34757@defvar calc-mode-map
34758This is the keymap that is used by Calc mode. The best time
34759to adjust it is probably in a @code{calc-mode-hook}. If the
34760Calc extensions package (@file{calc-ext.el}) has not yet been
34761loaded, many of these keys will be bound to @code{calc-missing-key},
34762which is a command that loads the extensions package and
34763``retypes'' the key. If your @code{calc-mode-hook} rebinds
34764one of these keys, it will probably be overridden when the
34765extensions are loaded.
34766@end defvar
34767
34768@defvar calc-digit-map
34769This is the keymap that is used during numeric entry. Numeric
34770entry uses the minibuffer, but this map binds every non-numeric
34771key to @code{calcDigit-nondigit} which generally calls
34772@code{exit-minibuffer} and ``retypes'' the key.
34773@end defvar
34774
34775@defvar calc-alg-ent-map
34776This is the keymap that is used during algebraic entry. This is
34777mostly a copy of @code{minibuffer-local-map}.
34778@end defvar
34779
34780@defvar calc-store-var-map
34781This is the keymap that is used during entry of variable names for
34782commands like @code{calc-store} and @code{calc-recall}. This is
34783mostly a copy of @code{minibuffer-local-completion-map}.
34784@end defvar
34785
34786@defvar calc-edit-mode-map
34787This is the (sparse) keymap used by @code{calc-edit} and other
34788temporary editing commands. It binds @key{RET}, @key{LFD},
34789and @kbd{C-c C-c} to @code{calc-edit-finish}.
34790@end defvar
34791
34792@defvar calc-mode-var-list
34793This is a list of variables which are saved by @code{calc-save-modes}.
34794Each entry is a list of two items, the variable (as a Lisp symbol)
34795and its default value. When modes are being saved, each variable
34796is compared with its default value (using @code{equal}) and any
34797non-default variables are written out.
34798@end defvar
34799
34800@defvar calc-local-var-list
34801This is a list of variables which should be buffer-local to the
34802Calc buffer. Each entry is a variable name (as a Lisp symbol).
34803These variables also have their default values manipulated by
34804the @code{calc} and @code{calc-quit} commands; @pxref{Multiple Calculators}.
34805Since @code{calc-mode-hook} is called after this list has been
34806used the first time, your hook should add a variable to the
34807list and also call @code{make-local-variable} itself.
34808@end defvar
34809
b154df16
JB
34810@node Customizable Variables, Reporting Bugs, Programming, Top
34811@appendix Customizable Variables
34812
34813GNU Calc is controlled by many variables, most of which can be reset
34814from within Calc. Some variables are less involved with actual
34815calculation, and can be set outside of Calc using Emacs's
34816customization facilities. These variables are listed below.
34817Typing @kbd{M-x customize-variable RET @var{variable-name} RET}
34818will bring up a buffer in which the variable's value can be redefined.
34819Typing @kbd{M-x customize-group RET calc RET} will bring up a buffer which
34820contains all of Calc's customizable variables. (These variables can
34821also be reset by putting the appropriate lines in your .emacs file;
34822@xref{Init File, ,Init File, emacs, The GNU Emacs Manual}.)
34823
34824Some of the customizable variables are regular expressions. A regular
34825expression is basically a pattern that Calc can search for.
34826See @ref{Regexp Search,, Regular Expression Search, emacs, The GNU Emacs Manual}
34827to see how regular expressions work.
d7b8e6c6 34828
651e237b 34829@defvar calc-settings-file
b154df16
JB
34830The variable @code{calc-settings-file} holds the file name in
34831which commands like @kbd{m m} and @kbd{Z P} store ``permanent''
34832definitions.
34833If @code{calc-settings-file} is not your user init file (typically
34834@file{~/.emacs}) and if the variable @code{calc-loaded-settings-file} is
34835@code{nil}, then Calc will automatically load your settings file (if it
34836exists) the first time Calc is invoked.
34837
34838The default value for this variable is @code{"~/.calc.el"}.
651e237b 34839@end defvar
b154df16 34840
651e237b 34841@defvar calc-gnuplot-name
b154df16
JB
34842See @ref{Graphics}.@*
34843The variable @code{calc-gnuplot-name} should be the name of the
34844GNUPLOT program (a string). If you have GNUPLOT installed on your
34845system but Calc is unable to find it, you may need to set this
34846variable. (@pxref{Customizable Variables})
34847You may also need to set some Lisp variables to show Calc how to run
34848GNUPLOT on your system, see @ref{Devices, ,Graphical Devices} . The default value
34849of @code{calc-gnuplot-name} is @code{"gnuplot"}.
651e237b 34850@end defvar
b154df16 34851
651e237b
JB
34852@defvar calc-gnuplot-plot-command
34853@defvarx calc-gnuplot-print-command
b154df16
JB
34854See @ref{Devices, ,Graphical Devices}.@*
34855The variables @code{calc-gnuplot-plot-command} and
34856@code{calc-gnuplot-print-command} represent system commands to
34857display and print the output of GNUPLOT, respectively. These may be
34858@code{nil} if no command is necessary, or strings which can include
34859@samp{%s} to signify the name of the file to be displayed or printed.
34860Or, these variables may contain Lisp expressions which are evaluated
34861to display or print the output.
d7b8e6c6 34862
b154df16
JB
34863The default value of @code{calc-gnuplot-plot-command} is @code{nil},
34864and the default value of @code{calc-gnuplot-print-command} is
34865@code{"lp %s"}.
651e237b 34866@end defvar
b154df16 34867
651e237b 34868@defvar calc-language-alist
b154df16
JB
34869See @ref{Basic Embedded Mode}.@*
34870The variable @code{calc-language-alist} controls the languages that
34871Calc will associate with major modes. When Calc embedded mode is
34872enabled, it will try to use the current major mode to
34873determine what language should be used. (This can be overridden using
34874Calc's mode changing commands, @xref{Mode Settings in Embedded Mode}.)
34875The variable @code{calc-language-alist} consists of a list of pairs of
5208b407 34876the form @code{(@var{MAJOR-MODE} . @var{LANGUAGE})}; for example,
b154df16 34877@code{(latex-mode . latex)} is one such pair. If Calc embedded is
5208b407
JB
34878activated in a buffer whose major mode is @var{MAJOR-MODE}, it will set itself
34879to use the language @var{LANGUAGE}.
b154df16
JB
34880
34881The default value of @code{calc-language-alist} is
d7b8e6c6 34882@example
b154df16
JB
34883 ((latex-mode . latex)
34884 (tex-mode . tex)
34885 (plain-tex-mode . tex)
34886 (context-mode . tex)
34887 (nroff-mode . eqn)
34888 (pascal-mode . pascal)
34889 (c-mode . c)
34890 (c++-mode . c)
34891 (fortran-mode . fortran)
34892 (f90-mode . fortran))
d7b8e6c6 34893@end example
651e237b 34894@end defvar
d7b8e6c6 34895
651e237b 34896@defvar calc-embedded-announce-formula
b154df16
JB
34897See @ref{Customizing Embedded Mode}.@*
34898The variable @code{calc-embedded-announce-formula} helps determine
34899what formulas @kbd{M-# a} will activate in a buffer. It is a
34900regular expression, and when activating embedded formulas with
34901@kbd{M-# a}, it will tell Calc that what follows is a formula to be
34902activated. (Calc also uses other patterns to find formulas, such as
34903@samp{=>} and @samp{:=}.)
d7b8e6c6 34904
b154df16
JB
34905The default pattern is @code{"%Embed\n\\(% .*\n\\)*"}, which checks
34906for @samp{%Embed} followed by any number of lines beginning with
34907@samp{%} and a space.
651e237b 34908@end defvar
d7b8e6c6 34909
651e237b
JB
34910@defvar calc-embedded-open-formula
34911@defvarx calc-embedded-close-formula
b154df16
JB
34912See @ref{Customizing Embedded Mode}.@*
34913The variables @code{calc-embedded-open-formula} and
34914@code{calc-embedded-open-formula} control the region that Calc will
34915activate as a formula when Embedded mode is entered with @kbd{M-# e}.
34916They are regular expressions;
34917Calc normally scans backward and forward in the buffer for the
34918nearest text matching these regular expressions to be the ``formula
34919delimiters''.
34920
34921The simplest delimiters are blank lines. Other delimiters that
34922Embedded mode understands by default are:
34923@enumerate
34924@item
34925The @TeX{} and La@TeX{} math delimiters @samp{$ $}, @samp{$$ $$},
34926@samp{\[ \]}, and @samp{\( \)};
34927@item
34928Lines beginning with @samp{\begin} and @samp{\end} (except matrix delimiters);
34929@item
34930Lines beginning with @samp{@@} (Texinfo delimiters).
34931@item
34932Lines beginning with @samp{.EQ} and @samp{.EN} (@dfn{eqn} delimiters);
34933@item
34934Lines containing a single @samp{%} or @samp{.\"} symbol and nothing else.
34935@end enumerate
651e237b 34936@end defvar
d7b8e6c6 34937
651e237b
JB
34938@defvar calc-embedded-open-word
34939@defvarx calc-embedded-close-word
b154df16
JB
34940See @ref{Customizing Embedded Mode}.@*
34941The variables @code{calc-embedded-open-word} and
34942@code{calc-embedded-close-word} control the region that Calc will
34943activate when Embedded mode is entered with @kbd{M-# w}. They are
34944regular expressions.
d7b8e6c6 34945
b154df16
JB
34946The default values of @code{calc-embedded-open-word} and
34947@code{calc-embedded-close-word} are @code{"^\\|[^-+0-9.eE]"} and
34948@code{"$\\|[^-+0-9.eE]"} respectively.
651e237b 34949@end defvar
b154df16 34950
651e237b
JB
34951@defvar calc-embedded-open-plain
34952@defvarx calc-embedded-close-plain
b154df16
JB
34953See @ref{Customizing Embedded Mode}.@*
34954The variables @code{calc-embedded-open-plain} and
34955@code{calc-embedded-open-plain} are used to delimit ``plain''
34956formulas. Note that these are actual strings, not regular
34957expressions, because Calc must be able to write these string into a
34958buffer as well as to recognize them.
34959
34960The default string for @code{calc-embedded-open-plain} is
34961@code{"%%% "}, note the trailing space. The default string for
34962@code{calc-embedded-close-plain} is @code{" %%%\n"}, without
34963the trailing newline here, the first line of a Big mode formula
34964that followed might be shifted over with respect to the other lines.
651e237b 34965@end defvar
b154df16 34966
651e237b
JB
34967@defvar calc-embedded-open-new-formula
34968@defvarx calc-embedded-close-new-formula
b154df16
JB
34969See @ref{Customizing Embedded Mode}.@*
34970The variables @code{calc-embedded-open-new-formula} and
34971@code{calc-embedded-close-new-formula} are strings which are
34972inserted before and after a new formula when you type @kbd{M-# f}.
34973
34974The default value of @code{calc-embedded-open-new-formula} is
34975@code{"\n\n"}. If this string begins with a newline character and the
34976@kbd{M-# f} is typed at the beginning of a line, @kbd{M-# f} will skip
34977this first newline to avoid introducing unnecessary blank lines in the
34978file. The default value of @code{calc-embedded-close-new-formula} is
34979also @code{"\n\n"}. The final newline is omitted by @w{@kbd{M-# f}}
34980if typed at the end of a line. (It follows that if @kbd{M-# f} is
34981typed on a blank line, both a leading opening newline and a trailing
34982closing newline are omitted.)
651e237b 34983@end defvar
b154df16 34984
651e237b
JB
34985@defvar calc-embedded-open-mode
34986@defvarx calc-embedded-close-mode
b154df16
JB
34987See @ref{Customizing Embedded Mode}.@*
34988The variables @code{calc-embedded-open-mode} and
34989@code{calc-embedded-close-mode} are strings which Calc will place before
34990and after any mode annotations that it inserts. Calc never scans for
34991these strings; Calc always looks for the annotation itself, so it is not
34992necessary to add them to user-written annotations.
34993
34994The default value of @code{calc-embedded-open-mode} is @code{"% "}
34995and the default value of @code{calc-embedded-close-mode} is
34996@code{"\n"}.
34997If you change the value of @code{calc-embedded-close-mode}, it is a good
34998idea still to end with a newline so that mode annotations will appear on
34999lines by themselves.
651e237b 35000@end defvar
b154df16
JB
35001
35002@node Reporting Bugs, Summary, Customizable Variables, Top
d7b8e6c6
EZ
35003@appendix Reporting Bugs
35004
35005@noindent
7b09dd5b 35006If you find a bug in Calc, send e-mail to Jay Belanger,
d7b8e6c6
EZ
35007
35008@example
d4c2c0ef 35009belanger@@truman.edu
d7b8e6c6
EZ
35010@end example
35011
35012@noindent
ed7899e8 35013There is an automatic command @kbd{M-x report-calc-bug} which helps
d7b8e6c6
EZ
35014you to report bugs. This command prompts you for a brief subject
35015line, then leaves you in a mail editing buffer. Type @kbd{C-c C-c} to
35016send your mail. Make sure your subject line indicates that you are
ed7899e8
CW
35017reporting a Calc bug; this command sends mail to the maintainer's
35018regular mailbox.
d7b8e6c6 35019
029b2a44
JB
35020If you have suggestions for additional features for Calc, please send
35021them. Some have dared to suggest that Calc is already top-heavy with
35022features; this obviously cannot be the case, so if you have ideas, send
35023them right in.
d7b8e6c6
EZ
35024
35025At the front of the source file, @file{calc.el}, is a list of ideas for
029b2a44
JB
35026future work. If any enthusiastic souls wish to take it upon themselves
35027to work on these, please send a message (using @kbd{M-x report-calc-bug})
35028so any efforts can be coordinated.
35029
35030The latest version of Calc is available from Savannah, in the Emacs
35031CVS tree. See @uref{http://savannah.gnu.org/projects/emacs}.
d7b8e6c6
EZ
35032
35033@c [summary]
35034@node Summary, Key Index, Reporting Bugs, Top
35035@appendix Calc Summary
35036
35037@noindent
17c5c219 35038This section includes a complete list of Calc 2.1 keystroke commands.
d7b8e6c6
EZ
35039Each line lists the stack entries used by the command (top-of-stack
35040last), the keystrokes themselves, the prompts asked by the command,
35041and the result of the command (also with top-of-stack last).
35042The result is expressed using the equivalent algebraic function.
35043Commands which put no results on the stack show the full @kbd{M-x}
35044command name in that position. Numbers preceding the result or
35045command name refer to notes at the end.
35046
35047Algebraic functions and @kbd{M-x} commands that don't have corresponding
35048keystrokes are not listed in this summary.
35049@xref{Command Index}. @xref{Function Index}.
35050
35051@iftex
35052@begingroup
35053@tex
35054\vskip-2\baselineskip \null
35055\gdef\sumrow#1{\sumrowx#1\relax}%
35056\gdef\sumrowx#1\:#2\:#3\:#4\:#5\:#6\relax{%
35057\leavevmode%
5d67986c
RS
35058{\smallfonts
35059\hbox to5em{\sl\hss#1}%
35060\hbox to5em{\tt#2\hss}%
35061\hbox to4em{\sl#3\hss}%
35062\hbox to5em{\rm\hss#4}%
d7b8e6c6 35063\thinspace%
5d67986c
RS
35064{\tt#5}%
35065{\sl#6}%
35066}}%
35067\gdef\sumlpar{{\rm(}}%
35068\gdef\sumrpar{{\rm)}}%
35069\gdef\sumcomma{{\rm,\thinspace}}%
35070\gdef\sumexcl{{\rm!}}%
d7b8e6c6
EZ
35071\gdef\sumbreak{\vskip-2.5\baselineskip\goodbreak}%
35072\gdef\minus#1{{\tt-}}%
35073@end tex
35074@let@:=@sumsep
35075@let@r=@sumrow
35076@catcode`@(=@active @let(=@sumlpar
35077@catcode`@)=@active @let)=@sumrpar
35078@catcode`@,=@active @let,=@sumcomma
35079@catcode`@!=@active @let!=@sumexcl
35080@end iftex
35081@format
35082@iftex
35083@advance@baselineskip-2.5pt
d7b8e6c6
EZ
35084@let@c@sumbreak
35085@end iftex
35086@r{ @: M-# a @: @: 33 @:calc-embedded-activate@:}
35087@r{ @: M-# b @: @: @:calc-big-or-small@:}
35088@r{ @: M-# c @: @: @:calc@:}
35089@r{ @: M-# d @: @: @:calc-embedded-duplicate@:}
35090@r{ @: M-# e @: @: 34 @:calc-embedded@:}
35091@r{ @: M-# f @:formula @: @:calc-embedded-new-formula@:}
35092@r{ @: M-# g @: @: 35 @:calc-grab-region@:}
35093@r{ @: M-# i @: @: @:calc-info@:}
35094@r{ @: M-# j @: @: @:calc-embedded-select@:}
35095@r{ @: M-# k @: @: @:calc-keypad@:}
35096@r{ @: M-# l @: @: @:calc-load-everything@:}
35097@r{ @: M-# m @: @: @:read-kbd-macro@:}
35098@r{ @: M-# n @: @: 4 @:calc-embedded-next@:}
35099@r{ @: M-# o @: @: @:calc-other-window@:}
35100@r{ @: M-# p @: @: 4 @:calc-embedded-previous@:}
35101@r{ @: M-# q @:formula @: @:quick-calc@:}
35102@r{ @: M-# r @: @: 36 @:calc-grab-rectangle@:}
35103@r{ @: M-# s @: @: @:calc-info-summary@:}
35104@r{ @: M-# t @: @: @:calc-tutorial@:}
909bd0ca 35105@r{ @: M-# u @: @: @:calc-embedded-update-formula@:}
d7b8e6c6
EZ
35106@r{ @: M-# w @: @: @:calc-embedded-word@:}
35107@r{ @: M-# x @: @: @:calc-quit@:}
35108@r{ @: M-# y @: @:1,28,49 @:calc-copy-to-buffer@:}
35109@r{ @: M-# z @: @: @:calc-user-invocation@:}
909bd0ca 35110@r{ @: M-# = @: @: @:calc-embedded-update-formula@:}
d7b8e6c6
EZ
35111@r{ @: M-# : @: @: 36 @:calc-grab-sum-down@:}
35112@r{ @: M-# _ @: @: 36 @:calc-grab-sum-across@:}
35113@r{ @: M-# ` @:editing @: 30 @:calc-embedded-edit@:}
35114@r{ @: M-# 0 @:(zero) @: @:calc-reset@:}
177c0ea7
JB
35115
35116@c
d7b8e6c6
EZ
35117@r{ @: 0-9 @:number @: @:@:number}
35118@r{ @: . @:number @: @:@:0.number}
35119@r{ @: _ @:number @: @:-@:number}
35120@r{ @: e @:number @: @:@:1e number}
bd712b70 35121@r{ @: # @:number @: @:@:current-radix@tfn{#}number}
d7b8e6c6
EZ
35122@r{ @: P @:(in number) @: @:+/-@:}
35123@r{ @: M @:(in number) @: @:mod@:}
35124@r{ @: @@ ' " @: (in number)@: @:@:HMS form}
35125@r{ @: h m s @: (in number)@: @:@:HMS form}
35126
177c0ea7 35127@c
d7b8e6c6
EZ
35128@r{ @: ' @:formula @: 37,46 @:@:formula}
35129@r{ @: $ @:formula @: 37,46 @:$@:formula}
35130@r{ @: " @:string @: 37,46 @:@:string}
177c0ea7
JB
35131
35132@c
d7b8e6c6
EZ
35133@r{ a b@: + @: @: 2 @:add@:(a,b) a+b}
35134@r{ a b@: - @: @: 2 @:sub@:(a,b) a@minus{}b}
35135@r{ a b@: * @: @: 2 @:mul@:(a,b) a b, a*b}
35136@r{ a b@: / @: @: 2 @:div@:(a,b) a/b}
35137@r{ a b@: ^ @: @: 2 @:pow@:(a,b) a^b}
35138@r{ a b@: I ^ @: @: 2 @:nroot@:(a,b) a^(1/b)}
35139@r{ a b@: % @: @: 2 @:mod@:(a,b) a%b}
35140@r{ a b@: \ @: @: 2 @:idiv@:(a,b) a\b}
35141@r{ a b@: : @: @: 2 @:fdiv@:(a,b)}
35142@r{ a b@: | @: @: 2 @:vconcat@:(a,b) a|b}
35143@r{ a b@: I | @: @: @:vconcat@:(b,a) b|a}
35144@r{ a b@: H | @: @: 2 @:append@:(a,b)}
35145@r{ a b@: I H | @: @: @:append@:(b,a)}
35146@r{ a@: & @: @: 1 @:inv@:(a) 1/a}
35147@r{ a@: ! @: @: 1 @:fact@:(a) a!}
35148@r{ a@: = @: @: 1 @:evalv@:(a)}
35149@r{ a@: M-% @: @: @:percent@:(a) a%}
177c0ea7
JB
35150
35151@c
5d67986c
RS
35152@r{ ... a@: @key{RET} @: @: 1 @:@:... a a}
35153@r{ ... a@: @key{SPC} @: @: 1 @:@:... a a}
35154@r{... a b@: @key{TAB} @: @: 3 @:@:... b a}
35155@r{. a b c@: M-@key{TAB} @: @: 3 @:@:... b c a}
35156@r{... a b@: @key{LFD} @: @: 1 @:@:... a b a}
35157@r{ ... a@: @key{DEL} @: @: 1 @:@:...}
35158@r{... a b@: M-@key{DEL} @: @: 1 @:@:... b}
35159@r{ @: M-@key{RET} @: @: 4 @:calc-last-args@:}
d7b8e6c6 35160@r{ a@: ` @:editing @: 1,30 @:calc-edit@:}
177c0ea7
JB
35161
35162@c
d7b8e6c6
EZ
35163@r{ ... a@: C-d @: @: 1 @:@:...}
35164@r{ @: C-k @: @: 27 @:calc-kill@:}
35165@r{ @: C-w @: @: 27 @:calc-kill-region@:}
35166@r{ @: C-y @: @: @:calc-yank@:}
35167@r{ @: C-_ @: @: 4 @:calc-undo@:}
35168@r{ @: M-k @: @: 27 @:calc-copy-as-kill@:}
35169@r{ @: M-w @: @: 27 @:calc-copy-region-as-kill@:}
177c0ea7
JB
35170
35171@c
d7b8e6c6
EZ
35172@r{ @: [ @: @: @:@:[...}
35173@r{[.. a b@: ] @: @: @:@:[a,b]}
35174@r{ @: ( @: @: @:@:(...}
35175@r{(.. a b@: ) @: @: @:@:(a,b)}
35176@r{ @: , @: @: @:@:vector or rect complex}
35177@r{ @: ; @: @: @:@:matrix or polar complex}
35178@r{ @: .. @: @: @:@:interval}
35179
177c0ea7 35180@c
d7b8e6c6
EZ
35181@r{ @: ~ @: @: @:calc-num-prefix@:}
35182@r{ @: < @: @: 4 @:calc-scroll-left@:}
35183@r{ @: > @: @: 4 @:calc-scroll-right@:}
35184@r{ @: @{ @: @: 4 @:calc-scroll-down@:}
35185@r{ @: @} @: @: 4 @:calc-scroll-up@:}
35186@r{ @: ? @: @: @:calc-help@:}
177c0ea7
JB
35187
35188@c
d7b8e6c6
EZ
35189@r{ a@: n @: @: 1 @:neg@:(a) @minus{}a}
35190@r{ @: o @: @: 4 @:calc-realign@:}
35191@r{ @: p @:precision @: 31 @:calc-precision@:}
35192@r{ @: q @: @: @:calc-quit@:}
35193@r{ @: w @: @: @:calc-why@:}
35194@r{ @: x @:command @: @:M-x calc-@:command}
35195@r{ a@: y @: @:1,28,49 @:calc-copy-to-buffer@:}
177c0ea7
JB
35196
35197@c
d7b8e6c6
EZ
35198@r{ a@: A @: @: 1 @:abs@:(a)}
35199@r{ a b@: B @: @: 2 @:log@:(a,b)}
35200@r{ a b@: I B @: @: 2 @:alog@:(a,b) b^a}
35201@r{ a@: C @: @: 1 @:cos@:(a)}
35202@r{ a@: I C @: @: 1 @:arccos@:(a)}
35203@r{ a@: H C @: @: 1 @:cosh@:(a)}
35204@r{ a@: I H C @: @: 1 @:arccosh@:(a)}
35205@r{ @: D @: @: 4 @:calc-redo@:}
35206@r{ a@: E @: @: 1 @:exp@:(a)}
35207@r{ a@: H E @: @: 1 @:exp10@:(a) 10.^a}
35208@r{ a@: F @: @: 1,11 @:floor@:(a,d)}
35209@r{ a@: I F @: @: 1,11 @:ceil@:(a,d)}
35210@r{ a@: H F @: @: 1,11 @:ffloor@:(a,d)}
35211@r{ a@: I H F @: @: 1,11 @:fceil@:(a,d)}
35212@r{ a@: G @: @: 1 @:arg@:(a)}
35213@r{ @: H @:command @: 32 @:@:Hyperbolic}
35214@r{ @: I @:command @: 32 @:@:Inverse}
35215@r{ a@: J @: @: 1 @:conj@:(a)}
35216@r{ @: K @:command @: 32 @:@:Keep-args}
35217@r{ a@: L @: @: 1 @:ln@:(a)}
35218@r{ a@: H L @: @: 1 @:log10@:(a)}
35219@r{ @: M @: @: @:calc-more-recursion-depth@:}
35220@r{ @: I M @: @: @:calc-less-recursion-depth@:}
35221@r{ a@: N @: @: 5 @:evalvn@:(a)}
35222@r{ @: P @: @: @:@:pi}
35223@r{ @: I P @: @: @:@:gamma}
35224@r{ @: H P @: @: @:@:e}
35225@r{ @: I H P @: @: @:@:phi}
35226@r{ a@: Q @: @: 1 @:sqrt@:(a)}
35227@r{ a@: I Q @: @: 1 @:sqr@:(a) a^2}
35228@r{ a@: R @: @: 1,11 @:round@:(a,d)}
35229@r{ a@: I R @: @: 1,11 @:trunc@:(a,d)}
35230@r{ a@: H R @: @: 1,11 @:fround@:(a,d)}
35231@r{ a@: I H R @: @: 1,11 @:ftrunc@:(a,d)}
35232@r{ a@: S @: @: 1 @:sin@:(a)}
35233@r{ a@: I S @: @: 1 @:arcsin@:(a)}
35234@r{ a@: H S @: @: 1 @:sinh@:(a)}
35235@r{ a@: I H S @: @: 1 @:arcsinh@:(a)}
35236@r{ a@: T @: @: 1 @:tan@:(a)}
35237@r{ a@: I T @: @: 1 @:arctan@:(a)}
35238@r{ a@: H T @: @: 1 @:tanh@:(a)}
35239@r{ a@: I H T @: @: 1 @:arctanh@:(a)}
35240@r{ @: U @: @: 4 @:calc-undo@:}
35241@r{ @: X @: @: 4 @:calc-call-last-kbd-macro@:}
177c0ea7
JB
35242
35243@c
d7b8e6c6
EZ
35244@r{ a b@: a = @: @: 2 @:eq@:(a,b) a=b}
35245@r{ a b@: a # @: @: 2 @:neq@:(a,b) a!=b}
35246@r{ a b@: a < @: @: 2 @:lt@:(a,b) a<b}
35247@r{ a b@: a > @: @: 2 @:gt@:(a,b) a>b}
35248@r{ a b@: a [ @: @: 2 @:leq@:(a,b) a<=b}
35249@r{ a b@: a ] @: @: 2 @:geq@:(a,b) a>=b}
35250@r{ a b@: a @{ @: @: 2 @:in@:(a,b)}
35251@r{ a b@: a & @: @: 2,45 @:land@:(a,b) a&&b}
35252@r{ a b@: a | @: @: 2,45 @:lor@:(a,b) a||b}
35253@r{ a@: a ! @: @: 1,45 @:lnot@:(a) !a}
35254@r{ a b c@: a : @: @: 45 @:if@:(a,b,c) a?b:c}
35255@r{ a@: a . @: @: 1 @:rmeq@:(a)}
35256@r{ a@: a " @: @: 7,8 @:calc-expand-formula@:}
177c0ea7
JB
35257
35258@c
d7b8e6c6
EZ
35259@r{ a@: a + @:i, l, h @: 6,38 @:sum@:(a,i,l,h)}
35260@r{ a@: a - @:i, l, h @: 6,38 @:asum@:(a,i,l,h)}
35261@r{ a@: a * @:i, l, h @: 6,38 @:prod@:(a,i,l,h)}
35262@r{ a b@: a _ @: @: 2 @:subscr@:(a,b) a_b}
177c0ea7
JB
35263
35264@c
d7b8e6c6
EZ
35265@r{ a b@: a \ @: @: 2 @:pdiv@:(a,b)}
35266@r{ a b@: a % @: @: 2 @:prem@:(a,b)}
35267@r{ a b@: a / @: @: 2 @:pdivrem@:(a,b) [q,r]}
35268@r{ a b@: H a / @: @: 2 @:pdivide@:(a,b) q+r/b}
177c0ea7
JB
35269
35270@c
d7b8e6c6
EZ
35271@r{ a@: a a @: @: 1 @:apart@:(a)}
35272@r{ a@: a b @:old, new @: 38 @:subst@:(a,old,new)}
35273@r{ a@: a c @:v @: 38 @:collect@:(a,v)}
35274@r{ a@: a d @:v @: 4,38 @:deriv@:(a,v)}
35275@r{ a@: H a d @:v @: 4,38 @:tderiv@:(a,v)}
35276@r{ a@: a e @: @: @:esimplify@:(a)}
35277@r{ a@: a f @: @: 1 @:factor@:(a)}
35278@r{ a@: H a f @: @: 1 @:factors@:(a)}
35279@r{ a b@: a g @: @: 2 @:pgcd@:(a,b)}
35280@r{ a@: a i @:v @: 38 @:integ@:(a,v)}
35281@r{ a@: a m @:pats @: 38 @:match@:(a,pats)}
35282@r{ a@: I a m @:pats @: 38 @:matchnot@:(a,pats)}
35283@r{ data x@: a p @: @: 28 @:polint@:(data,x)}
35284@r{ data x@: H a p @: @: 28 @:ratint@:(data,x)}
35285@r{ a@: a n @: @: 1 @:nrat@:(a)}
35286@r{ a@: a r @:rules @:4,8,38 @:rewrite@:(a,rules,n)}
35287@r{ a@: a s @: @: @:simplify@:(a)}
35288@r{ a@: a t @:v, n @: 31,39 @:taylor@:(a,v,n)}
35289@r{ a@: a v @: @: 7,8 @:calc-alg-evaluate@:}
35290@r{ a@: a x @: @: 4,8 @:expand@:(a)}
177c0ea7
JB
35291
35292@c
d7b8e6c6
EZ
35293@r{ data@: a F @:model, vars @: 48 @:fit@:(m,iv,pv,data)}
35294@r{ data@: I a F @:model, vars @: 48 @:xfit@:(m,iv,pv,data)}
35295@r{ data@: H a F @:model, vars @: 48 @:efit@:(m,iv,pv,data)}
35296@r{ a@: a I @:v, l, h @: 38 @:ninteg@:(a,v,l,h)}
35297@r{ a b@: a M @:op @: 22 @:mapeq@:(op,a,b)}
35298@r{ a b@: I a M @:op @: 22 @:mapeqr@:(op,a,b)}
35299@r{ a b@: H a M @:op @: 22 @:mapeqp@:(op,a,b)}
35300@r{ a g@: a N @:v @: 38 @:minimize@:(a,v,g)}
35301@r{ a g@: H a N @:v @: 38 @:wminimize@:(a,v,g)}
35302@r{ a@: a P @:v @: 38 @:roots@:(a,v)}
35303@r{ a g@: a R @:v @: 38 @:root@:(a,v,g)}
35304@r{ a g@: H a R @:v @: 38 @:wroot@:(a,v,g)}
35305@r{ a@: a S @:v @: 38 @:solve@:(a,v)}
35306@r{ a@: I a S @:v @: 38 @:finv@:(a,v)}
35307@r{ a@: H a S @:v @: 38 @:fsolve@:(a,v)}
35308@r{ a@: I H a S @:v @: 38 @:ffinv@:(a,v)}
35309@r{ a@: a T @:i, l, h @: 6,38 @:table@:(a,i,l,h)}
35310@r{ a g@: a X @:v @: 38 @:maximize@:(a,v,g)}
35311@r{ a g@: H a X @:v @: 38 @:wmaximize@:(a,v,g)}
177c0ea7
JB
35312
35313@c
d7b8e6c6
EZ
35314@r{ a b@: b a @: @: 9 @:and@:(a,b,w)}
35315@r{ a@: b c @: @: 9 @:clip@:(a,w)}
35316@r{ a b@: b d @: @: 9 @:diff@:(a,b,w)}
35317@r{ a@: b l @: @: 10 @:lsh@:(a,n,w)}
35318@r{ a n@: H b l @: @: 9 @:lsh@:(a,n,w)}
35319@r{ a@: b n @: @: 9 @:not@:(a,w)}
35320@r{ a b@: b o @: @: 9 @:or@:(a,b,w)}
35321@r{ v@: b p @: @: 1 @:vpack@:(v)}
35322@r{ a@: b r @: @: 10 @:rsh@:(a,n,w)}
35323@r{ a n@: H b r @: @: 9 @:rsh@:(a,n,w)}
35324@r{ a@: b t @: @: 10 @:rot@:(a,n,w)}
35325@r{ a n@: H b t @: @: 9 @:rot@:(a,n,w)}
35326@r{ a@: b u @: @: 1 @:vunpack@:(a)}
35327@r{ @: b w @:w @: 9,50 @:calc-word-size@:}
35328@r{ a b@: b x @: @: 9 @:xor@:(a,b,w)}
177c0ea7
JB
35329
35330@c
d7b8e6c6
EZ
35331@r{c s l p@: b D @: @: @:ddb@:(c,s,l,p)}
35332@r{ r n p@: b F @: @: @:fv@:(r,n,p)}
35333@r{ r n p@: I b F @: @: @:fvb@:(r,n,p)}
35334@r{ r n p@: H b F @: @: @:fvl@:(r,n,p)}
35335@r{ v@: b I @: @: 19 @:irr@:(v)}
35336@r{ v@: I b I @: @: 19 @:irrb@:(v)}
35337@r{ a@: b L @: @: 10 @:ash@:(a,n,w)}
35338@r{ a n@: H b L @: @: 9 @:ash@:(a,n,w)}
35339@r{ r n a@: b M @: @: @:pmt@:(r,n,a)}
35340@r{ r n a@: I b M @: @: @:pmtb@:(r,n,a)}
35341@r{ r n a@: H b M @: @: @:pmtl@:(r,n,a)}
35342@r{ r v@: b N @: @: 19 @:npv@:(r,v)}
35343@r{ r v@: I b N @: @: 19 @:npvb@:(r,v)}
35344@r{ r n p@: b P @: @: @:pv@:(r,n,p)}
35345@r{ r n p@: I b P @: @: @:pvb@:(r,n,p)}
35346@r{ r n p@: H b P @: @: @:pvl@:(r,n,p)}
35347@r{ a@: b R @: @: 10 @:rash@:(a,n,w)}
35348@r{ a n@: H b R @: @: 9 @:rash@:(a,n,w)}
35349@r{ c s l@: b S @: @: @:sln@:(c,s,l)}
35350@r{ n p a@: b T @: @: @:rate@:(n,p,a)}
35351@r{ n p a@: I b T @: @: @:rateb@:(n,p,a)}
35352@r{ n p a@: H b T @: @: @:ratel@:(n,p,a)}
35353@r{c s l p@: b Y @: @: @:syd@:(c,s,l,p)}
35354
35355@r{ r p a@: b # @: @: @:nper@:(r,p,a)}
35356@r{ r p a@: I b # @: @: @:nperb@:(r,p,a)}
35357@r{ r p a@: H b # @: @: @:nperl@:(r,p,a)}
35358@r{ a b@: b % @: @: @:relch@:(a,b)}
177c0ea7
JB
35359
35360@c
d7b8e6c6
EZ
35361@r{ a@: c c @: @: 5 @:pclean@:(a,p)}
35362@r{ a@: c 0-9 @: @: @:pclean@:(a,p)}
35363@r{ a@: H c c @: @: 5 @:clean@:(a,p)}
35364@r{ a@: H c 0-9 @: @: @:clean@:(a,p)}
35365@r{ a@: c d @: @: 1 @:deg@:(a)}
35366@r{ a@: c f @: @: 1 @:pfloat@:(a)}
35367@r{ a@: H c f @: @: 1 @:float@:(a)}
35368@r{ a@: c h @: @: 1 @:hms@:(a)}
35369@r{ a@: c p @: @: @:polar@:(a)}
35370@r{ a@: I c p @: @: @:rect@:(a)}
35371@r{ a@: c r @: @: 1 @:rad@:(a)}
177c0ea7
JB
35372
35373@c
d7b8e6c6
EZ
35374@r{ a@: c F @: @: 5 @:pfrac@:(a,p)}
35375@r{ a@: H c F @: @: 5 @:frac@:(a,p)}
177c0ea7
JB
35376
35377@c
d7b8e6c6 35378@r{ a@: c % @: @: @:percent@:(a*100)}
177c0ea7
JB
35379
35380@c
d7b8e6c6
EZ
35381@r{ @: d . @:char @: 50 @:calc-point-char@:}
35382@r{ @: d , @:char @: 50 @:calc-group-char@:}
35383@r{ @: d < @: @: 13,50 @:calc-left-justify@:}
35384@r{ @: d = @: @: 13,50 @:calc-center-justify@:}
35385@r{ @: d > @: @: 13,50 @:calc-right-justify@:}
35386@r{ @: d @{ @:label @: 50 @:calc-left-label@:}
35387@r{ @: d @} @:label @: 50 @:calc-right-label@:}
35388@r{ @: d [ @: @: 4 @:calc-truncate-up@:}
35389@r{ @: d ] @: @: 4 @:calc-truncate-down@:}
35390@r{ @: d " @: @: 12,50 @:calc-display-strings@:}
5d67986c
RS
35391@r{ @: d @key{SPC} @: @: @:calc-refresh@:}
35392@r{ @: d @key{RET} @: @: 1 @:calc-refresh-top@:}
177c0ea7
JB
35393
35394@c
d7b8e6c6
EZ
35395@r{ @: d 0 @: @: 50 @:calc-decimal-radix@:}
35396@r{ @: d 2 @: @: 50 @:calc-binary-radix@:}
35397@r{ @: d 6 @: @: 50 @:calc-hex-radix@:}
35398@r{ @: d 8 @: @: 50 @:calc-octal-radix@:}
177c0ea7
JB
35399
35400@c
d7b8e6c6
EZ
35401@r{ @: d b @: @:12,13,50 @:calc-line-breaking@:}
35402@r{ @: d c @: @: 50 @:calc-complex-notation@:}
35403@r{ @: d d @:format @: 50 @:calc-date-notation@:}
35404@r{ @: d e @: @: 5,50 @:calc-eng-notation@:}
35405@r{ @: d f @:num @: 31,50 @:calc-fix-notation@:}
35406@r{ @: d g @: @:12,13,50 @:calc-group-digits@:}
35407@r{ @: d h @:format @: 50 @:calc-hms-notation@:}
35408@r{ @: d i @: @: 50 @:calc-i-notation@:}
35409@r{ @: d j @: @: 50 @:calc-j-notation@:}
35410@r{ @: d l @: @: 12,50 @:calc-line-numbering@:}
35411@r{ @: d n @: @: 5,50 @:calc-normal-notation@:}
35412@r{ @: d o @:format @: 50 @:calc-over-notation@:}
35413@r{ @: d p @: @: 12,50 @:calc-show-plain@:}
35414@r{ @: d r @:radix @: 31,50 @:calc-radix@:}
35415@r{ @: d s @: @: 5,50 @:calc-sci-notation@:}
35416@r{ @: d t @: @: 27 @:calc-truncate-stack@:}
35417@r{ @: d w @: @: 12,13 @:calc-auto-why@:}
35418@r{ @: d z @: @: 12,50 @:calc-leading-zeros@:}
177c0ea7
JB
35419
35420@c
d7b8e6c6
EZ
35421@r{ @: d B @: @: 50 @:calc-big-language@:}
35422@r{ @: d C @: @: 50 @:calc-c-language@:}
35423@r{ @: d E @: @: 50 @:calc-eqn-language@:}
35424@r{ @: d F @: @: 50 @:calc-fortran-language@:}
35425@r{ @: d M @: @: 50 @:calc-mathematica-language@:}
35426@r{ @: d N @: @: 50 @:calc-normal-language@:}
35427@r{ @: d O @: @: 50 @:calc-flat-language@:}
35428@r{ @: d P @: @: 50 @:calc-pascal-language@:}
35429@r{ @: d T @: @: 50 @:calc-tex-language@:}
8ed713c6 35430@r{ @: d L @: @: 50 @:calc-latex-language@:}
d7b8e6c6
EZ
35431@r{ @: d U @: @: 50 @:calc-unformatted-language@:}
35432@r{ @: d W @: @: 50 @:calc-maple-language@:}
177c0ea7
JB
35433
35434@c
d7b8e6c6
EZ
35435@r{ a@: f [ @: @: 4 @:decr@:(a,n)}
35436@r{ a@: f ] @: @: 4 @:incr@:(a,n)}
177c0ea7
JB
35437
35438@c
d7b8e6c6
EZ
35439@r{ a b@: f b @: @: 2 @:beta@:(a,b)}
35440@r{ a@: f e @: @: 1 @:erf@:(a)}
35441@r{ a@: I f e @: @: 1 @:erfc@:(a)}
35442@r{ a@: f g @: @: 1 @:gamma@:(a)}
35443@r{ a b@: f h @: @: 2 @:hypot@:(a,b)}
35444@r{ a@: f i @: @: 1 @:im@:(a)}
35445@r{ n a@: f j @: @: 2 @:besJ@:(n,a)}
35446@r{ a b@: f n @: @: 2 @:min@:(a,b)}
35447@r{ a@: f r @: @: 1 @:re@:(a)}
35448@r{ a@: f s @: @: 1 @:sign@:(a)}
35449@r{ a b@: f x @: @: 2 @:max@:(a,b)}
35450@r{ n a@: f y @: @: 2 @:besY@:(n,a)}
177c0ea7
JB
35451
35452@c
d7b8e6c6
EZ
35453@r{ a@: f A @: @: 1 @:abssqr@:(a)}
35454@r{ x a b@: f B @: @: @:betaI@:(x,a,b)}
35455@r{ x a b@: H f B @: @: @:betaB@:(x,a,b)}
35456@r{ a@: f E @: @: 1 @:expm1@:(a)}
35457@r{ a x@: f G @: @: 2 @:gammaP@:(a,x)}
35458@r{ a x@: I f G @: @: 2 @:gammaQ@:(a,x)}
35459@r{ a x@: H f G @: @: 2 @:gammag@:(a,x)}
35460@r{ a x@: I H f G @: @: 2 @:gammaG@:(a,x)}
35461@r{ a b@: f I @: @: 2 @:ilog@:(a,b)}
35462@r{ a b@: I f I @: @: 2 @:alog@:(a,b) b^a}
35463@r{ a@: f L @: @: 1 @:lnp1@:(a)}
35464@r{ a@: f M @: @: 1 @:mant@:(a)}
35465@r{ a@: f Q @: @: 1 @:isqrt@:(a)}
35466@r{ a@: I f Q @: @: 1 @:sqr@:(a) a^2}
35467@r{ a n@: f S @: @: 2 @:scf@:(a,n)}
35468@r{ y x@: f T @: @: @:arctan2@:(y,x)}
35469@r{ a@: f X @: @: 1 @:xpon@:(a)}
177c0ea7
JB
35470
35471@c
d7b8e6c6
EZ
35472@r{ x y@: g a @: @: 28,40 @:calc-graph-add@:}
35473@r{ @: g b @: @: 12 @:calc-graph-border@:}
35474@r{ @: g c @: @: @:calc-graph-clear@:}
35475@r{ @: g d @: @: 41 @:calc-graph-delete@:}
35476@r{ x y@: g f @: @: 28,40 @:calc-graph-fast@:}
35477@r{ @: g g @: @: 12 @:calc-graph-grid@:}
35478@r{ @: g h @:title @: @:calc-graph-header@:}
35479@r{ @: g j @: @: 4 @:calc-graph-juggle@:}
35480@r{ @: g k @: @: 12 @:calc-graph-key@:}
35481@r{ @: g l @: @: 12 @:calc-graph-log-x@:}
35482@r{ @: g n @:name @: @:calc-graph-name@:}
35483@r{ @: g p @: @: 42 @:calc-graph-plot@:}
35484@r{ @: g q @: @: @:calc-graph-quit@:}
35485@r{ @: g r @:range @: @:calc-graph-range-x@:}
35486@r{ @: g s @: @: 12,13 @:calc-graph-line-style@:}
35487@r{ @: g t @:title @: @:calc-graph-title-x@:}
35488@r{ @: g v @: @: @:calc-graph-view-commands@:}
35489@r{ @: g x @:display @: @:calc-graph-display@:}
35490@r{ @: g z @: @: 12 @:calc-graph-zero-x@:}
177c0ea7
JB
35491
35492@c
d7b8e6c6
EZ
35493@r{ x y z@: g A @: @: 28,40 @:calc-graph-add-3d@:}
35494@r{ @: g C @:command @: @:calc-graph-command@:}
35495@r{ @: g D @:device @: 43,44 @:calc-graph-device@:}
35496@r{ x y z@: g F @: @: 28,40 @:calc-graph-fast-3d@:}
35497@r{ @: g H @: @: 12 @:calc-graph-hide@:}
35498@r{ @: g K @: @: @:calc-graph-kill@:}
35499@r{ @: g L @: @: 12 @:calc-graph-log-y@:}
35500@r{ @: g N @:number @: 43,51 @:calc-graph-num-points@:}
35501@r{ @: g O @:filename @: 43,44 @:calc-graph-output@:}
35502@r{ @: g P @: @: 42 @:calc-graph-print@:}
35503@r{ @: g R @:range @: @:calc-graph-range-y@:}
35504@r{ @: g S @: @: 12,13 @:calc-graph-point-style@:}
35505@r{ @: g T @:title @: @:calc-graph-title-y@:}
35506@r{ @: g V @: @: @:calc-graph-view-trail@:}
35507@r{ @: g X @:format @: @:calc-graph-geometry@:}
35508@r{ @: g Z @: @: 12 @:calc-graph-zero-y@:}
177c0ea7
JB
35509
35510@c
d7b8e6c6
EZ
35511@r{ @: g C-l @: @: 12 @:calc-graph-log-z@:}
35512@r{ @: g C-r @:range @: @:calc-graph-range-z@:}
35513@r{ @: g C-t @:title @: @:calc-graph-title-z@:}
177c0ea7
JB
35514
35515@c
d7b8e6c6
EZ
35516@r{ @: h b @: @: @:calc-describe-bindings@:}
35517@r{ @: h c @:key @: @:calc-describe-key-briefly@:}
35518@r{ @: h f @:function @: @:calc-describe-function@:}
35519@r{ @: h h @: @: @:calc-full-help@:}
35520@r{ @: h i @: @: @:calc-info@:}
35521@r{ @: h k @:key @: @:calc-describe-key@:}
35522@r{ @: h n @: @: @:calc-view-news@:}
35523@r{ @: h s @: @: @:calc-info-summary@:}
35524@r{ @: h t @: @: @:calc-tutorial@:}
35525@r{ @: h v @:var @: @:calc-describe-variable@:}
177c0ea7
JB
35526
35527@c
d7b8e6c6 35528@r{ @: j 1-9 @: @: @:calc-select-part@:}
5d67986c
RS
35529@r{ @: j @key{RET} @: @: 27 @:calc-copy-selection@:}
35530@r{ @: j @key{DEL} @: @: 27 @:calc-del-selection@:}
d7b8e6c6
EZ
35531@r{ @: j ' @:formula @: 27 @:calc-enter-selection@:}
35532@r{ @: j ` @:editing @: 27,30 @:calc-edit-selection@:}
35533@r{ @: j " @: @: 7,27 @:calc-sel-expand-formula@:}
177c0ea7
JB
35534
35535@c
d7b8e6c6
EZ
35536@r{ @: j + @:formula @: 27 @:calc-sel-add-both-sides@:}
35537@r{ @: j - @:formula @: 27 @:calc-sel-sub-both-sides@:}
35538@r{ @: j * @:formula @: 27 @:calc-sel-mul-both-sides@:}
35539@r{ @: j / @:formula @: 27 @:calc-sel-div-both-sides@:}
35540@r{ @: j & @: @: 27 @:calc-sel-invert@:}
177c0ea7
JB
35541
35542@c
d7b8e6c6
EZ
35543@r{ @: j a @: @: 27 @:calc-select-additional@:}
35544@r{ @: j b @: @: 12 @:calc-break-selections@:}
35545@r{ @: j c @: @: @:calc-clear-selections@:}
35546@r{ @: j d @: @: 12,50 @:calc-show-selections@:}
35547@r{ @: j e @: @: 12 @:calc-enable-selections@:}
35548@r{ @: j l @: @: 4,27 @:calc-select-less@:}
35549@r{ @: j m @: @: 4,27 @:calc-select-more@:}
35550@r{ @: j n @: @: 4 @:calc-select-next@:}
35551@r{ @: j o @: @: 4,27 @:calc-select-once@:}
35552@r{ @: j p @: @: 4 @:calc-select-previous@:}
35553@r{ @: j r @:rules @:4,8,27 @:calc-rewrite-selection@:}
35554@r{ @: j s @: @: 4,27 @:calc-select-here@:}
35555@r{ @: j u @: @: 27 @:calc-unselect@:}
35556@r{ @: j v @: @: 7,27 @:calc-sel-evaluate@:}
177c0ea7
JB
35557
35558@c
d7b8e6c6
EZ
35559@r{ @: j C @: @: 27 @:calc-sel-commute@:}
35560@r{ @: j D @: @: 4,27 @:calc-sel-distribute@:}
35561@r{ @: j E @: @: 27 @:calc-sel-jump-equals@:}
35562@r{ @: j I @: @: 27 @:calc-sel-isolate@:}
35563@r{ @: H j I @: @: 27 @:calc-sel-isolate@: (full)}
35564@r{ @: j L @: @: 4,27 @:calc-commute-left@:}
35565@r{ @: j M @: @: 27 @:calc-sel-merge@:}
35566@r{ @: j N @: @: 27 @:calc-sel-negate@:}
35567@r{ @: j O @: @: 4,27 @:calc-select-once-maybe@:}
35568@r{ @: j R @: @: 4,27 @:calc-commute-right@:}
35569@r{ @: j S @: @: 4,27 @:calc-select-here-maybe@:}
35570@r{ @: j U @: @: 27 @:calc-sel-unpack@:}
177c0ea7
JB
35571
35572@c
d7b8e6c6
EZ
35573@r{ @: k a @: @: @:calc-random-again@:}
35574@r{ n@: k b @: @: 1 @:bern@:(n)}
35575@r{ n x@: H k b @: @: 2 @:bern@:(n,x)}
35576@r{ n m@: k c @: @: 2 @:choose@:(n,m)}
35577@r{ n m@: H k c @: @: 2 @:perm@:(n,m)}
35578@r{ n@: k d @: @: 1 @:dfact@:(n) n!!}
35579@r{ n@: k e @: @: 1 @:euler@:(n)}
35580@r{ n x@: H k e @: @: 2 @:euler@:(n,x)}
35581@r{ n@: k f @: @: 4 @:prfac@:(n)}
35582@r{ n m@: k g @: @: 2 @:gcd@:(n,m)}
35583@r{ m n@: k h @: @: 14 @:shuffle@:(n,m)}
35584@r{ n m@: k l @: @: 2 @:lcm@:(n,m)}
35585@r{ n@: k m @: @: 1 @:moebius@:(n)}
35586@r{ n@: k n @: @: 4 @:nextprime@:(n)}
35587@r{ n@: I k n @: @: 4 @:prevprime@:(n)}
35588@r{ n@: k p @: @: 4,28 @:calc-prime-test@:}
35589@r{ m@: k r @: @: 14 @:random@:(m)}
35590@r{ n m@: k s @: @: 2 @:stir1@:(n,m)}
35591@r{ n m@: H k s @: @: 2 @:stir2@:(n,m)}
35592@r{ n@: k t @: @: 1 @:totient@:(n)}
177c0ea7
JB
35593
35594@c
d7b8e6c6
EZ
35595@r{ n p x@: k B @: @: @:utpb@:(x,n,p)}
35596@r{ n p x@: I k B @: @: @:ltpb@:(x,n,p)}
35597@r{ v x@: k C @: @: @:utpc@:(x,v)}
35598@r{ v x@: I k C @: @: @:ltpc@:(x,v)}
35599@r{ n m@: k E @: @: @:egcd@:(n,m)}
35600@r{v1 v2 x@: k F @: @: @:utpf@:(x,v1,v2)}
35601@r{v1 v2 x@: I k F @: @: @:ltpf@:(x,v1,v2)}
35602@r{ m s x@: k N @: @: @:utpn@:(x,m,s)}
35603@r{ m s x@: I k N @: @: @:ltpn@:(x,m,s)}
35604@r{ m x@: k P @: @: @:utpp@:(x,m)}
35605@r{ m x@: I k P @: @: @:ltpp@:(x,m)}
35606@r{ v x@: k T @: @: @:utpt@:(x,v)}
35607@r{ v x@: I k T @: @: @:ltpt@:(x,v)}
177c0ea7
JB
35608
35609@c
d7b8e6c6
EZ
35610@r{ @: m a @: @: 12,13 @:calc-algebraic-mode@:}
35611@r{ @: m d @: @: @:calc-degrees-mode@:}
746539f6 35612@r{ @: m e @: @: @:calc-embedded-preserve-modes@:}
d7b8e6c6
EZ
35613@r{ @: m f @: @: 12 @:calc-frac-mode@:}
35614@r{ @: m g @: @: 52 @:calc-get-modes@:}
35615@r{ @: m h @: @: @:calc-hms-mode@:}
35616@r{ @: m i @: @: 12,13 @:calc-infinite-mode@:}
35617@r{ @: m m @: @: @:calc-save-modes@:}
35618@r{ @: m p @: @: 12 @:calc-polar-mode@:}
35619@r{ @: m r @: @: @:calc-radians-mode@:}
35620@r{ @: m s @: @: 12 @:calc-symbolic-mode@:}
35621@r{ @: m t @: @: 12 @:calc-total-algebraic-mode@:}
35622@r{ @: m v @: @: 12,13 @:calc-matrix-mode@:}
35623@r{ @: m w @: @: 13 @:calc-working@:}
35624@r{ @: m x @: @: @:calc-always-load-extensions@:}
177c0ea7
JB
35625
35626@c
d7b8e6c6
EZ
35627@r{ @: m A @: @: 12 @:calc-alg-simplify-mode@:}
35628@r{ @: m B @: @: 12 @:calc-bin-simplify-mode@:}
35629@r{ @: m C @: @: 12 @:calc-auto-recompute@:}
35630@r{ @: m D @: @: @:calc-default-simplify-mode@:}
35631@r{ @: m E @: @: 12 @:calc-ext-simplify-mode@:}
35632@r{ @: m F @:filename @: 13 @:calc-settings-file-name@:}
35633@r{ @: m N @: @: 12 @:calc-num-simplify-mode@:}
35634@r{ @: m O @: @: 12 @:calc-no-simplify-mode@:}
35635@r{ @: m R @: @: 12,13 @:calc-mode-record-mode@:}
35636@r{ @: m S @: @: 12 @:calc-shift-prefix@:}
35637@r{ @: m U @: @: 12 @:calc-units-simplify-mode@:}
177c0ea7
JB
35638
35639@c
d7b8e6c6
EZ
35640@r{ @: s c @:var1, var2 @: 29 @:calc-copy-variable@:}
35641@r{ @: s d @:var, decl @: @:calc-declare-variable@:}
35642@r{ @: s e @:var, editing @: 29,30 @:calc-edit-variable@:}
35643@r{ @: s i @:buffer @: @:calc-insert-variables@:}
6188800e 35644@r{ @: s k @:const, var @: 29 @:calc-copy-special-constant@:}
d7b8e6c6
EZ
35645@r{ a b@: s l @:var @: 29 @:@:a (letting var=b)}
35646@r{ a ...@: s m @:op, var @: 22,29 @:calc-store-map@:}
35647@r{ @: s n @:var @: 29,47 @:calc-store-neg@: (v/-1)}
35648@r{ @: s p @:var @: 29 @:calc-permanent-variable@:}
35649@r{ @: s r @:var @: 29 @:@:v (recalled value)}
35650@r{ @: r 0-9 @: @: @:calc-recall-quick@:}
35651@r{ a@: s s @:var @: 28,29 @:calc-store@:}
35652@r{ a@: s 0-9 @: @: @:calc-store-quick@:}
35653@r{ a@: s t @:var @: 29 @:calc-store-into@:}
35654@r{ a@: t 0-9 @: @: @:calc-store-into-quick@:}
35655@r{ @: s u @:var @: 29 @:calc-unstore@:}
35656@r{ a@: s x @:var @: 29 @:calc-store-exchange@:}
177c0ea7
JB
35657
35658@c
d7b8e6c6
EZ
35659@r{ @: s A @:editing @: 30 @:calc-edit-AlgSimpRules@:}
35660@r{ @: s D @:editing @: 30 @:calc-edit-Decls@:}
35661@r{ @: s E @:editing @: 30 @:calc-edit-EvalRules@:}
35662@r{ @: s F @:editing @: 30 @:calc-edit-FitRules@:}
35663@r{ @: s G @:editing @: 30 @:calc-edit-GenCount@:}
35664@r{ @: s H @:editing @: 30 @:calc-edit-Holidays@:}
35665@r{ @: s I @:editing @: 30 @:calc-edit-IntegLimit@:}
35666@r{ @: s L @:editing @: 30 @:calc-edit-LineStyles@:}
35667@r{ @: s P @:editing @: 30 @:calc-edit-PointStyles@:}
35668@r{ @: s R @:editing @: 30 @:calc-edit-PlotRejects@:}
35669@r{ @: s T @:editing @: 30 @:calc-edit-TimeZone@:}
35670@r{ @: s U @:editing @: 30 @:calc-edit-Units@:}
35671@r{ @: s X @:editing @: 30 @:calc-edit-ExtSimpRules@:}
177c0ea7
JB
35672
35673@c
d7b8e6c6
EZ
35674@r{ a@: s + @:var @: 29,47 @:calc-store-plus@: (v+a)}
35675@r{ a@: s - @:var @: 29,47 @:calc-store-minus@: (v-a)}
35676@r{ a@: s * @:var @: 29,47 @:calc-store-times@: (v*a)}
35677@r{ a@: s / @:var @: 29,47 @:calc-store-div@: (v/a)}
35678@r{ a@: s ^ @:var @: 29,47 @:calc-store-power@: (v^a)}
35679@r{ a@: s | @:var @: 29,47 @:calc-store-concat@: (v|a)}
35680@r{ @: s & @:var @: 29,47 @:calc-store-inv@: (v^-1)}
35681@r{ @: s [ @:var @: 29,47 @:calc-store-decr@: (v-1)}
35682@r{ @: s ] @:var @: 29,47 @:calc-store-incr@: (v-(-1))}
bd712b70
JB
35683@r{ a b@: s : @: @: 2 @:assign@:(a,b) a @tfn{:=} b}
35684@r{ a@: s = @: @: 1 @:evalto@:(a,b) a @tfn{=>}}
177c0ea7
JB
35685
35686@c
d7b8e6c6
EZ
35687@r{ @: t [ @: @: 4 @:calc-trail-first@:}
35688@r{ @: t ] @: @: 4 @:calc-trail-last@:}
35689@r{ @: t < @: @: 4 @:calc-trail-scroll-left@:}
35690@r{ @: t > @: @: 4 @:calc-trail-scroll-right@:}
35691@r{ @: t . @: @: 12 @:calc-full-trail-vectors@:}
177c0ea7
JB
35692
35693@c
d7b8e6c6
EZ
35694@r{ @: t b @: @: 4 @:calc-trail-backward@:}
35695@r{ @: t d @: @: 12,50 @:calc-trail-display@:}
35696@r{ @: t f @: @: 4 @:calc-trail-forward@:}
35697@r{ @: t h @: @: @:calc-trail-here@:}
35698@r{ @: t i @: @: @:calc-trail-in@:}
35699@r{ @: t k @: @: 4 @:calc-trail-kill@:}
35700@r{ @: t m @:string @: @:calc-trail-marker@:}
35701@r{ @: t n @: @: 4 @:calc-trail-next@:}
35702@r{ @: t o @: @: @:calc-trail-out@:}
35703@r{ @: t p @: @: 4 @:calc-trail-previous@:}
35704@r{ @: t r @:string @: @:calc-trail-isearch-backward@:}
35705@r{ @: t s @:string @: @:calc-trail-isearch-forward@:}
35706@r{ @: t y @: @: 4 @:calc-trail-yank@:}
177c0ea7
JB
35707
35708@c
d7b8e6c6
EZ
35709@r{ d@: t C @:oz, nz @: @:tzconv@:(d,oz,nz)}
35710@r{d oz nz@: t C @:$ @: @:tzconv@:(d,oz,nz)}
35711@r{ d@: t D @: @: 15 @:date@:(d)}
35712@r{ d@: t I @: @: 4 @:incmonth@:(d,n)}
35713@r{ d@: t J @: @: 16 @:julian@:(d,z)}
35714@r{ d@: t M @: @: 17 @:newmonth@:(d,n)}
35715@r{ @: t N @: @: 16 @:now@:(z)}
35716@r{ d@: t P @:1 @: 31 @:year@:(d)}
35717@r{ d@: t P @:2 @: 31 @:month@:(d)}
35718@r{ d@: t P @:3 @: 31 @:day@:(d)}
35719@r{ d@: t P @:4 @: 31 @:hour@:(d)}
35720@r{ d@: t P @:5 @: 31 @:minute@:(d)}
35721@r{ d@: t P @:6 @: 31 @:second@:(d)}
35722@r{ d@: t P @:7 @: 31 @:weekday@:(d)}
35723@r{ d@: t P @:8 @: 31 @:yearday@:(d)}
35724@r{ d@: t P @:9 @: 31 @:time@:(d)}
35725@r{ d@: t U @: @: 16 @:unixtime@:(d,z)}
35726@r{ d@: t W @: @: 17 @:newweek@:(d,w)}
35727@r{ d@: t Y @: @: 17 @:newyear@:(d,n)}
177c0ea7
JB
35728
35729@c
d7b8e6c6
EZ
35730@r{ a b@: t + @: @: 2 @:badd@:(a,b)}
35731@r{ a b@: t - @: @: 2 @:bsub@:(a,b)}
177c0ea7
JB
35732
35733@c
d7b8e6c6
EZ
35734@r{ @: u a @: @: 12 @:calc-autorange-units@:}
35735@r{ a@: u b @: @: @:calc-base-units@:}
35736@r{ a@: u c @:units @: 18 @:calc-convert-units@:}
35737@r{ defn@: u d @:unit, descr @: @:calc-define-unit@:}
35738@r{ @: u e @: @: @:calc-explain-units@:}
35739@r{ @: u g @:unit @: @:calc-get-unit-definition@:}
35740@r{ @: u p @: @: @:calc-permanent-units@:}
35741@r{ a@: u r @: @: @:calc-remove-units@:}
35742@r{ a@: u s @: @: @:usimplify@:(a)}
35743@r{ a@: u t @:units @: 18 @:calc-convert-temperature@:}
35744@r{ @: u u @:unit @: @:calc-undefine-unit@:}
35745@r{ @: u v @: @: @:calc-enter-units-table@:}
35746@r{ a@: u x @: @: @:calc-extract-units@:}
35747@r{ a@: u 0-9 @: @: @:calc-quick-units@:}
177c0ea7
JB
35748
35749@c
d7b8e6c6
EZ
35750@r{ v1 v2@: u C @: @: 20 @:vcov@:(v1,v2)}
35751@r{ v1 v2@: I u C @: @: 20 @:vpcov@:(v1,v2)}
35752@r{ v1 v2@: H u C @: @: 20 @:vcorr@:(v1,v2)}
35753@r{ v@: u G @: @: 19 @:vgmean@:(v)}
35754@r{ a b@: H u G @: @: 2 @:agmean@:(a,b)}
35755@r{ v@: u M @: @: 19 @:vmean@:(v)}
35756@r{ v@: I u M @: @: 19 @:vmeane@:(v)}
35757@r{ v@: H u M @: @: 19 @:vmedian@:(v)}
35758@r{ v@: I H u M @: @: 19 @:vhmean@:(v)}
35759@r{ v@: u N @: @: 19 @:vmin@:(v)}
35760@r{ v@: u S @: @: 19 @:vsdev@:(v)}
35761@r{ v@: I u S @: @: 19 @:vpsdev@:(v)}
35762@r{ v@: H u S @: @: 19 @:vvar@:(v)}
35763@r{ v@: I H u S @: @: 19 @:vpvar@:(v)}
35764@r{ @: u V @: @: @:calc-view-units-table@:}
35765@r{ v@: u X @: @: 19 @:vmax@:(v)}
177c0ea7
JB
35766
35767@c
d7b8e6c6
EZ
35768@r{ v@: u + @: @: 19 @:vsum@:(v)}
35769@r{ v@: u * @: @: 19 @:vprod@:(v)}
35770@r{ v@: u # @: @: 19 @:vcount@:(v)}
177c0ea7
JB
35771
35772@c
d7b8e6c6
EZ
35773@r{ @: V ( @: @: 50 @:calc-vector-parens@:}
35774@r{ @: V @{ @: @: 50 @:calc-vector-braces@:}
35775@r{ @: V [ @: @: 50 @:calc-vector-brackets@:}
35776@r{ @: V ] @:ROCP @: 50 @:calc-matrix-brackets@:}
35777@r{ @: V , @: @: 50 @:calc-vector-commas@:}
35778@r{ @: V < @: @: 50 @:calc-matrix-left-justify@:}
35779@r{ @: V = @: @: 50 @:calc-matrix-center-justify@:}
35780@r{ @: V > @: @: 50 @:calc-matrix-right-justify@:}
35781@r{ @: V / @: @: 12,50 @:calc-break-vectors@:}
35782@r{ @: V . @: @: 12,50 @:calc-full-vectors@:}
177c0ea7
JB
35783
35784@c
d7b8e6c6
EZ
35785@r{ s t@: V ^ @: @: 2 @:vint@:(s,t)}
35786@r{ s t@: V - @: @: 2 @:vdiff@:(s,t)}
35787@r{ s@: V ~ @: @: 1 @:vcompl@:(s)}
35788@r{ s@: V # @: @: 1 @:vcard@:(s)}
35789@r{ s@: V : @: @: 1 @:vspan@:(s)}
35790@r{ s@: V + @: @: 1 @:rdup@:(s)}
177c0ea7
JB
35791
35792@c
d7b8e6c6 35793@r{ m@: V & @: @: 1 @:inv@:(m) 1/m}
177c0ea7
JB
35794
35795@c
d7b8e6c6
EZ
35796@r{ v@: v a @:n @: @:arrange@:(v,n)}
35797@r{ a@: v b @:n @: @:cvec@:(a,n)}
35798@r{ v@: v c @:n >0 @: 21,31 @:mcol@:(v,n)}
35799@r{ v@: v c @:n <0 @: 31 @:mrcol@:(v,-n)}
35800@r{ m@: v c @:0 @: 31 @:getdiag@:(m)}
35801@r{ v@: v d @: @: 25 @:diag@:(v,n)}
35802@r{ v m@: v e @: @: 2 @:vexp@:(v,m)}
35803@r{ v m f@: H v e @: @: 2 @:vexp@:(v,m,f)}
35804@r{ v a@: v f @: @: 26 @:find@:(v,a,n)}
35805@r{ v@: v h @: @: 1 @:head@:(v)}
35806@r{ v@: I v h @: @: 1 @:tail@:(v)}
35807@r{ v@: H v h @: @: 1 @:rhead@:(v)}
35808@r{ v@: I H v h @: @: 1 @:rtail@:(v)}
35809@r{ @: v i @:n @: 31 @:idn@:(1,n)}
35810@r{ @: v i @:0 @: 31 @:idn@:(1)}
35811@r{ h t@: v k @: @: 2 @:cons@:(h,t)}
35812@r{ h t@: H v k @: @: 2 @:rcons@:(h,t)}
35813@r{ v@: v l @: @: 1 @:vlen@:(v)}
35814@r{ v@: H v l @: @: 1 @:mdims@:(v)}
35815@r{ v m@: v m @: @: 2 @:vmask@:(v,m)}
35816@r{ v@: v n @: @: 1 @:rnorm@:(v)}
35817@r{ a b c@: v p @: @: 24 @:calc-pack@:}
35818@r{ v@: v r @:n >0 @: 21,31 @:mrow@:(v,n)}
35819@r{ v@: v r @:n <0 @: 31 @:mrrow@:(v,-n)}
35820@r{ m@: v r @:0 @: 31 @:getdiag@:(m)}
35821@r{ v i j@: v s @: @: @:subvec@:(v,i,j)}
35822@r{ v i j@: I v s @: @: @:rsubvec@:(v,i,j)}
35823@r{ m@: v t @: @: 1 @:trn@:(m)}
35824@r{ v@: v u @: @: 24 @:calc-unpack@:}
35825@r{ v@: v v @: @: 1 @:rev@:(v)}
35826@r{ @: v x @:n @: 31 @:index@:(n)}
35827@r{ n s i@: C-u v x @: @: @:index@:(n,s,i)}
177c0ea7
JB
35828
35829@c
d7b8e6c6
EZ
35830@r{ v@: V A @:op @: 22 @:apply@:(op,v)}
35831@r{ v1 v2@: V C @: @: 2 @:cross@:(v1,v2)}
35832@r{ m@: V D @: @: 1 @:det@:(m)}
35833@r{ s@: V E @: @: 1 @:venum@:(s)}
35834@r{ s@: V F @: @: 1 @:vfloor@:(s)}
35835@r{ v@: V G @: @: @:grade@:(v)}
35836@r{ v@: I V G @: @: @:rgrade@:(v)}
35837@r{ v@: V H @:n @: 31 @:histogram@:(v,n)}
35838@r{ v w@: H V H @:n @: 31 @:histogram@:(v,w,n)}
35839@r{ v1 v2@: V I @:mop aop @: 22 @:inner@:(mop,aop,v1,v2)}
35840@r{ m@: V J @: @: 1 @:ctrn@:(m)}
35841@r{ m@: V L @: @: 1 @:lud@:(m)}
35842@r{ v@: V M @:op @: 22,23 @:map@:(op,v)}
35843@r{ v@: V N @: @: 1 @:cnorm@:(v)}
35844@r{ v1 v2@: V O @:op @: 22 @:outer@:(op,v1,v2)}
35845@r{ v@: V R @:op @: 22,23 @:reduce@:(op,v)}
35846@r{ v@: I V R @:op @: 22,23 @:rreduce@:(op,v)}
35847@r{ a n@: H V R @:op @: 22 @:nest@:(op,a,n)}
35848@r{ a@: I H V R @:op @: 22 @:fixp@:(op,a)}
35849@r{ v@: V S @: @: @:sort@:(v)}
35850@r{ v@: I V S @: @: @:rsort@:(v)}
35851@r{ m@: V T @: @: 1 @:tr@:(m)}
35852@r{ v@: V U @:op @: 22 @:accum@:(op,v)}
35853@r{ v@: I V U @:op @: 22 @:raccum@:(op,v)}
35854@r{ a n@: H V U @:op @: 22 @:anest@:(op,a,n)}
35855@r{ a@: I H V U @:op @: 22 @:afixp@:(op,a)}
35856@r{ s t@: V V @: @: 2 @:vunion@:(s,t)}
35857@r{ s t@: V X @: @: 2 @:vxor@:(s,t)}
177c0ea7
JB
35858
35859@c
d7b8e6c6 35860@r{ @: Y @: @: @:@:user commands}
177c0ea7
JB
35861
35862@c
d7b8e6c6 35863@r{ @: z @: @: @:@:user commands}
177c0ea7
JB
35864
35865@c
d7b8e6c6
EZ
35866@r{ c@: Z [ @: @: 45 @:calc-kbd-if@:}
35867@r{ c@: Z | @: @: 45 @:calc-kbd-else-if@:}
35868@r{ @: Z : @: @: @:calc-kbd-else@:}
35869@r{ @: Z ] @: @: @:calc-kbd-end-if@:}
177c0ea7
JB
35870
35871@c
d7b8e6c6
EZ
35872@r{ @: Z @{ @: @: 4 @:calc-kbd-loop@:}
35873@r{ c@: Z / @: @: 45 @:calc-kbd-break@:}
35874@r{ @: Z @} @: @: @:calc-kbd-end-loop@:}
35875@r{ n@: Z < @: @: @:calc-kbd-repeat@:}
35876@r{ @: Z > @: @: @:calc-kbd-end-repeat@:}
35877@r{ n m@: Z ( @: @: @:calc-kbd-for@:}
35878@r{ s@: Z ) @: @: @:calc-kbd-end-for@:}
177c0ea7
JB
35879
35880@c
d7b8e6c6 35881@r{ @: Z C-g @: @: @:@:cancel if/loop command}
177c0ea7
JB
35882
35883@c
d7b8e6c6
EZ
35884@r{ @: Z ` @: @: @:calc-kbd-push@:}
35885@r{ @: Z ' @: @: @:calc-kbd-pop@:}
faa3b6fc 35886@r{ @: Z # @: @: @:calc-kbd-query@:}
177c0ea7
JB
35887
35888@c
d7b8e6c6
EZ
35889@r{ comp@: Z C @:func, args @: 50 @:calc-user-define-composition@:}
35890@r{ @: Z D @:key, command @: @:calc-user-define@:}
35891@r{ @: Z E @:key, editing @: 30 @:calc-user-define-edit@:}
35892@r{ defn@: Z F @:k, c, f, a, n@: 28 @:calc-user-define-formula@:}
35893@r{ @: Z G @:key @: @:calc-get-user-defn@:}
35894@r{ @: Z I @: @: @:calc-user-define-invocation@:}
35895@r{ @: Z K @:key, command @: @:calc-user-define-kbd-macro@:}
35896@r{ @: Z P @:key @: @:calc-user-define-permanent@:}
35897@r{ @: Z S @: @: 30 @:calc-edit-user-syntax@:}
35898@r{ @: Z T @: @: 12 @:calc-timing@:}
35899@r{ @: Z U @:key @: @:calc-user-undefine@:}
35900
35901@end format
35902
35903@noindent
35904NOTES
35905
35906@enumerate
35907@c 1
35908@item
a4231b04
JB
35909Positive prefix arguments apply to @expr{n} stack entries.
35910Negative prefix arguments apply to the @expr{-n}th stack entry.
d7b8e6c6 35911A prefix of zero applies to the entire stack. (For @key{LFD} and
5d67986c 35912@kbd{M-@key{DEL}}, the meaning of the sign is reversed.)
d7b8e6c6
EZ
35913
35914@c 2
35915@item
a4231b04 35916Positive prefix arguments apply to @expr{n} stack entries.
d7b8e6c6 35917Negative prefix arguments apply to the top stack entry
a4231b04 35918and the next @expr{-n} stack entries.
d7b8e6c6
EZ
35919
35920@c 3
35921@item
a4231b04
JB
35922Positive prefix arguments rotate top @expr{n} stack entries by one.
35923Negative prefix arguments rotate the entire stack by @expr{-n}.
d7b8e6c6
EZ
35924A prefix of zero reverses the entire stack.
35925
35926@c 4
35927@item
35928Prefix argument specifies a repeat count or distance.
35929
35930@c 5
35931@item
a4231b04
JB
35932Positive prefix arguments specify a precision @expr{p}.
35933Negative prefix arguments reduce the current precision by @expr{-p}.
d7b8e6c6
EZ
35934
35935@c 6
35936@item
35937A prefix argument is interpreted as an additional step-size parameter.
35938A plain @kbd{C-u} prefix means to prompt for the step size.
35939
35940@c 7
35941@item
35942A prefix argument specifies simplification level and depth.
359431=Default, 2=like @kbd{a s}, 3=like @kbd{a e}.
35944
35945@c 8
35946@item
35947A negative prefix operates only on the top level of the input formula.
35948
35949@c 9
35950@item
a4231b04
JB
35951Positive prefix arguments specify a word size of @expr{w} bits, unsigned.
35952Negative prefix arguments specify a word size of @expr{w} bits, signed.
d7b8e6c6
EZ
35953
35954@c 10
35955@item
a4231b04 35956Prefix arguments specify the shift amount @expr{n}. The @expr{w} argument
d7b8e6c6
EZ
35957cannot be specified in the keyboard version of this command.
35958
35959@c 11
35960@item
a4231b04 35961From the keyboard, @expr{d} is omitted and defaults to zero.
d7b8e6c6
EZ
35962
35963@c 12
35964@item
35965Mode is toggled; a positive prefix always sets the mode, and a negative
35966prefix always clears the mode.
35967
35968@c 13
35969@item
35970Some prefix argument values provide special variations of the mode.
35971
35972@c 14
35973@item
a4231b04
JB
35974A prefix argument, if any, is used for @expr{m} instead of taking
35975@expr{m} from the stack. @expr{M} may take any of these values:
d7b8e6c6
EZ
35976@iftex
35977{@advance@tableindent10pt
35978@end iftex
35979@table @asis
35980@item Integer
a4231b04 35981Random integer in the interval @expr{[0 .. m)}.
d7b8e6c6 35982@item Float
a4231b04 35983Random floating-point number in the interval @expr{[0 .. m)}.
d7b8e6c6
EZ
35984@item 0.0
35985Gaussian with mean 1 and standard deviation 0.
35986@item Error form
35987Gaussian with specified mean and standard deviation.
35988@item Interval
35989Random integer or floating-point number in that interval.
35990@item Vector
35991Random element from the vector.
35992@end table
35993@iftex
35994}
35995@end iftex
35996
35997@c 15
35998@item
35999A prefix argument from 1 to 6 specifies number of date components
36000to remove from the stack. @xref{Date Conversions}.
36001
36002@c 16
36003@item
36004A prefix argument specifies a time zone; @kbd{C-u} says to take the
36005time zone number or name from the top of the stack. @xref{Time Zones}.
36006
36007@c 17
36008@item
36009A prefix argument specifies a day number (0-6, 0-31, or 0-366).
36010
36011@c 18
36012@item
36013If the input has no units, you will be prompted for both the old and
36014the new units.
36015
36016@c 19
36017@item
36018With a prefix argument, collect that many stack entries to form the
36019input data set. Each entry may be a single value or a vector of values.
36020
36021@c 20
36022@item
a4231b04 36023With a prefix argument of 1, take a single
8e04863e
JB
36024@texline @var{n}@math{\times2}
36025@infoline @mathit{@var{N}x2}
a4231b04 36026matrix from the stack instead of two separate data vectors.
d7b8e6c6
EZ
36027
36028@c 21
36029@item
a4231b04
JB
36030The row or column number @expr{n} may be given as a numeric prefix
36031argument instead. A plain @kbd{C-u} prefix says to take @expr{n}
36032from the top of the stack. If @expr{n} is a vector or interval,
d7b8e6c6
EZ
36033a subvector/submatrix of the input is created.
36034
36035@c 22
36036@item
a4231b04 36037The @expr{op} prompt can be answered with the key sequence for the
d7b8e6c6
EZ
36038desired function, or with @kbd{x} or @kbd{z} followed by a function name,
36039or with @kbd{$} to take a formula from the top of the stack, or with
36040@kbd{'} and a typed formula. In the last two cases, the formula may
36041be a nameless function like @samp{<#1+#2>} or @samp{<x, y : x+y>}, or it
36042may include @kbd{$}, @kbd{$$}, etc. (where @kbd{$} will correspond to the
36043last argument of the created function), or otherwise you will be
36044prompted for an argument list. The number of vectors popped from the
36045stack by @kbd{V M} depends on the number of arguments of the function.
36046
36047@c 23
36048@item
36049One of the mapping direction keys @kbd{_} (horizontal, i.e., map
36050by rows or reduce across), @kbd{:} (vertical, i.e., map by columns or
36051reduce down), or @kbd{=} (map or reduce by rows) may be used before
a4231b04 36052entering @expr{op}; these modify the function name by adding the letter
d7b8e6c6
EZ
36053@code{r} for ``rows,'' @code{c} for ``columns,'' @code{a} for ``across,''
36054or @code{d} for ``down.''
36055
36056@c 24
36057@item
36058The prefix argument specifies a packing mode. A nonnegative mode
36059is the number of items (for @kbd{v p}) or the number of levels
36060(for @kbd{v u}). A negative mode is as described below. With no
36061prefix argument, the mode is taken from the top of the stack and
36062may be an integer or a vector of integers.
36063@iftex
36064{@advance@tableindent-20pt
36065@end iftex
36066@table @cite
36067@item -1
b275eac7 36068(@var{2}) Rectangular complex number.
d7b8e6c6 36069@item -2
b275eac7 36070(@var{2}) Polar complex number.
d7b8e6c6 36071@item -3
b275eac7 36072(@var{3}) HMS form.
d7b8e6c6 36073@item -4
b275eac7 36074(@var{2}) Error form.
d7b8e6c6 36075@item -5
b275eac7 36076(@var{2}) Modulo form.
d7b8e6c6 36077@item -6
b275eac7 36078(@var{2}) Closed interval.
d7b8e6c6 36079@item -7
b275eac7 36080(@var{2}) Closed .. open interval.
d7b8e6c6 36081@item -8
b275eac7 36082(@var{2}) Open .. closed interval.
d7b8e6c6 36083@item -9
b275eac7 36084(@var{2}) Open interval.
d7b8e6c6 36085@item -10
b275eac7 36086(@var{2}) Fraction.
d7b8e6c6 36087@item -11
b275eac7 36088(@var{2}) Float with integer mantissa.
d7b8e6c6 36089@item -12
a4231b04 36090(@var{2}) Float with mantissa in @expr{[1 .. 10)}.
d7b8e6c6 36091@item -13
b275eac7 36092(@var{1}) Date form (using date numbers).
d7b8e6c6 36093@item -14
b275eac7 36094(@var{3}) Date form (using year, month, day).
d7b8e6c6 36095@item -15
b275eac7 36096(@var{6}) Date form (using year, month, day, hour, minute, second).
d7b8e6c6
EZ
36097@end table
36098@iftex
36099}
36100@end iftex
36101
36102@c 25
36103@item
a4231b04
JB
36104A prefix argument specifies the size @expr{n} of the matrix. With no
36105prefix argument, @expr{n} is omitted and the size is inferred from
d7b8e6c6
EZ
36106the input vector.
36107
36108@c 26
36109@item
a4231b04 36110The prefix argument specifies the starting position @expr{n} (default 1).
d7b8e6c6
EZ
36111
36112@c 27
36113@item
36114Cursor position within stack buffer affects this command.
36115
36116@c 28
36117@item
36118Arguments are not actually removed from the stack by this command.
36119
36120@c 29
36121@item
36122Variable name may be a single digit or a full name.
36123
36124@c 30
36125@item
33108698
JB
36126Editing occurs in a separate buffer. Press @kbd{C-c C-c} (or
36127@key{LFD}, or in some cases @key{RET}) to finish the edit, or kill the
36128buffer with @kbd{C-x k} to cancel the edit. The @key{LFD} key prevents evaluation
d7b8e6c6
EZ
36129of the result of the edit.
36130
36131@c 31
36132@item
36133The number prompted for can also be provided as a prefix argument.
36134
36135@c 32
36136@item
36137Press this key a second time to cancel the prefix.
36138
36139@c 33
36140@item
36141With a negative prefix, deactivate all formulas. With a positive
36142prefix, deactivate and then reactivate from scratch.
36143
36144@c 34
36145@item
36146Default is to scan for nearest formula delimiter symbols. With a
36147prefix of zero, formula is delimited by mark and point. With a
36148non-zero prefix, formula is delimited by scanning forward or
36149backward by that many lines.
36150
36151@c 35
36152@item
36153Parse the region between point and mark as a vector. A nonzero prefix
36154parses @var{n} lines before or after point as a vector. A zero prefix
36155parses the current line as a vector. A @kbd{C-u} prefix parses the
36156region between point and mark as a single formula.
36157
36158@c 36
36159@item
36160Parse the rectangle defined by point and mark as a matrix. A positive
36161prefix @var{n} divides the rectangle into columns of width @var{n}.
36162A zero or @kbd{C-u} prefix parses each line as one formula. A negative
36163prefix suppresses special treatment of bracketed portions of a line.
36164
36165@c 37
36166@item
36167A numeric prefix causes the current language mode to be ignored.
36168
36169@c 38
36170@item
36171Responding to a prompt with a blank line answers that and all
36172later prompts by popping additional stack entries.
36173
36174@c 39
36175@item
a4231b04
JB
36176Answer for @expr{v} may also be of the form @expr{v = v_0} or
36177@expr{v - v_0}.
d7b8e6c6
EZ
36178
36179@c 40
36180@item
a4231b04
JB
36181With a positive prefix argument, stack contains many @expr{y}'s and one
36182common @expr{x}. With a zero prefix, stack contains a vector of
36183@expr{y}s and a common @expr{x}. With a negative prefix, stack
36184contains many @expr{[x,y]} vectors. (For 3D plots, substitute
36185@expr{z} for @expr{y} and @expr{x,y} for @expr{x}.)
d7b8e6c6
EZ
36186
36187@c 41
36188@item
36189With any prefix argument, all curves in the graph are deleted.
36190
36191@c 42
36192@item
36193With a positive prefix, refines an existing plot with more data points.
36194With a negative prefix, forces recomputation of the plot data.
36195
36196@c 43
36197@item
36198With any prefix argument, set the default value instead of the
36199value for this graph.
36200
36201@c 44
36202@item
36203With a negative prefix argument, set the value for the printer.
36204
36205@c 45
36206@item
36207Condition is considered ``true'' if it is a nonzero real or complex
36208number, or a formula whose value is known to be nonzero; it is ``false''
36209otherwise.
36210
36211@c 46
36212@item
36213Several formulas separated by commas are pushed as multiple stack
36214entries. Trailing @kbd{)}, @kbd{]}, @kbd{@}}, @kbd{>}, and @kbd{"}
36215delimiters may be omitted. The notation @kbd{$$$} refers to the value
36216in stack level three, and causes the formula to replace the top three
36217stack levels. The notation @kbd{$3} refers to stack level three without
36218causing that value to be removed from the stack. Use @key{LFD} in place
36219of @key{RET} to prevent evaluation; use @kbd{M-=} in place of @key{RET}
a4231b04 36220to evaluate variables.
d7b8e6c6
EZ
36221
36222@c 47
36223@item
36224The variable is replaced by the formula shown on the right. The
36225Inverse flag reverses the order of the operands, e.g., @kbd{I s - x}
a4231b04 36226assigns
8e04863e 36227@texline @math{x \coloneq a-x}.
a4231b04 36228@infoline @expr{x := a-x}.
d7b8e6c6
EZ
36229
36230@c 48
36231@item
36232Press @kbd{?} repeatedly to see how to choose a model. Answer the
a4231b04 36233variables prompt with @expr{iv} or @expr{iv;pv} to specify
d7b8e6c6 36234independent and parameter variables. A positive prefix argument
8e04863e 36235takes @mathit{@var{n}+1} vectors from the stack; a zero prefix takes a matrix
d7b8e6c6
EZ
36236and a vector from the stack.
36237
36238@c 49
36239@item
36240With a plain @kbd{C-u} prefix, replace the current region of the
36241destination buffer with the yanked text instead of inserting.
36242
36243@c 50
36244@item
36245All stack entries are reformatted; the @kbd{H} prefix inhibits this.
36246The @kbd{I} prefix sets the mode temporarily, redraws the top stack
36247entry, then restores the original setting of the mode.
36248
36249@c 51
36250@item
36251A negative prefix sets the default 3D resolution instead of the
36252default 2D resolution.
36253
36254@c 52
36255@item
36256This grabs a vector of the form [@var{prec}, @var{wsize}, @var{ssize},
36257@var{radix}, @var{flfmt}, @var{ang}, @var{frac}, @var{symb}, @var{polar},
36258@var{matrix}, @var{simp}, @var{inf}]. A prefix argument from 1 to 12
36259grabs the @var{n}th mode value only.
36260@end enumerate
36261
36262@iftex
36263(Space is provided below for you to keep your own written notes.)
36264@page
36265@endgroup
36266@end iftex
36267
36268
36269@c [end-summary]
36270
36271@node Key Index, Command Index, Summary, Top
36272@unnumbered Index of Key Sequences
36273
36274@printindex ky
36275
36276@node Command Index, Function Index, Key Index, Top
36277@unnumbered Index of Calculator Commands
36278
36279Since all Calculator commands begin with the prefix @samp{calc-}, the
36280@kbd{x} key has been provided as a variant of @kbd{M-x} which automatically
36281types @samp{calc-} for you. Thus, @kbd{x last-args} is short for
36282@kbd{M-x calc-last-args}.
36283
36284@printindex pg
36285
36286@node Function Index, Concept Index, Command Index, Top
36287@unnumbered Index of Algebraic Functions
36288
36289This is a list of built-in functions and operators usable in algebraic
36290expressions. Their full Lisp names are derived by adding the prefix
36291@samp{calcFunc-}, as in @code{calcFunc-sqrt}.
36292@iftex
36293All functions except those noted with ``*'' have corresponding
36294Calc keystrokes and can also be found in the Calc Summary.
36295@end iftex
36296
36297@printindex tp
36298
36299@node Concept Index, Variable Index, Function Index, Top
36300@unnumbered Concept Index
36301
36302@printindex cp
36303
36304@node Variable Index, Lisp Function Index, Concept Index, Top
36305@unnumbered Index of Variables
36306
36307The variables in this list that do not contain dashes are accessible
36308as Calc variables. Add a @samp{var-} prefix to get the name of the
36309corresponding Lisp variable.
36310
36311The remaining variables are Lisp variables suitable for @code{setq}ing
3b846359 36312in your Calc init file or @file{.emacs} file.
d7b8e6c6
EZ
36313
36314@printindex vr
36315
36316@node Lisp Function Index, , Variable Index, Top
36317@unnumbered Index of Lisp Math Functions
36318
36319The following functions are meant to be used with @code{defmath}, not
36320@code{defun} definitions. For names that do not start with @samp{calc-},
36321the corresponding full Lisp name is derived by adding a prefix of
36322@samp{math-}.
36323
36324@printindex fn
36325
36326@summarycontents
36327
36328@c [end]
36329
36330@contents
36331@bye
36332
36333
ab5796a9
MB
36334@ignore
36335 arch-tag: 77a71809-fa4d-40be-b2cc-da3e8fb137c0
36336@end ignore